src/mathed/InsetMathGrid.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetMathGrid.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef MATH_GRID_H
  13 #define MATH_GRID_H
  14
  15 #include "InsetMathNest.h"
  16 #include "Length.h"
  17
  18
  19 namespace lyx {
  20
  21
  22 /** Gridded math inset base class.
  23  *  This is the base to all grid-like editable math objects
  24  */
  25 class InsetMathGrid : public InsetMathNest {
  26 public:
  27
  28         /// additional per-cell information
  29         class CellInfo {
  30         public:
  31                 ///
  32                 CellInfo();
  33                 /// a dummy cell before a multicolumn cell
  34                 int dummy_;
  35                 /// special multi colums alignment
  36                 docstring align_;
  37                 /// these should be a per-cell property, but ok to have it here
  38                 /// for single-column grids like paragraphs
  39                 mutable int glue_;
  40                 ///
  41                 mutable pos_type begin_;
  42                 ///
  43                 mutable pos_type end_;
  44         };
  45
  46         /// additional per-row information
  47         class RowInfo {
  48         public:
  49                 ///
  50                 RowInfo();
  51                 ///
  52                 int skipPixels() const;
  53                 /// cached descent
  54                 mutable int descent_;
  55                 /// cached ascent
  56                 mutable int ascent_;
  57                 /// cached offset
  58                 mutable int offset_;
  59                 /// how many hlines above this row?
  60                 unsigned int lines_;
  61                 /// parameter to the line break
  62                 Length crskip_;
  63                 /// extra distance between lines
  64                 int skip_;
  65                 /// Is a page break allowed after this row?
  66                 bool allow_newpage_;
  67         };
  68
  69         // additional per-row information
  70         class ColInfo {
  71         public:
  72                 ///
  73                 ColInfo();
  74                 /// currently possible: 'l', 'c', 'r'
  75                 char align_;
  76                 /// cache for drawing
  77                 int h_offset;
  78                 /// cached width
  79                 mutable int width_;
  80                 /// cached offset
  81                 mutable int offset_;
  82                 /// how many lines to the left of this column?
  83                 unsigned int lines_;
  84                 /// additional amount to be skipped when drawing
  85                 int skip_;
  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_.
  90                 docstring special_;
  91         };
  92
  93 public:
  94         /// sets nrows and ncols to 1, vertical alingment to 'c'
  95         InsetMathGrid();
  96         /// Note: columns first!
  97         InsetMathGrid(col_type m, row_type n);
  98         ///
  99         InsetMathGrid(col_type m, row_type n, char valign, docstring const & halign);
 100         ///
 101         void metrics(MetricsInfo & mi, Dimension &) const;
 102         ///
 103         void draw(PainterInfo & pi, int x, int y) const;
 104         ///
 105         void drawWithMargin(PainterInfo & pi, int x, int y,
 106                 int lmargin = 0, int rmargin = 0) const;
 107         /// draw decorations.
 108         void drawDecoration(PainterInfo & pi, int x, int y) const
 109         { drawMarkers2(pi, x, y); }
 110         ///
 111         void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
 112         ///
 113         void drawT(TextPainter & pi, int x, int y) const;
 114         /// extract number of columns from alignment string
 115         static col_type guessColumns(docstring const & halign);
 116         /// accepts some LaTeX column codes: p,m,!,@,M,<,>
 117         void setHorizontalAlignments(docstring const & align);
 118         ///
 119         void setHorizontalAlignment(char c, col_type col);
 120         ///
 121         char horizontalAlignment(col_type col) const;
 122         ///
 123         docstring horizontalAlignments() const;
 124         /// 't', 'b', or 'm'
 125         void setVerticalAlignment(char c);
 126         ///
 127         char verticalAlignment() const;
 128         ///
 129         void vcrskip(Length const &, row_type row);
 130         ///
 131         Length vcrskip(row_type row) const;
 132         ///
 133         void resize(short int type, col_type cols);
 134         ///
 135         const RowInfo & rowinfo(row_type row) const;
 136         /// returns topmost row if passed (-1)
 137         RowInfo & rowinfo(row_type row);
 138         ///
 139         const CellInfo & cellinfo(idx_type idx) const { return cellinfo_[idx]; }
 140         ///
 141         CellInfo & cellinfo(idx_type idx) { return cellinfo_[idx]; }
 142         /// identifies GridInset
 143         InsetMathGrid * asGridInset() { return this; }
 144         /// identifies GridInset
 145         InsetMathGrid const * asGridInset() const { return this; }
 146         ///
 147         col_type ncols() const;
 148         ///
 149         row_type nrows() const;
 150         ///
 151         col_type col(idx_type idx) const;
 152         ///
 153         row_type row(idx_type idx) const;
 154
 155         ///
 156         bool idxUpDown(Cursor &, bool up) const;
 157         ///
 158         bool idxBackward(Cursor &) const;
 159         ///
 160         bool idxForward(Cursor &) const;
 161         ///
 162         bool idxFirst(Cursor &) const;
 163         ///
 164         bool idxLast(Cursor &) const;
 165         ///
 166         bool idxDelete(idx_type & idx);
 167         /// pulls cell after pressing erase
 168         void idxGlue(idx_type idx);
 169
 170         /// add a row, one row down
 171         virtual void addRow(row_type r);
 172         /// delete a row
 173         virtual void delRow(row_type r);
 174         /// copy a row
 175         virtual void copyRow(row_type r);
 176         /// swap two rows
 177         virtual void swapRow(row_type r);
 178         /// add a column, here
 179         virtual void addCol(col_type c);
 180         /// delete a column
 181         virtual void delCol(col_type c);
 182         /// copy a column
 183         virtual void copyCol(col_type c);
 184         /// swap two columns
 185         virtual void swapCol(col_type c);
 186         ///
 187         virtual void appendRow();
 188         ///
 189         idx_type index(row_type r, col_type c) const;
 190         ///
 191         bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
 192         ///
 193         virtual int defaultColSpace(col_type) { return 0; }
 194         ///
 195         virtual char defaultColAlign(col_type) { return 'c'; }
 196         ///
 197         void setDefaults();
 198
 199         ///
 200         virtual int colsep() const;
 201         ///
 202         virtual int rowsep() const;
 203         ///
 204         virtual int hlinesep() const;
 205         ///
 206         virtual int vlinesep() const;
 207         ///
 208         virtual int border() const;
 209
 210         ///
 211         void write(WriteStream & os) const;
 212         ///
 213         void normalize(NormalStream &) const;
 214         ///
 215         //void maple(MapleStream &) const;
 216         ///
 217         void mathmlize(MathStream &) const;
 218         ///
 219         //void octave(OctaveStream &) const;
 220
 221 protected:
 222         ///
 223         void doDispatch(Cursor & cur, FuncRequest & cmd);
 224         ///
 225         bool getStatus(Cursor & cur, FuncRequest const & cmd,
 226                 FuncStatus & flag) const;
 227         /// returns x offset of cell compared to inset
 228         int cellXOffset(BufferView const &, idx_type idx) const;
 229         /// returns y offset of cell compared to inset
 230         int cellYOffset(idx_type idx) const;
 231         /// returns proper 'end of line' code for LaTeX
 232         virtual docstring eolString(row_type row, bool emptyline,
 233                                       bool fragile) const;
 234         /// returns proper 'end of column' code for LaTeX
 235         virtual docstring eocString(col_type col, col_type lastcol) const;
 236         /// splits cells and shifts right part to the next cell
 237         void splitCell(Cursor & cur);
 238
 239         /// row info.
 240         /// rowinfo_[nrows()] is a dummy row used only for hlines.
 241         std::vector<RowInfo> rowinfo_;
 242         /// column info.
 243         /// colinfo_[ncols()] is a dummy column used only for vlines.
 244         std::vector<ColInfo> colinfo_;
 245         /// cell info
 246         std::vector<CellInfo> cellinfo_;
 247 private:
 248         ///
 249         char v_align_; // add approp. type
 250         ///
 251         Inset * clone() const;
 252 };
 253
 254
 255 } // namespace lyx
 256
 257 #endif