// -*- C++ -*- /** * \file insetinclude.h * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * * \author Lars Gullik Bjønnes * * Full author contact details are available in file CREDITS */ #ifndef INSET_INCLUDE_H #define INSET_INCLUDE_H #include "insetcommand.h" #include class Buffer; struct LaTeXFeatures; // Created by AAS 970521 /// for including tex/lyx files class InsetInclude: public InsetButton, boost::noncopyable { public: /// the type of inclusion enum Flags { INCLUDE = 0, //< VERB = 1, //< INPUT = 2, //< VERBAST = 3 //< }; struct Params { Params(InsetCommandParams const & cp = InsetCommandParams("input"), Flags f = INPUT, string const & name = string()) : cparams(cp), flag(f), masterFilename_(name) {} InsetCommandParams cparams; Flags flag; string masterFilename_; /// bool operator==(Params const &) const; /// bool operator!=(Params const &) const; }; /// InsetInclude(Params const &); /// InsetInclude(InsetCommandParams const &, Buffer const &); ~InsetInclude(); /// virtual dispatch_result localDispatch(FuncRequest const & cmd); /// Override these InsetButton methods if Previewing int ascent(BufferView *, LyXFont const &) const; /// int descent(BufferView *, LyXFont const &) const; /// int width(BufferView *, LyXFont const &) const; /// void draw(PainterInfo & pi, int x, int y) const; /// get the parameters Params const & params(void) const; /// set the parameters void set(Params const & params); /// virtual Inset * clone(Buffer const &) const; /// Inset::Code lyxCode() const { return Inset::INCLUDE_CODE; } /// This returns the list of labels on the child buffer std::vector const getLabelList() const; /// This returns the list of bibkeys on the child buffer void fillWithBibKeys(std::vector > & keys) const; /// EDITABLE editable() const { return IS_EDITABLE; } /// With lyx3 we won't overload these 3 methods void write(Buffer const *, std::ostream &) const; /// void read(Buffer const *, LyXLex &); /// int latex(Buffer const *, std::ostream &, LatexRunParams const &) const; /// int ascii(Buffer const *, std::ostream &, int linelen) const; /// int linuxdoc(Buffer const *, std::ostream &) const; /// int docbook(Buffer const *, std::ostream &, bool mixcont) const; /// void validate(LaTeXFeatures &) const; /// take up a whole row if we're not type INPUT bool display() const; /// return true if the file is or got loaded. bool loadIfNeeded() const; /// void addPreview(grfx::PreviewLoader &) const; private: /// get the text displayed on the button string const getScreenLabel(Buffer const *) const; /// is this a verbatim include ? bool isVerbatim() const; /// get the filename of the master buffer string const getMasterFilename() const; /// get the included file name string const getFileName() const; /// the parameters Params params_; /// holds the entity name that defines the file location (SGML) string const include_label; /// Use the Pimpl idiom to hide the internals of the previewer. class PreviewImpl; friend class PreviewImpl; /// The pointer never changes although *preview_'s contents may. boost::scoped_ptr const preview_; }; inline bool InsetInclude::isVerbatim() const { return params_.flag == VERB || params_.flag == VERBAST; } #include "mailinset.h" class InsetIncludeMailer : public MailInset { public: /// InsetIncludeMailer(InsetInclude & inset); /// virtual InsetBase & inset() const { return inset_; } /// virtual string const & name() const { return name_; } /// virtual string const inset2string() const; /// static void string2params(string const &, InsetInclude::Params &); /// static string const params2string(InsetInclude::Params const &); private: /// static string const name_; /// InsetInclude & inset_; }; #endif // INSETINCLUDE_H