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
8 * \author Richard Heck (conversion to InsetCommand)
10 * Full author contact details are available in file CREDITS.
13 #ifndef INSET_INCLUDE_H
14 #define INSET_INCLUDE_H
16 #include "InsetCommand.h"
18 #include "BiblioInfo.h"
20 #include "InsetCommandParams.h"
21 #include "RenderButton.h"
23 #include "support/FileNameList.h"
25 #include <boost/scoped_ptr.hpp>
33 class RenderMonitoredPreview;
35 /// for including tex/lyx files
36 class InsetInclude : public InsetCommand {
39 InsetInclude(Buffer * buf, InsetCommandParams const &);
42 void setBuffer(Buffer & buffer);
43 bool isLabeled() const { return true; }
45 /// Override these InsetButton methods if Previewing
46 void metrics(MetricsInfo & mi, Dimension & dim) const;
48 void draw(PainterInfo & pi, int x, int y) const;
50 DisplayType display() const;
52 InsetCode lyxCode() const { return INCLUDE_CODE; }
55 void setChildBuffer(Buffer * buffer);
58 * \param buffer the Buffer containing this inset.
59 * \param keys the list of bibkeys in the child buffer.
60 * \param it not used here
62 void fillWithBibKeys(BiblioInfo & keys, InsetIterator const & it) const;
65 bool hasSettings() const { return true; }
67 int latex(odocstream &, OutputParams const &) const;
69 int plaintext(odocstream &, OutputParams const &) const;
71 int docbook(odocstream &, OutputParams const &) const;
73 docstring xhtml(XHTMLStream &, OutputParams const &) const;
75 void validate(LaTeXFeatures &) const;
77 void addPreview(DocIterator const &, graphics::PreviewLoader &) const;
79 void addToToc(DocIterator const &);
83 void updateBuffer(ParIterator const &, UpdateType);
85 static ParamInfo const & findInfo(std::string const &);
87 static std::string defaultCommand() { return "include"; }
89 static bool isCompatibleCommand(std::string const & s);
91 docstring contextMenu(BufferView const & bv, int x, int y) const;
92 /// \return the child buffer if the file is a LyX doc and could be loaded
93 Buffer * getChildBuffer() const;
95 InsetInclude(InsetInclude const &);
97 void doDispatch(Cursor & cur, FuncRequest & cmd);
99 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
101 Inset * clone() const { return new InsetInclude(*this); }
103 /** Slot receiving a signal that the external file has changed
104 * and the preview should be regenerated.
106 void fileChanged() const;
108 /// \return loaded Buffer or zero if the file loading did not proceed.
109 Buffer * loadIfNeeded() const;
110 /// launch external application
111 void editIncluded(std::string const & file);
112 /// set the parameters
113 void setParams(InsetCommandParams const & params);
114 /// get the text displayed on the button
115 docstring screenLabel() const;
116 /// holds the entity name that defines the file location (SGML)
117 docstring const include_label;
119 bool isChildIncluded() const;
121 /// The pointer never changes although *preview_'s contents may.
122 boost::scoped_ptr<RenderMonitoredPreview> const preview_;
125 mutable bool failedtoload_;
127 mutable bool set_label_;
128 mutable RenderButton button_;
129 mutable docstring listings_label_;
131 mutable Buffer * child_buffer_;
137 #endif // INSET_INCLUDE_H