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(MetricsInfo const & mi) 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?
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, vertical alingment to 'c'
95 InsetMathGrid(Buffer * buf);
96 /// Note: columns first!
97 InsetMathGrid(Buffer * buf, col_type m, row_type n);
99 InsetMathGrid(Buffer * buf, col_type m, row_type n, char valign,
100 docstring const & halign);
102 void metrics(MetricsInfo & mi, Dimension &) const;
104 void draw(PainterInfo & pi, int x, int y) const;
106 void drawWithMargin(PainterInfo & pi, int x, int y,
107 int lmargin = 0, int rmargin = 0) const;
108 /// draw decorations.
109 void drawDecoration(PainterInfo & pi, int x, int y) const
110 { drawMarkers2(pi, x, y); }
112 void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
114 void drawT(TextPainter & pi, int x, int y) const;
116 void updateBuffer(ParIterator const &, UpdateType);
117 /// extract number of columns from alignment string
118 static col_type guessColumns(docstring const & halign);
119 /// accepts some LaTeX column codes: p,m,!,@,M,<,>
120 void setHorizontalAlignments(docstring const & align);
122 void setHorizontalAlignment(char c, col_type col);
124 char horizontalAlignment(col_type col) const;
126 docstring horizontalAlignments() const;
128 void setVerticalAlignment(char c);
130 char verticalAlignment() const;
132 void vcrskip(Length const &, row_type row);
134 Length vcrskip(row_type row) const;
136 void resize(short int type, col_type cols);
138 const RowInfo & rowinfo(row_type row) const;
139 /// returns topmost row if passed (-1)
140 RowInfo & rowinfo(row_type row);
142 const CellInfo & cellinfo(idx_type idx) const { return cellinfo_[idx]; }
144 CellInfo & cellinfo(idx_type idx) { return cellinfo_[idx]; }
145 /// identifies GridInset
146 InsetMathGrid * asGridInset() { return this; }
147 /// identifies GridInset
148 InsetMathGrid const * asGridInset() const { return this; }
150 col_type ncols() const;
152 row_type nrows() const;
154 col_type col(idx_type idx) const;
156 row_type row(idx_type idx) const;
159 bool idxUpDown(Cursor &, bool up) const;
161 bool idxBackward(Cursor &) const;
163 bool idxForward(Cursor &) const;
165 bool idxFirst(Cursor &) const;
167 bool idxLast(Cursor &) const;
169 bool idxDelete(idx_type & idx);
170 /// pulls cell after pressing erase
171 void idxGlue(idx_type idx);
173 /// add a row, one row down
174 virtual void addRow(row_type r);
176 virtual void delRow(row_type r);
178 virtual void copyRow(row_type r);
180 virtual void swapRow(row_type r);
181 /// add a column, here
182 virtual void addCol(col_type c);
184 virtual void delCol(col_type c);
186 virtual void copyCol(col_type c);
188 virtual void swapCol(col_type c);
190 virtual void appendRow();
192 idx_type index(row_type r, col_type c) const;
194 bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
196 virtual int defaultColSpace(col_type) { return 0; }
198 virtual char defaultColAlign(col_type) { return 'c'; }
203 virtual int colsep() const;
205 virtual int rowsep() const;
207 virtual int hlinesep() const;
209 virtual int vlinesep() const;
211 virtual int border() const;
214 void write(WriteStream & os) const;
216 void write(WriteStream & os,
217 row_type beg_row, col_type beg_col,
218 row_type end_row, col_type end_col) const;
220 void normalize(NormalStream &) const;
222 //void maple(MapleStream &) const;
224 void mathmlize(MathStream &) const;
226 void htmlize(HtmlStream &) const;
228 void htmlize(HtmlStream &, std::string attrib) const;
230 //void octave(OctaveStream &) const;
234 void doDispatch(Cursor & cur, FuncRequest & cmd);
236 bool getStatus(Cursor & cur, FuncRequest const & cmd,
237 FuncStatus & flag) const;
238 /// returns x offset of cell compared to inset
239 int cellXOffset(BufferView const &, idx_type idx) const;
240 /// returns y offset of cell compared to inset
241 int cellYOffset(idx_type idx) const;
242 /// returns proper 'end of line' code for LaTeX
243 virtual docstring eolString(row_type row, bool fragile) const;
244 /// returns proper 'end of column' code for LaTeX
245 virtual docstring eocString(col_type col, col_type lastcol) const;
246 /// splits cells and shifts right part to the next cell
247 void splitCell(Cursor & cur);
250 /// rowinfo_[nrows()] is a dummy row used only for hlines.
251 std::vector<RowInfo> rowinfo_;
253 /// colinfo_[ncols()] is a dummy column used only for vlines.
254 std::vector<ColInfo> colinfo_;
256 std::vector<CellInfo> cellinfo_;
258 InsetCode lyxCode() const { return MATH_GRID_CODE; }
262 char v_align_; // add approp. type
264 Inset * clone() const;