]> git.lyx.org Git - lyx.git/blobdiff - src/insets/lyxinset.h
some reindentation, revert workarea xpos++, constify, remove all traces of LyXParagra...
[lyx.git] / src / insets / lyxinset.h
index a4804875bb00b7f5e70fe03bd6723a241d31b278..5d14cd0ae3ac00a5fa595c19a901b64d6bd18089 100644 (file)
@@ -19,7 +19,6 @@
 
 #include <X11/Xlib.h>
 
-#include "gettext.h"
 #include "lyxfont.h"
 #include "lyxlex.h"
 #include "commandtags.h"
@@ -46,71 +45,67 @@ public:
                ///
                TOC_CODE,  // do these insets really need a code? (ale)
                ///
-               LOF_CODE, // 2
-               ///
-               LOT_CODE,
-               ///
-               LOA_CODE,
-               ///
-               QUOTE_CODE, // 5
+               QUOTE_CODE,
                ///
                MARK_CODE,
                ///
-               REF_CODE,
+               REF_CODE, // 5
                ///
                URL_CODE,
                ///
                HTMLURL_CODE,
                ///
-               SEPARATOR_CODE, // 10
+               SEPARATOR_CODE,
                ///
                ENDING_CODE,
                ///
-               LABEL_CODE,
+               LABEL_CODE, // 10
                ///
                IGNORE_CODE,
                ///
                ACCENT_CODE,
                ///
-               MATH_CODE, // 15
+               MATH_CODE,
                ///
                INDEX_CODE,
                ///
-               INCLUDE_CODE,
+               INCLUDE_CODE, // 15
                ///
                GRAPHICS_CODE,
                ///
                PARENT_CODE,
                ///
-               BIBTEX_CODE, // 20
+               BIBTEX_CODE,
                ///
                TEXT_CODE,
                ///
-               ERT_CODE,
+               ERT_CODE, // 20
                ///
                FOOT_CODE,
                ///
                MARGIN_CODE,
                ///
-               FLOAT_CODE, // 25
+               FLOAT_CODE,
                ///
                MINIPAGE_CODE,
                ///
-               SPECIALCHAR_CODE,
+               SPECIALCHAR_CODE, // 25
                ///
                TABULAR_CODE,
                ///
                EXTERNAL_CODE,
                ///
-               THEOREM_CODE, // 30
+               THEOREM_CODE,
                ///
                CAPTION_CODE,
                ///
-               MATHMACRO_CODE,
+               MATHMACRO_CODE, // 30
                ///
                ERROR_CODE,
                ///
-               CITE_CODE
+               CITE_CODE,
+               ///
+               FLOAT_LIST_CODE
        };
 
        ///
@@ -128,10 +123,10 @@ public:
                ///
                HIGHLY_EDITABLE
        };
-
-       ///
-       Inset() { owner_ = 0; top_x = top_baseline = 0; scx = 0; }
+       
        ///
+       Inset() : top_x(0), top_baseline(0), scx(0), owner_(0) {}
+       /// Virtual base destructor
        virtual ~Inset() {}
        ///
        virtual int ascent(BufferView *, LyXFont const &) const = 0;
@@ -170,11 +165,11 @@ public:
        ///
        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.
-        */
+           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(Buffer const *, std::ostream &, bool fragile,
                          bool free_spc) const = 0;
        ///
@@ -188,17 +183,17 @@ public:
        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 { return NO_CODE; }
-  
+       
        virtual std::vector<string> const getLabelList() const {
                return std::vector<string>();
        }
 
        ///
        virtual Inset * Clone(Buffer const &) const = 0;
-
+       
        /// returns true to override begin and end inset in file
        virtual bool DirectWrite() const;
 
@@ -228,20 +223,26 @@ public:
        // 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 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; }
+       virtual int scroll(bool recursive=true) const {
+               if (!recursive || !owner_)
+                       return scx;
+               return 0;
+       }
 
 protected:
        ///
        mutable int top_x;
+       ///
        mutable int top_baseline;
+       ///
        mutable int scx;
-
 private:
        ///
        Inset * owner_;
