#include "math_xdata.h"
#include "math_defs.h"
-/** Abstract base class for all math objects.
- A math insets is for use of the math editor only, it isn't a
- general LyX inset. It's used to represent all the math objects.
- The formulaInset (a LyX inset) encapsulates a math inset.
+/**
+
+Abstract base class for all math objects. A math insets is for use of the
+math editor only, it isn't a general LyX inset. It's used to represent all
+the math objects.
+
+Math insets do not know there parents, a cursor position or things
+like that. The are dumb object that are contained in other math insets
+(mathNestInsets, in fact) thus forming a tree. The root of this tree is
+always a mathHullInset, which provides an interface to the Outer World by
+inclusion in the "real LyX insets" FormulaInset and FormulaMacroInset.
+
*/
class BufferView;
class UpdatableInset;
class MathMacroTemplate;
+class MathPosFinder;
class MathInset {
/// type for column numbers
typedef size_type col_type;
- ///
- MathInset();
+ /// our members behave nicely...
+ MathInset() {}
/// the virtual base destructor
- virtual ~MathInset();
+ virtual ~MathInset() {}
/// draw the object
virtual void draw(Painter &, int x, int y) const;
virtual int height() const;
/// Where should we go when we press the up cursor key?
- virtual bool idxUp(idx_type & idx, pos_type & pos) const;
+ virtual bool idxUp(idx_type & idx) const;
/// The down key
- virtual bool idxDown(idx_type & idx, pos_type & pos) const;
+ virtual bool idxDown(idx_type & idx) const;
/// The left key
virtual bool idxLeft(idx_type & idx, pos_type & pos) const;
/// The right key
/// Target pos when we enter the inset from the left by pressing "Right"
virtual bool idxFirst(idx_type & idx, pos_type & pos) const;
- /// Target pos when we enter the inset from the left by pressing "Up"
- virtual bool idxFirstUp(idx_type & idx, pos_type & pos) const;
- /// Target pos when we enter the inset from the left by pressing "Down"
- virtual bool idxFirstDown(idx_type & idx, pos_type & pos) const;
/// Target pos when we enter the inset from the right by pressing "Left"
virtual bool idxLast(idx_type & idx, pos_type & pos) const;
- /// Target pos when we enter the inset from the right by pressing "Up"
- virtual bool idxLastUp(idx_type & idx, pos_type & pos) const;
- /// Target pos when we enter the inset from the right by pressing "Down"
- virtual bool idxLastDown(idx_type & idx, pos_type & pos) const;
/// Where should we go if we press home?
virtual bool idxHome(idx_type & idx, pos_type & pos) const;
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;
+ 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; }
/// any additional y-offset when drawing a cell?
virtual int cellYOffset(idx_type) const { return 0; }
- /// add a row after a given one
- virtual void addRow(row_type) {}
- /// delete a given row
- virtual void delRow(row_type) {}
- /// add a column after a given one
- virtual void addCol(col_type) {}
- /// delete a given row
- virtual void delCol(col_type) {}
-
- /// does this inset cover the pixel at (x,y)?
- virtual bool covers(int x, int y) const;
/// identifies certain types of insets
virtual MathArrayInset * asArrayInset() { return 0; }
virtual MathBoxInset * asBoxInset() { return 0; }
+ virtual MathBoxInset const * asBoxInset() const { return 0; }
virtual MathCharInset const * asCharInset() const { return 0; }
virtual MathDelimInset * asDelimInset() { return 0; }
virtual MathDelimInset const * asDelimInset() const { return 0; }
virtual MathScriptInset const * asScriptInset() const { return 0; }
virtual MathSpaceInset * asSpaceInset() { return 0; }
virtual MathStringInset * asStringInset() { return 0; }
- virtual MathSymbolInset * asSymbolInset() { return 0; }
+ virtual MathSymbolInset const * asSymbolInset() const { return 0; }
virtual UpdatableInset * asHyperActiveInset() const { return 0; }
/// identifies things that can get scripts