* In the process of fixing the math background color bug, this commit transfer backgr...

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

diff --git a/src/insets/insetbase.h b/src/insets/insetbase.h
index 4f90fc1fa141da4e4da4c0439cb6ef260c3f2cbd..09990a217a52890a663f163cb5f14b99af1db5e3 100644 (file)
--- a/src/insets/insetbase.h
+++ b/src/insets/insetbase.h
@@ -23,6 +23,7 @@
 namespace lyx {
 
 class Buffer;
+class BufferParams;
 class BufferView;
 class CursorSlice;
 class FuncRequest;
@@ -30,6 +31,7 @@ class FuncStatus;
 class InsetMath;
 class InsetText;
 class LaTeXFeatures;
+class LColor_color;
 class LCursor;
 class LyXLex;
 class LyXText;
@@ -114,6 +116,10 @@ public:
        virtual bool editing(BufferView * bv) const;
        ///
        virtual bool showInsetDialog(BufferView *) const { return false; }
+
+       /// 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;
        /// draw two angular markers
@@ -195,15 +201,20 @@ public:
        /// describe content if cursor behind
        virtual void infoize2(odocstream &) const {}
 
+       enum {
+               PLAINTEXT_NEWLINE = 10000
+       };
+
        /// plain text output in ucs4 encoding
+       /// return the number of characters; in case of multiple lines of
+       /// output, add PLAINTEXT_NEWLINE to the number of chars in the last line
        virtual int plaintext(Buffer const &, odocstream &,
-               OutputParams const &) const;
+                             OutputParams const &) const = 0;
        /// docbook output
        virtual int docbook(Buffer const &, odocstream & os,
-               OutputParams const &) const;
+                           OutputParams const &) const;
        /// the string that is passed to the TOC
-       virtual int textString(Buffer const &, odocstream &,
-               OutputParams const &) const { return 0; };
+       virtual void textString(Buffer const &, odocstream &) const {}
 
        /** This enum indicates by which means the inset can be modified:
        - NOT_EDITABLE: the inset's content cannot be modified at all
@@ -332,7 +343,9 @@ public:
                ///
                NOMENCL_CODE, // 45
                ///
-               NOMENCL_PRINT_CODE
+               NOMENCL_PRINT_CODE,
+               ///
+               PAGEBREAK_CODE
        };
 
        /** returns the Code corresponding to the \c name.
@@ -343,8 +356,10 @@ public:
        /// returns true if the inset can hold an inset of given type
        virtual bool insetAllowed(Code) const { return false; }
        /// if this inset has paragraphs should they be output all as default
-       /// paragraphs with "Standard" layout?
+       /// paragraphs with the default layout of the text class?
        virtual bool forceDefaultParagraphs(idx_type) const { return false; }
+       /// Is the width forced to some value?
+       virtual bool hasFixedWidth() const { return false; }
 
        ///
        virtual docstring const & getInsetName() const;
@@ -418,19 +433,23 @@ public:
        /// set the change for the entire inset
        virtual void setChange(Change const &) {}
        /// accept the changes within the inset
-       virtual void acceptChanges() {};
+       virtual void acceptChanges(BufferParams const &) {};
        /// reject the changes within the inset
-       virtual void rejectChanges() {};
-
-       /// pretty arbitrary
-       virtual int width() const { return 10; }
-       /// pretty arbitrary
-       virtual int ascent() const { return 10; }
-       /// pretty arbitrary
-       virtual int descent() const { return 10; }
+       virtual void rejectChanges(BufferParams const &) {};
+
+       /// inset width.
+       int width() const { return dim_.wid; }
+       /// inset ascent.
+       int ascent() const { return dim_.asc; }
+       /// inset descent.
+       int descent() const { return dim_.des; }
        ///
        int scroll() const { return 0; }
        ///
+       void setBackgroundColor(LColor_color);
+       ///
+       LColor_color backgroundColor() const;
+       ///
        enum CollapseStatus {
                Collapsed,
                Inlined,
@@ -439,8 +458,8 @@ public:
        ///
        virtual void setStatus(LCursor &, CollapseStatus) {}
 protected:
-       InsetBase() {}
-       InsetBase(InsetBase const &) {}
+       InsetBase();
+       InsetBase(InsetBase const & i);
        /** The real dispatcher.
         *  Gets normally called from LCursor::dispatch(). LCursor::dispatch()
         *  assumes the common case of 'LFUN handled, need update'.
@@ -458,6 +477,10 @@ protected:
        mutable Dimension dim_;
 private:
        virtual std::auto_ptr<InsetBase> doClone() const = 0;
+       /** We store the LColor::color value as an int to get LColor.h out
+        *  of the header file.
+        */
+       int background_color_;
 };