@@ -256,27 +257,27 @@ private:
 //  [Alejandro 080596] 
 
 /** Extracted from Matthias notes:
 
 * An inset can simple call LockInset in it's edit call and *ONLY* 
 * in it's edit call.
 *
 * Unlocking is either done by LyX or the inset itself with a 
 * UnlockInset-call
 *
 * During the lock, all button and keyboard events will be modified
 * and send to the inset through the following inset-features. Note that
 * Inset::InsetUnlock will be called from inside UnlockInset. It is meant
 * to contain the code for restoring the menus and things like this.
 
 * If a inset wishes any redraw and/or update it just has to call
 * UpdateInset(this).
 
 * It's is completly irrelevant, where the inset is. UpdateInset will
 * find it in any paragraph in any buffer. 
 * Of course the_locking_inset and the insets in the current paragraph/buffer
 *  are checked first, so no performance problem should occur.
 */
-class UpdatableInset: public Inset {
+ * 
+ * An inset can simple call LockInset in it's edit call and *ONLY* 
+ * in it's edit call.
+ *
+ * Unlocking is either done by LyX or the inset itself with a 
+ * UnlockInset-call
+ *
+ * During the lock, all button and keyboard events will be modified
+ * and send to the inset through the following inset-features. Note that
+ * Inset::InsetUnlock will be called from inside UnlockInset. It is meant
+ * to contain the code for restoring the menus and things like this.
+ * 
+ * If a inset wishes any redraw and/or update it just has to call
+ * UpdateInset(this).
+ * 
+ * It's is completly irrelevant, where the inset is. UpdateInset will
+ * find it in any paragraph in any buffer. 
+ * Of course the_locking_inset and the insets in the current paragraph/buffer
+ *  are checked first, so no performance problem should occur.
+ */
+class UpdatableInset : public Inset {
 public:
        /** Dispatch result codes
            Now that nested updatable insets are allowed, the local dispatch
@@ -285,17 +286,17 @@ public:
         
            DISPATCHED   = the inset catched the action
            DISPATCHED_NOUPDATE = the inset catched the action and no update
-                                  is needed here to redraw the inset
+                                 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
                           dispatched by lower level insets
        */ 
        enum RESULT {
-           UNDISPATCHED = 0,
-           DISPATCHED,
-           DISPATCHED_NOUPDATE,
-           FINISHED
+               UNDISPATCHED = 0,
+               DISPATCHED,
+               DISPATCHED_NOUPDATE,
+               FINISHED
        };
     
        /// To convert old binary dispatch results
@@ -304,14 +305,15 @@ public:
        }
 
        ///
-       UpdatableInset() {}
+       UpdatableInset() : cursor_visible_(false), block_drawing_(false) {}
+
        ///
        virtual EDITABLE Editable() const;
-   
+       
        /// may call ToggleLockedInsetCursor
        virtual void ToggleInsetCursor(BufferView *);
        ///
-       virtual void ShowInsetCursor(BufferView *, bool show=true);
+       virtual void ShowInsetCursor(BufferView *, bool show = true);
        ///
        virtual void HideInsetCursor(BufferView *);
        ///
@@ -359,19 +361,43 @@ public:
        ///  An updatable inset could handle lyx editing commands
        virtual RESULT LocalDispatch(BufferView *, kb_action, string const &);
        ///
-       virtual bool isCursorVisible() const { return cursor_visible; }
+       bool isCursorVisible() const { return cursor_visible_; }
+       ///
+       virtual int getMaxWidth(BufferView * bv, UpdatableInset const *) const;
+       ///
+       int scroll(bool recursive=true) const {
+               // We need this method to not clobber the real method in Inset
+               return Inset::scroll(recursive);
+       }
+       ///
+       virtual bool ShowInsetDialog(BufferView *) const { return false; }
        ///
-       virtual int getMaxWidth(Painter & pain, UpdatableInset const *) const;
+       virtual void nodraw(bool b) {
+               block_drawing_ = b;
+       }
        ///
-       int scroll() const { return scx; }
+       virtual bool nodraw() const {
+               return block_drawing_;
+       }
 
 protected:
        ///
-       mutable bool cursor_visible;
-
-       // scrolls to absolute position in bufferview-workwidth * sx units
+       void toggleCursorVisible() const {
+               cursor_visible_ = !cursor_visible_;
+       }
+       ///
+       void setCursorVisible(bool b) const {
+               cursor_visible_ = b;
+       }
+       /// scrolls to absolute position in bufferview-workwidth * sx units
        void scroll(BufferView *, float sx) const;
-       // scrolls offset pixels
+       /// scrolls offset pixels
        void scroll(BufferView *, int offset) const;
+
+private:
+       ///
+       mutable bool cursor_visible_;
+       ///
+       bool block_drawing_;
 };
 #endif