]> git.lyx.org Git - features.git/blobdiff - src/insets/lyxinset.h
read the Changelog
[features.git] / src / insets / lyxinset.h
index 6665370371b0dd82f67b4e3abd481b219c6e07ef..ba66d0f74b6e3ad507f4e592fb656ced5dbaf4a8 100644 (file)
@@ -4,7 +4,6 @@
  * 
  *           LyX, The Document Processor
  *      
- *           Copyright 1995 Matthias Ettrich
  *           Copyright 1995-2000 the LyX Team.
  *
  * ====================================================== */
 #pragma interface
 #endif
 
+#include <vector>
+
+#include <X11/Xlib.h>
+
 #include "gettext.h"
 #include "lyxfont.h"
 #include "lyxlex.h"
 
-class Painter;
-class Buffer;
 class BufferView;
+class Buffer;
+class Painter;
+class LyXText;
 
 struct LaTeXFeatures;
 
@@ -81,68 +85,98 @@ public:
                ///
                TEXT_CODE,
                ///
+               ERT_CODE,
+               ///
                FOOT_CODE,
                ///
                MARGIN_CODE,
                ///
-               SPECIALCHAR_CODE
+               FLOAT_CODE,
+               ///
+               MINIPAGE_CODE,
+               ///
+               SPECIALCHAR_CODE,
+               ///
+               TABULAR_CODE,
+               ///
+               EXTERNAL_CODE,
+               ///
+               THEOREM_CODE
        };
 
+       ///
+       enum { TEXT_TO_INSET_OFFSET = 2 };
+
        enum EDITABLE {
            NOT_EDITABLE = 0,
            IS_EDITABLE,
            HIGHLY_EDITABLE
        };
 
+       ///
+       Inset() { owner_ = 0; top_x = top_baseline = 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);
        /// what appears in the minibuffer when opening
-       virtual const char * EditMessage() const {return _("Opened inset");}
+       virtual const char * 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) {}
+       ///
+       virtual bool IsTextInset() const { return false; }
+       ///
+       virtual bool doClearArea() const { return true; }
        ///
        virtual bool AutoDelete() const;
        ///
-       virtual void Write(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 != 0 means, that the inset should take care about
+        fragile == true means, that the inset should take care about
         fragile commands by adding a \protect before.
-        If the freee_spc (freespacing) variable is set, then this inset
+        If the free_spc (freespacing) variable is set, then this inset
         is in a free-spacing paragraph.
         */
-       virtual int Latex(ostream &, signed char fragile,
+       virtual int Latex(Buffer const *, std::ostream &, bool fragile,
                          bool free_spc) const = 0;
-
        ///
-       virtual int Linuxdoc(ostream &) const = 0;
+       virtual int Ascii(Buffer const *, std::ostream &) const = 0;
+       ///
+       virtual int Linuxdoc(Buffer const *, std::ostream &) const = 0;
        ///
-       virtual int DocBook(ostream &) const = 0;
+       virtual int DocBook(Buffer const *, std::ostream &) const = 0;
        /// Updates needed features for this inset.
        virtual void Validate(LaTeXFeatures & features) const;
        ///
        virtual bool Deletable() const;
 
        /// returns LyX code associated with the inset. Used for TOC, ...)
-       virtual Inset::Code LyxCode() const = 0;
+       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> getLabelList() const {
+               return std::vector<string>();
        }
 
        ///
@@ -152,16 +186,44 @@ 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) {}
        ///
-       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; }
+       ///
+       virtual string getInsetName() const { return name; }
+       ///
+       virtual void setOwner(Inset * inset) { owner_ = inset; }
+       ///
+       virtual Inset * owner() const { return owner_; }
        ///
-       virtual void init(BufferView *) {}
+       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:
+       ///
+       mutable int top_x;
+       mutable int top_baseline;
 
+private:
+       ///
+       Inset * owner_;
+       ///
+       string name;
 };
 
 
@@ -199,6 +261,8 @@ public:
            are not enough. 
         
            DISPATCHED   = the inset catched the action
+           DISPATCHED_NOUPDATE = the inset catched the action and no update
+                                  is needed here to redraw the inset
            FINISHED     = the inset must be unlocked as a result
                           of the action
            UNDISPATCHED = the action was not catched, it should be
@@ -207,6 +271,7 @@ public:
        enum RESULT {
            UNDISPATCHED = 0,
            DISPATCHED,
+           DISPATCHED_NOUPDATE,
            FINISHED
        };
     
@@ -216,19 +281,18 @@ public:
        }
 
        ///
-       UpdatableInset() {
-           scx = mx_scx = 0;
-           owner_ = 0;
-       }
-       ///
-       //virtual ~UpdatableInset() {}
+       UpdatableInset() { scx = mx_scx = 0; }
        ///
        virtual EDITABLE Editable() const;
    
        /// may call ToggleLockedInsetCursor
        virtual void ToggleInsetCursor(BufferView *);
        ///
-       virtual void GetCursorPos(int &, int &) const {}
+       virtual void ShowInsetCursor(BufferView *);
+       ///
+       virtual void HideInsetCursor(BufferView *);
+       ///
+       virtual void GetCursorPos(BufferView *, int &, int &) const {}
        ///
        virtual void InsetButtonPress(BufferView *, int x, int y, int button);
        ///
@@ -243,22 +307,30 @@ 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);
        ///
        virtual bool InsertInset(BufferView *, Inset *) { return false; }
        ///
+       virtual bool InsertInsetAllowed(Inset *) const { return true; }
+       ///
        virtual UpdatableInset * GetLockingInset() { return this; }
        ///
+       virtual UpdatableInset * GetFirstLockingInsetOfType(Inset::Code c)
+               { return (c == LyxCode()) ? this : 0; }
+       ///
        virtual int InsetInInsetY() { return 0; }
        ///
        virtual bool UpdateInsetInInset(BufferView *, Inset *)
                { return false; }
        ///
-       virtual bool UnlockInsetInInset(BufferView *, Inset *,
+       virtual bool LockInsetInInset(BufferView *, UpdatableInset *)
+               { return false; }
+       ///
+       virtual bool UnlockInsetInInset(BufferView *, UpdatableInset *,
                                        bool /*lr*/ = false)
                { return false; }
        ///  An updatable inset could handle lyx editing commands
@@ -266,26 +338,15 @@ public:
        ///
        virtual bool isCursorVisible() const { return cursor_visible; }
        ///
-       virtual int getMaxWidth(Painter & pain) const;
-       ///
-       virtual void setOwner(UpdatableInset * inset) { owner_ = inset; }
-       ///
-       virtual UpdatableInset * owner() { return owner_; }
+       virtual int getMaxWidth(Painter & pain, UpdatableInset const *) const;
 
 protected:
        ///
-       // virtual void UpdateLocal(bool flag=true);
-       ///
-       mutable int top_x;
-       mutable int top_baseline;
        mutable bool cursor_visible;
 
 private:
        ///
        int mx_scx;
        mutable int scx;
-       ///
-       UpdatableInset * owner_;
-
 };
 #endif