src/mathed/math_gridinset.h

   1 // -*- C++ -*-
   2 #ifndef MATH_GRID_H
   3 #define MATH_GRID_H
   4
   5 #include "math_nestinset.h"
   6 #include "vspace.h"
   7 #include "LString.h"
   8
   9 #ifdef __GNUG__
  10 #pragma interface
  11 #endif
  12
  13 /** Gridded math inset base class.
  14     This is the base to all grid-like editable math objects
  15     like array and eqnarray.
  16     \author André Pönitz 2001
  17 */
  18
  19 class MathGridInset : public MathNestInset {
  20
  21         /// additional per-row information
  22         struct RowInfo {
  23                 ///
  24                 RowInfo();
  25                 ///
  26                 int skipPixels() const;
  27                 /// cached descent
  28                 mutable int descent_;
  29                 /// cached ascent
  30                 mutable int ascent_;
  31                 /// cached offset
  32                 mutable int offset_;
  33                 /// how many hlines above this row?
  34                 int lines_;
  35                 /// parameter to the line break
  36                 LyXLength crskip_;
  37                 /// extra distance between lines
  38                 int skip_;
  39         };
  40
  41         // additional per-row information
  42         struct ColInfo {
  43                 ///
  44                 ColInfo();
  45                 /// currently possible: 'l', 'c', 'r'
  46                 char align_;
  47                 /// cache for drawing
  48                 int h_offset;
  49                 /// cached width
  50                 mutable int width_;
  51                 /// cached offset
  52                 mutable int offset_;
  53                 /// do we need a line to the left?
  54                 bool leftline_;
  55                 /// do we need a line to the right?
  56                 bool rightline_;
  57                 /// how many lines to the left of this column?
  58                 int lines_;
  59                 /// additional amount to be skipped when drawing
  60                 int skip_;
  61         };
  62
  63 public:
  64         /// constructor from columns description, creates one row
  65         MathGridInset(char valign, string const & halign);
  66         /// Note: columns first!
  67         MathGridInset(col_type m, row_type n);
  68         ///
  69         MathGridInset(col_type m, row_type n, char valign, string const & halign);
  70         ///
  71         void metrics(MathMetricsInfo const & st) const;
  72         ///
  73         void draw(Painter &, int x, int y) const;
  74         ///
  75         void halign(string const &);
  76         ///
  77         void halign(char c, col_type col);
  78         ///
  79         char halign(col_type col) const;
  80         ///
  81         string halign() const;
  82         ///
  83         void valign(char c);
  84         ///
  85         char valign() const;
  86         ///
  87         void vcrskip(LyXLength const &, row_type row);
  88         ///
  89         LyXLength vcrskip(row_type row) const;
  90         ///
  91         void resize(short int type, col_type cols);
  92         ///
  93         const RowInfo & rowinfo(row_type row) const;
  94         /// returns topmost row if passed (-1)
  95         RowInfo & rowinfo(row_type row);
  96         /// identifies GridInset
  97         virtual MathGridInset * asGridInset() { return this; }
  98
  99         ///
 100         col_type ncols() const;
 101         ///
 102         row_type nrows() const;
 103         ///
 104         col_type col(idx_type idx) const;
 105         ///
 106         row_type row(idx_type idx) const;
 107         ///
 108         int cellXOffset(idx_type idx) const;
 109         ///
 110         int cellYOffset(idx_type idx) const;
 111
 112         ///
 113         bool idxUp(idx_type &) const;
 114         ///
 115         bool idxDown(idx_type &) const;
 116         ///
 117         bool idxLeft(idx_type &, pos_type &) const;
 118         ///
 119         bool idxRight(idx_type &, pos_type &) const;
 120         ///
 121         bool idxFirst(idx_type &, pos_type &) const;
 122         ///
 123         bool idxLast(idx_type &, pos_type &) const;
 124         ///
 125         bool idxHome(idx_type &, pos_type &) const;
 126         ///
 127         bool idxEnd(idx_type &, pos_type &) const;
 128         ///
 129         void idxDelete(idx_type &, bool &, bool &);
 130         ///
 131         void idxDeleteRange(idx_type, idx_type);
 132
 133         ///
 134         virtual void addRow(row_type);
 135         ///
 136         virtual void delRow(row_type);
 137         ///
 138         virtual void addCol(col_type);
 139         ///
 140         virtual void delCol(col_type);
 141         ///
 142         virtual void appendRow();
 143         ///
 144         idx_type index(row_type row, col_type col) const;
 145         ///
 146         std::vector<idx_type> idxBetween(idx_type from, idx_type to) const;
 147         ///
 148         virtual int defaultColSpace(col_type) { return 0; }
 149         ///
 150         virtual char defaultColAlign(col_type) { return 'c'; }
 151         ///
 152         void setDefaults();
 153
 154         ///
 155         void write(WriteStream & os) const;
 156         ///
 157         void normalize(NormalStream &) const;
 158         ///
 159         //void maplize(MapleStream &) const;
 160         ///
 161         void mathmlize(MathMLStream &) const;
 162         ///
 163         //void octavize(OctaveStream &) const;
 164
 165 protected:
 166         /// returns proper 'end of line' code for LaTeX
 167         string eolString(row_type row) const;
 168         /// returns proper 'end of column' code for LaTeX
 169         string eocString(col_type col) const;
 170         /// extract number of columns from alignment string
 171         col_type guessColumns(string const & halign) const;
 172
 173         /// row info
 174         std::vector<RowInfo> rowinfo_;
 175         /// column info
 176         std::vector<ColInfo> colinfo_;
 177         ///
 178         char v_align_; // add approp. type
 179 };
 180
 181 #endif