This should be the last of the commits refactoring the InsetLayout code.

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

diff --git a/src/insets/Inset.h b/src/insets/Inset.h
index 8c70ded2103f038e2f73b787a605c12131a81542..c3b72f4debcade449f5b78f8f0f2f0eaf7f94b6c 100644 (file)
--- a/src/insets/Inset.h
+++ b/src/insets/Inset.h
@@ -20,6 +20,8 @@
 
 #include "support/strfwd.h"
 
+#include <boost/shared_ptr.hpp>
+
 #include <vector>
 
 namespace lyx {
@@ -284,6 +286,49 @@ public:
        /// return true if the inset should be removed automatically
        virtual bool autoDelete() const;
 
+       class CompletionList {
+       public:
+               ///
+               virtual ~CompletionList() {}
+               ///
+               virtual size_t size() const =0;
+               /// returns the string shown in the gui.
+               virtual docstring 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
+       /// cursor position. In this case the completion might be stored
+       /// in the BufferView's inlineCompletion property.
+       virtual bool inlineCompletionSupported(Cursor const & /*cur*/) const 
+               { return false; }
+       /// Return true if the inline completion should be automatic.
+       virtual bool automaticInlineCompletion() const { return true; }
+       /// Return true if the popup completion should be automatic.
+       virtual bool automaticPopupCompletion() 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!
+       virtual CompletionList const * completionList(Cursor const &) const 
+               { 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(); }
+       /// 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
+       /// a partial completion.
+       virtual bool insertCompletion(Cursor & /*cur*/, 
+               docstring const & /*completion*/, bool /*finished*/) 
+               { return false; }
+       /// Get the completion inset position and size
+       virtual void completionPosAndDim(Cursor const &, int & /*x*/, int & /*y*/, 
+               Dimension & /*dim*/) const {}
+
        /// returns true if the inset can hold an inset of given type
        virtual bool insetAllowed(InsetCode) const { return false; }
        /// should this inset use the empty layout by default rather than