3 * \file InsetMathGrid.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.
15 #include "InsetMathNest.h"
22 /** Gridded math inset base class.
23 * This is the base to all grid-like editable math objects
25 class InsetMathGrid : public InsetMathNest {
31 /// A multicolumn cell. The number of columns is <tt>1 + number
32 /// of CELL_PART_OF_MULTICOLUMN cells</tt> that follow directly
33 CELL_BEGIN_OF_MULTICOLUMN = 1,
34 /// This is a dummy cell (part of a multicolumn cell)
35 CELL_PART_OF_MULTICOLUMN = 2
38 /// additional per-cell information
45 /// special multi colums alignment
49 /// additional per-row information
55 int skipPixels(MetricsInfo const & mi) const;
62 /// how many hlines above this row?
64 /// parameter to the line break
66 /// extra distance between lines
68 /// Is a page break allowed after this row?
72 // additional per-row information
77 /// currently possible: 'l', 'c', 'r'
83 /// how many lines to the left of this column?
85 /// additional amount to the right to be skipped when drawing
87 /// Special alignment.
88 /// This does also contain align_ and lines_ if it is nonempty.
89 /// It needs to be in sync with align_ and lines_ because some
90 /// code only uses align_ and lines_.
95 /// sets nrows and ncols to 1, vertical alingment to 'c'
96 InsetMathGrid(Buffer * buf);
97 /// Note: columns first!
98 InsetMathGrid(Buffer * buf, col_type m, row_type n);
100 InsetMathGrid(Buffer * buf, col_type m, row_type n, char valign,
101 docstring const & halign);
103 void metrics(MetricsInfo & mi, Dimension &) const;
105 void draw(PainterInfo & pi, int x, int y) const;
107 void drawWithMargin(PainterInfo & pi, int x, int y,
108 int lmargin = 0, int rmargin = 0) const;
109 /// draw decorations.
110 void drawDecoration(PainterInfo & pi, int x, int y) const
111 { drawMarkers2(pi, x, y); }
113 void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
115 void drawT(TextPainter & pi, int x, int y) const;
117 void updateBuffer(ParIterator const &, UpdateType);
118 /// extract number of columns from alignment string
119 static col_type guessColumns(docstring const & halign);
120 /// accepts some LaTeX column codes: p,m,!,@,M,<,>
121 void setHorizontalAlignments(docstring const & align);
123 void setHorizontalAlignment(char c, col_type col);
125 char horizontalAlignment(col_type col) const;
127 docstring horizontalAlignments() const;
129 void setVerticalAlignment(char c);
131 char verticalAlignment() const;
133 void vcrskip(Length const &, row_type row);
135 Length vcrskip(row_type row) const;
137 void resize(short int type, col_type cols);
139 const RowInfo & rowinfo(row_type row) const;
140 /// returns topmost row if passed (-1)
141 RowInfo & rowinfo(row_type row);
143 const CellInfo & cellinfo(idx_type idx) const { return cellinfo_[idx]; }
145 CellInfo & cellinfo(idx_type idx) { return cellinfo_[idx]; }
146 /// identifies GridInset
147 InsetMathGrid * asGridInset() { return this; }
148 /// identifies GridInset
149 InsetMathGrid const * asGridInset() const { return this; }
151 bool isTable() const { return true; }
153 col_type ncols() const;
155 row_type nrows() const;
157 col_type col(idx_type idx) const;
159 row_type row(idx_type idx) const;
160 /// number of columns of cell \p idx
161 col_type ncellcols(idx_type idx) const;
164 bool idxUpDown(Cursor &, bool up) const;
166 bool idxBackward(Cursor &) const;
168 bool idxForward(Cursor &) const;
170 bool idxFirst(Cursor &) const;
172 bool idxLast(Cursor &) const;
174 bool idxDelete(idx_type & idx);
175 /// pulls cell after pressing erase
176 void idxGlue(idx_type idx);
178 /// add a row, one row down
179 virtual void addRow(row_type r);
181 virtual void delRow(row_type r);
183 virtual void copyRow(row_type r);
185 virtual void swapRow(row_type r);
186 /// add a column, here
187 virtual void addCol(col_type c);
189 virtual void delCol(col_type c);
191 virtual void copyCol(col_type c);
193 virtual void swapCol(col_type c);
195 idx_type index(row_type r, col_type c) const;
197 bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
199 virtual int defaultColSpace(col_type) { return 0; }
201 virtual char defaultColAlign(col_type) { return 'c'; }
205 virtual bool interpretString(Cursor & cur, docstring const & str);
208 virtual int colsep() const;
210 virtual int rowsep() const;
212 virtual int hlinesep() const;
214 virtual int vlinesep() const;
216 virtual int border() const;
219 void write(WriteStream & os) const;
221 void write(WriteStream & os,
222 row_type beg_row, col_type beg_col,
223 row_type end_row, col_type end_col) const;
225 void normalize(NormalStream &) const;
227 //void maple(MapleStream &) const;
229 void mathmlize(MathStream &) const;
231 void htmlize(HtmlStream &) const;
233 void htmlize(HtmlStream &, std::string attrib) const;
235 void validate(LaTeXFeatures & features) const;
237 //void octave(OctaveStream &) const;
241 void doDispatch(Cursor & cur, FuncRequest & cmd);
243 bool getStatus(Cursor & cur, FuncRequest const & cmd,
244 FuncStatus & flag) const;
245 /// returns x offset of cell compared to inset
246 int cellXOffset(BufferView const &, idx_type idx) const;
247 /// returns y offset of cell compared to inset
248 int cellYOffset(idx_type idx) const;
249 /// Width of cell, taking combined columns into account
250 int cellWidth(idx_type idx) const;
251 /// returns proper 'end of line' code for LaTeX
252 virtual docstring eolString(row_type row, bool fragile, bool latex,
253 bool last_eoln) const;
254 /// returns proper 'end of column' code for LaTeX
255 virtual docstring eocString(col_type col, col_type lastcol) const;
256 /// splits cells and shifts right part to the next cell
257 void splitCell(Cursor & cur);
258 /// Column alignment for display of cell \p idx.
259 /// Must not be written to file!
260 virtual char displayColAlign(idx_type idx) const;
261 /// Column spacing for display of column \p col.
262 /// Must not be written to file!
263 virtual int displayColSpace(col_type col) const;
265 // The following two functions are used in InsetMathHull and
267 /// The value of a fixed col align for a certain hull type
268 static char colAlign(HullType type, col_type col);
269 /// The value of a fixed col spacing for a certain hull type
270 static int colSpace(HullType type, col_type col);
273 /// rowinfo_[nrows()] is a dummy row used only for hlines.
274 std::vector<RowInfo> rowinfo_;
276 /// colinfo_[ncols()] is a dummy column used only for vlines.
277 std::vector<ColInfo> colinfo_;
279 std::vector<CellInfo> cellinfo_;
281 InsetCode lyxCode() const { return MATH_GRID_CODE; }
285 char v_align_; // add approp. type
287 Inset * clone() const;