* src/LyXAction.C: mark goto-clear-bookmark as working without buffer

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

diff --git a/src/insets/insetinclude.h b/src/insets/insetinclude.h
index 456abb80a848782566247c55fdb6cd43fbcc4022..c42159e30ce4fdfd0297565ac483ea11d2638921 100644 (file)
--- a/src/insets/insetinclude.h
+++ b/src/insets/insetinclude.h
@@ -15,50 +15,65 @@
 #include "inset.h"
 #include "insetcommandparams.h"
 #include "render_button.h"
+#include "mailinset.h"
+
+#include "support/filename.h"
+
 #include <boost/scoped_ptr.hpp>
 
+namespace lyx {
+
 class Buffer;
 class Dimension;
-struct LaTeXFeatures;
+class LaTeXFeatures;
 class RenderMonitoredPreview;
 
 
 /// for including tex/lyx files
-class InsetInclude: public InsetOld {
+class InsetInclude : public InsetOld {
 public:
        ///
        InsetInclude(InsetCommandParams const &);
-       InsetInclude(InsetInclude const &);
        ~InsetInclude();
 
-       ///
-       virtual std::auto_ptr<InsetBase> clone() const;
-
        /// Override these InsetButton methods if Previewing
-       void metrics(MetricsInfo & mi, Dimension & dim) const;
+       bool metrics(MetricsInfo & mi, Dimension & dim) const;
        ///
        void draw(PainterInfo & pi, int x, int y) const;
        ///
-       virtual bool display() const { return true; }
+       virtual bool display() const;
 
        /// get the parameters
-       InsetCommandParams const & params(void) const;
+       InsetCommandParams const & params() const;
 
        ///
-       InsetOld::Code lyxCode() const { return InsetOld::INCLUDE_CODE; }
+       InsetBase::Code lyxCode() const { return InsetBase::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<std::string> & list) const;
+                         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.
         */
-       ///
        void fillWithBibKeys(Buffer const & buffer,
-               std::vector<std::pair<std::string,std::string> > & keys) const;
+               std::vector<std::pair<std::string, docstring> > & keys) 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(Buffer const & buffer);
+       /** 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 &
+       getBibfilesCache(Buffer const & buffer) const;
        ///
        EDITABLE editable() const { return IS_EDITABLE; }
        ///
@@ -66,29 +81,31 @@ public:
        ///
        void read(Buffer const &, LyXLex &);
        ///
-       int latex(Buffer const &, std::ostream &,
+       int latex(Buffer const &, odocstream &,
                  OutputParams const &) const;
        ///
-       int plaintext(Buffer const &, std::ostream &,
+       int plaintext(Buffer const &, odocstream &,
                  OutputParams const &) const;
        ///
-       int linuxdoc(Buffer const &, std::ostream &,
-                    OutputParams const &) const;
-       ///
-       int docbook(Buffer const &, std::ostream &,
-                   OutputParams const &) const;
+       int docbook(Buffer const &, odocstream &,
+           OutputParams const &) const;
        ///
        void validate(LaTeXFeatures &) const;
        ///
-       void addPreview(lyx::graphics::PreviewLoader &) const;
+       void addPreview(graphics::PreviewLoader &) const;
+       ///
+       void addToToc(TocList &, Buffer const &) const;
+       ///
+       void updateLabels(Buffer const & buffer) const;
+       ///
+       bool getStatus(LCursor &, FuncRequest const &, FuncStatus &) const;
 protected:
+       InsetInclude(InsetInclude const &);
        ///
-       virtual
-       DispatchResult
-       priv_dispatch(BufferView & bv, FuncRequest const & cmd);
+       virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
 private:
-       /// Slot receiving a signal that the preview is ready to display.
-       void statusChanged() const;
+       virtual std::auto_ptr<InsetBase> doClone() const;
+
        /** Slot receiving a signal that the external file has changed
         *  and the preview should be regenerated.
         */
@@ -99,7 +116,7 @@ private:
        /// set the parameters
        void set(InsetCommandParams const & params, Buffer const &);
        /// get the text displayed on the button
-       std::string const getScreenLabel(Buffer const &) const;
+       docstring const getScreenLabel(Buffer const &) const;
        ///
        void write(std::ostream &) const;
        ///
@@ -108,7 +125,7 @@ private:
        /// the parameters
        InsetCommandParams params_;
        /// holds the entity name that defines the file location (SGML)
-       std::string const include_label;
+       docstring const include_label;
 
        /// The pointer never changes although *preview_'s contents may.
        boost::scoped_ptr<RenderMonitoredPreview> const preview_;
@@ -119,8 +136,6 @@ private:
 };
 
 
-#include "mailinset.h"
-
 class InsetIncludeMailer : public MailInset {
 public:
        ///
@@ -142,4 +157,7 @@ private:
        InsetInclude & inset_;
 };
 
+
+} // namespace lyx
+
 #endif // INSETINCLUDE_H