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
33 /** Abstract base class for all math objects.
34 A math insets is for use of the math editor only, it isn't a
35 general LyX inset. It's used to represent all the math objects.
36 The formulaInset (a LyX inset) encapsulates a math inset.
42 class MathScriptInset;
47 typedef MathArray::size_type size_type;
51 /// the virtual base destructor
54 /// draw the object, sets xo_ and yo_ cached values
55 virtual void draw(Painter &, int x, int y) const;
56 /// write LaTeX and Lyx code
57 virtual void write(std::ostream &, bool fragile) const;
58 /// write normalized content
59 virtual void writeNormal(std::ostream &) const;
61 virtual MathInset * clone() const = 0;
62 ///substitutes macro arguments if necessary
63 virtual void substitute(MathMacro const & macro);
64 /// compute the size of the object, sets ascend_, descend_ and width_
65 virtual void metrics(MathStyles st) const;
67 virtual int ascent() const { return 1; }
69 virtual int descent() const { return 1; }
71 virtual int width() const { return 2; }
73 virtual int height() const;
75 virtual MathStyles size() const;
77 /// Where should we go when we press the up cursor key?
78 virtual bool idxUp(int & idx, int & pos) const;
80 virtual bool idxDown(int & idx, int & pos) const;
82 virtual bool idxLeft(int & idx, int & pos) const;
84 virtual bool idxRight(int & idx, int & pos) const;
86 /// Move one physical cell up
87 virtual bool idxNext(int & idx, int & pos) const;
88 /// Move one physical cell down
89 virtual bool idxPrev(int & idx, int & pos) const;
91 /// Target pos when we enter the inset from the left by pressing "Right"
92 virtual bool idxFirst(int & idx, int & pos) const;
93 /// Target pos when we enter the inset from the right by pressing "Left"
94 virtual bool idxLast(int & idx, int & pos) const;
96 /// Where should we go if we press home?
97 virtual bool idxHome(int & idx, int & pos) const;
98 /// Where should we go if we press end?
99 virtual bool idxEnd(int & idx, int & pos) const;
101 /// Delete a cell and move cursor
102 // the return value indicates whether the cursor should leave the inset
103 // and/or the whole inset should be deleted
104 virtual void idxDelete(int & idx, bool & popit, bool & deleteit);
105 // deletes a cell range and moves the cursor
106 virtual void idxDeleteRange(int from, int to);
107 // returns list of cell indices that are "between" from and to for
108 // selection purposes
109 virtual std::vector<int> idxBetween(int from, int to) const;
112 virtual int nargs() const;
115 virtual MathArray & cell(int);
117 virtual MathArray const & cell(int) const;
119 virtual MathXArray & xcell(int);
121 virtual MathXArray const & xcell(int) const;
124 virtual int xo() const;
126 virtual int yo() const;
128 virtual void xo(int tx) const;
130 virtual void yo(int ty) const;
134 virtual int ncols() const { return 1; }
136 virtual int nrows() const { return 1; }
138 virtual int col(int) const { return 0; }
140 virtual int row(int) const { return 0; }
142 virtual int cellXOffset(int) const { return 0; }
144 virtual int cellYOffset(int) const { return 0; }
146 virtual void addRow(int) {}
148 virtual void delRow(int) {}
150 virtual void addCol(int) {}
152 virtual void delCol(int) {}
155 virtual void userSetSize(MathStyles &) {}
158 virtual void getXY(int & x, int & y) const;
160 virtual bool covers(int x, int y) const;
161 /// identifies things that can get scripts
162 virtual bool isScriptable() const { return false; }
163 /// identifies ScriptInsets
164 virtual bool isScriptInset() const { return false; }
165 /// identifies SpaceInsets
166 virtual bool isSpaceInset() const { return false; }
167 /// identifies GridInsets
168 virtual bool isGrid() const { return false; }
169 /// identifies ArrayInsets
170 virtual bool isArray() const { return false; }
171 /// identifies CharInsets
172 virtual MathCharInset const * asCharInset() const { return 0; }
173 /// identifies ScriptInsets
174 virtual MathScriptInset const * asScriptInset() const { return 0; }
176 virtual bool isActive() const { return nargs() > 0; }
178 virtual bool isRelOp() const { return false; }
180 virtual bool isMacro() const { return false; }
182 virtual char getChar() const { return 0; }
184 virtual MathTextCodes code() const { return LM_TC_MIN; }
185 /// identifies things that can get \limits or \nolimits
186 virtual bool takesLimits() const { return false; }
189 virtual void push_back(MathInset *);
191 virtual void push_back(unsigned char c, MathTextCodes code);
193 virtual void dump() const;
196 virtual void validate(LaTeXFeatures & features) const;
198 virtual void handleFont(MathTextCodes) {}
201 static int workwidth;
205 void size(MathStyles s) const;
206 /// the used font size
207 mutable MathStyles size_;
210 /// the following are used for positioning the cursor with the mouse
211 /// cached cursor start position in pixels from the document left
213 /// cached cursor start position in pixels from the document top
217 std::ostream & operator<<(std::ostream &, MathInset const &);