X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2Finsetinclude.h;h=99d930061e096f1eece840c6dfef3248c3783c68;hb=62be565337f08855dbbbeea9d90db2ce497d4c10;hp=95e9136dc1e2e9bd222554e7b8a28ce57348deb8;hpb=ee1229d7431f99788d04e99fcd8c57de69b4acaf;p=lyx.git diff --git a/src/insets/insetinclude.h b/src/insets/insetinclude.h index 95e9136dc1..99d930061e 100644 --- a/src/insets/insetinclude.h +++ b/src/insets/insetinclude.h @@ -1,190 +1,165 @@ // -*- C++ -*- -/* This file is part of* - * ====================================================== +/** + * \file insetinclude.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * LyX, The Document Processor - * - * Copyright (C) 1997 LyX Team (this file was created this year) - * - * ====================================================== */ + * \author Lars Gullik Bjønnes + * + * Full author contact details are available in file CREDITS + */ #ifndef INSET_INCLUDE_H #define INSET_INCLUDE_H -#ifdef __GNUG__ -#pragma interface -#endif - #include "insetcommand.h" -#include "buffer.h" -#include "support/filetools.h" +#include + +class Buffer; struct LaTeXFeatures; // Created by AAS 970521 -/** Used to include files - */ -class InsetInclude: public InsetCommand { +/// 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(): InsetCommand("include") - { - flag = InsetInclude::INCLUDE; - } - /// - InsetInclude(string const &, Buffer *); + InsetInclude(Params const &); /// + InsetInclude(InsetCommandParams const &, Buffer const &); + ~InsetInclude(); - /// - Inset * Clone() const; + /// - Inset::Code LyxCode() const { return Inset::INCLUDE_CODE; } - /// This is 1 if the childs have labels, 0 otherwise - int GetNumberOfLabels() const; + 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(BufferView *, LyXFont const &, int, float &) const; + + /// get the parameters + Params const & params(void) const; + /// set the parameters + void set(Params const & params); + + /// + virtual Inset * clone(Buffer const &, bool same_id = false) const; + /// + Inset::Code lyxCode() const { return Inset::INCLUDE_CODE; } /// This returns the list of labels on the child buffer - string getLabel(int) const; + std::vector const getLabelList() const; /// This returns the list of bibkeys on the child buffer - string getKeys() const; - /// - void Edit(int, int); + void fillWithBibKeys(std::vector > & keys) const; /// - unsigned char Editable() const + EDITABLE editable() const { - return 1; + return IS_EDITABLE; } - /// With lyx3 we won't overload these 3 methods - void Write(ostream &); - /// - void Read(LyXLex &); - /// - int Latex(ostream &, signed char fragile); - /// - int Latex(string & file, signed char fragile); - - /// - void Validate(LaTeXFeatures &) const; - - /// Input inserts anything inside a paragraph, Display can give some visual feedback - bool display() const { return !(isInput()); } - /// - string getScreenLabel() const; - /// - void setContents(string const & c) { - InsetCommand::setContents(c); - filename = MakeAbsPath(contents, - OnlyPath(getMasterFilename())); - } - /// - void setFilename(string const & n) { setContents(n); } - /// - string getMasterFilename() const { return master->fileName(); } - /// - string getFileName() const { - return filename; - } - /// In "input" mode uses \input instead of \include. - bool isInput() const { return flag == InsetInclude::INPUT; } - /// If this is true, the child file shouldn't be loaded by lyx - bool isNoLoad() const { return noload; } - - /** A verbatim file shouldn't be loaded by LyX - * No need to generate LaTeX code of a verbatim file - */ - bool isVerb() const; - /// - bool isVerbVisibleSpace() const { return flag == InsetInclude::VERBAST;} - /// - bool isInclude() const { return flag == InsetInclude::INCLUDE;} - /// - void setInput(); - /// - void setNoLoad(bool); - /// - void setInclude(); - /// - void setVerb(); - /// - void setVisibleSpace(bool b); - /// return true if the file is or got loaded. - bool loadIfNeeded() const; -private: - /// - enum Include_Flags { - /// - INCLUDE= 0, - /// - VERB = 1, - /// - INPUT = 2, - /// - VERBAST = 3 - }; - + /// With lyx3 we won't overload these 3 methods + void write(Buffer const *, std::ostream &) const; /// - bool noload; + void read(Buffer const *, LyXLex &); /// - int flag; - /// - Buffer * master; + int latex(Buffer const *, std::ostream &, + bool fragile, bool free_spc) const; /// - string filename; -}; - - -inline -bool InsetInclude::isVerb() const -{ - return (bool)(flag == InsetInclude::VERB || flag == InsetInclude::VERBAST); -} + 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; -inline -void InsetInclude::setInput() -{ - if (!isInput()) { - flag = InsetInclude::INPUT; - setCmdName("input"); - } -} + /// return true if the file is or got loaded. + bool loadIfNeeded() const; + /// + void addPreview(grfx::PreviewLoader &) const; -inline -void InsetInclude::setNoLoad(bool b) -{ - noload = b; -} +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 -void InsetInclude::setInclude() +inline bool InsetInclude::isVerbatim() const { - if (!isInclude()) { - flag = InsetInclude::INCLUDE; - setCmdName("include"); - } + return params_.flag == VERB || params_.flag == VERBAST; } +#include "mailinset.h" -inline -void InsetInclude::setVerb() -{ - if (!isVerb()) { - flag = InsetInclude::VERB; - setCmdName("verbatiminput"); - } -} - +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_; +}; -inline -void InsetInclude::setVisibleSpace(bool b) -{ - if (b && flag == InsetInclude::VERB) { - setCmdName("verbatiminput*"); - flag = InsetInclude::VERBAST; - } else if (!b && flag == InsetInclude::VERBAST) { - setCmdName("verbatiminput"); - flag = InsetInclude::VERB; - } -} -#endif +#endif // INSETINCLUDE_H