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 &);
33 /// Override these InsetButton methods if Previewing
34 void metrics(MetricsInfo & mi, Dimension & dim) const;
36 void draw(PainterInfo & pi, int x, int y) const;
38 virtual bool display() const;
40 /// get the parameters
41 InsetCommandParams const & params(void) const;
44 InsetBase::Code lyxCode() const { return InsetBase::INCLUDE_CODE; }
46 * \param buffer the Buffer containing this inset.
47 * \param list the list of labels in the child buffer.
49 void getLabelList(Buffer const & buffer,
50 std::vector<std::string> & list) const;
52 * \param buffer the Buffer containing this inset.
53 * \param keys the list of bibkeys in the child buffer.
56 void fillWithBibKeys(Buffer const & buffer,
57 std::vector<std::pair<std::string,std::string> > & keys) const;
59 EDITABLE editable() const { return IS_EDITABLE; }
61 void write(Buffer const &, std::ostream &) const;
63 void read(Buffer const &, LyXLex &);
65 int latex(Buffer const &, std::ostream &,
66 OutputParams const &) const;
68 int plaintext(Buffer const &, std::ostream &,
69 OutputParams const &) const;
71 int linuxdoc(Buffer const &, std::ostream &,
72 OutputParams const &) const;
74 int docbook(Buffer const &, std::ostream &,
75 OutputParams const &) const;
77 void validate(LaTeXFeatures &) const;
79 void addPreview(lyx::graphics::PreviewLoader &) const;
81 bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
83 InsetInclude(InsetInclude const &);
85 virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
87 virtual std::auto_ptr<InsetBase> doClone() const;
89 /** Slot receiving a signal that the external file has changed
90 * and the preview should be regenerated.
92 void fileChanged() const;
94 friend class InsetIncludeMailer;
96 /// set the parameters
97 void set(InsetCommandParams const & params, Buffer const &);
98 /// get the text displayed on the button
99 std::string const getScreenLabel(Buffer const &) const;
101 void write(std::ostream &) const;
106 InsetCommandParams params_;
107 /// holds the entity name that defines the file location (SGML)
108 std::string const include_label;
110 /// The pointer never changes although *preview_'s contents may.
111 boost::scoped_ptr<RenderMonitoredPreview> const preview_;
114 mutable bool set_label_;
115 mutable RenderButton button_;
119 #include "mailinset.h"
121 class InsetIncludeMailer : public MailInset {
124 InsetIncludeMailer(InsetInclude & inset);
126 virtual InsetBase & inset() const { return inset_; }
128 virtual std::string const & name() const { return name_; }
130 virtual std::string const inset2string(Buffer const &) const;
132 static void string2params(std::string const &, InsetCommandParams &);
134 static std::string const params2string(InsetCommandParams const &);
137 static std::string const name_;
139 InsetInclude & inset_;
142 #endif // INSETINCLUDE_H