read the Changelog

[features.git] / src / insets / lyxinset.h

diff --git a/src/insets/lyxinset.h b/src/insets/lyxinset.h
index ff08faa4685cd9fa744e307217577b41c106c2dd..ba66d0f74b6e3ad507f4e592fb656ced5dbaf4a8 100644 (file)
--- a/src/insets/lyxinset.h
+++ b/src/insets/lyxinset.h
@@ -23,13 +23,14 @@
 #include "lyxfont.h"
 #include "lyxlex.h"
 
-class Painter;
 class BufferView;
+class Buffer;
+class Painter;
+class LyXText;
 
 struct LaTeXFeatures;
 
 
-
 /// Insets
 class Inset {
 public:
@@ -90,11 +91,22 @@ public:
                ///
                MARGIN_CODE,
                ///
+               FLOAT_CODE,
+               ///
+               MINIPAGE_CODE,
+               ///
                SPECIALCHAR_CODE,
                ///
-               TABULAR_CODE
+               TABULAR_CODE,
+               ///
+               EXTERNAL_CODE,
+               ///
+               THEOREM_CODE
        };
 
+       ///
+       enum { TEXT_TO_INSET_OFFSET = 2 };
+
        enum EDITABLE {
            NOT_EDITABLE = 0,
            IS_EDITABLE,
@@ -106,14 +118,17 @@ public:
        ///
        virtual ~Inset() {}
        ///
-       virtual int ascent(Painter &, LyXFont const &) const = 0;
+       virtual int ascent(BufferView *, LyXFont const &) const = 0;
        ///
-       virtual int descent(Painter &, LyXFont const &) const = 0;
+       virtual int descent(BufferView *, LyXFont const &) const = 0;
        ///
-       virtual int width(Painter &, LyXFont const &) const = 0;
+       virtual int width(BufferView *, LyXFont const &) const = 0;
        ///
-       virtual void draw(Painter &, LyXFont const &,
-                         int baseline, float & x) const = 0;
+       virtual void draw(BufferView *, LyXFont const &,
+                         int baseline, float & x, bool cleared) const = 0;
+       /// update the inset representation
+       virtual void update(BufferView *, LyXFont const &, bool = false)
+               {}
        ///
        virtual LyXFont ConvertFont(LyXFont font);
        /// what appears in the minibuffer when opening
@@ -122,34 +137,36 @@ public:
        virtual void Edit(BufferView *, int x, int y, unsigned int button);
        ///
        virtual EDITABLE Editable() const;
-       ///
+       /// This is called when the user clicks inside an inset
        virtual void InsetButtonPress(BufferView *, int, int, int) {}
-       ///
+       /// This is called when the user releases the button inside an inset
        virtual void InsetButtonRelease(BufferView *, int, int, int) {}
-       ///
+       /// This is caleld when the user moves the mouse inside an inset
        virtual void InsetMotionNotify(BufferView *, int , int , int) {}
        ///
-       bool IsTextInset() const;
+       virtual bool IsTextInset() const { return false; }
+       ///
+       virtual bool doClearArea() const { return true; }
        ///
        virtual bool AutoDelete() const;
        ///
-       virtual void Write(std::ostream &) const = 0;
+       virtual void Write(Buffer const *, std::ostream &) const = 0;
        ///
-       virtual void Read(LyXLex & lex) = 0;
+       virtual void Read(Buffer const *, LyXLex & lex) = 0;
        /** returns the number of rows (\n's) of generated tex code.
         fragile == true means, that the inset should take care about
         fragile commands by adding a \protect before.
         If the free_spc (freespacing) variable is set, then this inset
         is in a free-spacing paragraph.
         */
-       virtual int Latex(std::ostream &, bool fragile,
+       virtual int Latex(Buffer const *, std::ostream &, bool fragile,
                          bool free_spc) const = 0;
        ///
-       virtual int Ascii(std::ostream &) const = 0;
+       virtual int Ascii(Buffer const *, std::ostream &) const = 0;
        ///
-       virtual int Linuxdoc(std::ostream &) const = 0;
+       virtual int Linuxdoc(Buffer const *, std::ostream &) const = 0;
        ///
-       virtual int DocBook(std::ostream &) const = 0;
+       virtual int DocBook(Buffer const *, std::ostream &) const = 0;
        /// Updates needed features for this inset.
        virtual void Validate(LaTeXFeatures & features) const;
        ///
@@ -169,9 +186,13 @@ public:
        virtual bool DirectWrite() const;
 
        /// Returns true if the inset should be centered alone
-       virtual bool display() const { return false; }  
+       virtual bool display() const { return false; }
        /// Changes the display state of the inset
-       virtual void display(bool) {}  
+       virtual void display(bool) {}
+       ///
+       /// returns true if this inset needs a row on it's own
+       ///
+       virtual bool needFullRow() const { return false; }
        ///
        virtual bool InsertInsetAllowed(Inset *) const { return false; }
        ///
@@ -186,6 +207,12 @@ public:
        int x() const { return top_x; }
        ///
        int y() const { return top_baseline; }
+       ///
+       /// because we could have fake text insets and have to call this
+       /// inside them without cast!!!
+       virtual LyXText * getLyXText(BufferView *) const;
+       virtual void deleteLyXText(BufferView *, bool =true) const {}
+       virtual void resizeLyXText(BufferView *) const {}
 
 protected:
        ///
@@ -256,8 +283,6 @@ public:
        ///
        UpdatableInset() { scx = mx_scx = 0; }
        ///
-       //virtual ~UpdatableInset() {}
-       ///
        virtual EDITABLE Editable() const;
    
        /// may call ToggleLockedInsetCursor
@@ -267,7 +292,7 @@ public:
        ///
        virtual void HideInsetCursor(BufferView *);
        ///
-       virtual void GetCursorPos(int &, int &) const {}
+       virtual void GetCursorPos(BufferView *, int &, int &) const {}
        ///
        virtual void InsetButtonPress(BufferView *, int x, int y, int button);
        ///
@@ -282,8 +307,8 @@ public:
        ///
        virtual void Edit(BufferView *, int x, int y, unsigned int button);
        ///
-       virtual void draw(Painter &, LyXFont const &,
-                         int baseline, float & x) const;
+       virtual void draw(BufferView *, LyXFont const &,
+                         int baseline, float & x, bool cleared) const;
        ///
        virtual void SetFont(BufferView *, LyXFont const &,
                             bool toggleall = false);