src/insets/InsetInclude.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetInclude.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Richard Heck (conversion to InsetCommand)
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef INSET_INCLUDE_H
  14 #define INSET_INCLUDE_H
  15
  16 #include "InsetCommand.h"
  17
  18 #include "RenderButton.h"
  19
  20 #include <boost/scoped_ptr.hpp>
  21
  22 namespace lyx {
  23
  24 class BiblioInfo;
  25 class Buffer;
  26 class Dimension;
  27 class InsetCommandParams;
  28 class InsetLabel;
  29 class LaTeXFeatures;
  30 class RenderMonitoredPreview;
  31
  32 namespace support {
  33         class FileNameList;
  34 }
  35
  36 /// for including tex/lyx files
  37 class InsetInclude : public InsetCommand {
  38 public:
  39         ///
  40         InsetInclude(Buffer * buf, InsetCommandParams const &);
  41         ///
  42         ~InsetInclude();
  43
  44         ///
  45         void setChildBuffer(Buffer * buffer);
  46         /// \return the child buffer if the file is a LyX doc and could be loaded
  47         Buffer * getChildBuffer() const;
  48
  49         /** Update the cache with all bibfiles in use of the child buffer
  50          *  (including bibfiles of grandchild documents).
  51          *  Does nothing if the child document is not loaded to prevent
  52          *  automatic loading of all child documents upon loading the master.
  53          *  \param buffer the Buffer containing this inset.
  54          */
  55         void updateBibfilesCache();
  56
  57         /** Return the cache with all bibfiles in use of the child buffer
  58          *  (including bibfiles of grandchild documents).
  59          *  Return an empty vector if the child doc is not loaded.
  60          *  \param buffer the Buffer containing this inset.
  61          */
  62         support::FileNameList const &
  63                 getBibfilesCache() const;
  64
  65         ///
  66         void updateCommand();
  67
  68         /// \name Public functions inherited from Inset class
  69         //@{
  70         ///
  71         void setBuffer(Buffer & buffer);
  72         ///
  73         bool isLabeled() const { return true; }
  74         /// Override these InsetButton methods if Previewing
  75         void metrics(MetricsInfo & mi, Dimension & dim) const;
  76         ///
  77         void draw(PainterInfo & pi, int x, int y) const;
  78         ///
  79         DisplayType display() const;
  80         ///
  81         InsetCode lyxCode() const { return INCLUDE_CODE; }
  82         ///
  83         docstring layoutName() const;
  84         /** Fills \c key
  85          *  \param keys the list of bibkeys in the child buffer.
  86          *  \param it not used here
  87          */
  88         void collectBibKeys(InsetIterator const &) const;
  89         ///
  90         bool hasSettings() const { return true; }
  91         ///
  92         void latex(otexstream &, OutputParams const &) const;
  93         ///
  94         int plaintext(odocstream &, OutputParams const &) const;
  95         ///
  96         int docbook(odocstream &, OutputParams const &) const;
  97         ///
  98         docstring xhtml(XHTMLStream &, OutputParams const &) const;
  99         ///
 100         void validate(LaTeXFeatures &) const;
 101         ///
 102         void addPreview(DocIterator const &, graphics::PreviewLoader &) const;
 103         ///
 104         void addToToc(DocIterator const &) const;
 105         ///
 106         void updateBuffer(ParIterator const &, UpdateType);
 107         ///
 108         std::string contextMenuName() const;
 109         //@}
 110
 111         /// \name Static public methods obligated for InsetCommand derived classes
 112         //@{
 113         ///
 114         static ParamInfo const & findInfo(std::string const &);
 115         ///
 116         static std::string defaultCommand() { return "include"; }
 117         ///
 118         static bool isCompatibleCommand(std::string const & s);
 119         //@}
 120
 121 protected:
 122         ///
 123         InsetInclude(InsetInclude const &);
 124
 125 private:
 126         /** Slot receiving a signal that the external file has changed
 127          *  and the preview should be regenerated.
 128          */
 129         void fileChanged() const;
 130         /// \return loaded Buffer or zero if the file loading did not proceed.
 131         Buffer * loadIfNeeded() const;
 132         /// launch external application
 133         void editIncluded(std::string const & file);
 134         ///
 135         bool isChildIncluded() const;
 136
 137         /// \name Private functions inherited from Inset class
 138         //@{
 139         Inset * clone() const { return new InsetInclude(*this); }
 140         ///
 141         void doDispatch(Cursor & cur, FuncRequest & cmd);
 142         ///
 143         bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
 144         //@}
 145
 146         /// \name Private functions inherited from InsetCommand class
 147         //@{
 148         /// set the parameters
 149         // FIXME:InsetCommmand::setParams is not virtual
 150         void setParams(InsetCommandParams const & params);
 151         /// get the text displayed on the button
 152         docstring screenLabel() const;
 153         //@}
 154
 155         /// holds the entity name that defines the file location (SGML)
 156         docstring const include_label;
 157
 158         /// The pointer never changes although *preview_'s contents may.
 159         boost::scoped_ptr<RenderMonitoredPreview> const preview_;
 160
 161         ///
 162         mutable bool failedtoload_;
 163         /// cache
 164         mutable bool set_label_;
 165         mutable RenderButton button_;
 166         mutable docstring listings_label_;
 167         InsetLabel * label_;
 168         mutable Buffer * child_buffer_;
 169 };
 170
 171
 172 } // namespace lyx
 173
 174 #endif // INSET_INCLUDE_H