3 * \file math_nestinset.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
12 #ifndef MATH_NESTINSET_H
13 #define MATH_NESTINSET_H
15 #include "math_diminset.h"
18 /** Abstract base class for all math objects that contain nested items.
19 This is basically everything that is not a single character or a
23 class MathNestInset : public MathDimInset {
25 /// nestinsets have a fixed size to start with
26 explicit MathNestInset(idx_type ncells);
28 /// the size is usually some sort of convex hull of the cells
29 /// hides inset::metrics() intentionally!
30 void metrics(MetricsInfo const & mi) const;
31 /// draw background if locked
32 void draw(PainterInfo & pi, int x, int y) const;
33 /// draw selection background
34 void drawSelection(PainterInfo & pi, int x, int y) const;
35 /// appends itself with macro arguments substituted
36 void substitute(MathMacro const & macro);
37 /// identifies NestInsets
38 MathNestInset * asNestInset() { return this; }
39 /// identifies NestInsets
40 MathNestInset const * asNestInset() const { return this; }
41 /// get cursor position
42 void getCursorPos(CursorSlice const & cur, int & x, int & y) const;
44 void edit(LCursor & cur, bool left);
46 InsetBase * editXY(LCursor & cur, int x, int y);
48 /// order of movement through the cells when pressing the left key
49 bool idxLeft(LCursor &) const;
50 /// order of movement through the cells when pressing the right key
51 bool idxRight(LCursor &) const;
53 /// move one physical cell up
54 bool idxNext(LCursor &) const;
55 /// move one physical cell down
56 bool idxPrev(LCursor &) const;
58 /// target pos when we enter the inset from the left by pressing "Right"
59 bool idxFirst(LCursor &) const;
60 /// target pos when we enter the inset from the right by pressing "Left"
61 bool idxLast(LCursor &) const;
63 /// number of cells currently governed by us
64 idx_type nargs() const;
65 /// access to the lock
67 /// access to the lock
69 /// get notification when the cursor leaves this inset
70 void notifyCursorLeaves(idx_type);
72 /// direct access to the cell
73 MathArray & cell(idx_type);
74 /// direct access to the cell
75 MathArray const & cell(idx_type) const;
77 /// can we move into this cell (see macroarg.h)
78 bool isActive() const;
79 /// request "external features"
80 void validate(LaTeXFeatures & features) const;
82 /// replace in all cells
83 void replace(ReplaceData &);
84 /// do we contain a given pattern?
85 bool contains(MathArray const &) const;
86 /// glue everything to a single cell
87 MathArray glue() const;
92 /// writes \\, name(), and args in braces and '\\lyxlock' if necessary
93 void write(WriteStream & os) const;
94 /// writes [, name(), and args in []
95 void normalize(NormalStream & os) const;
99 void priv_dispatch(LCursor & cur, FuncRequest & cmd);
100 /// do we want to handle this event?
101 bool getStatus(LCursor & cur, FuncRequest const & cmd,
102 FuncStatus & status) const;
104 void handleFont(LCursor & cur,
105 std::string const & arg, std::string const & font);
107 void handleFont2(LCursor & cur, std::string const & arg);
110 bool interpret(LCursor & cur, char c);
112 bool script(LCursor & cur, bool);
117 void lfunMousePress(LCursor &, FuncRequest &);
119 void lfunMouseRelease(LCursor &, FuncRequest &);
121 void lfunMouseMotion(LCursor &, FuncRequest &);
124 /// we store the cells in a vector
125 typedef std::vector<MathArray> cells_type;
128 /// if the inset is locked, it can't be entered with the cursor