ws changes only

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

diff --git a/src/insets/insetbase.h b/src/insets/insetbase.h
index c6dc34894ee7e0b175c478e42ec093160104a512..f261618f9b2888024269bfd5c34ead4624e09182 100644 (file)
--- a/src/insets/insetbase.h
+++ b/src/insets/insetbase.h
@@ -6,16 +6,23 @@
  *
  * \author none
  *
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
  */
 
 #ifndef INSETBASE_H
 #define INSETBASE_H
 
+#include <string>
 #include <vector>
+#include <memory>
 
+class Buffer;
 class BufferView;
 class FuncRequest;
+class MetricsInfo;
+class Dimension;
+class PainterInfo;
+class LaTeXFeatures;
 
 /** Dispatch result codes
                DISPATCHED          = the inset catched the action
@@ -43,18 +50,39 @@ enum dispatch_result {
        DISPATCHED_POP
 };
 
+/** \c DispatchResult is a wrapper for dispatch_result.
+ *  It can be forward-declared and passed as a function argument without
+ *  having to expose insetbase.h.
+ */
+class DispatchResult {
+       dispatch_result val_;
+public:
+       DispatchResult(dispatch_result val) : val_(val) {}
+       operator dispatch_result() const{ return val_; }
+};
+
+
 
 /// Common base class to all insets
 class InsetBase {
 public:
+       ///
+       typedef int      difference_type;
+       /// short of anything else reasonable
+       typedef size_t   size_type;
        /// type for cell indices
-       typedef size_t                   idx_type;
+       typedef size_t  idx_type;
        /// type for cursor positions
-       typedef size_t                   pos_type;
+       typedef size_t  pos_type;
        /// type for row numbers
-       typedef size_t                   row_type;
+       typedef size_t  row_type;
        /// type for column numbers
-       typedef size_t                   col_type;
+       typedef size_t  col_type;
+
+       /// virtual base class destructor
+       virtual ~InsetBase() {}
+       /// replicate ourselves
+       virtual std::auto_ptr<InsetBase> clone() const = 0;
 
        // the real dispatcher
        virtual dispatch_result dispatch
@@ -62,14 +90,16 @@ public:
 
        /// small wrapper for the time being
        virtual dispatch_result localDispatch(FuncRequest const & cmd);
+       /// compute the size of the object returned in dim
+       virtual void metrics(MetricsInfo & mi, Dimension & dim) const = 0;
+       /// draw inset and update (xo, yo)-cache
+       virtual void draw(PainterInfo & pi, int x, int y) const = 0;
 
-       ///
-       virtual ~InsetBase() {}
-
-       /// Methods to cache and retrieve a cached BufferView.
-       virtual void cache(BufferView *) const {}
-       ///
-       virtual BufferView * view() const { return 0; }
+       /// request "external features"
+       virtual void validate(LaTeXFeatures &) const {}
+       /// Appends \c list with all labels found within this inset.
+       virtual void getLabelList(Buffer const &,
+                                 std::vector<std::string> & /* list */) const {}
 };
 
 #endif