]> git.lyx.org Git - lyx.git/blobdiff - src/insets/lyxinset.h
reformatting and remove using delc
[lyx.git] / src / insets / lyxinset.h
index 26dba9c5ee42b1824d513a9ff0d931a5cfb13f1d..86321f977cf7f3fcda1cb2e12d679410534130f0 100644 (file)
 #pragma interface
 #endif
 
+#include <vector>
+
 #include <X11/Xlib.h>
 
 #include "gettext.h"
 #include "lyxfont.h"
 #include "lyxlex.h"
+#include "commandtags.h"
 
-class Painter;
 class BufferView;
+class Buffer;
+class Painter;
+class LyXText;
 
 struct LaTeXFeatures;
 
 
-
 /// Insets
 class Inset {
 public:
@@ -42,13 +46,13 @@ public:
                ///
                TOC_CODE,  // do these insets really need a code? (ale)
                ///
-               LOF_CODE,
+               LOF_CODE, // 2
                ///
                LOT_CODE,
                ///
                LOA_CODE,
                ///
-               QUOTE_CODE,
+               QUOTE_CODE, // 5
                ///
                MARK_CODE,
                ///
@@ -58,7 +62,7 @@ public:
                ///
                HTMLURL_CODE,
                ///
-               SEPARATOR_CODE,
+               SEPARATOR_CODE, // 10
                ///
                ENDING_CODE,
                ///
@@ -68,7 +72,7 @@ public:
                ///
                ACCENT_CODE,
                ///
-               MATH_CODE,
+               MATH_CODE, // 15
                ///
                INDEX_CODE,
                ///
@@ -78,7 +82,7 @@ public:
                ///
                PARENT_CODE,
                ///
-               BIBTEX_CODE,
+               BIBTEX_CODE, // 20
                ///
                TEXT_CODE,
                ///
@@ -88,66 +92,98 @@ public:
                ///
                MARGIN_CODE,
                ///
+               FLOAT_CODE, // 25
+               ///
+               MINIPAGE_CODE,
+               ///
                SPECIALCHAR_CODE,
                ///
-               TABULAR_CODE
+               TABULAR_CODE,
+               ///
+               EXTERNAL_CODE,
+               ///
+               THEOREM_CODE, // 30
+               ///
+               CAPTION_CODE,
+               ///
+               MATHMACRO_CODE,
+               ///
+               ERROR_CODE,
+               ///
+               CITE_CODE
        };
 
+       ///
+       enum {
+               ///
+               TEXT_TO_INSET_OFFSET = 2
+       };
+
+       ///
        enum EDITABLE {
-           NOT_EDITABLE = 0,
-           IS_EDITABLE,
-           HIGHLY_EDITABLE
+               ///
+               NOT_EDITABLE = 0,
+               ///
+               IS_EDITABLE,
+               ///
+               HIGHLY_EDITABLE
        };
 
        ///
-       Inset() { owner_ = 0; top_x = top_baseline = 0; }
+       Inset() { owner_ = 0; top_x = top_baseline = 0; scx = 0; }
        ///
        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);
+       virtual LyXFont const ConvertFont(LyXFont const & font) const;
        /// what appears in the minibuffer when opening
-       virtual const char * EditMessage() const;
+       virtual string const EditMessage() const;
        ///
        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 &, int linelen = 0) 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;
        ///
@@ -156,44 +192,55 @@ public:
        /// returns LyX code associated with the inset. Used for TOC, ...)
        virtual Inset::Code LyxCode() const { return NO_CODE; }
   
-       /// Get the label that appears at screen
-       virtual string getLabel(int) const {
-               return string();
+       virtual std::vector<string> const getLabelList() const {
+               return std::vector<string>();
        }
 
        ///
-       virtual Inset * Clone() const = 0;
+       virtual Inset * Clone(Buffer const &) const = 0;
 
        /// returns true to override begin and end inset in file
        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) {}
        ///
-       virtual int GetNumberOfLabels() const {
-               return 0;
-       }
+       /// 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; }
        ///
-       virtual void setInsetName(const char * s) { name = s; }
+       void setInsetName(string const & s) { name = s; }
        ///
-       virtual string getInsetName() const { return name; }
+       string const getInsetName() const { return name; }
        ///
-       virtual void setOwner(Inset * inset) { owner_ = inset; }
+       void setOwner(Inset * inset) { owner_ = inset; }
        ///
-       virtual Inset * owner() const { return owner_; }
+       Inset * owner() const { return owner_; }
        ///
        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 *, bool const recursive=false) const;
+       ///
+       virtual void deleteLyXText(BufferView *, bool = true) const {}
+       ///
+       virtual void resizeLyXText(BufferView *) const {}
+       /// returns the actuall scroll-value
+       int scroll() const { return scx; }
 
 protected:
        ///
        mutable int top_x;
        mutable int top_baseline;
+       mutable int scx;
 
 private:
        ///
@@ -257,20 +304,18 @@ public:
        }
 
        ///
-       UpdatableInset() { scx = mx_scx = 0; }
-       ///
-       //virtual ~UpdatableInset() {}
+       UpdatableInset() {}
        ///
        virtual EDITABLE Editable() const;
    
        /// may call ToggleLockedInsetCursor
        virtual void ToggleInsetCursor(BufferView *);
        ///
-       virtual void ShowInsetCursor(BufferView *);
+       virtual void ShowInsetCursor(BufferView *, bool show=true);
        ///
        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);
        ///
@@ -285,8 +330,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);
@@ -300,7 +345,7 @@ public:
        virtual UpdatableInset * GetFirstLockingInsetOfType(Inset::Code c)
                { return (c == LyxCode()) ? this : 0; }
        ///
-       virtual int InsetInInsetY() { return 0; }
+       virtual unsigned int InsetInInsetY() { return 0; }
        ///
        virtual bool UpdateInsetInInset(BufferView *, Inset *)
                { return false; }
@@ -312,19 +357,23 @@ public:
                                        bool /*lr*/ = false)
                { return false; }
        ///  An updatable inset could handle lyx editing commands
-       virtual RESULT LocalDispatch(BufferView *, int, string const &);
+       virtual RESULT LocalDispatch(BufferView *, kb_action, string const &);
        ///
        virtual bool isCursorVisible() const { return cursor_visible; }
        ///
-       virtual int getMaxWidth(Painter & pain, UpdatableInset const *) const;
+       virtual int getMaxWidth(BufferView * bv, UpdatableInset const *) const;
+       ///
+       int scroll() const { return scx; }
+       ///
+       virtual bool ShowInsetDialog(BufferView *) const { return false; }
 
 protected:
        ///
        mutable bool cursor_visible;
 
-private:
-       ///
-       int mx_scx;
-       mutable int scx;
+       // scrolls to absolute position in bufferview-workwidth * sx units
+       void scroll(BufferView *, float sx) const;
+       // scrolls offset pixels
+       void scroll(BufferView *, int offset) const;
 };
 #endif