lyx_mirror/src/mathed/InsetMathGrid.h
Georg Baum 6d75800f5d Fix bug #6936.
If \hline is entered, do not create an unknown inset, but increase the number
of hlines of the current row if that is allowed. The same idea is applied to
copy-paste (not part of the bug report).
This is also a test for committing via git.
2012-03-25 11:16:32 +02:00

274 lines
6.8 KiB
C++

// -*- C++ -*-
/**
* \file InsetMathGrid.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author André Pönitz
*
* Full author contact details are available in file CREDITS.
*/
#ifndef MATH_GRID_H
#define MATH_GRID_H
#include "InsetMathNest.h"
#include "Length.h"
namespace lyx {
/** Gridded math inset base class.
* This is the base to all grid-like editable math objects
*/
class InsetMathGrid : public InsetMathNest {
public:
/// additional per-cell information
class CellInfo {
public:
///
CellInfo();
/// a dummy cell before a multicolumn cell
int dummy_;
/// special multi colums alignment
docstring align_;
/// these should be a per-cell property, but ok to have it here
/// for single-column grids like paragraphs
mutable int glue_;
///
mutable pos_type begin_;
///
mutable pos_type end_;
};
/// additional per-row information
class RowInfo {
public:
///
RowInfo();
///
int skipPixels(MetricsInfo const & mi) const;
/// cached descent
mutable int descent_;
/// cached ascent
mutable int ascent_;
/// cached offset
mutable int offset_;
/// how many hlines above this row?
unsigned int lines_;
/// parameter to the line break
Length crskip_;
/// extra distance between lines
int skip_;
/// Is a page break allowed after this row?
bool allow_newpage_;
};
// additional per-row information
class ColInfo {
public:
///
ColInfo();
/// currently possible: 'l', 'c', 'r'
char align_;
/// cached width
mutable int width_;
/// cached offset
mutable int offset_;
/// how many lines to the left of this column?
unsigned int lines_;
/// additional amount to be skipped when drawing
int skip_;
/// Special alignment.
/// This does also contain align_ and lines_ if it is nonempty.
/// It needs to be in sync with align_ and lines_ because some
/// code only uses align_ and lines_.
docstring special_;
};
public:
/// sets nrows and ncols to 1, vertical alingment to 'c'
InsetMathGrid(Buffer * buf);
/// Note: columns first!
InsetMathGrid(Buffer * buf, col_type m, row_type n);
///
InsetMathGrid(Buffer * buf, col_type m, row_type n, char valign,
docstring const & halign);
///
void metrics(MetricsInfo & mi, Dimension &) const;
///
void draw(PainterInfo & pi, int x, int y) const;
///
void drawWithMargin(PainterInfo & pi, int x, int y,
int lmargin = 0, int rmargin = 0) const;
/// draw decorations.
void drawDecoration(PainterInfo & pi, int x, int y) const
{ drawMarkers2(pi, x, y); }
///
void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
///
void drawT(TextPainter & pi, int x, int y) const;
///
void updateBuffer(ParIterator const &, UpdateType);
/// extract number of columns from alignment string
static col_type guessColumns(docstring const & halign);
/// accepts some LaTeX column codes: p,m,!,@,M,<,>
void setHorizontalAlignments(docstring const & align);
///
void setHorizontalAlignment(char c, col_type col);
///
char horizontalAlignment(col_type col) const;
///
docstring horizontalAlignments() const;
/// 't', 'b', or 'm'
void setVerticalAlignment(char c);
///
char verticalAlignment() const;
///
void vcrskip(Length const &, row_type row);
///
Length vcrskip(row_type row) const;
///
void resize(short int type, col_type cols);
///
const RowInfo & rowinfo(row_type row) const;
/// returns topmost row if passed (-1)
RowInfo & rowinfo(row_type row);
///
const CellInfo & cellinfo(idx_type idx) const { return cellinfo_[idx]; }
///
CellInfo & cellinfo(idx_type idx) { return cellinfo_[idx]; }
/// identifies GridInset
InsetMathGrid * asGridInset() { return this; }
/// identifies GridInset
InsetMathGrid const * asGridInset() const { return this; }
///
col_type ncols() const;
///
row_type nrows() const;
///
col_type col(idx_type idx) const;
///
row_type row(idx_type idx) const;
///
bool idxUpDown(Cursor &, bool up) const;
///
bool idxBackward(Cursor &) const;
///
bool idxForward(Cursor &) const;
///
bool idxFirst(Cursor &) const;
///
bool idxLast(Cursor &) const;
///
bool idxDelete(idx_type & idx);
/// pulls cell after pressing erase
void idxGlue(idx_type idx);
/// add a row, one row down
virtual void addRow(row_type r);
/// delete a row
virtual void delRow(row_type r);
/// copy a row
virtual void copyRow(row_type r);
/// swap two rows
virtual void swapRow(row_type r);
/// add a column, here
virtual void addCol(col_type c);
/// delete a column
virtual void delCol(col_type c);
/// copy a column
virtual void copyCol(col_type c);
/// swap two columns
virtual void swapCol(col_type c);
///
idx_type index(row_type r, col_type c) const;
///
bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
///
virtual int defaultColSpace(col_type) { return 0; }
///
virtual char defaultColAlign(col_type) { return 'c'; }
///
void setDefaults();
///
virtual bool interpretString(Cursor & cur, docstring const & str);
///
virtual int colsep() const;
///
virtual int rowsep() const;
///
virtual int hlinesep() const;
///
virtual int vlinesep() const;
///
virtual int border() const;
///
void write(WriteStream & os) const;
///
void write(WriteStream & os,
row_type beg_row, col_type beg_col,
row_type end_row, col_type end_col) const;
///
void normalize(NormalStream &) const;
///
//void maple(MapleStream &) const;
///
void mathmlize(MathStream &) const;
///
void htmlize(HtmlStream &) const;
///
void htmlize(HtmlStream &, std::string attrib) const;
///
//void octave(OctaveStream &) const;
protected:
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
///
bool getStatus(Cursor & cur, FuncRequest const & cmd,
FuncStatus & flag) const;
/// returns x offset of cell compared to inset
int cellXOffset(BufferView const &, idx_type idx) const;
/// returns y offset of cell compared to inset
int cellYOffset(idx_type idx) const;
/// returns proper 'end of line' code for LaTeX
virtual docstring eolString(row_type row, bool fragile, bool latex,
bool last_eoln) const;
/// returns proper 'end of column' code for LaTeX
virtual docstring eocString(col_type col, col_type lastcol) const;
/// splits cells and shifts right part to the next cell
void splitCell(Cursor & cur);
/// Column aligmment for display of cell at (\p row, \p col).
/// Must not be written to file!
virtual char displayColAlign(col_type col, row_type) const { return colinfo_[col].align_; }
/// row info.
/// rowinfo_[nrows()] is a dummy row used only for hlines.
std::vector<RowInfo> rowinfo_;
/// column info.
/// colinfo_[ncols()] is a dummy column used only for vlines.
std::vector<ColInfo> colinfo_;
/// cell info
std::vector<CellInfo> cellinfo_;
///
InsetCode lyxCode() const { return MATH_GRID_CODE; }
private:
///
char v_align_; // add approp. type
///
Inset * clone() const;
};
} // namespace lyx
#endif