The return value for xhtml() is not going to be needed.

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

diff --git a/src/insets/Inset.h b/src/insets/Inset.h
index a06837b1d690395d8f086536ed881b9dda8b49fd..ba8dd18da85dc017a0521318fc31a4ec4fbfae44 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.
@@ -17,6 +17,7 @@
 
 #include "ColorCode.h"
 #include "InsetCode.h"
+#include "Layout.h"
 
 #include "support/strfwd.h"
 #include "support/types.h"
@@ -53,8 +54,6 @@ class ParConstIterator;
 class ParIterator;
 class Text;
 class TocList;
-class FileNameList;
-
 
 namespace graphics { class PreviewLoader; }
 
@@ -174,6 +173,9 @@ public:
        virtual void draw(PainterInfo & pi, int x, int y) const = 0;
        /// draw inset selection if necessary
        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 bool editing(BufferView const * bv) const;
        ///
@@ -211,9 +213,6 @@ public:
        /// Force inset into LTR environment if surroundings are RTL?
        virtual bool forceLTR() const { return false; }
 
-       /// 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;
        /// Move one cell backwards
@@ -259,10 +258,17 @@ public:
        /// Returns true if cursor is now invalid, e.g. if former 
        /// insets in higher cursor slices of \c old do not exist 
        /// anymore.
-       /// \c old is the old cursor, i.e. there is a slice pointing to this.
+       /// \c old is the old cursor, the last slice points to this.
        /// \c cur is the new cursor. Use the update flags to cause a redraw.
        virtual bool notifyCursorLeaves(Cursor const & /*old*/, Cursor & /*cur*/)
                { return false; }
+       /// Is called when the cursor enters this inset.
+       /// Returns true if cursor is now invalid, e.g. if former 
+       /// insets in higher cursor slices of \c old do not exist 
+       /// anymore.
+       /// \c cur is the new cursor, some slice points to this. Use the update flags to cause a redraw.
+       virtual bool notifyCursorEnters(Cursor & /*cur*/)
+               { return false; }
        /// is called when the mouse enter or leave this inset
        /// return true if this inset needs repaint
        virtual bool setMouseHover(bool) { return false; }
@@ -289,30 +295,26 @@ public:
        virtual int plaintext(odocstream &, OutputParams const &) const = 0;
        /// docbook output
        virtual int docbook(odocstream & os, OutputParams const &) const;
+       /// LyX HTML output
+       virtual void xhtml(odocstream & os, OutputParams const &) const;
        /// the string that is passed to the TOC
-       virtual void textString(odocstream &) const {}
-
-       /** This enum indicates by which means the inset can be modified:
-       - NOT_EDITABLE: the inset's content cannot be modified at all
-         (e.g. printindex, insetspecialchar)
-       - IS_EDITABLE: content can be edited via dialog (e.g. bibtex, index, href)
-       - HIGHLY_EDITABLE: content can be edited on screen (normally means that
-         insettext is contained, e.g. collapsables, tabular) */
-       // FIXME: This has not yet been fully implemented to math insets
-       enum EDITABLE {
-               ///
-               NOT_EDITABLE = 0,
-               ///
-               IS_EDITABLE,
-               ///
-               HIGHLY_EDITABLE
-       };
+       virtual void tocString(odocstream &) const {}
+
        /// what appears in the minibuffer when opening
        virtual docstring editMessage() const;
-       ///
-       virtual EDITABLE editable() const;
+       /// can the contents of the inset be edited on screen ?
+       // true for InsetCollapsables (not ButtonOnly) (not InsetInfo), InsetText
+       virtual bool editable() const;
+       /// has the Inset settings that can be modified in a dialog ?
+       virtual bool hasSettings() const;
        /// can we go further down on mouse click?
+       // true for InsetCaption, InsetCollapsables (not ButtonOnly), InsetTabular
        virtual bool descendable() const { return false; }
+       /// is this an inset that can be moved into?
+       /// FIXME: merge with editable()
+       // true for InsetTabular & InsetText
+       virtual bool isActive() const { return nargs() > 0; }
+
        /// does this contain text that can be change track marked in DVI?
        virtual bool canTrackChanges() const { return false; }
        /// return true if the inset should be removed automatically
@@ -405,6 +407,8 @@ public:
 
        /// should we have a non-filled line before this inset?
        virtual DisplayType display() const { return Inline; }
+       ///
+       virtual LyXAlignment contentAlignment() const { return LYX_ALIGN_NONE; }
        /// should we break lines after this inset?
        virtual bool isLineSeparator() const { return false; }
        /// should paragraph indendation be ommitted in any case?
@@ -437,6 +441,16 @@ public:
         *  defaults to empty.
         */
        virtual void addPreview(graphics::PreviewLoader &) const {}
+
+       /** Classifies the unicode characters appearing in a math inset
+        *  depending on whether they are to be translated as latex
+        *  math/text commands or used as math symbols without translation.
+        *
+        *  Only math insets have interest in this classification, so the
+        *  method defaults to empty.
+        */
+       virtual void initUnicodeMath() const {}
+
        /// Add an entry to the TocList
        /// pit is the ParConstIterator of the paragraph containing the inset
        virtual void addToToc(DocIterator const &) {}