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;
38 virtual dispatch_result localDispatch(FuncRequest const & cmd);
40 /// Override these InsetButton methods if Previewing
41 void metrics(MetricsInfo & mi, Dimension & dim) const;
43 void draw(PainterInfo & pi, int x, int y) const;
45 /// get the parameters
46 InsetCommandParams const & params(void) const;
49 InsetOld::Code lyxCode() const { return InsetOld::INCLUDE_CODE; }
51 * \param buffer the Buffer containing this inset.
52 * \param list the list of labels in the child buffer.
54 void getLabelList(Buffer const & buffer,
55 std::vector<std::string> & list) const;
57 * \param buffer the Buffer containing this inset.
58 * \param keys the list of bibkeys in the child buffer.
61 void fillWithBibKeys(Buffer const & buffer,
62 std::vector<std::pair<std::string,std::string> > & keys) const;
64 EDITABLE editable() const { return IS_EDITABLE; }
66 void write(Buffer const &, std::ostream &) const;
68 void read(Buffer const &, LyXLex &);
70 int latex(Buffer const &, std::ostream &, LatexRunParams const &) const;
72 int ascii(Buffer const &, std::ostream &, int linelen) const;
74 int linuxdoc(Buffer const &, std::ostream &) const;
76 int docbook(Buffer const &, std::ostream &, bool mixcont) const;
78 void validate(LaTeXFeatures &) const;
80 void addPreview(lyx::graphics::PreviewLoader &) const;
83 /// Slot receiving a signal that the preview is ready to display.
84 void statusChanged() const;
85 /** Slot receiving a signal that the external file has changed
86 * and the preview should be regenerated.
88 void fileChanged() const;
90 friend class InsetIncludeMailer;
92 /// set the parameters
93 void set(InsetCommandParams const & params, Buffer const &);
94 /// get the text displayed on the button
95 std::string const getScreenLabel(Buffer const &) const;
97 void write(std::ostream &) const;
102 InsetCommandParams params_;
103 /// holds the entity name that defines the file location (SGML)
104 std::string const include_label;
106 /// The pointer never changes although *preview_'s contents may.
107 boost::scoped_ptr<RenderMonitoredPreview> const preview_;
110 mutable bool set_label_;
111 mutable RenderButton button_;
115 #include "mailinset.h"
117 class InsetIncludeMailer : public MailInset {
120 InsetIncludeMailer(InsetInclude & inset);
122 virtual InsetBase & inset() const { return inset_; }
124 virtual std::string const & name() const { return name_; }
126 virtual std::string const inset2string(Buffer const &) const;
128 static void string2params(std::string const &, InsetCommandParams &);
130 static std::string const params2string(InsetCommandParams const &);
133 static std::string const name_;
135 InsetInclude & inset_;
138 #endif // INSETINCLUDE_H