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
15 #include "insetcommand.h"
17 #include <boost/scoped_ptr.hpp>
22 // Created by AAS 970521
24 /// for including tex/lyx files
25 class InsetInclude: public InsetButton, boost::noncopyable {
27 /// the type of inclusion
36 Params(InsetCommandParams const & cp = InsetCommandParams("input"),
38 string const & name = string())
39 : cparams(cp), flag(f),
40 masterFilename_(name) {}
42 InsetCommandParams cparams;
44 string masterFilename_;
47 bool operator==(Params const &) const;
49 bool operator!=(Params const &) const;
53 InsetInclude(Params const &);
55 InsetInclude(InsetCommandParams const &, Buffer const &);
60 virtual dispatch_result localDispatch(FuncRequest const & cmd);
62 /// Override these InsetButton methods if Previewing
63 int ascent(BufferView *, LyXFont const &) const;
65 int descent(BufferView *, LyXFont const &) const;
67 int width(BufferView *, LyXFont const &) const;
69 void draw(BufferView *, LyXFont const &, int, float &) const;
71 /// get the parameters
72 Params const & params(void) const;
73 /// set the parameters
74 void set(Params const & params);
77 virtual Inset * clone(Buffer const &) const;
79 Inset::Code lyxCode() const { return Inset::INCLUDE_CODE; }
80 /// This returns the list of labels on the child buffer
81 std::vector<string> const getLabelList() const;
82 /// This returns the list of bibkeys on the child buffer
83 void fillWithBibKeys(std::vector<std::pair<string,string> > & keys) const;
85 EDITABLE editable() const
89 /// With lyx3 we won't overload these 3 methods
90 void write(Buffer const *, std::ostream &) const;
92 void read(Buffer const *, LyXLex &);
94 int latex(Buffer const *, std::ostream &,
95 LatexRunParams const &) const;
97 int ascii(Buffer const *, std::ostream &, int linelen) const;
99 int linuxdoc(Buffer const *, std::ostream &) const;
101 int docbook(Buffer const *, std::ostream &, bool mixcont) const;
103 void validate(LaTeXFeatures &) const;
105 /// take up a whole row if we're not type INPUT
106 bool display() const;
108 /// return true if the file is or got loaded.
109 bool loadIfNeeded() const;
112 void addPreview(grfx::PreviewLoader &) const;
115 /// get the text displayed on the button
116 string const getScreenLabel(Buffer const *) const;
117 /// is this a verbatim include ?
118 bool isVerbatim() const;
119 /// get the filename of the master buffer
120 string const getMasterFilename() const;
121 /// get the included file name
122 string const getFileName() const;
126 /// holds the entity name that defines the file location (SGML)
127 string const include_label;
129 /// Use the Pimpl idiom to hide the internals of the previewer.
131 friend class PreviewImpl;
132 /// The pointer never changes although *preview_'s contents may.
133 boost::scoped_ptr<PreviewImpl> const preview_;
137 inline bool InsetInclude::isVerbatim() const
139 return params_.flag == VERB || params_.flag == VERBAST;
142 #include "mailinset.h"
144 class InsetIncludeMailer : public MailInset {
147 InsetIncludeMailer(InsetInclude & inset);
149 virtual InsetBase & inset() const { return inset_; }
151 virtual string const & name() const { return name_; }
153 virtual string const inset2string() const;
155 static void string2params(string const &, InsetInclude::Params &);
157 static string const params2string(InsetInclude::Params const &);
160 static string const name_;
162 InsetInclude & inset_;
165 #endif // INSETINCLUDE_H