Cleanup mouse/selection/context-menu interactions.

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

diff --git a/src/insets/Inset.h b/src/insets/Inset.h
index 1f3e9114979a56224cd2093c881eb4c1bbae4a91..a5fe6e6b6b2aaa964010414e6c1898b997fb00eb 100644 (file)
--- a/src/insets/Inset.h
+++ b/src/insets/Inset.h
@@ -19,10 +19,8 @@
 #include "InsetCode.h"
 
 #include "support/strfwd.h"
+#include "support/types.h"
 
-#include <boost/shared_ptr.hpp>
-
-#include <vector>
 
 namespace lyx {
 
@@ -31,6 +29,7 @@ class Buffer;
 class BufferParams;
 class BufferView;
 class Change;
+class CompletionList;
 class Cursor;
 class CursorSlice;
 class Dimension;
@@ -60,6 +59,14 @@ class EmbeddedFileList;
 namespace graphics { class PreviewLoader; }
 
 
+/** returns the InsetCode corresponding to the \c name.
+*   Eg, insetCode("branch") == BRANCH_CODE
+*   Implemented in 'Inset.cpp'.
+*/
+InsetCode insetCode(std::string const & name);
+/// the other way
+std::string insetName(InsetCode);
+
 /// Common base class to all insets
 
 // Do not add _any_ (non-static) data members as this would inflate
@@ -101,9 +108,14 @@ public:
        /**
          * This is typically used after this inset is created interactively.
          * Intented purpose is to sanitize internal state with regard to current
-         * Buffer.
+         * Buffer. The default implementation calls updateLabels(buffer()) is
+         * the inset is labeled.
+         *
+         * \sa isLabeled()
          **/
-       virtual void initView() {}
+       virtual void initView();
+       /// \return true if this inset is labeled.
+       virtual bool isLabeled() const { return false; }
 
        /// identification as math inset
        virtual InsetMath * asInsetMath() { return 0; }
@@ -224,7 +236,7 @@ public:
        virtual col_type col(idx_type) const { return 0; }
        /// to which row belongs a cell with a given index?
        virtual row_type row(idx_type) const { return 0; }
-       /// cell idex corresponding to row and column;
+       /// cell index corresponding to row and column;
        virtual idx_type index(row_type row, col_type col) const;
        /// any additional x-offset when drawing a cell?
        virtual int cellXOffset(idx_type) const { return 0; }
@@ -299,20 +311,6 @@ public:
        /// return true if the inset should be removed automatically
        virtual bool autoDelete() const;
 
-       class CompletionList {
-       public:
-               ///
-               virtual ~CompletionList() {}
-               ///
-               virtual bool sorted() const =0;
-               ///
-               virtual size_t size() const =0;
-               /// returns the string shown in the gui.
-               virtual docstring const & data(size_t idx) const = 0;
-               /// returns the resource string used to load an icon.
-               virtual std::string icon(size_t /*idx*/) const { return std::string(); }
-       };
-
        /// Returns true if the inset supports completions.
        virtual bool completionSupported(Cursor const &) const { return false; }
        /// Returns true if the inset supports inline completions at the
@@ -324,6 +322,8 @@ public:
        virtual bool automaticInlineCompletion() const { return true; }
        /// Return true if the popup completion should be automatic.
        virtual bool automaticPopupCompletion() const { return true; }
+       /// Return true if the cursor should indicate a completion.
+       virtual bool showCompletionCursor() const { return true; }
        /// Returns completion suggestions at cursor position. Return an
        /// null pointer if no completion is a available or possible.
        /// The caller is responsible to free the returned object!
@@ -331,8 +331,7 @@ public:
                { return 0; }
        /// Returns the completion prefix to filter the suggestions for completion.
        /// This is only called if completionList returned a non-null list.
-       virtual docstring completionPrefix(Cursor const &) const 
-               { return docstring(); }
+       virtual docstring completionPrefix(Cursor const &) const;
        /// Do a completion at the cursor position. Return true on success.
        /// The completion does not contain the prefix. If finished is true, the
        /// completion is final. If finished is false, completion might only be
@@ -351,10 +350,10 @@ public:
        virtual bool useEmptyLayout() const { return forceEmptyLayout(); }
        /// if this inset has paragraphs should they be forced to use the
        /// empty layout?
-       virtual bool forceEmptyLayout() const { return false; }
+       virtual bool forceEmptyLayout(idx_type = 0) const { return false; }
        /// if this inset has paragraphs should the user be allowed to
        /// customize alignment, etc?
-       virtual bool allowParagraphCustomization(idx_type) const { return true; }
+       virtual bool allowParagraphCustomization(idx_type = 0) const { return true; }
        /// Is the width forced to some value?
        virtual bool hasFixedWidth() const { return false; }
 
@@ -384,6 +383,8 @@ public:
        /// is this equivalent to a space (which is BTW different from
        /// a line separator)?
        virtual bool isSpace() const { return false; }
+       /// is this an expandible space (rubber length)?
+       virtual bool isStretchableSpace() const { return false; }
 
        enum DisplayType {
                Inline = 0,