3 * \file InsetMathNest.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 "InsetMath.h"
21 /** Abstract base class for all math objects that contain nested items.
22 This is basically everything that is not a single character or a
26 class InsetMathNest : public InsetMath {
28 /// nestinsets have a fixed size to start with
29 explicit InsetMathNest(idx_type ncells);
31 virtual ~InsetMathNest() {}
33 /// the size is usually some sort of convex hull of the cells
34 /// hides inset::metrics() intentionally!
35 void metrics(MetricsInfo const & mi) const;
36 /// draw background if locked
37 void draw(PainterInfo & pi, int x, int y) const;
38 /// draw selection background
39 void drawSelection(PainterInfo & pi, int x, int y) const;
41 void drawDecoration(PainterInfo & pi, int x, int y) const
42 { drawMarkers(pi, x, y); }
43 /// identifies NestInsets
44 InsetMathNest * asNestInset() { return this; }
45 /// identifies NestInsets
46 InsetMathNest const * asNestInset() const { return this; }
47 /// get cursor position
48 void cursorPos(BufferView const & bv, CursorSlice const & sl,
49 bool boundary, int & x, int & y) const;
51 void edit(Cursor & cur, bool left);
53 Inset * editXY(Cursor & cur, int x, int y);
55 /// order of movement through the cells when pressing the left key
56 bool idxLeft(Cursor &) const;
57 /// order of movement through the cells when pressing the right key
58 bool idxRight(Cursor &) const;
60 /// move one physical cell up
61 bool idxNext(Cursor &) const;
62 /// move one physical cell down
63 bool idxPrev(Cursor &) const;
65 /// target pos when we enter the inset from the left by pressing "Right"
66 bool idxFirst(Cursor &) const;
67 /// target pos when we enter the inset from the right by pressing "Left"
68 bool idxLast(Cursor &) const;
70 /// number of cells currently governed by us
71 idx_type nargs() const;
72 /// access to the lock
74 /// access to the lock
76 /// get notification when the cursor leaves this inset
77 bool notifyCursorLeaves(Cursor & cur);
79 /// direct access to the cell.
80 /// inlined because shows in profile.
82 MathData & cell(idx_type i) { return cells_[i]; }
83 MathData const & cell(idx_type i) const { return cells_[i]; }
86 /// can we move into this cell (see macroarg.h)
87 bool isActive() const;
88 /// request "external features"
89 void validate(LaTeXFeatures & features) const;
91 /// replace in all cells
92 void replace(ReplaceData &);
93 /// do we contain a given pattern?
94 bool contains(MathData const &) const;
95 /// glue everything to a single cell
96 MathData glue() const;
101 /// writes \\, name(), and args in braces and '\\lyxlock' if necessary
102 void write(WriteStream & os) const;
103 /// writes [, name(), and args in []
104 void normalize(NormalStream & os) const;
106 int latex(Buffer const &, odocstream & os,
107 OutputParams const & runparams) const;
109 bool setMouseHover(bool mouse_hover);
111 bool mouseHovered() const { return mouse_hover_; }
115 InsetMathNest(InsetMathNest const & inset);
117 InsetMathNest & operator=(InsetMathNest const &);
120 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
121 /// do we want to handle this event?
122 bool getStatus(Cursor & cur, FuncRequest const & cmd,
123 FuncStatus & status) const;
125 void handleFont(Cursor & cur,
126 docstring const & arg, docstring const & font);
127 void handleFont(Cursor & cur,
128 docstring const & arg, char const * const font);
130 void handleFont2(Cursor & cur, docstring const & arg);
132 /// interpret \p c and insert the result at the current position of
133 /// of \p cur. Return whether the cursor should stay in the formula.
134 bool interpretChar(Cursor & cur, char_type c);
136 bool script(Cursor & cur, bool,
137 docstring const & save_selection = docstring());
140 /// interpret \p str and insert the result at the current position of
141 /// \p cur if it is something known. Return whether \p cur was
143 bool interpretString(Cursor & cur, docstring const & str);
147 void lfunMousePress(Cursor &, FuncRequest &);
149 void lfunMouseRelease(Cursor &, FuncRequest &);
151 void lfunMouseMotion(Cursor &, FuncRequest &);
154 /// we store the cells in a vector
155 typedef std::vector<MathData> cells_type;
158 /// if the inset is locked, it can't be entered with the cursor