]> git.lyx.org Git - lyx.git/blobdiff - src/insets/Inset.h
The last commit was, uhh, not what I intended.
[lyx.git] / src / insets / Inset.h
index 3c188f1f325f6fb153f45501d025f377cba6636e..48341f119c3d4d93e32d6acd07dd33b8815b3e8a 100644 (file)
 
 #include "ColorCode.h"
 #include "InsetCode.h"
+#include "Layout.h"
 
 #include "support/strfwd.h"
+#include "support/types.h"
 
-#include <boost/shared_ptr.hpp>
-
-#include <vector>
 
 namespace lyx {
 
@@ -31,6 +30,7 @@ class Buffer;
 class BufferParams;
 class BufferView;
 class Change;
+class CompletionList;
 class Cursor;
 class CursorSlice;
 class Dimension;
@@ -42,6 +42,7 @@ class InsetIterator;
 class InsetLayout;
 class InsetList;
 class InsetMath;
+class InsetTabular;
 class InsetText;
 class LaTeXFeatures;
 class Lexer;
@@ -53,13 +54,18 @@ class ParConstIterator;
 class ParIterator;
 class Text;
 class TocList;
-class EmbeddedFile;
-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
@@ -96,14 +102,22 @@ public:
        /// retrieve associated Buffer
        virtual Buffer & buffer();
        virtual Buffer const & buffer() const;
+       /// This checks whether the Buffer * actually points to an open 
+       /// Buffer. It might not if that Buffer has been closed.
+       bool isBufferValid() const;
 
        /// initialize view for this inset.
        /**
          * 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; }
@@ -117,6 +131,10 @@ public:
        virtual InsetCollapsable * asInsetCollapsable() { return 0; }
        /// is this inset based on the InsetCollapsable class?
        virtual InsetCollapsable const * asInsetCollapsable() const { return 0; }
+       /// is this inset based on the InsetTabular class?
+       virtual InsetTabular * asInsetTabular() { return 0; }
+       /// is this inset based on the InsetTabular class?
+       virtual InsetTabular const * asInsetTabular() const { return 0; }
 
        /// the real dispatcher
        void dispatch(Cursor & cur, FuncRequest & cmd);
@@ -155,6 +173,9 @@ public:
        virtual void draw(PainterInfo & pi, int x, int y) const = 0;
        /// draw inset selection if necessary
        virtual void drawSelection(PainterInfo &, int, int) const {}
+       /// draw inset background if the inset has an own background and a
+       /// selection is drawn by drawSelection.
+       virtual void drawBackground(PainterInfo &, int, int) const {}
        ///
        virtual bool editing(BufferView const * bv) const;
        ///
@@ -224,7 +245,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; }
@@ -256,8 +277,6 @@ public:
 
        /// request "external features"
        virtual void validate(LaTeXFeatures &) const {}
-       /// Appends \c list with all labels found within this inset.
-       virtual void getLabelList(std::vector<docstring> & /* list */) const {}
 
        /// describe content if cursor inside
        virtual void infoize(odocstream &) const {}
@@ -301,20 +320,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
@@ -326,6 +331,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!
@@ -333,8 +340,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
@@ -350,16 +356,19 @@ public:
        virtual bool insetAllowed(InsetCode) const { return false; }
        /// should this inset use the empty layout by default rather than 
        /// the standard layout? (default: only if that is forced.)
-       virtual bool useEmptyLayout() const { return forceEmptyLayout(); }
+       virtual bool usePlainLayout() const { return forcePlainLayout(); }
        /// if this inset has paragraphs should they be forced to use the
        /// empty layout?
-       virtual bool forceEmptyLayout() const { return false; }
+       virtual bool forcePlainLayout(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; }
 
+       /// Is the content of this inset part of the output document?
+       virtual bool producesOutput() const { return true; }
+
        /// \return Tool tip for this inset.
        /// This default implementation returns an empty string.
        virtual docstring toolTip(BufferView const & bv, int x, int y) const;
@@ -386,6 +395,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,
@@ -396,6 +407,8 @@ public:
 
        /// should we have a non-filled line before this inset?
        virtual DisplayType display() const { return Inline; }
+       ///
+       virtual LyXAlignment contentAlignment() const { return LYX_ALIGN_NONE; }
        /// should we break lines after this inset?
        virtual bool isLineSeparator() const { return false; }
        /// should paragraph indendation be ommitted in any case?
@@ -428,13 +441,19 @@ public:
         *  defaults to empty.
         */
        virtual void addPreview(graphics::PreviewLoader &) const {}
+
+       /** Classifies the unicode characters appearing in a math inset
+        *  depending on whether they are to be translated as latex
+        *  math/text commands or used as math symbols without translation.
+        *
+        *  Only math insets have interest in this classification, so the
+        *  method defaults to empty.
+        */
+       virtual void initUnicodeMath() const {}
+
        /// Add an entry to the TocList
        /// pit is the ParConstIterator of the paragraph containing the inset
-       virtual void addToToc(ParConstIterator const &) const {}
-       /// report files that can be embedded with the lyx file
-       virtual void registerEmbeddedFiles(EmbeddedFileList &) const {}
-       /// use embedded or external file after the embedding status of a file is changed
-       virtual void updateEmbeddedFile(EmbeddedFile const &) {}
+       virtual void addToToc(DocIterator const &) {}
        /// Fill keys with BibTeX information
        virtual void fillWithBibKeys(BiblioInfo &, InsetIterator const &) const {}
        /// Update the counters of this inset and of its contents
@@ -487,8 +506,9 @@ public:
        enum { TEXT_TO_INSET_OFFSET = 4 };
 
 protected:
-       /// Constructor
-       explicit Inset() : buffer_(0) {}
+       /// Constructors
+       Inset() : buffer_(0) {}
+       Inset(Inset const &) : buffer_(0) {}
 
        /// replicate ourselves
        friend class InsetList;