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.
48 /// the virtual base destructor
49 virtual ~MathInset() {}
51 /// draw the object, sets xo_ and yo_ cached values
52 virtual void draw(Painter &, int x, int y) const;
53 /// write LaTeX and Lyx code
54 virtual void write(std::ostream &, bool fragile) const;
55 /// write normalized content
56 virtual void writeNormal(std::ostream &) const;
58 virtual MathInset * clone() const = 0;
59 /// appends itself with macro arguments substituted
60 virtual void substitute(MathArray & array, MathMacro const & macro) const;
61 /// compute the size of the object, sets ascend_, descend_ and width_
62 virtual void metrics(MathStyles st) const;
64 virtual int ascent() const { return 1; }
66 virtual int descent() const { return 1; }
68 virtual int width() const { return 2; }
70 virtual int height() const;
72 virtual MathStyles size() const;
74 /// Where should we go when we press the up cursor key?
75 virtual bool idxUp(int & idx, int & pos) const;
77 virtual bool idxDown(int & idx, int & pos) const;
79 virtual bool idxLeft(int & idx, int & pos) const;
81 virtual bool idxRight(int & idx, int & pos) const;
83 /// Move one physical cell up
84 virtual bool idxNext(int & idx, int & pos) const;
85 /// Move one physical cell down
86 virtual bool idxPrev(int & idx, int & pos) const;
88 /// Target pos when we enter the inset from the left by pressing "Right"
89 virtual bool idxFirst(int & idx, int & pos) const;
90 /// Target pos when we enter the inset from the left by pressing "Up"
91 virtual bool idxFirstUp(int & idx, int & pos) const;
92 /// Target pos when we enter the inset from the left by pressing "Down"
93 virtual bool idxFirstDown(int & idx, int & pos) const;
95 /// Target pos when we enter the inset from the right by pressing "Left"
96 virtual bool idxLast(int & idx, int & pos) const;
97 /// Target pos when we enter the inset from the right by pressing "Up"
98 virtual bool idxLastUp(int & idx, int & pos) const;
99 /// Target pos when we enter the inset from the right by pressing "Down"
100 virtual bool idxLastDown(int & idx, int & pos) const;
102 /// Where should we go if we press home?
103 virtual bool idxHome(int & idx, int & pos) const;
104 /// Where should we go if we press end?
105 virtual bool idxEnd(int & idx, int & pos) const;
107 /// Delete a cell and move cursor
108 // the return value indicates whether the cursor should leave the inset
109 // and/or the whole inset should be deleted
110 virtual void idxDelete(int & idx, bool & popit, bool & deleteit);
111 // deletes a cell range and moves the cursor
112 virtual void idxDeleteRange(int from, int to);
113 // returns list of cell indices that are "between" from and to for
114 // selection purposes
115 virtual std::vector<int> idxBetween(int from, int to) const;
118 virtual int nargs() const;
121 virtual MathArray & cell(int);
123 virtual MathArray const & cell(int) const;
125 virtual MathXArray & xcell(int);
127 virtual MathXArray const & xcell(int) const;
130 virtual int xo() const;
132 virtual int yo() const;
134 virtual void xo(int tx) const;
136 virtual void yo(int ty) const;
140 virtual int ncols() const { return 1; }
142 virtual int nrows() const { return 1; }
144 virtual int col(int) const { return 0; }
146 virtual int row(int) const { return 0; }
148 virtual int cellXOffset(int) const { return 0; }
150 virtual int cellYOffset(int) const { return 0; }
152 virtual void addRow(int) {}
154 virtual void delRow(int) {}
156 virtual void addCol(int) {}
158 virtual void delCol(int) {}
161 virtual void userSetSize(MathStyles &) {}
164 virtual void getXY(int & x, int & y) const;
166 virtual bool covers(int x, int y) const;
167 /// identifies things that can get scripts
168 virtual bool isScriptable() const { return false; }
169 /// identifies ScriptInsets
170 virtual bool isScriptInset() const { return false; }
171 /// identifies SpaceInsets
172 virtual bool isSpaceInset() const { return false; }
173 /// identifies GridInsets
174 virtual bool isGrid() const { return false; }
175 /// identifies ArrayInsets
176 virtual bool isArray() const { return false; }
177 /// identifies Charinsets
178 virtual MathCharInset const * asCharInset() const { return 0; }
180 virtual bool isActive() const { return nargs() > 0; }
182 virtual bool isRelOp() const { return false; }
184 virtual bool isMacro() const { return false; }
186 virtual char getChar() const { return 0; }
188 virtual MathTextCodes code() const { return LM_TC_MIN; }
191 virtual void push_back(MathInset *);
193 virtual void push_back(unsigned char c, MathTextCodes code);
195 virtual void dump() const;
198 virtual void validate(LaTeXFeatures & features) const;
200 virtual void handleFont(MathTextCodes) {}
203 static int workwidth;
207 void size(MathStyles s) const;
208 /// the used font size
209 mutable MathStyles size_;
212 /// the following are used for positioning the cursor with the mouse
213 /// cached cursor start position in pixels from the document left
215 /// cached cursor start position in pixels from the document top
219 std::ostream & operator<<(std::ostream &, MathInset const &);