* \author Matthias Ettrich
* \author André Pönitz
* \author Jürgen Vigna
+ * \author Edwin Leuven
+ * \author Uwe Stöhr
+ * \author Scott Kostyshak
*
* Full author contact details are available in file CREDITS.
*/
-// This is Juergen's rewrite of the tabular (table) support.
-
// Things to think of when designing the new tabular support:
// - color support (colortbl, color)
// - decimal alignment (dcloumn)
// - custom lines (hhline)
-// - rotation
-// - multicolumn
-// - multirow
// - column styles
#ifndef INSET_TABULAR_H
#include "Inset.h"
#include "InsetText.h"
-#include "Layout.h"
#include "Length.h"
-#include <boost/shared_ptr.hpp>
+#include "support/shared_ptr.h"
+#include <climits>
#include <iosfwd>
#include <vector>
class Buffer;
class BufferView;
class CompletionList;
+class Cursor;
class CursorSlice;
-class InsetTableCell;
class FuncStatus;
class Lexer;
+class OutputParams;
class Paragraph;
class XHTMLStream;
-namespace frontend { class Painter; }
+///
+class InsetTableCell : public InsetText
+{
+public:
+ ///
+ InsetTableCell(Buffer * buf);
+ ///
+ InsetCode lyxCode() const { return CELL_CODE; }
+ ///
+ Inset * clone() const { return new InsetTableCell(*this); }
+ ///
+ bool getStatus(Cursor & cur, FuncRequest const & cmd,
+ FuncStatus & status) const;
+ ///
+ void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
+ ///
+ void setContentAlignment(LyXAlignment al) {contentAlign = al; }
+ /// writes the contents of the cell as a string, optionally
+ /// descending into insets
+ docstring asString(bool intoInsets = true);
+ ///
+ docstring xhtml(XHTMLStream &, OutputParams const &) const;
+private:
+ /// unimplemented
+ InsetTableCell();
+ /// unimplemented
+ void operator=(InsetTableCell const &);
+ // FIXME
+ // This boolean is supposed to track whether the cell has had its
+ // width explicitly set. We need to know this to determine whether
+ // layout changes and paragraph customization are allowed---that is,
+ // we need it in forcePlainLayout() and allowParagraphCustomization().
+ // Unfortunately, that information is not readily available in
+ // InsetTableCell. In the case of multicolumn cells, it is present
+ // in CellData, and so would be available here if CellData were to
+ // become a member of InsetTableCell. But in the other case, it isn't
+ // even available there, but is held in Tabular::ColumnData.
+ // So, the present solution uses this boolean to track the information
+ // we need to track, and tries to keep it updated. This is not ideal,
+ // but the other solutions are no better. These are:
+ // (i) Keep a pointer in InsetTableCell to the table;
+ // (ii) Find the table by iterating over the Buffer's insets.
+ // Solution (i) raises the problem of updating the pointer when an
+ // InsetTableCell is copied, and we'd therefore need a copy constructor
+ // in InsetTabular and then in Tabular, which seems messy, given how
+ // complicated those classes are. Solution (ii) involves a lot of
+ // iterating, since this information is needed quite often, and so may
+ // be quite slow.
+ // So, well, if someone can do better, please do!
+ // --rgh
+ ///
+ bool isFixedWidth;
+ // FIXME: Here the thoughts from the comment above also apply.
+ ///
+ LyXAlignment contentAlign;
+ /// should paragraph indendation be omitted in any case?
+ bool neverIndent() const { return true; }
+ ///
+ LyXAlignment contentAlignment() const { return contentAlign; }
+ ///
+ virtual bool usePlainLayout() const { return true; }
+ ///
+ virtual bool forcePlainLayout(idx_type = 0) const;
+ ///
+ virtual bool allowParagraphCustomization(idx_type = 0) const;
+ /// Is the width forced to some value?
+ bool hasFixedWidth() const { return isFixedWidth; }
+};
-class InsetTabular;
-class Cursor;
-class OutputParams;
//
// A helper struct for tables
///
COPY_COLUMN,
///
- TOGGLE_LINE_TOP,
+ MOVE_COLUMN_RIGHT,
///
- TOGGLE_LINE_BOTTOM,
+ MOVE_COLUMN_LEFT,
///
- TOGGLE_LINE_LEFT,
+ MOVE_ROW_DOWN,
+ ///
+ MOVE_ROW_UP,
+ ///
+ SET_LINE_TOP,
+ ///
+ SET_LINE_BOTTOM,
///
+ SET_LINE_LEFT,
+ ///
+ SET_LINE_RIGHT,
+ ///FIXME: remove
+ TOGGLE_LINE_TOP,
+ ///FIXME: remove
+ TOGGLE_LINE_BOTTOM,
+ ///FIXME: remove
+ TOGGLE_LINE_LEFT,
+ ///FIXME: remove
TOGGLE_LINE_RIGHT,
///
ALIGN_LEFT,
///
ALIGN_BLOCK,
///
+ ALIGN_DECIMAL,
+ ///
VALIGN_TOP,
///
VALIGN_BOTTOM,
///
MULTICOLUMN,
///
+ SET_MULTICOLUMN,
+ ///
+ UNSET_MULTICOLUMN,
+ ///
MULTIROW,
///
+ SET_MULTIROW,
+ ///
+ UNSET_MULTIROW,
+ ///
+ SET_MROFFSET,
+ ///
SET_ALL_LINES,
///
UNSET_ALL_LINES,
UNSET_LTLASTFOOT,
///
SET_LTNEWPAGE,
+ UNSET_LTNEWPAGE,
///
TOGGLE_LTCAPTION,
///
+ SET_LTCAPTION,
+ ///
+ UNSET_LTCAPTION,
+ ///
SET_SPECIAL_COLUMN,
///
SET_SPECIAL_MULTICOLUMN,
///
- SET_SPECIAL_MULTIROW,
- ///
SET_BOOKTABS,
///
UNSET_BOOKTABS,
///
LONGTABULAR_ALIGN_RIGHT,
///
+ SET_DECIMAL_POINT,
+ ///
+ SET_TABULAR_WIDTH,
+ ///
LAST_ACTION
};
///
BOX_MINIPAGE = 2
};
+ enum CaptionType {
+ ///
+ CAPTION_FIRSTHEAD,
+ ///
+ CAPTION_HEAD,
+ ///
+ CAPTION_FOOT,
+ ///
+ CAPTION_LASTFOOT,
+ ///
+ CAPTION_ANY
+ };
+
+ enum RowDirection {
+ UP,
+ DOWN
+ };
+
+ enum ColDirection {
+ RIGHT,
+ LEFT
+ };
+
class ltType {
public:
// constructor
/// Returns true if there is a topline, returns false if not
bool rightLine(idx_type cell) const;
- ///
- bool topAlreadyDrawn(idx_type cell) const;
- ///
- bool leftAlreadyDrawn(idx_type cell) const;
- ///
- bool isLastRow(idx_type cell) const;
-
/// return space occupied by the second horizontal line and
/// interline space above row \p row in pixels
int interRowSpace(row_type row) const;
/* returns the maximum over all rows */
///
- int columnWidth(idx_type cell) const;
+ int cellWidth(idx_type cell) const;
///
- int rowHeight(idx_type cell) const;
+ int cellHeight(idx_type cell) const;
///
int width() const;
///
int height() const;
///
+ row_type nrows() const {return row_info.size();}
+ ///
+ col_type ncols() const {return column_info.size();}
+ ///
int rowAscent(row_type row) const;
///
int rowDescent(row_type row) const;
///
void setRowDescent(row_type row, int height);
///
- void setCellWidth(idx_type cell, int new_width);
- ///
- void setAllLines(idx_type cell, bool line);
- ///
void setTopLine(idx_type cell, bool line);
///
void setBottomLine(idx_type cell, bool line);
void setVAlignment(idx_type cell, VAlignment align,
bool onlycolumn = false);
///
+ void setTabularWidth(Length const & l) { tabular_width = l; }
+ ///
+ Length tabularWidth() const { return tabular_width; }
+ ///
void setColumnPWidth(Cursor &, idx_type, Length const &);
///
bool setMColumnPWidth(Cursor &, idx_type, Length const &);
///
+ bool setMROffset(Cursor &, idx_type, Length const &);
+ ///
void setAlignSpecial(idx_type cell, docstring const & special,
Feature what);
///
///
Length const getPWidth(idx_type cell) const;
///
- int cellWidth(idx_type cell) const;
+ Length const getMROffset(idx_type cell) const;
///
int textHOffset(idx_type cell) const;
///
int textVOffset(idx_type cell) const;
///
- void appendRow(idx_type cell);
+ void appendRow(row_type row);
///
void deleteRow(row_type row);
///
- void copyRow(row_type);
+ void copyRow(row_type row);
+ ///
+ void insertRow(row_type row, bool copy);
///
- void appendColumn(idx_type cell);
+ void moveColumn(col_type col, ColDirection direction);
+ ///
+ void moveRow(row_type row, RowDirection direction);
+ ///
+ void appendColumn(col_type column);
///
void deleteColumn(col_type column);
///
- void copyColumn(col_type);
+ void copyColumn(col_type column);
///
- idx_type getFirstCellInRow(row_type row) const;
+ void insertColumn(col_type column, bool copy);
///
- bool isLastCellInRow(idx_type cell) const;
+ idx_type getFirstCellInRow(row_type row) const;
///
idx_type getLastCellInRow(row_type row) const;
///
- idx_type numberOfCellsInRow(idx_type cell) const;
+ idx_type numberOfCellsInRow(row_type row) const;
///
void write(std::ostream &) const;
///
void read(Lexer &);
///
- int latex(odocstream &, OutputParams const &) const;
+ void latex(otexstream &, OutputParams const &) const;
///
int docbook(odocstream & os, OutputParams const &) const;
///
docstring xhtml(XHTMLStream & os, OutputParams const &) const;
///
- void plaintext(odocstream &,
+ void plaintext(odocstringstream &,
OutputParams const & runparams, int const depth,
- bool onlydata, char_type delim) const;
+ bool onlydata, char_type delim, size_t max_length = INT_MAX) const;
///
bool isMultiColumn(idx_type cell) const;
///
- bool isMultiColumnReal(idx_type cell) const;
+ bool hasMultiColumn(col_type cell) const;
///
- void setMultiColumn(idx_type cell, idx_type number);
+ idx_type setMultiColumn(idx_type cell, idx_type number,
+ bool const right_border);
///
void unsetMultiColumn(idx_type cell);
///
///
bool isMultiRow(idx_type cell) const;
///
- void setMultiRow(idx_type cell, idx_type number);
+ bool hasMultiRow(row_type r) const;
+ ///
+ idx_type setMultiRow(idx_type cell, idx_type number,
+ bool const bottom_border);
///
void unsetMultiRow(idx_type cell);
///
///
col_type cellColumn(idx_type cell) const;
///
- col_type cellRightColumn(idx_type cell) const;
- ///
- void setRotateCell(idx_type cell, bool);
+ void setRotateCell(idx_type cell, int);
///
- bool getRotateCell(idx_type cell) const;
+ int getRotateCell(idx_type cell) const;
///
bool needRotating() const;
///
//
// Long Tabular Options support functions
///
- bool checkLTType(row_type row, ltType const &) const;
- ///
void setLTHead(row_type row, bool flag, ltType const &, bool first);
///
bool getRowOfLTHead(row_type row, ltType &) const;
///
bool ltCaption(row_type row) const;
///
- bool haveLTHead() const;
+ bool haveLTHead(bool withcaptions = true) const;
///
- bool haveLTFirstHead() const;
+ bool haveLTFirstHead(bool withcaptions = true) const;
///
- bool haveLTFoot() const;
+ bool haveLTFoot(bool withcaptions = true) const;
///
- bool haveLTLastFoot() const;
+ bool haveLTLastFoot(bool withcaptions = true) const;
///
- bool haveLTCaption() const;
+ bool haveLTCaption(CaptionType captiontype = CAPTION_ANY) const;
///
// end longtable support
///
- boost::shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
+ shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
///
- boost::shared_ptr<InsetTableCell> cellInset(row_type row,
+ shared_ptr<InsetTableCell> cellInset(row_type row,
col_type column) const;
///
void setCellInset(row_type row, col_type column,
- boost::shared_ptr<InsetTableCell>) const;
+ shared_ptr<InsetTableCell>) const;
/// Search for \param inset in the tabular, with the
///
void validate(LaTeXFeatures &) const;
///
int multirow;
///
+ Length mroffset;
+ ///
LyXAlignment alignment;
///
VAlignment valignment;
+ /// width of the part before the decimal
+ int decimal_hoffset;
+ /// width of the decimal part
+ int decimal_width;
+ ///
+ int voffset;
///
bool top_line;
///
///
BoxType usebox;
///
- bool rotate;
+ int rotate;
///
docstring align_special;
///
Length p_width; // this is only set for multicolumn!!!
///
- boost::shared_ptr<InsetTableCell> inset;
+ shared_ptr<InsetTableCell> inset;
};
CellData & cellInfo(idx_type cell) const;
///
Length p_width;
///
docstring align_special;
+ ///
+ docstring decimal_point;
};
///
typedef std::vector<ColumnData> column_vector;
///
mutable cell_vvector cell_info;
///
+ Length tabular_width;
+ ///
bool use_booktabs;
///
- bool rotate;
+ int rotate;
///
VAlignment tabular_valignment;
//
void updateIndexes();
///
bool setFixedWidth(row_type r, col_type c);
- ///
- void updateContentAlignment(row_type r, col_type c);
/// return true of update is needed
bool updateColumnWidths();
///
///
BoxType useParbox(idx_type cell) const;
///
- // helper function for Latex returns number of newlines
+ // helper function for Latex
///
- int TeXTopHLine(odocstream &, row_type row, std::string const lang) const;
+ void TeXTopHLine(otexstream &, row_type row, std::string const lang) const;
///
- int TeXBottomHLine(odocstream &, row_type row, std::string const lang) const;
+ void TeXBottomHLine(otexstream &, row_type row, std::string const lang) const;
///
- int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const;
+ void TeXCellPreamble(otexstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const;
///
- int TeXCellPostamble(odocstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
+ void TeXCellPostamble(otexstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
///
- int TeXLongtableHeaderFooter(odocstream &, OutputParams const &) const;
+ void TeXLongtableHeaderFooter(otexstream &, OutputParams const &) const;
///
bool isValidRow(row_type const row) const;
///
- int TeXRow(odocstream &, row_type const row,
- OutputParams const &) const;
+ void TeXRow(otexstream &, row_type const row,
+ OutputParams const &) const;
///
// helper functions for plain text
///
- bool plaintextTopHLine(odocstream &, row_type row,
+ bool plaintextTopHLine(odocstringstream &, row_type row,
std::vector<unsigned int> const &) const;
///
- bool plaintextBottomHLine(odocstream &, row_type row,
+ bool plaintextBottomHLine(odocstringstream &, row_type row,
std::vector<unsigned int> const &) const;
///
- void plaintextPrintCell(odocstream &,
+ void plaintextPrintCell(odocstringstream &,
OutputParams const &,
idx_type cell, row_type row, col_type column,
std::vector<unsigned int> const &,
- bool onlydata) const;
+ bool onlydata, size_t max_length) const;
/// auxiliary function for docbook
int docbookRow(odocstream & os, row_type, OutputParams const &) const;
///
- docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &) const;
+ docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &,
+ bool header = false) const;
/// change associated Buffer
void setBuffer(Buffer & buffer);
}; // Tabular
-///
-class InsetTableCell : public InsetText
-{
-public:
- ///
- InsetTableCell(Buffer * buf);
- ///
- InsetCode lyxCode() const { return CELL_CODE; }
- ///
- Inset * clone() { return new InsetTableCell(*this); }
- ///
- bool getStatus(Cursor & cur, FuncRequest const & cmd,
- FuncStatus & status) const;
- ///
- void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
- ///
- void setContentAlignment(LyXAlignment al) {contentAlign = al; }
- /// writes the contents of the cell as a string, optionally
- /// descending into insets
- docstring asString(bool intoInsets = true);
- ///
- docstring xhtml(XHTMLStream &, OutputParams const &) const;
-private:
- /// unimplemented
- InsetTableCell();
- /// unimplemented
- void operator=(InsetTableCell const &);
- // FIXME
- // This boolean is supposed to track whether the cell has had its
- // width explicitly set. We need to know this to determine whether
- // layout changes and paragraph customization are allowed---that is,
- // we need it in forcePlainLayout() and allowParagraphCustomization().
- // Unfortunately, that information is not readily available in
- // InsetTableCell. In the case of multicolumn cells, it is present
- // in CellData, and so would be available here if CellData were to
- // become a member of InsetTableCell. But in the other case, it isn't
- // even available there, but is held in Tabular::ColumnData.
- // So, the present solution uses this boolean to track the information
- // we need to track, and tries to keep it updated. This is not ideal,
- // but the other solutions are no better. These are:
- // (i) Keep a pointer in InsetTableCell to the table;
- // (ii) Find the table by iterating over the Buffer's insets.
- // Solution (i) raises the problem of updating the pointer when an
- // InsetTableCell is copied, and we'd therefore need a copy constructor
- // in InsetTabular and then in Tabular, which seems messy, given how
- // complicated those classes are. Solution (ii) involves a lot of
- // iterating, since this information is needed quite often, and so may
- // be quite slow.
- // So, well, if someone can do better, please do!
- // --rgh
- ///
- bool isFixedWidth;
- // FIXME: Here the thoughts from the comment above also apply.
- ///
- LyXAlignment contentAlign;
- /// should paragraph indendation be omitted in any case?
- bool neverIndent() const { return true; }
- ///
- LyXAlignment contentAlignment() const { return contentAlign; }
- ///
- virtual bool usePlainLayout() const { return true; }
- ///
- virtual bool forcePlainLayout(idx_type = 0) const;
- ///
- virtual bool allowParagraphCustomization(idx_type = 0) const;
- /// Is the width forced to some value?
- bool hasFixedWidth() const { return isFixedWidth; }
-};
-
-
class InsetTabular : public Inset
{
public:
///
void drawSelection(PainterInfo & pi, int x, int y) const;
///
+ void drawBackground(PainterInfo & pi, int x, int y) const;
+ ///
bool editable() const { return true; }
///
bool hasSettings() const { return true; }
bool allowSpellCheck() const { return true; }
///
bool canTrackChanges() const { return true; }
- /** returns true if, when outputing LaTeX, font changes should
+ /** returns false if, when outputing LaTeX, font changes should
be closed before generating this inset. This is needed for
insets that may contain several paragraphs */
- bool noFontChange() const { return true; }
+ bool inheritFont() const { return false; }
+ ///
+ bool allowsCaptionVariation(std::string const &) const;
///
DisplayType display() const;
///
- int latex(odocstream &, OutputParams const &) const;
+ void latex(otexstream &, OutputParams const &) const;
///
- int plaintext(odocstream &, OutputParams const &) const;
+ int plaintext(odocstringstream & ods, OutputParams const & op,
+ size_t max_length = INT_MAX) const;
///
int docbook(odocstream &, OutputParams const &) const;
///
///
InsetCode lyxCode() const { return TABULAR_CODE; }
///
- docstring contextMenu(BufferView const & bv, int x, int y) const;
+ std::string contextMenu(BufferView const &, int, int) const;
+ ///
+ std::string contextMenuName() const;
/// get offset of this cursor slice relative to our upper left corner
void cursorPos(BufferView const & bv, CursorSlice const & sl,
bool boundary, int & x, int & y) const;
///
void tabularFeatures(Cursor & cur, Tabular::Feature feature,
std::string const & val = std::string());
- ///
- void openLayoutDialog(BufferView *) const;
- ///
- bool showInsetDialog(BufferView *) const;
/// number of cells
size_t nargs() const { return tabular.numberofcells; }
///
- boost::shared_ptr<InsetTableCell const> cell(idx_type) const;
+ shared_ptr<InsetTableCell const> cell(idx_type) const;
///
- boost::shared_ptr<InsetTableCell> cell(idx_type);
+ shared_ptr<InsetTableCell> cell(idx_type);
///
Text * getText(int) const;
/// can we go further down on mouse click?
bool descendable(BufferView const &) const { return true; }
/// Update the counters of this inset and of its contents
- void updateLabels(ParIterator const &, UpdateType);
+ void updateBuffer(ParIterator const &, UpdateType);
///
- void addToToc(DocIterator const &);
+ void addToToc(DocIterator const & di, bool output_active) const;
///
bool completionSupported(Cursor const &) const;
virtual bool usePlainLayout() const { return true; }
///
- virtual InsetTabular * asInsetTabular() { return this; }
+ InsetTabular * asInsetTabular() { return this; }
///
- virtual InsetTabular const * asInsetTabular() const { return this; }
+ InsetTabular const * asInsetTabular() const { return this; }
///
bool isRightToLeft(Cursor & cur) const;
/// writes the cells between stidx and enidx as a string, optionally
///
bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
///
- int scroll() const { return scx_; }
- ///
Inset * clone() const { return new InsetTabular(*this); }
///
- void drawCellLines(frontend::Painter &, int x, int y, row_type row,
- idx_type cell, Change const & change) const;
+ void drawCellLines(PainterInfo &, int x, int y, row_type row,
+ idx_type cell) const;
///
void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
///
int cellXPos(idx_type cell) const;
///
- void resetPos(Cursor & cur) const;
+ int cellYPos(idx_type cell) const;
///
- void removeTabularRow();
+ void resetPos(Cursor & cur) const;
///
bool copySelection(Cursor & cur);
///
mutable idx_type first_visible_cell;
///
mutable int scx_;
+ /// The vertical offset of the table due to the vertical
+ /// alignment with respect to the baseline.
+ mutable int offset_valign_;
/// true when selecting rows with the mouse
bool rowselect_;
/// true when selecting columns with the mouse
std::string const featureAsString(Tabular::Feature feature);
+/// Split cell on decimal symbol
+InsetTableCell splitCell(InsetTableCell & head, docstring const decimal_sym, bool & hassep);
+
} // namespace lyx
#endif // INSET_TABULAR_H