4 * Purpose: Declaration of insets for mathed
5 * Author: Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
6 * Created: January 1996
7 * Description: Math paragraph and objects for a WYSIWYG math editor.
9 * Dependencies: Xlib, XForms
11 * Copyright: 1996, 1997 Alejandro Aguilar Sierra
13 * Version: 0.8beta, Math & Lyx project.
15 * You are free to use and modify this code under the terms of
16 * the GNU General Public Licence version 2 or later.
19 // Note: These math insets are internal to Math and are not derived
32 #include "math_defs.h"
34 /** Abstract base class for all math objects.
35 A math insets is for use of the math editor only, it isn't a
36 general LyX inset. It's used to represent all the math objects.
37 The formulaInset (a LyX inset) encapsulates a math inset.
46 class MathMatrixInset;
47 class MathScriptInset;
49 class MathMacroTemplate;
55 struct MathWriteInfo {
57 MathWriteInfo(Buffer const * buffer_, std::ostream & os_, bool fragile_)
58 : buffer(buffer_), os(os_), fragile(fragile_)
61 explicit MathWriteInfo(std::ostream & os_)
62 : buffer(0), os(os_), fragile(false)
67 MathWriteInfo & operator<<(T const & t)
73 MathWriteInfo & operator<<(MathArray const & ar)
81 Buffer const * buffer;
91 /// short of anything else reasonable
92 typedef MathArray::size_type size_type;
93 /// type for cursor positions within a cell
94 typedef MathArray::size_type pos_type;
95 /// type for cell indices
96 typedef size_type idx_type;
97 /// type for row numbers
98 typedef size_type row_type;
99 /// type for column numbers
100 typedef size_type col_type;
104 /// the virtual base destructor
105 virtual ~MathInset();
107 /// draw the object, sets xo_ and yo_ cached values
108 virtual void draw(Painter &, int x, int y) const;
109 /// write LaTeX and Lyx code
110 virtual void write(MathWriteInfo & os) const;
111 /// write normalized content
112 virtual void writeNormal(std::ostream &) const;
114 virtual MathInset * clone() const = 0;
115 ///substitutes macro arguments if necessary
116 virtual void substitute(MathMacro const & macro);
117 /// compute the size of the object, sets ascend_, descend_ and width_
118 virtual void metrics(MathMetricsInfo const & st) const;
120 virtual int ascent() const { return 1; }
122 virtual int descent() const { return 1; }
124 virtual int width() const { return 2; }
126 virtual int height() const;
128 /// Where should we go when we press the up cursor key?
129 virtual bool idxUp(idx_type & idx, pos_type & pos) const;
131 virtual bool idxDown(idx_type & idx, pos_type & pos) const;
133 virtual bool idxLeft(idx_type & idx, pos_type & pos) const;
135 virtual bool idxRight(idx_type & idx, pos_type & pos) const;
137 /// Move one physical cell up
138 virtual bool idxNext(idx_type & idx, pos_type & pos) const;
139 /// Move one physical cell down
140 virtual bool idxPrev(idx_type & idx, pos_type & pos) const;
142 /// Target pos when we enter the inset from the left by pressing "Right"
143 virtual bool idxFirst(idx_type & idx, pos_type & pos) const;
144 /// Target pos when we enter the inset from the right by pressing "Left"
145 virtual bool idxLast(idx_type & idx, pos_type & pos) const;
147 /// Where should we go if we press home?
148 virtual bool idxHome(idx_type & idx, pos_type & pos) const;
149 /// Where should we go if we press end?
150 virtual bool idxEnd(idx_type & idx, pos_type & pos) const;
152 /// Delete a cell and move cursor
153 // the return value indicates whether the cursor should leave the inset
154 // and/or the whole inset should be deleted
155 virtual void idxDelete(idx_type & idx, bool & popit, bool & deleteit);
156 // deletes a cell range and moves the cursor
157 virtual void idxDeleteRange(idx_type from, idx_type to);
158 // returns list of cell indices that are "between" from and to for
159 // selection purposes
160 virtual std::vector<idx_type> idxBetween(idx_type from, idx_type to) const;
163 virtual idx_type nargs() const;
166 virtual MathArray & cell(idx_type);
168 virtual MathArray const & cell(idx_type) const;
170 virtual MathXArray & xcell(idx_type);
172 virtual MathXArray const & xcell(idx_type) const;
175 virtual int xo() const;
177 virtual int yo() const;
179 virtual void xo(int tx) const;
181 virtual void yo(int ty) const;
185 virtual col_type ncols() const { return 1; }
187 virtual row_type nrows() const { return 1; }
189 virtual col_type col(row_type) const { return 0; }
191 virtual row_type row(row_type) const { return 0; }
193 virtual int cellXOffset(row_type) const { return 0; }
195 virtual int cellYOffset(row_type) const { return 0; }
197 virtual void addRow(row_type) {}
199 virtual void delRow(row_type) {}
201 virtual void addCol(col_type) {}
203 virtual void delCol(col_type) {}
206 virtual void getXY(int & x, int & y) const;
208 virtual bool covers(int x, int y) const;
210 /// identifies NestInsets
211 virtual MathNestInset * asNestInset() { return 0; }
212 /// identifies CharInsets
213 virtual MathCharInset const * asCharInset() const { return 0; }
214 /// identifies ScriptInsets
215 virtual MathScriptInset const * asScriptInset() const { return 0; }
216 /// identifies ScriptInsets
217 virtual MathScriptInset * asScriptInset() { return 0; }
218 /// identifies MatrixInsets
219 virtual MathMatrixInset const * asMatrixInset() const { return 0; }
220 /// identifies MatrixInsets
221 virtual MathMatrixInset * asMatrixInset() { return 0; }
222 /// identifies SpaceInset
223 virtual MathSpaceInset * asSpaceInset() { return 0; }
224 /// identifies GridInset
225 virtual MathGridInset * asGridInset() { return 0; }
226 /// identifies ArrayInsets
227 virtual MathArrayInset * asArrayInset() { return 0; }
228 /// identifies BoxInsets
229 virtual MathBoxInset * asBoxInset() { return 0; }
230 /// identifies macro templates
231 virtual MathMacroTemplate * asMacroTemplate() { return 0; }
233 /// identifies things that can get scripts
234 virtual bool isScriptable() const { return false; }
236 virtual bool isActive() const { return nargs() > 0; }
238 virtual bool isRelOp() const { return false; }
240 virtual bool isMacro() const { return false; }
243 virtual char getChar() const { return 0; }
245 virtual MathTextCodes code() const { return LM_TC_MIN; }
246 /// identifies things that can get \limits or \nolimits
247 virtual bool takesLimits() const { return false; }
250 virtual void dump() const;
253 virtual void validate(LaTeXFeatures & features) const;
255 virtual void handleFont(MathTextCodes) {}
258 /// the following are used for positioning the cursor with the mouse
259 /// cached cursor start position in pixels from the document left
261 /// cached cursor start position in pixels from the document top
265 std::ostream & operator<<(std::ostream &, MathInset const &);