make code look a bit more uniform

[lyx.git] / src / insets / InsetInclude.h

diff --git a/src/insets/InsetInclude.h b/src/insets/InsetInclude.h
index 225bbd4bbef213b2b601707f3cd926badbdb1edc..db177f17aeb3d6a3d6ebd59669cbe94a2f752838 100644 (file)
--- a/src/insets/InsetInclude.h
+++ b/src/insets/InsetInclude.h
@@ -5,6 +5,7 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Lars Gullik Bjønnes
+ * \author Richard Heck (conversion to InsetCommand)
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -20,8 +21,6 @@
 #include "Counters.h"
 #include "EmbeddedFiles.h"
 
-#include "support/FileName.h"
-
 #include <boost/scoped_ptr.hpp>
 
 namespace lyx {
@@ -31,7 +30,6 @@ class Dimension;
 class LaTeXFeatures;
 class RenderMonitoredPreview;
 
-
 /// for including tex/lyx files
 class InsetInclude : public InsetCommand {
 public:
@@ -43,22 +41,20 @@ public:
        ///
        void draw(PainterInfo & pi, int x, int y) const;
        ///
-       virtual DisplayType display() const;
+       DisplayType display() const;
        ///
        InsetCode lyxCode() const { return INCLUDE_CODE; }
        /** Fills \c list
         *  \param buffer the Buffer containing this inset.
         *  \param list the list of labels in the child buffer.
         */
-       void getLabelList(Buffer const & buffer,
-                         std::vector<docstring> & list) const;
+       void getLabelList(std::vector<docstring> & list) const;
        /** Fills \c keys
         *  \param buffer the Buffer containing this inset.
         *  \param keys the list of bibkeys in the child buffer.
         *  \param it not used here
         */
-       virtual void fillWithBibKeys(Buffer const & buffer,
-               BiblioInfo & keys, InsetIterator const & it) const;
+       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).
@@ -66,41 +62,46 @@ public:
         *  automatic loading of all child documents upon loading the master.
         *  \param buffer the Buffer containing this inset.
         */
-       void updateBibfilesCache(Buffer const & buffer);
+       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.
         */
-       std::vector<support::FileName> const &
+       EmbeddedFileList const &
                getBibfilesCache(Buffer const & buffer) const;
        ///
        EDITABLE editable() const { return IS_EDITABLE; }
        ///
-       int latex(Buffer const &, odocstream &,
-                 OutputParams const &) const;
+       int latex(odocstream &, OutputParams const &) const;
        ///
-       int plaintext(Buffer const &, odocstream &,
-                     OutputParams const &) const;
+       int plaintext(odocstream &, OutputParams const &) const;
        ///
-       int docbook(Buffer const &, odocstream &,
-                   OutputParams const &) const;
+       int docbook(odocstream &, OutputParams const &) const;
        ///
        void validate(LaTeXFeatures &) const;
        ///
        void addPreview(graphics::PreviewLoader &) const;
        ///
-       void addToToc(TocList &, Buffer const &, ParConstIterator const &) const;
+       void addToToc(ParConstIterator const &) const;
        ///
-       void updateLabels(Buffer const & buffer, ParIterator const &);
+       void updateLabels(ParIterator const &);
        /// child document can be embedded
-       void registerEmbeddedFiles(Buffer const &, EmbeddedFiles &) const;
+       void registerEmbeddedFiles(EmbeddedFileList &) const;
+       ///
+       void updateEmbeddedFile(EmbeddedFile const & file);
+       ///
+       static ParamInfo const & findInfo(std::string const &);
+       ///
+       static std::string defaultCommand() { return "include"; };
+       ///
+       static bool isCompatibleCommand(std::string const & s);
 protected:
        InsetInclude(InsetInclude const &);
        ///
-       virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
+       void doDispatch(Cursor & cur, FuncRequest & cmd);
 private:
-       virtual Inset * clone() const;
+       Inset * clone() const { return new InsetInclude(*this); }
 
        /** Slot receiving a signal that the external file has changed
         *  and the preview should be regenerated.
@@ -108,9 +109,9 @@ private:
        void fileChanged() const;
 
        /// set the parameters
-       void set(InsetCommandParams const & params, Buffer const &);
+       void setParams(InsetCommandParams const & params);
        /// get the text displayed on the button
-       docstring const getScreenLabel(Buffer const &) const;
+       docstring screenLabel() const;
        /// holds the entity name that defines the file location (SGML)
        docstring const include_label;
 
@@ -123,10 +124,16 @@ private:
        mutable docstring listings_label_;
 };
 
-
+/// return the child buffer if the file is a LyX doc and is loaded
+Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params);
+       
 /// return loaded Buffer or zero if the file loading did not proceed.
 Buffer * loadIfNeeded(Buffer const & parent, InsetCommandParams const & params);
 
+///
+void resetParentBuffer(Buffer const * parent, InsetCommandParams const & params,
+       bool close_it);
+
 } // namespace lyx
 
 #endif // INSETINCLUDE_H