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 {
28 /// additional per-cell information
33 /// a dummy cell before a multicolumn cell
35 /// special multi colums alignment
37 /// these should be a per-cell property, but ok to have it here
38 /// for single-column grids like paragraphs
41 mutable pos_type begin_;
43 mutable pos_type end_;
46 /// additional per-row information
52 int skipPixels() const;
59 /// how many hlines above this row?
61 /// parameter to the line break
63 /// extra distance between lines
65 /// Is a page break allowed after this row?
66 bool allow_pagebreak_;
69 // additional per-row information
74 /// currently possible: 'l', 'c', 'r'
82 /// how many lines to the left of this column?
84 /// additional amount to be skipped when drawing
86 /// Special alignment.
87 /// This does also contain align_ and lines_ if it is nonempty.
88 /// It needs to be in sync with align_ and lines_ because some
89 /// code only uses align_ and lines_.
94 /// sets nrows and ncols to 1
96 /// constructor from columns description, creates one row
97 InsetMathGrid(char valign, docstring const & halign);
98 /// Note: columns first!
99 InsetMathGrid(col_type m, row_type n);
101 InsetMathGrid(col_type m, row_type n, char valign, docstring const & halign);
103 void metrics(MetricsInfo & mi) const;
105 bool metrics(MetricsInfo & mi, Dimension &) const;
107 void draw(PainterInfo & pi, int x, int y) const;
109 void drawWithMargin(PainterInfo & pi, int x, int y,
110 int lmargin = 0, int rmargin = 0) const;
111 /// draw decorations.
112 void drawDecoration(PainterInfo & pi, int x, int y) const
113 { drawMarkers2(pi, x, y); }
115 void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
117 void drawT(TextPainter & pi, int x, int y) const;
119 void halign(docstring const & align);
121 void halign(char c, col_type col);
123 char halign(col_type col) const;
125 docstring halign() const;
131 void vcrskip(Length const &, row_type row);
133 Length vcrskip(row_type row) const;
135 void resize(short int type, col_type cols);
137 const RowInfo & rowinfo(row_type row) const;
138 /// returns topmost row if passed (-1)
139 RowInfo & rowinfo(row_type row);
141 const CellInfo & cellinfo(idx_type idx) const { return cellinfo_[idx]; }
143 CellInfo & cellinfo(idx_type idx) { return cellinfo_[idx]; }
144 /// identifies GridInset
145 InsetMathGrid * asGridInset() { return this; }
146 /// identifies GridInset
147 InsetMathGrid const * asGridInset() const { return this; }
149 col_type ncols() const;
151 row_type nrows() const;
153 col_type col(idx_type idx) const;
155 row_type row(idx_type idx) const;
158 bool idxUpDown(Cursor &, bool up) const;
160 bool idxLeft(Cursor &) const;
162 bool idxRight(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);
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);
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 virtual void appendRow();
191 idx_type index(row_type r, col_type c) const;
193 bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
195 virtual int defaultColSpace(col_type) { return 0; }
197 virtual char defaultColAlign(col_type) { return 'c'; }
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;
213 void write(WriteStream & os) const;
215 void normalize(NormalStream &) const;
217 //void maple(MapleStream &) const;
219 void mathmlize(MathStream &) const;
221 //void octave(OctaveStream &) const;
224 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
226 bool getStatus(Cursor & cur, FuncRequest const & cmd,
227 FuncStatus & flag) const;
228 /// returns x offset of cell compared to inset
229 int cellXOffset(idx_type idx) const;
230 /// returns y offset of cell compared to inset
231 int cellYOffset(idx_type idx) const;
232 /// returns proper 'end of line' code for LaTeX
233 virtual docstring eolString(row_type row, bool emptyline,
235 /// returns proper 'end of column' code for LaTeX
236 virtual docstring eocString(col_type col, col_type lastcol) const;
237 /// extract number of columns from alignment string
238 col_type guessColumns(docstring const & halign) const;
239 /// splits cells and shifts right part to the next cell
240 void splitCell(Cursor & cur);
243 /// rowinfo_[nrows()] is a dummy row used only for hlines.
244 std::vector<RowInfo> rowinfo_;
246 /// colinfo_[ncols()] is a dummy column used only for vlines.
247 std::vector<ColInfo> colinfo_;
249 std::vector<CellInfo> cellinfo_;
251 char v_align_; // add approp. type
253 virtual Inset * clone() const;