X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetInclude.h;h=18329fe6d9117826e8f62c9eaf2e1b8990123d8f;hb=6e4e0869006aa4c225162164aaa14a70d041facf;hp=e2c3a8a2684d69534473d3aba17bf6e1e5e931e7;hpb=1e51e87f680a7a903d1c24bccf26598459efec47;p=lyx.git diff --git a/src/insets/InsetInclude.h b/src/insets/InsetInclude.h index e2c3a8a268..18329fe6d9 100644 --- a/src/insets/InsetInclude.h +++ b/src/insets/InsetInclude.h @@ -4,7 +4,7 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * \author Richard Heck (conversion to InsetCommand) * * Full author contact details are available in file CREDITS. @@ -15,33 +15,61 @@ #include "InsetCommand.h" -#include "BiblioInfo.h" -#include "Counters.h" -#include "InsetCommandParams.h" #include "RenderButton.h" -#include "support/FileNameList.h" +#include "support/unique_ptr.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(InsetCommandParams const &); + 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(); + + /// + 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,86 +78,97 @@ public: DisplayType display() const; /// InsetCode lyxCode() const { return INCLUDE_CODE; } - /** 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; - - /** 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(Buffer const & buffer) const; + void collectBibKeys(InsetIterator const &, support::FileNameList &) const; /// - EDITABLE editable() const { return IS_EDITABLE; } + 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; /// + docstring xhtml(XHTMLStream &, OutputParams const &) const; + /// void validate(LaTeXFeatures &) const; /// - void addPreview(graphics::PreviewLoader &) const; + void addPreview(DocIterator const &, graphics::PreviewLoader &) const; /// - void addToToc(DocIterator const &); + void addToToc(DocIterator const & di, bool output_active, + UpdateType utype, TocBackend & backend) const; /// - void updateLabels(ParIterator 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; + //@} + 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; /// The pointer never changes although *preview_'s contents may. - boost::scoped_ptr const preview_; + unique_ptr const preview_; + /// + mutable bool failedtoload_; /// cache mutable bool set_label_; mutable RenderButton button_; mutable docstring listings_label_; InsetLabel * label_; + mutable Buffer * child_buffer_; }; -/// return loaded Buffer or zero if the file loading did not proceed. -Buffer * loadIfNeeded(Buffer const & parent, InsetCommandParams const & params); } // namespace lyx