First step towards unified insets...

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

diff --git a/src/insets/inset.h b/src/insets/inset.h
index e7fbd1a84864e5875f516a7429a68ecb009b44f1..7df0f29e04a623eaf1fa5b867245c9ae04f25d4b 100644 (file)
--- a/src/insets/inset.h
+++ b/src/insets/inset.h
@@ -1,24 +1,27 @@
 // -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- *           LyX, The Document Processor
+/**
+ * \file inset.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           Copyright 1995-2001 the LyX Team.
+ * \author Alejandro Aguilar Sierra
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
+ * \author Matthias Ettrich
  *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS
+ */
 
 #ifndef INSET_H
 #define INSET_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
 
 #include <vector>
 #include "LString.h"
 #include "LColor.h"
+#include "insetbase.h"
 #include "frontends/mouse_state.h"
+#include "support/types.h"
 
 class LyXFont;
 class BufferView;
@@ -38,7 +41,7 @@ namespace grfx {
 }
 
 /// Insets
-class Inset {
+class Inset : public InsetBase {
 public:
        /** This is not quite the correct place for this enum. I think
            the correct would be to let each subclass of Inset declare
@@ -93,6 +96,8 @@ public:
                ///
                FLOAT_CODE,
                ///
+               WRAP_CODE,
+               ///
                MINIPAGE_CODE,
                ///
                SPECIALCHAR_CODE, // 25
@@ -115,7 +120,9 @@ public:
                ///
                FLOAT_LIST_CODE,
                ///
-               INDEX_PRINT_CODE
+               INDEX_PRINT_CODE,
+               ///
+               OPTARG_CODE
        };
 
        ///
@@ -134,39 +141,8 @@ public:
                HIGHLY_EDITABLE
        };
 
-       /** Dispatch result codes
-           Now that nested updatable insets are allowed, the local dispatch
-           becomes a bit complex, just two possible results (boolean)
-           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
-           FINISHED_RIGHT      = FINISHED, but put the cursor to the RIGHT of
-                                 the inset.
-           FINISHED_UP         = FINISHED, but put the cursor UP of
-                                 the inset.
-           FINISHED_DOWN       = FINISHED, but put the cursor DOWN of
-                                 the inset.
-           UNDISPATCHED        = the action was not catched, it should be
-                                 dispatched by lower level insets
-       */
-       enum RESULT {
-               UNDISPATCHED = 0,
-               DISPATCHED,
-               DISPATCHED_NOUPDATE,
-               FINISHED,
-               FINISHED_RIGHT,
-               FINISHED_UP,
-               FINISHED_DOWN
-       };
-
-       /// To convert old binary dispatch results
-       RESULT DISPATCH_RESULT(bool b) {
-               return b ? DISPATCHED : FINISHED;
-       }
+       ///
+       typedef InsetBase::dispatch_result RESULT;
 
        ///
        Inset();
@@ -194,13 +170,13 @@ public:
        virtual void edit(BufferView *, bool front = true);
        ///
        virtual EDITABLE editable() const;
-       /// 
+       ///
        virtual RESULT localDispatch(FuncRequest const & cmd);
        ///
        virtual bool isTextInset() const { return false; }
        ///
        virtual bool doClearArea() const { return true; }
-       ///
+       /// return true if the inset should be removed automatically
        virtual bool autoDelete() const;
        /// returns true the inset can hold an inset of given type
        virtual bool insetAllowed(Inset::Code) const { return false; }
@@ -227,8 +203,6 @@ public:
        virtual int docbook(Buffer const *, std::ostream &, bool) 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 { return NO_CODE; }
@@ -287,11 +261,7 @@ public:
                        return scx;
                return 0;
        }
-       /// try to get a paragraph pointer from it's id if we have a
-       /// paragraph to give back!
-       virtual Paragraph * getParFromID(int /* id */) const {
-               return 0;
-       }
+
        /// try to get a inset pointer from it's id if we have
        /// an inset to give back!
        virtual Inset * getInsetFromID(int /* id */) const {
@@ -332,7 +302,7 @@ public:
        ///
        // needed for spellchecking text
        ///
-       virtual bool allowSpellcheck() { return false; }
+       virtual bool allowSpellcheck() const { return false; }
 
        // should this inset be handled like a normal charater
        virtual bool isChar() const { return false; }
@@ -347,8 +317,8 @@ public:
        // paragraphs with "Standard" layout?
        virtual bool forceDefaultParagraphs(Inset const *) const;
        /** returns true if, when outputing LaTeX, font changes should
-            be closed before generating this inset. This is needed for
-            insets that may contain several paragraphs */
+           be closed before generating this inset. This is needed for
+           insets that may contain several paragraphs */
        virtual bool noFontChange() const { return false; }
        //
        virtual void getDrawFont(LyXFont &) const {}
@@ -358,6 +328,9 @@ public:
           minipage somewhere, it will be the width of this minipage */
        virtual int latexTextWidth(BufferView *) const;
 
+       /// mark the inset contents as erased (for change tracking)
+       virtual void markErased() {}
+ 
        /** Adds a LaTeX snippet to the Preview Loader for transformation
         *  into a bitmap image. Does not start the laoding process.
         *
@@ -374,6 +347,7 @@ public:
         */
        virtual void generatePreview() const {}
 
+
 protected:
        ///
        mutable int top_x;
@@ -516,16 +490,20 @@ public:
        ///
        // needed for spellchecking text
        ///
-       virtual bool allowSpellcheck() { return false; }
+       virtual bool allowSpellcheck() const { return false; }
        ///
        virtual WordLangTuple const
        selectNextWordToSpellcheck(BufferView *, float & value) const;
        ///
-       virtual void selectSelectedWord(BufferView *) { return; }
+       virtual void selectSelectedWord(BufferView *) {}
        ///
        virtual void toggleSelection(BufferView *, bool /*kill_selection*/) {
                return;
        }
+
+       /// find the next change in the inset
+       virtual bool nextChange(BufferView * bv, lyx::pos_type & length);
+ 
        ///
        // needed for search/replace functionality
        ///
@@ -535,6 +513,7 @@ public:
        virtual bool searchBackward(BufferView *, string const &,
                                    bool = true, bool = false);
 
+
 protected:
        ///
        void toggleCursorVisible() const {