src/mathed/math_nestinset.h

   1 #ifndef MATH_NESTINSET_H
   2 #define MATH_NESTINSET_H
   3
   4 #ifdef __GNUG__
   5 #pragma interface
   6 #endif
   7
   8 #include "math_diminset.h"
   9
  10 /** Abstract base class for all math objects that contain nested items.
  11     This is basically everything that is not a single character or a
  12     single symbol.
  13 */
  14
  15
  16 class LaTeXFeatures;
  17
  18 class MathNestInset : public MathDimInset {
  19 public:
  20         /// nestinsets have a fixed size to start with
  21         explicit MathNestInset(idx_type ncells);
  22
  23         /// the size is usuall some sort of convex hull of the cells
  24         void metrics(MathMetricsInfo const & mi) const;
  25         /// add space for markers
  26         void metricsMarkers(int frame = 1) const;
  27         /// add space for markers
  28         void metricsMarkers2(int frame = 1) const;
  29         /// draw background if locked
  30         void draw(MathPainterInfo & pi, int x, int y) const;
  31         /// draw selection background
  32         void drawSelection(MathPainterInfo & pi,
  33                 idx_type idx1, pos_type pos1, idx_type idx2, pos_type pos2) const;
  34         void drawMarkers(MathPainterInfo & pi, int x, int y) const;
  35         /// draw four angular markers
  36         void drawMarkers2(MathPainterInfo & pi, int x, int y) const;
  37         /// appends itself with macro arguments substituted
  38         void substitute(MathMacro const & macro);
  39         /// identifies NestInsets
  40         MathNestInset * asNestInset() { return this; }
  41         /// identifies NestInsets
  42         MathNestInset const * asNestInset() const { return this; }
  43         /// get cursor position
  44         void getPos(idx_type idx, pos_type pos, int & x, int & y) const;
  45
  46         /// order of movement through the cells when pressing the left key
  47         bool idxLeft(idx_type & idx, pos_type & pos) const;
  48         /// order of movement through the cells when pressing the right key
  49         bool idxRight(idx_type & idx, pos_type & pos) const;
  50
  51         /// move one physical cell up
  52         bool idxNext(idx_type & idx, pos_type & pos) const;
  53         /// move one physical cell down
  54         bool idxPrev(idx_type & idx, pos_type & pos) const;
  55
  56         /// target pos when we enter the inset from the left by pressing "Right"
  57         bool idxFirst(idx_type & idx, pos_type & pos) const;
  58         /// target pos when we enter the inset from the right by pressing "Left"
  59         bool idxLast(idx_type & idx, pos_type & pos) const;
  60
  61         /// where should we go if we press home?
  62         bool idxHome(idx_type & idx, pos_type & pos) const;
  63         /// where should we go if we press end?
  64         bool idxEnd(idx_type & idx, pos_type & pos) const;
  65
  66         /// number of cells currently governed by us
  67         idx_type nargs() const;
  68         /// access to the lock
  69         bool lock() const;
  70         /// access to the lock
  71         void lock(bool);
  72         /// get notification when the cursor leaves this inset
  73         void notifyCursorLeaves(idx_type);
  74
  75         /// direct access to the cell
  76         MathArray & cell(idx_type);
  77         /// direct access to the cell
  78         MathArray const & cell(idx_type) const;
  79
  80         /// can we move into this cell (see macroarg.h)
  81         bool isActive() const;
  82         /// request "external features"
  83         void validate(LaTeXFeatures & features) const;
  84
  85         /// match in all cells
  86         bool match(MathAtom const &) const;
  87         /// replace in all cells
  88         void replace(ReplaceData &);
  89         /// do we contain a given pattern?
  90         bool contains(MathArray const &) const;
  91         /// glue everything to a single cell
  92         MathArray glue() const;
  93
  94         /// debug helper
  95         void dump() const;
  96         /// is the cursor currently somewhere within this inset?
  97         virtual bool editing() const;
  98
  99         /// writes \\, name(), and args in braces and '\\lyxlock' if necessary
 100         void write(WriteStream & os) const;
 101         /// writes [, name(), and args in []
 102         void normalize(NormalStream & os) const;
 103
 104         /// local dispatcher
 105         result_type dispatch(FuncRequest const & cmd, idx_type & idx, pos_type & pos);
 106
 107 protected:
 108         /// we store the cells in a vector
 109         typedef std::vector<MathArray> cells_type;
 110         /// thusly:
 111         cells_type cells_;
 112         /// if the inset is locked, it can't be entered with the cursor
 113         bool lock_;
 114 };
 115
 116 #endif