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 "RenderButton.h"
20 #include <boost/scoped_ptr.hpp>
27 class InsetCommandParams;
30 class RenderMonitoredPreview;
36 /// for including tex/lyx files
37 class InsetInclude : public InsetCommand {
40 InsetInclude(Buffer * buf, InsetCommandParams const &);
45 void setChildBuffer(Buffer * buffer);
46 /// \return the child buffer if the file is a LyX doc and could be loaded
47 Buffer * getChildBuffer() const;
49 /** Update the cache with all bibfiles in use of the child buffer
50 * (including bibfiles of grandchild documents).
51 * Does nothing if the child document is not loaded to prevent
52 * automatic loading of all child documents upon loading the master.
53 * \param buffer the Buffer containing this inset.
55 void updateBibfilesCache();
57 /** Return the cache with all bibfiles in use of the child buffer
58 * (including bibfiles of grandchild documents).
59 * Return an empty vector if the child doc is not loaded.
60 * \param buffer the Buffer containing this inset.
62 support::FileNameList const &
63 getBibfilesCache() const;
68 /// \name Public functions inherited from Inset class
71 void setBuffer(Buffer & buffer);
73 bool isLabeled() const { return true; }
74 /// Override these InsetButton methods if Previewing
75 void metrics(MetricsInfo & mi, Dimension & dim) const;
77 void draw(PainterInfo & pi, int x, int y) const;
79 DisplayType display() const;
81 InsetCode lyxCode() const { return INCLUDE_CODE; }
83 docstring layoutName() const;
85 * \param keys the list of bibkeys in the child buffer.
86 * \param it not used here
88 void collectBibKeys(InsetIterator const &) const;
90 bool hasSettings() const { return true; }
92 void latex(otexstream &, OutputParams const &) const;
94 int plaintext(odocstringstream & ods, OutputParams const & op,
95 size_t max_length = INT_MAX) const;
97 int docbook(odocstream &, OutputParams const &) const;
99 docstring xhtml(XHTMLStream &, OutputParams const &) const;
101 void validate(LaTeXFeatures &) const;
103 void addPreview(DocIterator const &, graphics::PreviewLoader &) const;
105 void addToToc(DocIterator const & di, bool output_active) const;
107 void updateBuffer(ParIterator const &, UpdateType);
109 std::string contextMenuName() const;
112 /// \name Static public methods obligated for InsetCommand derived classes
115 static ParamInfo const & findInfo(std::string const &);
117 static std::string defaultCommand() { return "include"; }
119 static bool isCompatibleCommand(std::string const & s);
124 InsetInclude(InsetInclude const &);
127 /** Slot receiving a signal that the external file has changed
128 * and the preview should be regenerated.
130 void fileChanged() const;
131 /// \return loaded Buffer or zero if the file loading did not proceed.
132 Buffer * loadIfNeeded() const;
133 /// launch external application
134 void editIncluded(std::string const & file);
136 bool isChildIncluded() const;
138 /// \name Private functions inherited from Inset class
140 Inset * clone() const { return new InsetInclude(*this); }
142 void doDispatch(Cursor & cur, FuncRequest & cmd);
144 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
147 /// \name Private functions inherited from InsetCommand class
149 /// set the parameters
150 // FIXME:InsetCommmand::setParams is not virtual
151 void setParams(InsetCommandParams const & params);
152 /// get the text displayed on the button
153 docstring screenLabel() const;
156 /// holds the entity name that defines the file location (SGML)
157 docstring const include_label;
159 /// The pointer never changes although *preview_'s contents may.
160 boost::scoped_ptr<RenderMonitoredPreview> const preview_;
163 mutable bool failedtoload_;
165 mutable bool set_label_;
166 mutable RenderButton button_;
167 mutable docstring listings_label_;
169 mutable Buffer * child_buffer_;
175 #endif // INSET_INCLUDE_H