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 /// identifies NestInsets
36 MathNestInset * asNestInset() { return this; }
37 /// identifies NestInsets
38 MathNestInset const * asNestInset() const { return this; }
39 /// get cursor position
40 void cursorPos(CursorSlice const & sl, bool boundary, int & x, int & y) const;
42 void edit(LCursor & cur, bool left);
44 InsetBase * editXY(LCursor & cur, int x, int y);
46 /// order of movement through the cells when pressing the left key
47 bool idxLeft(LCursor &) const;
48 /// order of movement through the cells when pressing the right key
49 bool idxRight(LCursor &) const;
51 /// move one physical cell up
52 bool idxNext(LCursor &) const;
53 /// move one physical cell down
54 bool idxPrev(LCursor &) const;
56 /// target pos when we enter the inset from the left by pressing "Right"
57 bool idxFirst(LCursor &) const;
58 /// target pos when we enter the inset from the right by pressing "Left"
59 bool idxLast(LCursor &) const;
61 /// number of cells currently governed by us
62 idx_type nargs() const;
63 /// access to the lock
65 /// access to the lock
67 /// get notification when the cursor leaves this inset
68 void notifyCursorLeaves(LCursor & cur);
70 /// direct access to the cell
71 MathArray & cell(idx_type);
72 /// direct access to the cell
73 MathArray const & cell(idx_type) const;
75 /// can we move into this cell (see macroarg.h)
76 bool isActive() const;
77 /// request "external features"
78 void validate(LaTeXFeatures & features) const;
80 /// replace in all cells
81 void replace(ReplaceData &);
82 /// do we contain a given pattern?
83 bool contains(MathArray const &) const;
84 /// glue everything to a single cell
85 MathArray glue() const;
90 /// writes \\, name(), and args in braces and '\\lyxlock' if necessary
91 void write(WriteStream & os) const;
92 /// writes [, name(), and args in []
93 void normalize(NormalStream & os) const;
95 int latex(Buffer const &, std::ostream & os,
96 OutputParams const & runparams) const;
100 virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
101 /// do we want to handle this event?
102 bool getStatus(LCursor & cur, FuncRequest const & cmd,
103 FuncStatus & status) const;
105 void handleFont(LCursor & cur,
106 std::string const & arg, std::string const & font);
108 void handleFont2(LCursor & cur, std::string const & arg);
110 /// interpret \p c and insert the result at the current position of
111 /// of \p cur. Return whether the cursor should stay in the formula.
112 bool interpret(LCursor & cur, char c);
114 bool script(LCursor & cur, bool,
115 std::string const & save_selection = std::string());
118 /// interpret \p str and insert the result at the current position of
119 /// \p cur if it is something known. Return whether \p cur was
121 bool interpret(LCursor & cur, std::string const & str);
125 void lfunMousePress(LCursor &, FuncRequest &);
127 void lfunMouseRelease(LCursor &, FuncRequest &);
129 void lfunMouseMotion(LCursor &, FuncRequest &);
132 /// we store the cells in a vector
133 typedef std::vector<MathArray> cells_type;
136 /// if the inset is locked, it can't be entered with the cursor