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 metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
109 void drawT(TextPainter & pi, int x, int y) const;
111 void updateBuffer(ParIterator const &, UpdateType);
112 /// extract number of columns from alignment string
113 static col_type guessColumns(docstring const & halign);
114 /// accepts some LaTeX column codes: p,m,!,@,M,<,>
115 void setHorizontalAlignments(docstring const & align);
117 void setHorizontalAlignment(char c, col_type col);
119 char horizontalAlignment(col_type col) const;
121 docstring horizontalAlignments() const;
123 void setVerticalAlignment(char c);
125 char verticalAlignment() const;
127 void vcrskip(Length const &, row_type row);
129 Length vcrskip(row_type row) const;
131 void resize(short int type, col_type cols);
133 const RowInfo & rowinfo(row_type row) const;
134 /// returns topmost row if passed (-1)
135 RowInfo & rowinfo(row_type row);
137 const CellInfo & cellinfo(idx_type idx) const { return cellinfo_[idx]; }
139 CellInfo & cellinfo(idx_type idx) { return cellinfo_[idx]; }
140 /// identifies GridInset
141 InsetMathGrid * asGridInset() { return this; }
142 /// identifies GridInset
143 InsetMathGrid const * asGridInset() const { return this; }
145 bool isTable() const { return true; }
147 col_type ncols() const;
149 row_type nrows() const;
151 col_type col(idx_type idx) const;
153 row_type row(idx_type idx) const;
154 /// number of columns of cell \p idx
155 col_type ncellcols(idx_type idx) const;
158 bool idxUpDown(Cursor &, bool up) const;
160 bool idxBackward(Cursor &) const;
162 bool idxForward(Cursor &) const;
164 bool idxFirst(Cursor &) const;
166 bool idxLast(Cursor &) const;
168 bool idxDelete(idx_type & idx);
169 /// pulls cell after pressing erase
170 void idxGlue(idx_type idx);
172 /// add a row, one row down
173 virtual void addRow(row_type r);
175 virtual void delRow(row_type r);
177 virtual void copyRow(row_type r);
179 virtual void swapRow(row_type r);
180 /// add a column, here
181 virtual void addCol(col_type c);
183 virtual void delCol(col_type c);
185 virtual void copyCol(col_type c);
187 virtual void swapCol(col_type c);
189 idx_type index(row_type r, col_type c) const;
191 bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
193 virtual int defaultColSpace(col_type) { return 0; }
195 virtual char defaultColAlign(col_type) { return 'c'; }
199 virtual bool interpretString(Cursor & cur, docstring const & str);
202 virtual int colsep() const;
204 virtual int rowsep() const;
206 virtual int hlinesep() const;
208 virtual int vlinesep() const;
210 virtual int border() const;
212 virtual bool handlesMulticolumn() const { return false; }
215 void write(WriteStream & os) const;
217 void write(WriteStream & os,
218 row_type beg_row, col_type beg_col,
219 row_type end_row, col_type end_col) const;
221 void normalize(NormalStream &) const;
223 //void maple(MapleStream &) const;
225 void mathmlize(MathStream &) const;
227 void htmlize(HtmlStream &) const;
229 void htmlize(HtmlStream &, std::string attrib) const;
231 void validate(LaTeXFeatures & features) const;
233 //void octave(OctaveStream &) const;
237 void doDispatch(Cursor & cur, FuncRequest & cmd);
239 bool getStatus(Cursor & cur, FuncRequest const & cmd,
240 FuncStatus & flag) const;
241 /// returns x offset of cell compared to inset
242 int cellXOffset(BufferView const &, idx_type idx) const;
243 /// returns y offset of cell compared to inset
244 int cellYOffset(idx_type idx) const;
245 /// Width of cell, taking combined columns into account
246 int cellWidth(idx_type idx) const;
248 virtual int leftMargin() const { return 0; }
250 virtual int rightMargin() const { return 0; }
252 /// returns proper 'end of line' code for LaTeX
253 virtual docstring eolString(row_type row, bool fragile, bool latex,
254 bool last_eoln) const;
255 /// returns proper 'end of column' code for LaTeX
256 virtual docstring eocString(col_type col, col_type lastcol) const;
257 /// splits cells and shifts right part to the next cell
258 void splitCell(Cursor & cur);
259 /// Column alignment for display of cell \p idx.
260 /// Must not be written to file!
261 virtual char displayColAlign(idx_type idx) const;
262 /// Column spacing for display of column \p col.
263 /// Must not be written to file!
264 virtual int displayColSpace(col_type col) const;
266 // The following two functions are used in InsetMathHull and
268 /// The value of a fixed col align for a certain hull type
269 static char colAlign(HullType type, col_type col);
270 /// The value of a fixed col spacing for a certain hull type
271 static int colSpace(HullType type, col_type col);
273 /// positions of vertical and horizontal lines
274 int vLineHOffset(col_type col, unsigned int line) const;
275 int hLineVOffset(row_type row, unsigned int line) const;
278 /// rowinfo_[nrows()] is a dummy row used only for hlines.
279 std::vector<RowInfo> rowinfo_;
281 /// colinfo_[ncols()] is a dummy column used only for vlines.
282 std::vector<ColInfo> colinfo_;
284 std::vector<CellInfo> cellinfo_;
286 InsetCode lyxCode() const { return MATH_GRID_CODE; }
290 char v_align_; // FIXME: add approp. type
292 Inset * clone() const;