Merge branch 'master' into biblatex2

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

diff --git a/src/insets/Inset.h b/src/insets/Inset.h
index f92883037b67624c5a42918c98131acdcbd2f405..0783ec1ffbb0c1dea4d130b1a39358d072e9036f 100644 (file)
--- a/src/insets/Inset.h
+++ b/src/insets/Inset.h
@@ -74,7 +74,7 @@ std::string insetName(InsetCode);
 /// Eg, insetDisplayName(BRANCH_CODE) == _("Branch")
 docstring insetDisplayName(InsetCode);
 ///
-static int const TOC_ENTRY_LENGTH = 128;
+static int const TOC_ENTRY_LENGTH = 120;
 
 /// Common base class to all insets
 
@@ -108,6 +108,8 @@ public:
 
        /// change associated Buffer
        virtual void setBuffer(Buffer & buffer);
+       /// reset associated Buffer to null value
+       virtual void resetBuffer();
        /// retrieve associated Buffer
        virtual Buffer & buffer();
        virtual Buffer const & buffer() const;
@@ -190,33 +192,34 @@ public:
        virtual void drawSelection(PainterInfo &, int, int) const {}
        /// draw inset background if the inset has an own background and a
        /// selection is drawn by drawSelection.
-       virtual void drawBackground(PainterInfo &, int, int) const {}
+       virtual void drawBackground(PainterInfo &, int, int) const;
        ///
        virtual bool editing(BufferView const * bv) const;
        ///
        virtual bool showInsetDialog(BufferView *) const;
 
-       /// draw inset decoration if necessary.
-       /// This can use \c drawMarkers() for example.
-       virtual void drawDecoration(PainterInfo &, int, int) const {}
-       /// draw four angular markers
-       void drawMarkers(PainterInfo & pi, int x, int y) const;
+       // The possible marker types for insets
+       enum marker_type { NO_MARKER, MARKER2, MARKER };
        /// draw two angular markers
+       void drawMarkers(PainterInfo & pi, int x, int y) const;
+       /// draw four angular markers
        void drawMarkers2(PainterInfo & pi, int x, int y) const;
        /// add space for markers
        void metricsMarkers(Dimension & dim, int framesize = 1) const;
        /// add space for markers
        void metricsMarkers2(Dimension & dim, int framesize = 1) const;
+       /// draw inset decoration if necessary.
+       /// This can use \c drawMarkers() for example.
+       virtual void drawDecoration(PainterInfo &, int, int) const {}
+
+       /// last metrics computed for the inset
+       Dimension const dimension(BufferView const &) const;
        /// last drawn position for 'important' insets
        int xo(BufferView const & bv) const;
        /// last drawn position for 'important' insets
        int yo(BufferView const & bv) const;
-       /// set x/y drawing position cache if available
-       virtual void setPosCache(PainterInfo const &, int, int) const;
-       ///
-       void setDimCache(MetricsInfo const &, Dimension const &) const;
        /// do we cover screen position x/y?
-       virtual bool covers(BufferView const & bv, int x, int y) const;
+       bool covers(BufferView const & bv, int x, int y) const;
        /// get the screen positions of the cursor (see note in Cursor.cpp)
        virtual void cursorPos(BufferView const & bv,
                CursorSlice const & sl, bool boundary, int & x, int & y) const;
@@ -344,12 +347,17 @@ public:
        // true for InsetTabular & InsetText
        virtual bool isActive() const { return nargs() > 0; }
        /// can we click at the specified position ?
-       virtual bool clickable(int, int) const { return false; }
+       virtual bool clickable(BufferView const &, int, int) const { return false; }
        /// Move one cell backwards
        virtual bool allowsCaptionVariation(std::string const &) const { return false; }
+       // true for insets that have a table structure (InsetMathGrid, InsetTabular)
+       virtual bool isTable() const { return false; }
 
        /// does this contain text that can be change track marked in DVI?
        virtual bool canTrackChanges() const { return false; }
+       /// Will this inset paint its own change tracking status (in the parent
+       /// paragraph) or will it let RowPainter handle it?
+       virtual bool canPaintChange(BufferView const &) const { return false; }
        /// return true if the inset should be removed automatically
        virtual bool autoDelete() const;
 
@@ -405,9 +413,13 @@ public:
 
        /// Is the content of this inset part of the output document?
        virtual bool producesOutput() const { return true; }
+       /// Is the content of this inset part of the immediate (visible) text sequence?
+       virtual bool isPartOfTextSequence() const { return producesOutput(); }
 
        /// \return Tool tip for this inset.
-       /// This default implementation returns an empty string.
+       /// This default implementation returns an empty string. This can be
+       /// either plain text or Qt html, and formatToolTip will be called
+       /// on it before display in both cases.
        virtual docstring toolTip(BufferView const & bv, int x, int y) const;
        
        /// \return Context menu identifier. This function determines
@@ -517,7 +529,7 @@ public:
        /// returns LyX code associated with the inset. Used for TOC, ...)
        virtual InsetCode lyxCode() const { return NO_CODE; }
 
-       /// -1: text mode, 1: math mode, 0 undecided
+       ///
        enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
        /// return text or mathmode if that is possible to determine
        virtual mode_type currentMode() const { return UNDECIDED_MODE; }
@@ -560,8 +572,6 @@ public:
        /// reject the changes within the inset
        virtual void rejectChanges() {}
 
-       ///
-       virtual Dimension const dimension(BufferView const &) const;
        ///
        virtual ColorCode backgroundColor(PainterInfo const &) const;
        ///