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"
17 #include "support/Length.h"
26 /** Gridded math inset base class.
27 * This is the base to all grid-like editable math objects
29 class InsetMathGrid : public InsetMathNest {
35 /// A multicolumn cell. The number of columns is <tt>1 + number
36 /// of CELL_PART_OF_MULTICOLUMN cells</tt> that follow directly
37 CELL_BEGIN_OF_MULTICOLUMN = 1,
38 /// This is a dummy cell (part of a multicolumn cell)
39 CELL_PART_OF_MULTICOLUMN = 2
42 /// additional per-cell information
49 /// special multi columns alignment
53 /// additional per-row information
59 int skipPixels(MetricsInfo const & mi) const;
64 /// cached offset for each bufferview
65 mutable std::map<BufferView const *, int> offset;
66 /// how many hlines above this row?
68 /// parameter to the line break
70 /// extra distance between lines
72 /// Is a page break allowed after this row?
76 // additional per-row information
81 /// currently possible: 'l', 'c', 'r'
87 /// how many lines to the left of this column?
89 /// additional amount to the right to be skipped when drawing
91 /// Special alignment.
92 /// This does also contain align_ and lines_ if it is nonempty.
93 /// It needs to be in sync with align_ and lines_ because some
94 /// code only uses align_ and lines_.
99 /// sets nrows and ncols to 1, vertical alignment to 'c'
100 explicit InsetMathGrid(Buffer * buf);
101 /// Note: columns first!
102 InsetMathGrid(Buffer * buf, col_type m, row_type n);
104 InsetMathGrid(Buffer * buf, col_type m, row_type n, char valign,
105 docstring const & halign);
107 marker_type marker(BufferView const *) const { return MARKER2; };
109 void metrics(MetricsInfo & mi, Dimension &) const;
111 void draw(PainterInfo & pi, int x, int y) const;
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, bool const deleted = false);
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 idx_type firstIdx() const;
172 idx_type lastIdx() 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;
218 virtual bool handlesMulticolumn() const { return false; }
221 void write(WriteStream & os) const;
223 void write(WriteStream & os,
224 row_type beg_row, col_type beg_col,
225 row_type end_row, col_type end_col) const;
227 void normalize(NormalStream &) const;
229 //void maple(MapleStream &) const;
231 void mathmlize(MathStream &) const;
233 void htmlize(HtmlStream &) const;
235 void htmlize(HtmlStream &, std::string attrib) const;
237 void validate(LaTeXFeatures & features) const;
239 //void octave(OctaveStream &) const;
243 void doDispatch(Cursor & cur, FuncRequest & cmd);
245 bool getStatus(Cursor & cur, FuncRequest const & cmd,
246 FuncStatus & flag) const;
247 /// returns x offset of cell compared to inset
248 int cellXOffset(BufferView const &, idx_type idx) const;
249 /// returns y offset of cell compared to inset
250 int cellYOffset(BufferView const &, idx_type idx) const;
251 /// Width of cell, taking combined columns into account
252 int cellWidth(idx_type idx) const;
254 virtual int leftMargin() const { return 0; }
256 virtual int rightMargin() const { return 0; }
258 /// returns proper 'end of line' code for LaTeX
259 virtual docstring eolString(row_type row, bool fragile, bool latex,
260 bool last_eoln) const;
261 /// returns proper 'end of column' code for LaTeX
262 virtual docstring eocString(col_type col, col_type lastcol) const;
263 /// splits cells and shifts right part to the next cell
264 void splitCell(Cursor & cur);
265 /// Column alignment for display of cell \p idx.
266 /// Must not be written to file!
267 virtual char displayColAlign(idx_type idx) const;
268 /// Column spacing for display of column \p col.
269 /// Must not be written to file!
270 virtual int displayColSpace(col_type col) const;
272 // The following two functions are used in InsetMathHull and
274 /// The value of a fixed col align for a certain hull type (can
275 /// depend on the "indent math" setting).
276 char colAlign(HullType type, col_type col) const;
277 /// The value of a fixed col spacing for a certain hull type
278 static int colSpace(HullType type, col_type col);
280 /// positions of vertical and horizontal lines
281 int vLineHOffset(col_type col, unsigned int line) const;
282 int hLineVOffset(BufferView const &, row_type row, unsigned int line) const;
285 InsetCode lyxCode() const { return MATH_GRID_CODE; }
289 /// rowinfo_[nrows()] is a dummy row used only for hlines.
290 std::vector<RowInfo> rowinfo_;
292 /// colinfo_[ncols()] is a dummy column used only for vlines.
293 std::vector<ColInfo> colinfo_;
295 std::vector<CellInfo> cellinfo_;
297 char v_align_; // FIXME: add approp. type
299 Inset * clone() const;