X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetInclude.h;h=78d308008ce4d0f5ad233400112b78978ba7fdcf;hb=dc8c4f3eab6e01f3767de765423fda5e4d6c5124;hp=cfc990cbcc40ce854ed800158a2e6b6cb29ed692;hpb=350b82fd624aa91bf9e58e2f3b4c609c339fa54f;p=lyx.git diff --git a/src/insets/InsetInclude.h b/src/insets/InsetInclude.h index cfc990cbcc..78d308008c 100644 --- a/src/insets/InsetInclude.h +++ b/src/insets/InsetInclude.h @@ -15,33 +15,68 @@ #include "InsetCommand.h" -#include "BiblioInfo.h" -#include "Counters.h" -#include "InsetCommandParams.h" #include "RenderButton.h" -#include "support/FileNameList.h" - #include namespace lyx { +class BiblioInfo; class Buffer; class Dimension; +class InsetCommandParams; class InsetLabel; class LaTeXFeatures; class RenderMonitoredPreview; +namespace support { + class FileNameList; +} + /// for including tex/lyx files class InsetInclude : public InsetCommand { + // Disable assignment operator, since it is not used, and cannot be + // implemented consistently with the copy constructor, because + // include_label is const. + InsetInclude & operator=(InsetInclude const &); public: /// InsetInclude(Buffer * buf, InsetCommandParams const &); + /// ~InsetInclude(); + /// + void setChildBuffer(Buffer * buffer); + /// \return the child buffer if the file is a LyX doc and could be loaded + Buffer * getChildBuffer() const; + + /** Update the cache with all bibfiles in use of the child buffer + * (including bibfiles of grandchild documents). + * Does nothing if the child document is not loaded to prevent + * automatic loading of all child documents upon loading the master. + * \param buffer the Buffer containing this inset. + */ + void updateBibfilesCache(); + + /** Return the cache with all bibfiles in use of the child buffer + * (including bibfiles of grandchild documents). + * Return an empty vector if the child doc is not loaded. + * \param buffer the Buffer containing this inset. + */ + support::FileNameList const & + getBibfilesCache() const; + + /// + void updateCommand(); + /// + void write(std::ostream &) const; + + /// \name Public functions inherited from Inset class + //@{ + /// void setBuffer(Buffer & buffer); + /// bool isLabeled() const { return true; } - /// Override these InsetButton methods if Previewing void metrics(MetricsInfo & mi, Dimension & dim) const; /// @@ -50,23 +85,20 @@ public: DisplayType display() const; /// InsetCode lyxCode() const { return INCLUDE_CODE; } - /// - void setChildBuffer(Buffer * buffer); - - /** Fills \c keys - * \param buffer the Buffer containing this inset. + docstring layoutName() const; + /** Fills \c key * \param keys the list of bibkeys in the child buffer. * \param it not used here */ - void fillWithBibKeys(BiblioInfo & keys, InsetIterator const & it) const; - + void collectBibKeys(InsetIterator const &) const; /// bool hasSettings() const { return true; } /// - int latex(odocstream &, OutputParams const &) const; + void latex(otexstream &, OutputParams const &) const; /// - int plaintext(odocstream &, OutputParams const &) const; + int plaintext(odocstringstream & ods, OutputParams const & op, + size_t max_length = INT_MAX) const; /// int docbook(odocstream &, OutputParams const &) const; /// @@ -76,47 +108,60 @@ public: /// void addPreview(DocIterator const &, graphics::PreviewLoader &) const; /// - void addToToc(DocIterator const &); - /// - void updateCommand(); + void addToToc(DocIterator const & di, bool output_active, + UpdateType utype) const; /// void updateBuffer(ParIterator const &, UpdateType); /// + std::string contextMenuName() const; + //@} + + /// \name Static public methods obligated for InsetCommand derived classes + //@{ + /// static ParamInfo const & findInfo(std::string const &); /// static std::string defaultCommand() { return "include"; } /// static bool isCompatibleCommand(std::string const & s); - /// - docstring contextMenu(BufferView const & bv, int x, int y) const; - /// \return the child buffer if the file is a LyX doc and could be loaded - Buffer * getChildBuffer() const; + //@} + protected: - InsetInclude(InsetInclude const &); /// - void doDispatch(Cursor & cur, FuncRequest & cmd); - /// - bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const; -private: - Inset * clone() const { return new InsetInclude(*this); } + InsetInclude(InsetInclude const &); +private: /** Slot receiving a signal that the external file has changed * and the preview should be regenerated. */ void fileChanged() const; - /// \return loaded Buffer or zero if the file loading did not proceed. Buffer * loadIfNeeded() const; /// launch external application void editIncluded(std::string const & file); + /// + bool isChildIncluded() const; + + /// \name Private functions inherited from Inset class + //@{ + Inset * clone() const { return new InsetInclude(*this); } + /// + void doDispatch(Cursor & cur, FuncRequest & cmd); + /// + bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const; + //@} + + /// \name Private functions inherited from InsetCommand class + //@{ /// set the parameters + // FIXME:InsetCommmand::setParams is not virtual void setParams(InsetCommandParams const & params); /// get the text displayed on the button docstring screenLabel() const; + //@} + /// holds the entity name that defines the file location (SGML) docstring const include_label; - /// - bool isChildIncluded() const; /// The pointer never changes although *preview_'s contents may. boost::scoped_ptr const preview_;