add warning make controllers compile and remove some alomost unused functions, commen...

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

diff --git a/src/insets/insetinclude.h b/src/insets/insetinclude.h
index 971e5d50ae3d3f56ecfb045d85b2ea540ae013e2..99d930061e096f1eece840c6dfef3248c3783c68 100644 (file)
--- a/src/insets/insetinclude.h
+++ b/src/insets/insetinclude.h
@@ -1,53 +1,46 @@
 // -*- C++ -*-
-/* This file is part of*
- * ======================================================
+/**
+ * \file insetinclude.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
+ * \author Lars Gullik Bjønnes
  *
- *         Copyright 1997 LyX Team (this file was created this year)
- *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS
+ */
 
 #ifndef INSET_INCLUDE_H
 #define INSET_INCLUDE_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "insetcommand.h"
 
+#include <boost/scoped_ptr.hpp>
+
 class Buffer;
 struct LaTeXFeatures;
 
 // Created by AAS 970521
 
-/**  Used to include files
- */
+/// for including tex/lyx files
 class InsetInclude: public InsetButton, boost::noncopyable {
 public:
        /// the type of inclusion
        enum Flags {
-               ///
-               INCLUDE = 0,
-               ///
-               VERB = 1,
-               ///
-               INPUT = 2,
-               ///
-               VERBAST = 3
+               INCLUDE = 0, //<
+               VERB = 1, //<
+               INPUT = 2, //<
+               VERBAST = 3 //<
        };
 
        struct Params {
-               Params(InsetCommandParams const & cp = InsetCommandParams(),
-                      Flags f = INCLUDE,
-                      bool nl = false,
+               Params(InsetCommandParams const & cp = InsetCommandParams("input"),
+                      Flags f = INPUT,
                       string const & name = string())
-                       : cparams(cp), flag(f), noload(nl),
+                       : cparams(cp), flag(f),
                          masterFilename_(name) {}
+
                InsetCommandParams cparams;
                Flags flag;
-               bool noload;
                string masterFilename_;
 
                ///
@@ -60,9 +53,21 @@ public:
        InsetInclude(Params const &);
        ///
        InsetInclude(InsetCommandParams const &, Buffer const &);
-       ///
+
        ~InsetInclude();
 
+       ///
+       virtual dispatch_result localDispatch(FuncRequest const & cmd); 
+
+       /// Override these InsetButton methods if Previewing
+       int ascent(BufferView *, LyXFont const &) const;
+       ///
+       int descent(BufferView *, LyXFont const &) const;
+       ///
+       int width(BufferView *, LyXFont const &) const;
+       ///
+       void draw(BufferView *, LyXFont const &, int, float &) const;
+
        /// get the parameters
        Params const & params(void) const;
        /// set the parameters
@@ -75,11 +80,7 @@ public:
        /// This returns the list of labels on the child buffer
        std::vector<string> const getLabelList() const;
        /// This returns the list of bibkeys on the child buffer
-       std::vector< std::pair<string,string> > const getKeys() const;
-       ///
-       void edit(BufferView *, int x, int y, unsigned int button);
-       ///
-       void edit(BufferView * bv, bool front = true);
+       void fillWithBibKeys(std::vector<std::pair<string,string> > & keys) const;
        ///
        EDITABLE editable() const
        {
@@ -97,26 +98,19 @@ public:
        ///
        int linuxdoc(Buffer const *, std::ostream &) const;
        ///
-       int docbook(Buffer const *, std::ostream &) const;
+       int docbook(Buffer const *, std::ostream &, bool mixcont) const;
        ///
        void validate(LaTeXFeatures &) const;
 
-       /** Input inserts anything inside a paragraph.
-           Display can give some visual feedback
-       */
+       /// take up a whole row if we're not type INPUT
        bool display() const;
 
-       /// return the filename stub of the included file
-       string const getRelFileBaseName() const;
-
-       /// return true if the included file is not loaded
-       bool isIncludeOnly() const;
-
        /// return true if the file is or got loaded.
        bool loadIfNeeded() const;
 
-       /// hide a dialog if about
-       SigC::Signal0<void> hideDialog;
+       ///
+       void addPreview(grfx::PreviewLoader &) const;
+
 private:
        /// get the text displayed on the button
        string const getScreenLabel(Buffer const *) const;
@@ -131,6 +125,12 @@ private:
        Params params_;
        /// holds the entity name that defines the file location (SGML)
        string const include_label;
+
+       /// Use the Pimpl idiom to hide the internals of the previewer.
+       class PreviewImpl;
+       friend class PreviewImpl;
+       /// The pointer never changes although *preview_'s contents may.
+       boost::scoped_ptr<PreviewImpl> const preview_;
 };
 
 
@@ -139,10 +139,27 @@ inline bool InsetInclude::isVerbatim() const
        return params_.flag == VERB || params_.flag == VERBAST;
 }
 
+#include "mailinset.h"
 
-inline bool InsetInclude::isIncludeOnly() const
-{
-       return params_.flag == INCLUDE && params_.noload;
-}
+class InsetIncludeMailer : public MailInset {
+public:
+       ///
+       InsetIncludeMailer(InsetInclude & inset);
+       ///
+       virtual InsetBase & inset() const { return inset_; }
+       ///
+       virtual string const & name() const { return name_; }
+       ///
+       virtual string const inset2string() const;
+       ///
+       static void string2params(string const &, InsetInclude::Params &);
+       ///
+       static string const params2string(InsetInclude::Params const &);
+private:
+       ///
+       static string const name_;
+       ///
+       InsetInclude & inset_;
+};
 
-#endif
+#endif // INSETINCLUDE_H