4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
9 * Full author contact details are available in file CREDITS.
12 #ifndef INSET_INCLUDE_H
13 #define INSET_INCLUDE_H
16 #include "insetcommandparams.h"
17 #include "render_button.h"
18 #include <boost/scoped_ptr.hpp>
23 class RenderMonitoredPreview;
26 /// for including tex/lyx files
27 class InsetInclude: public InsetOld {
30 InsetInclude(InsetCommandParams const &);
31 InsetInclude(InsetInclude const &);
35 virtual std::auto_ptr<InsetBase> clone() const;
37 /// Override these InsetButton methods if Previewing
38 void metrics(MetricsInfo & mi, Dimension & dim) const;
40 void draw(PainterInfo & pi, int x, int y) const;
42 virtual bool display() const { return true; }
44 /// get the parameters
45 InsetCommandParams const & params(void) const;
48 InsetOld::Code lyxCode() const { return InsetOld::INCLUDE_CODE; }
50 * \param buffer the Buffer containing this inset.
51 * \param list the list of labels in the child buffer.
53 void getLabelList(Buffer const & buffer,
54 std::vector<std::string> & list) const;
56 * \param buffer the Buffer containing this inset.
57 * \param keys the list of bibkeys in the child buffer.
60 void fillWithBibKeys(Buffer const & buffer,
61 std::vector<std::pair<std::string,std::string> > & keys) const;
63 EDITABLE editable() const { return IS_EDITABLE; }
65 void write(Buffer const &, std::ostream &) const;
67 void read(Buffer const &, LyXLex &);
69 int latex(Buffer const &, std::ostream &,
70 LatexRunParams const &) const;
72 int ascii(Buffer const &, std::ostream &,
73 LatexRunParams const &) const;
75 int linuxdoc(Buffer const &, std::ostream &,
76 LatexRunParams const &) const;
78 int docbook(Buffer const &, std::ostream &,
79 LatexRunParams const &) const;
81 void validate(LaTeXFeatures &) const;
83 void addPreview(lyx::graphics::PreviewLoader &) const;
88 priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &);
90 /// Slot receiving a signal that the preview is ready to display.
91 void statusChanged() const;
92 /** Slot receiving a signal that the external file has changed
93 * and the preview should be regenerated.
95 void fileChanged() const;
97 friend class InsetIncludeMailer;
99 /// set the parameters
100 void set(InsetCommandParams const & params, Buffer const &);
101 /// get the text displayed on the button
102 std::string const getScreenLabel(Buffer const &) const;
104 void write(std::ostream &) const;
109 InsetCommandParams params_;
110 /// holds the entity name that defines the file location (SGML)
111 std::string const include_label;
113 /// The pointer never changes although *preview_'s contents may.
114 boost::scoped_ptr<RenderMonitoredPreview> const preview_;
117 mutable bool set_label_;
118 mutable RenderButton button_;
122 #include "mailinset.h"
124 class InsetIncludeMailer : public MailInset {
127 InsetIncludeMailer(InsetInclude & inset);
129 virtual InsetBase & inset() const { return inset_; }
131 virtual std::string const & name() const { return name_; }
133 virtual std::string const inset2string(Buffer const &) const;
135 static void string2params(std::string const &, InsetCommandParams &);
137 static std::string const params2string(InsetCommandParams const &);
140 static std::string const name_;
142 InsetInclude & inset_;
145 #endif // INSETINCLUDE_H