Fix text frame drawing.

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

diff --git a/src/insets/Inset.h b/src/insets/Inset.h
index c98dcc3a973c1ac506c982ccd5bd34087ad821c6..6b2b14a7310c12f99beecbb4fbfd210dfff44cb1 100644 (file)
--- a/src/insets/Inset.h
+++ b/src/insets/Inset.h
@@ -5,8 +5,8 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Alejandro Aguilar Sierra
- * \author Jürgen Vigna
- * \author Lars Gullik Bjønnes
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
  * \author Matthias Ettrich
  *
  * Full author contact details are available in file CREDITS.
@@ -15,37 +15,41 @@
 #ifndef INSETBASE_H
 #define INSETBASE_H
 
-#include "Changes.h"
 #include "Dimension.h"
 
 #include "support/docstream.h"
 
-#include <boost/signal.hpp>
-
 #include <memory>
 #include <vector>
 
 namespace lyx {
 
+class BiblioInfo;
 class Buffer;
 class BufferParams;
 class BufferView;
-class ParConstIterator;
+class Change;
+class Color_color;
+class Cursor;
 class CursorSlice;
 class FuncRequest;
 class FuncStatus;
+class InsetIterator;
+class InsetLayout;
 class InsetMath;
 class InsetText;
 class LaTeXFeatures;
-class Color_color;
-class Cursor;
 class Lexer;
-class Text;
+class MathAtom;
 class MetricsInfo;
-class Dimension;
-class PainterInfo;
 class OutputParams;
+class PainterInfo;
+class Paragraph;
+class ParConstIterator;
+class ParIterator;
+class Text;
 class TocList;
+class EmbeddedFiles;
 
 
 namespace graphics { class PreviewLoader; }
@@ -74,8 +78,6 @@ public:
 
        /// virtual base class destructor
        virtual ~Inset() {}
-       /// replicate ourselves
-       std::auto_ptr<Inset> clone() const;
 
        /// identification as math inset
        virtual InsetMath * asInsetMath() { return 0; }
@@ -151,6 +153,7 @@ public:
                CursorSlice const & sl, bool boundary, int & x, int & y) const;
 
        /// is this an inset that can be moved into?
+       /// FIXME: merge with editable()
        virtual bool isActive() const { return nargs() > 0; }
        /// Where should we go when we press the up or down cursor key?
        virtual bool idxUpDown(Cursor & cur, bool up) const;
@@ -199,6 +202,12 @@ public:
        /// is called when the mouse enter or leave this inset
        /// return true if this inset needs repaint
        virtual bool setMouseHover(bool) { return false; }
+       /// return true if this inset is hovered (under mouse)
+       /// This is by now only used by mathed to draw corners 
+       /// (Inset::drawMarkers() and Inset::drawMarkers2()).
+       /// Other insets do not have to redefine this function to 
+       /// return the correct status of mouseHovered.
+       virtual bool mouseHovered() const { return false; }
 
        /// request "external features"
        virtual void validate(LaTeXFeatures &) const {}
@@ -373,6 +382,8 @@ public:
 
        ///
        virtual docstring name() const { return from_ascii("unknown"); }
+       ///
+       virtual InsetLayout const & getLayout(BufferParams const & bp) const;
        /// used to toggle insets
        /// is the inset open?
        /// should this inset be handled like a normal charater
@@ -427,7 +438,16 @@ public:
        virtual void addPreview(graphics::PreviewLoader &) const {}
        /// Add an entry to the TocList
        /// pit is the ParConstIterator of the paragraph containing the inset
-       virtual void addToToc(TocList &, Buffer const &, ParConstIterator & pit) const {}
+       virtual void addToToc(TocList &, Buffer const &, ParConstIterator const &) const {}
+       /// report files that can be embedded with the lyx file
+       virtual void registerEmbeddedFiles(Buffer const &, EmbeddedFiles &,
+                       ParConstIterator const &) const {};
+       /// Fill keys with BibTeX information
+       virtual void fillWithBibKeys(Buffer const &,
+               BiblioInfo &, InsetIterator const &) const { return; }
+       /// Update the counters of this inset and of its contents
+       virtual void updateLabels(Buffer const &, ParIterator const &) {}
+
 
 public:
        /// returns LyX code associated with the inset. Used for TOC, ...)
@@ -456,6 +476,8 @@ public:
        /// reject the changes within the inset
        virtual void rejectChanges(BufferParams const &) {};
 
+       /// FIXME: move dim_ out of Inset!
+       Dimension const & dimension() { return dim_; }
        /// inset width.
        int width() const { return dim_.wid; }
        /// inset ascent.
@@ -465,13 +487,10 @@ public:
        ///
        int scroll() const { return 0; }
        ///
-       void setBackgroundColor(Color_color);
-       ///
-       Color_color backgroundColor() const;
+       virtual Color_color backgroundColor() const;
        ///
        enum CollapseStatus {
                Collapsed,
-               Inlined,
                Open
        };
        ///
@@ -479,15 +498,14 @@ public:
        //
        enum { TEXT_TO_INSET_OFFSET = 4 };
 
-       /// Signal for inset destruction.
-       /** This signal is emitted at the inset destruction for insets that
-       *   support this.
-       */
-       virtual boost::signal<void()> * destroyedSignal() { return 0; }
-
 protected:
        Inset();
 
+       /// replicate ourselves
+       friend class Paragraph;
+       friend class MathAtom;
+       virtual Inset * clone() const = 0;
+
        /** The real dispatcher.
         *  Gets normally called from Cursor::dispatch(). Cursor::dispatch()
         *  assumes the common case of 'LFUN handled, need update'.
@@ -503,12 +521,6 @@ protected:
 
        /// Cached dimensions of the inset.
        mutable Dimension dim_;
-private:
-       virtual std::auto_ptr<Inset> doClone() const = 0;
-       /** We store the Color::color value as an int to get Color.h out
-        *  of the header file.
-        */
-       int background_color_;
 };
 
 
@@ -529,7 +541,6 @@ bool isHighlyEditableInset(Inset const * inset);
  *  It can be forward-declared and passed as a function argument without
  *  having to expose Inset.h.
  */
-
 class Inset_code {
        Inset::Code val_;
 public: