Finish the task of removing all cruft from the header files.

[lyx.git] / src / mathed / math_nestinset.h

diff --git a/src/mathed/math_nestinset.h b/src/mathed/math_nestinset.h
index 32555e7a1dbdf12ad51b6a3fae2c378bfc5ee5cf..4af8f0ab19c6679254230a2357c3303b8dbb57ec 100644 (file)
--- a/src/mathed/math_nestinset.h
+++ b/src/mathed/math_nestinset.h
@@ -1,41 +1,48 @@
+// -*- C++ -*-
+/**
+ * \file math_nestinset.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author André Pönitz
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
 #ifndef MATH_NESTINSET_H
 #define MATH_NESTINSET_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "math_diminset.h"
 
+class MathArray;
+
+
 /** Abstract base class for all math objects that contain nested items.
     This is basically everything that is not a single character or a
     single symbol.
 */
 
-
-class LaTeXFeatures;
-
 class MathNestInset : public MathDimInset {
 public:
        /// nestinsets have a fixed size to start with
        explicit MathNestInset(idx_type ncells);
 
        /// the size is usuall some sort of convex hull of the cells
-       void metrics(MathMetricsInfo const & mi) const;
-       /// add space for markers
-       void metricsMarkers(int frame = 1) const;
-       /// add space for markers
-       void metricsMarkers2(int frame = 1) const;
+       /// hides inset::metrics() intentionally!
+       void metrics(MetricsInfo const & mi) const;
        /// draw background if locked
-       void draw(MathPainterInfo & pi, int x, int y) const;
-       /// draw two angular markers
-       void drawMarkers(MathPainterInfo & pi, int x, int y) const;
-       /// draw four angular markers
-       void drawMarkers2(MathPainterInfo & pi, int x, int y) const;
+       void draw(PainterInfo & pi, int x, int y) const;
+       /// draw selection background
+       void drawSelection(PainterInfo & pi,
+               idx_type idx1, pos_type pos1, idx_type idx2, pos_type pos2) const;
        /// appends itself with macro arguments substituted
        void substitute(MathMacro const & macro);
        /// identifies NestInsets
        MathNestInset * asNestInset() { return this; }
+       /// identifies NestInsets
+       MathNestInset const * asNestInset() const { return this; }
+       /// get cursor position
+       void getPos(idx_type idx, pos_type pos, int & x, int & y) const;
 
        /// order of movement through the cells when pressing the left key
        bool idxLeft(idx_type & idx, pos_type & pos) const;
@@ -64,16 +71,12 @@ public:
        /// access to the lock
        void lock(bool);
        /// get notification when the cursor leaves this inset
-       void notifyCursorLeaves();
+       void notifyCursorLeaves(idx_type);
 
        /// direct access to the cell
        MathArray & cell(idx_type);
        /// direct access to the cell
        MathArray const & cell(idx_type) const;
-       /// direct access to the cell including the drawing cache
-       MathXArray & xcell(idx_type);
-       /// direct access to the cell including the drawing cache
-       MathXArray const & xcell(idx_type) const;
 
        /// can we move into this cell (see macroarg.h)
        bool isActive() const;
@@ -81,11 +84,11 @@ public:
        void validate(LaTeXFeatures & features) const;
 
        /// match in all cells
-       bool match(MathInset *) const;
+       bool match(MathAtom const &) const;
        /// replace in all cells
        void replace(ReplaceData &);
        /// do we contain a given pattern?
-       bool contains(MathArray const &);
+       bool contains(MathArray const &) const;
        /// glue everything to a single cell
        MathArray glue() const;
 
@@ -94,13 +97,33 @@ public:
        /// is the cursor currently somewhere within this inset?
        virtual bool editing() const;
 
+       /// writes \\, name(), and args in braces and '\\lyxlock' if necessary
+       void write(WriteStream & os) const;
+       /// writes [, name(), and args in []
+       void normalize(NormalStream & os) const;
+
+       /// local dispatcher
+       dispatch_result
+               dispatch(FuncRequest const & cmd, idx_type & idx, pos_type & pos);
+
 protected:
        /// we store the cells in a vector
-       typedef std::vector<MathXArray> cells_type;
+       typedef std::vector<MathArray> cells_type;
        /// thusly:
        cells_type cells_;
        /// if the inset is locked, it can't be entered with the cursor
        bool lock_;
+
+       /// draw four angular markers
+       void drawMarkers(PainterInfo & pi, int x, int y) const;
+       /// draw two angular markers
+       void drawMarkers2(PainterInfo & pi, int x, int y) const;
+
+       /// add space for markers
+       void metricsMarkers(int frame = 1) const;
+       /// add space for markers
+       void metricsMarkers2(int frame = 1) const;
+
 };
 
 #endif