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 "BiblioInfo.h"
17 #include "InsetCommand.h"
18 #include "InsetCommandParams.h"
19 #include "RenderButton.h"
20 #include "MailInset.h"
22 #include "EmbeddedFiles.h"
24 #include <boost/scoped_ptr.hpp>
32 class RenderMonitoredPreview;
34 /// for including tex/lyx files
35 class InsetInclude : public InsetCommand {
38 InsetInclude(InsetCommandParams const &);
41 void setBuffer(Buffer & buffer);
43 /// Override these InsetButton methods if Previewing
44 void metrics(MetricsInfo & mi, Dimension & dim) const;
46 void draw(PainterInfo & pi, int x, int y) const;
48 DisplayType display() const;
50 InsetCode lyxCode() const { return INCLUDE_CODE; }
52 * \param buffer the Buffer containing this inset.
53 * \param keys the list of bibkeys in the child buffer.
54 * \param it not used here
56 void fillWithBibKeys(BiblioInfo & keys, InsetIterator const & it) const;
58 /** Update the cache with all bibfiles in use of the child buffer
59 * (including bibfiles of grandchild documents).
60 * Does nothing if the child document is not loaded to prevent
61 * automatic loading of all child documents upon loading the master.
62 * \param buffer the Buffer containing this inset.
64 void updateBibfilesCache();
65 /** Return the cache with all bibfiles in use of the child buffer
66 * (including bibfiles of grandchild documents).
67 * Return an empty vector if the child doc is not loaded.
68 * \param buffer the Buffer containing this inset.
70 EmbeddedFileList const &
71 getBibfilesCache(Buffer const & buffer) const;
73 EDITABLE editable() const { return IS_EDITABLE; }
75 int latex(odocstream &, OutputParams const &) const;
77 int plaintext(odocstream &, OutputParams const &) const;
79 int docbook(odocstream &, OutputParams const &) const;
81 void validate(LaTeXFeatures &) const;
83 void addPreview(graphics::PreviewLoader &) const;
85 void addToToc(ParConstIterator const &) const;
87 void updateLabels(ParIterator const &);
88 /// child document can be embedded
89 void registerEmbeddedFiles(EmbeddedFileList &) const;
91 void updateEmbeddedFile(EmbeddedFile const & file);
93 static ParamInfo const & findInfo(std::string const &);
95 static std::string defaultCommand() { return "include"; };
97 static bool isCompatibleCommand(std::string const & s);
99 InsetInclude(InsetInclude const &);
101 void doDispatch(Cursor & cur, FuncRequest & cmd);
103 Inset * clone() const { return new InsetInclude(*this); }
105 /** Slot receiving a signal that the external file has changed
106 * and the preview should be regenerated.
108 void fileChanged() const;
110 /// set the parameters
111 void setParams(InsetCommandParams const & params);
112 /// get the text displayed on the button
113 docstring screenLabel() const;
114 /// holds the entity name that defines the file location (SGML)
115 docstring const include_label;
117 /// The pointer never changes although *preview_'s contents may.
118 boost::scoped_ptr<RenderMonitoredPreview> const preview_;
121 mutable bool set_label_;
122 mutable RenderButton button_;
123 mutable docstring listings_label_;
127 /// return loaded Buffer or zero if the file loading did not proceed.
128 Buffer * loadIfNeeded(Buffer const & parent, InsetCommandParams const & params);
132 #endif // INSETINCLUDE_H