* \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
-// This is what I have written about tabular support in the LyX3-Tasks file:
-//
-// o rewrite of table code. Should probably be written as some
-// kind of an inset. [Done]
-// o enhance longtable support
-
-// Lgb
-
#ifndef INSET_TABULAR_H
#define INSET_TABULAR_H
-#include "Inset.h"
+#include "BufferParams.h"
+#include "Changes.h"
#include "InsetText.h"
-#include "Layout.h"
-#include "Length.h"
-#include <boost/shared_ptr.hpp>
+#include "support/Length.h"
+#include "support/types.h"
+#include <climits>
#include <iosfwd>
+#include <memory>
#include <vector>
+
namespace lyx {
class Buffer;
-class BufferParams;
class BufferView;
class CompletionList;
+class Cursor;
class CursorSlice;
-class InsetTableCell;
class FuncStatus;
class Lexer;
-class Paragraph;
+class OutputParams;
+class XMLStream;
-namespace frontend { class Painter; }
+///
+class InsetTableCell : public InsetText
+{
+public:
+ ///
+ explicit InsetTableCell(Buffer * buf);
+ /// We need this since generation of the default is deprecated
+ /// (since we declare the assignment constuctor below).
+ InsetTableCell(InsetTableCell const & in) = default;
+ ///
+ InsetCode lyxCode() const override { return CELL_CODE; }
+ ///
+ Inset * clone() const override { return new InsetTableCell(*this); }
+ ///
+ bool getStatus(Cursor & cur, FuncRequest const & cmd,
+ FuncStatus & status) const override;
+ ///
+ void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
+ ///
+ void toggleVarWidth(bool vw) { isVarwidth = vw; }
+ ///
+ void toggleMultiCol(bool m) { isMultiColumn = m; }
+ ///
+ void toggleMultiRow(bool m) { isMultiRow = m; }
+ ///
+ 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(XMLStream &, OutputParams const &) const override;
+ ///
+ void docbook(XMLStream &, OutputParams const &) const override;
+ ///
+ void addToToc(DocIterator const & di, bool output_active,
+ UpdateType utype, TocBackend & backend) const override;
+ ///
+ void metrics(MetricsInfo &, Dimension &) const override;
+ /// Needs to be same as InsetTabular
+ bool inheritFont() const override { return false; }
+ /// Can the cell contain several paragraphs?
+ bool allowMultiPar() const override { return !isMultiRow && (!isMultiColumn || isFixedWidth); }
+ ///
+ bool canPaintChange(BufferView const &) const override { return false; }
+ /// This assures we never output \maketitle in table cells
+ bool isInTitle() const override { return true; }
+private:
+ ///
+ InsetTableCell() = delete;
+ ///
+ void operator=(InsetTableCell const &) = delete;
+ // FIXME
+ // These booleans are supposed to track whether the cell has had its
+ // width explicitly set and whether it is part of a multicolumn, respectively.
+ // 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!
+ // --rkh
+ ///
+ bool isFixedWidth;
+ ///
+ bool isVarwidth;
+ ///
+ bool isMultiColumn;
+ ///
+ bool isMultiRow;
+ // FIXME: Here the thoughts from the comment above also apply.
+ ///
+ LyXAlignment contentAlign;
+ /// should paragraph indentation be omitted in any case?
+ bool neverIndent() const override { return true; }
+ ///
+ LyXAlignment contentAlignment() const override { return contentAlign; }
+ ///
+ bool usePlainLayout() const override { return true; }
+ ///
+ bool allowParagraphCustomization(idx_type = 0) const override;
+ ///
+ bool forceLocalFontSwitch() const override;
+ /// Is the width forced to some value?
+ bool hasFixedWidth() const override { 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,
///
+ SET_LTRIM_TOP,
+ ///
+ SET_RTRIM_TOP,
+ ///
+ SET_LTRIM_BOTTOM,
+ ///
+ SET_RTRIM_BOTTOM,
+ ///
+ TOGGLE_LTRIM_TOP,
+ ///
+ TOGGLE_RTRIM_TOP,
+ ///
+ TOGGLE_LTRIM_BOTTOM,
+ ///
+ TOGGLE_RTRIM_BOTTOM,
+ ///
ALIGN_LEFT,
///
ALIGN_RIGHT,
///
ALIGN_BLOCK,
///
+ ALIGN_DECIMAL,
+ ///
VALIGN_TOP,
///
VALIGN_BOTTOM,
///
MULTICOLUMN,
///
+ SET_MULTICOLUMN,
+ ///
+ UNSET_MULTICOLUMN,
+ ///
+ MULTIROW,
+ ///
+ SET_MULTIROW,
+ ///
+ UNSET_MULTIROW,
+ ///
+ SET_MROFFSET,
+ ///
SET_ALL_LINES,
///
+ RESET_FORMAL_DEFAULT,
+ ///
UNSET_ALL_LINES,
///
+ TOGGLE_LONGTABULAR,
+ ///
SET_LONGTABULAR,
///
UNSET_LONGTABULAR,
///
SET_MPWIDTH,
///
+ TOGGLE_VARWIDTH_COLUMN,
+ ///
SET_ROTATE_TABULAR,
///
UNSET_ROTATE_TABULAR,
UNSET_LTLASTFOOT,
///
SET_LTNEWPAGE,
+ UNSET_LTNEWPAGE,
///
TOGGLE_LTCAPTION,
///
+ SET_LTCAPTION,
+ ///
+ UNSET_LTCAPTION,
+ ///
SET_SPECIAL_COLUMN,
///
- SET_SPECIAL_MULTI,
+ SET_SPECIAL_MULTICOLUMN,
+ ///
+ TOGGLE_BOOKTABS,
///
SET_BOOKTABS,
///
///
TABULAR_VALIGN_BOTTOM,
///
+ LONGTABULAR_ALIGN_LEFT,
+ ///
+ LONGTABULAR_ALIGN_CENTER,
+ ///
+ LONGTABULAR_ALIGN_RIGHT,
+ ///
+ SET_DECIMAL_POINT,
+ ///
+ SET_TABULAR_WIDTH,
+ ///
+ SET_INNER_LINES,
+ ///
+ TOGGLE_INNER_LINES,
+ ///
+ TOGGLE_BORDER_LINES,
+ ///
+ TOGGLE_ALL_LINES,
+ ///
LAST_ACTION
};
///
///
CELL_BEGIN_OF_MULTICOLUMN,
///
- CELL_PART_OF_MULTICOLUMN
+ CELL_PART_OF_MULTICOLUMN,
+ ///
+ CELL_BEGIN_OF_MULTIROW,
+ ///
+ CELL_PART_OF_MULTIROW
};
///
///
LYX_VALIGN_TOP = 0,
///
- LYX_VALIGN_BOTTOM = 1,
+ LYX_VALIGN_MIDDLE = 1,
///
- LYX_VALIGN_MIDDLE = 2
+ LYX_VALIGN_BOTTOM = 2
+
+ };
+ ///
+ enum HAlignment {
+ ///
+ LYX_LONGTABULAR_ALIGN_LEFT = 0,
+ ///
+ LYX_LONGTABULAR_ALIGN_CENTER = 1,
+ ///
+ LYX_LONGTABULAR_ALIGN_RIGHT = 2
};
enum BoxType {
///
BOX_PARBOX = 1,
///
- BOX_MINIPAGE = 2
+ BOX_MINIPAGE = 2,
+ ///
+ BOX_VARWIDTH = 3
+ };
+
+ enum CaptionType {
+ ///
+ CAPTION_FIRSTHEAD,
+ ///
+ CAPTION_HEAD,
+ ///
+ CAPTION_FOOT,
+ ///
+ CAPTION_LASTFOOT,
+ ///
+ CAPTION_ANY
+ };
+
+ enum RowDirection {
+ UP,
+ DOWN
+ };
+
+ enum ColDirection {
+ RIGHT,
+ LEFT
};
class ltType {
bool empty;
};
- /// type for row numbers
- typedef size_t row_type;
- /// type for column numbers
- typedef size_t col_type;
- /// type for cell indices
- typedef size_t idx_type;
/// index indicating an invalid position
static const idx_type npos = static_cast<idx_type>(-1);
/// constructor
- Tabular(Buffer &, col_type columns_arg, row_type rows_arg);
+ Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
/// Returns true if there is a topline, returns false if not
bool topLine(idx_type cell) const;
/// Returns true if there is a topline, returns false if not
bool bottomLine(idx_type cell) const;
/// Returns true if there is a topline, returns false if not
- bool leftLine(idx_type cell) const;
+ /// If \p ignore_bt is true, we return the state as if booktabs was
+ /// not used
+ bool leftLine(idx_type cell, bool const ignore_bt = false) const;
/// 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;
+ /// If \p ignore_bt is true, we return the state as if booktabs was
+ /// not used
+ bool rightLine(idx_type cell, bool const ignore_bt = false) const;
+ /// Returns true if there is an outside border around the selection
+ bool outsideBorders(row_type sel_row_start, row_type sel_row_end,
+ col_type sel_col_start, col_type sel_col_end) const;
+ /// Returns true if there are inside lines in the selection
+ bool innerBorders(row_type sel_row_start, row_type sel_row_end,
+ col_type sel_col_start, col_type sel_col_end) const;
+ /// Sets the grid lines in the selection
+ /// if \p setLinesInnerOnly is true, outside borders are excluded
+ /// if \p setLines is true the lines are set otherwise they are unset
+ void setLines(row_type const sel_row_start, row_type const sel_row_end,
+ col_type const sel_col_start, col_type const sel_col_end,
+ bool setLinesInnerOnly, bool setLines);
+ /// Returns whether the top line is trimmed left and/or right
+ std::pair<bool, bool> topLineTrim(idx_type const cell) const;
+ /// Returns whether the bottom line is trimmed left and/or right
+ std::pair<bool, bool> bottomLineTrim(idx_type const cell) const;
/// return space occupied by the second horizontal line and
/// interline space above row \p row in pixels
- int getAdditionalHeight(row_type row) const;
+ int interRowSpace(row_type row) const;
///
- int getAdditionalWidth(idx_type cell) const;
+ int interColumnSpace(idx_type cell) const;
/* returns the maximum over all rows */
///
- int columnWidth(idx_type cell) const;
+ int cellWidth(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 setTopLineLTrim(idx_type cell, bool val);
+ ///
+ void setBottomLineLTrim(idx_type cell, bool val);
+ ///
+ void setTopLineRTrim(idx_type cell, bool val);
+ ///
+ void setBottomLineRTrim(idx_type cell, bool val);
+ ///
+ void setTopLineTrim(idx_type cell, std::pair<bool, bool>);
+ ///
+ void setBottomLineTrim(idx_type cell, std::pair<bool, bool>);
+ ///
void setLeftLine(idx_type cell, bool line);
///
void setRightLine(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 toggleVarwidth(idx_type, bool const);
+ ///
+ bool setMROffset(Cursor &, idx_type, Length const &);
+ ///
void setAlignSpecial(idx_type cell, docstring const & special,
Feature what);
///
///
VAlignment getVAlignment(idx_type cell,
bool onlycolumn = false) const;
+ /// The vertical offset of the table due to the vertical
+ /// alignment with respect to the baseline.
+ int offsetVAlignment() const;
///
Length const getPWidth(idx_type cell) const;
///
- int cellWidth(idx_type cell) const;
+ Length const getMROffset(idx_type cell) const;
///
- int getBeginningOfTextInCell(idx_type cell) const;
+ int textHOffset(idx_type cell) const;
///
- void appendRow(idx_type cell);
+ int textVOffset(idx_type cell) const;
///
- void deleteRow(row_type row);
+ void appendRow(row_type row);
///
- void copyRow(row_type);
+ void deleteRow(row_type row, bool const force = false);
///
- void appendColumn(idx_type cell);
+ void copyRow(row_type row);
///
- void deleteColumn(col_type column);
+ void insertRow(row_type row, bool copy);
///
- void copyColumn(col_type);
+ void moveColumn(col_type col_start, col_type col_end,
+ ColDirection direction);
///
- bool isFirstCellInRow(idx_type cell) const;
+ void moveRow(row_type row_start, row_type row_end,
+ RowDirection direction);
///
- idx_type getFirstCellInRow(row_type row) const;
+ void appendColumn(col_type column);
///
- bool isLastCellInRow(idx_type cell) const;
+ void deleteColumn(col_type column, bool const force = false);
///
- idx_type getLastCellInRow(row_type row) const;
+ void copyColumn(col_type column);
///
- idx_type numberOfCellsInRow(idx_type cell) const;
+ void insertColumn(col_type column, bool copy);
+ ///
+ idx_type getFirstCellInRow(row_type row, bool const ct = false) const;
+ ///
+ idx_type getLastCellInRow(row_type row, bool const ct = false) const;
+ ///
+ idx_type getFirstRow(bool const ct = false) const;
+ ///
+ idx_type getLastRow(bool const ct = false) const;
+ ///
+ idx_type numberOfCellsInRow(row_type row) const;
///
void write(std::ostream &) const;
///
void read(Lexer &);
///
- int latex(odocstream &, OutputParams const &) const;
- //
- int docbook(odocstream & os, OutputParams const &) const;
+ void latex(otexstream &, OutputParams const &) const;
+ /// serialise the table in DocBook, according to buffer parameters
+ void docbook(XMLStream &, OutputParams const &) const;
///
- void plaintext(odocstream &,
+ docstring xhtml(XMLStream &, OutputParams const &) const;
+ ///
+ 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;
+ ///
+ bool hasVarwidthColumn() const;
///
- void setMultiColumn(idx_type cell, idx_type number);
+ bool isVTypeColumn(col_type cell) const;
///
- idx_type unsetMultiColumn(idx_type cell); // returns number of new cells
+ idx_type setMultiColumn(Cursor & cur, idx_type cell, idx_type number,
+ bool const right_border);
+ ///
+ void unsetMultiColumn(idx_type cell);
///
bool isPartOfMultiColumn(row_type row, col_type column) const;
///
+ bool isPartOfMultiRow(row_type row, col_type column) const;
+ ///
+ bool isMultiRow(idx_type cell) const;
+ ///
+ bool hasMultiRow(row_type r) const;
+ ///
+ idx_type setMultiRow(Cursor & cur, idx_type cell, idx_type number,
+ bool const bottom_border,
+ LyXAlignment const halign);
+ ///
+ void unsetMultiRow(idx_type cell);
+ ///
row_type cellRow(idx_type cell) const;
///
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;
///
idx_type cellAbove(idx_type cell) const;
///
idx_type cellBelow(idx_type cell) const;
- ///
+ /// \return the index of the VISIBLE cell at row, column
+ /// this will be the same as the cell in the previous row,
+ /// e.g., if the cell is part of a multirow
idx_type cellIndex(row_type row, col_type column) const;
///
void setUsebox(idx_type cell, BoxType);
//
// 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 getLTNewPage(row_type row) const;
///
- idx_type setLTCaption(row_type row, bool what);
+ idx_type setLTCaption(Cursor & cur, row_type row, bool what);
///
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;
///
- // end longtable support
- ///
- boost::shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
+ bool haveLTCaption(CaptionType captiontype = CAPTION_ANY) const;
///
- boost::shared_ptr<InsetTableCell> cellInset(row_type row,
- col_type column) const;
+ // end longtable support
+
+ //@{
+ /// there is a subtle difference between these two methods.
+ /// cellInset(r,c);
+ /// and
+ /// cellInset(cellIndex(r,c));
+ /// can return different things. this is because cellIndex(r,c)
+ /// returns the VISIBLE cell at r,c, which may be the same as the
+ /// cell at the previous row or column, if we're dealing with some
+ /// multirow or multicolumn.
+ std::shared_ptr<InsetTableCell> cellInset(idx_type cell);
+ std::shared_ptr<InsetTableCell> cellInset(row_type row, col_type column);
+ InsetTableCell const * cellInset(idx_type cell) const;
+ //@}
///
void setCellInset(row_type row, col_type column,
- boost::shared_ptr<InsetTableCell>) const;
+ std::shared_ptr<InsetTableCell>);
/// Search for \param inset in the tabular, with the
///
void validate(LaTeXFeatures &) const;
-//private:
- // FIXME Now that cells have an InsetTableCell as their insets, rather
- // than an InsetText, it'd be possible to reverse the relationship here,
- // so that cell_vector was a vector<InsetTableCell> rather than a
- // vector<CellData>, and an InsetTableCell had a CellData as a member,
- // or perhaps just had its members as members.
+
+ //private:
+ // FIXME Now that cells have an InsetTableCell as their insets, rather
+ // than an InsetText, it'd be possible to reverse the relationship here,
+ // so that cell_vector was a vector<InsetTableCell> rather than a
+ // vector<CellData>, and an InsetTableCell had a CellData as a member,
+ // or perhaps just had its members as members.
///
class CellData {
public:
///
- CellData(Buffer &);
+ explicit CellData(Buffer *);
///
CellData(CellData const &);
///
- CellData & operator=(CellData);
- ///
- void swap(CellData & rhs);
+ CellData & operator=(CellData const &);
///
idx_type cellno;
///
///
int multicolumn;
///
+ 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;
///
///
bool right_line;
///
+ bool top_line_rtrimmed;
+ ///
+ bool top_line_ltrimmed;
+ ///
+ bool bottom_line_rtrimmed;
+ ///
+ bool bottom_line_ltrimmed;
+ ///
BoxType usebox;
///
- bool rotate;
+ int rotate;
///
docstring align_special;
///
Length p_width; // this is only set for multicolumn!!!
///
- boost::shared_ptr<InsetTableCell> inset;
+ std::shared_ptr<InsetTableCell> inset;
};
- CellData & cellInfo(idx_type cell) const;
+ ///
+ CellData const & cellInfo(idx_type cell) const;
+ ///
+ CellData & cellInfo(idx_type cell);
///
typedef std::vector<CellData> cell_vector;
///
bool newpage;
/// caption
bool caption;
+ ///
+ Change change;
};
///
typedef std::vector<RowData> row_vector;
Length p_width;
///
docstring align_special;
+ ///
+ docstring decimal_point;
+ ///
+ bool varwidth;
+ ///
+ Change change;
};
///
typedef std::vector<ColumnData> column_vector;
+private:
+ // Determines the style of borders, per row.
+ class XmlRowWiseBorders {
+ public:
+ // Whether to draw double bottom line.
+ bool completeBorder = true;
+
+ // Whether to draw booktabs' thicker lines.
+ bool completeBorderAbove = true;
+ bool completeBorderBelow = true;
+
+ // Size of the borders.
+ double borderBottomWidth = 1.0;
+ double borderBottomWidthComplete = 3.0;
+ double borderTopWidth = 1.0;
+ };
+
+public:
///
idx_type numberofcells;
///
///
column_vector column_info;
///
- mutable cell_vvector cell_info;
+ cell_vvector cell_info;
+ ///
+ Length tabular_width;
///
bool use_booktabs;
///
- bool rotate;
+ int rotate;
///
VAlignment tabular_valignment;
//
// for long tabulars
+ ///
+ HAlignment longtabular_alignment;
//
bool is_long_tabular;
/// endhead data
ltType endlastfoot;
///
- void init(Buffer &, row_type rows_arg,
+ void init(Buffer *, row_type rows_arg,
col_type columns_arg);
///
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();
+ bool updateColumnWidths(MetricsInfo & mi);
///
idx_type columnSpan(idx_type cell) const;
///
- BoxType useParbox(idx_type cell) const;
- ///
- // helper function for Latex returns number of newlines
+ idx_type rowSpan(idx_type cell) const;
///
- int TeXTopHLine(odocstream &, row_type row, std::string const lang) const;
+ BoxType useBox(idx_type cell) const;
///
- int TeXBottomHLine(odocstream &, row_type row, std::string const lang) const;
- ///
- int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol) const;
- ///
- int TeXCellPostamble(odocstream &, idx_type cell, bool ismulticol) const;
- ///
- int TeXLongtableHeaderFooter(odocstream &, OutputParams const &) const;
+ bool hasNewlines(idx_type cell) const;
///
bool isValidRow(row_type const row) const;
///
- int TeXRow(odocstream &, row_type const row,
- OutputParams const &) const;
- ///
- // helper functions for plain text
- ///
- bool plaintextTopHLine(odocstream &, row_type row,
- std::vector<unsigned int> const &) const;
- ///
- bool plaintextBottomHLine(odocstream &, row_type row,
- std::vector<unsigned int> const &) const;
- ///
- void plaintextPrintCell(odocstream &,
- OutputParams const &,
- idx_type cell, row_type row, col_type column,
- std::vector<unsigned int> const &,
- bool onlydata) const;
- /// auxiliary function for docbook
- int docbookRow(odocstream & os, row_type, OutputParams const &) const;
+ void TeXRow(otexstream &, row_type const row,
+ OutputParams const &, std::list<col_type>, std::list<col_type>) const;
/// change associated Buffer
void setBuffer(Buffer & buffer);
/// retrieve associated Buffer
- Buffer & buffer() const { return *buffer_; }
+ Buffer const & buffer() const { return *buffer_; }
+ /// retrieve associated Buffer
+ Buffer & buffer() { return *buffer_; }
private:
Buffer * buffer_;
-}; // Tabular
+ ///
+ // helper function for DocBook
+ ///
+ /// Determines whether the tabular item should be generated as DocBook or XHTML.
+ enum class XmlOutputFormat : bool {
+ XHTML = true,
+ DOCBOOK = false
+ };
+ /// Transforms the vertical alignment of the given cell as prebaked CSS (for HTML tables in HTML output).
+ std::string getHAlignAsXmlAttribute(idx_type cell) const;
+ /// Transforms the vertical alignment of the given cell as a prebaked XML attribute (for CALS or HTML tables in DocBook).
+ std::string getHAlignAsCssAttribute(idx_type cell) const;
+ /// Transforms the vertical alignment of the given cell as prebaked CSS (for HTML tables in HTML output).
+ std::string getVAlignAsCssAttribute(idx_type cell) const;
+ /// Transforms the vertical alignment of the given cell as a prebaked XML attribute (for CALS or HTML tables in DocBook).
+ std::string getVAlignAsXmlAttribute(idx_type cell) const;
+
+ /// Helpers for XML tables (XHTML or DocBook).
+ docstring xmlRow(XMLStream & xs, row_type row, OutputParams const &,
+ bool header, XmlOutputFormat output_format,
+ BufferParams::TableOutput docbook_table_output = BufferParams::TableOutput::HTMLTable) const;
+ void xmlHeader(XMLStream & xs, OutputParams const &, XmlOutputFormat output_format) const;
+ void xmlFooter(XMLStream & xs, OutputParams const &, XmlOutputFormat output_format) const;
+ void xmlBody(XMLStream & xs, OutputParams const &, XmlOutputFormat output_format) const;
+ XmlRowWiseBorders computeXmlBorders(row_type row) const;
+ std::vector<std::string> computeCssStylePerCell(row_type row, col_type col, idx_type cell) const;
-///
-class InsetTableCell : public InsetText
-{
-public:
///
- InsetTableCell(Buffer & buf);
+ // helper functions for plain text
///
- InsetCode lyxCode() const { return CELL_CODE; }
+ bool plaintextTopHLine(odocstringstream &, row_type row,
+ std::vector<unsigned int> const &) const;
///
- Inset * clone() { return new InsetTableCell(*this); }
+ bool plaintextBottomHLine(odocstringstream &, row_type row,
+ std::vector<unsigned int> const &) const;
///
- bool getStatus(Cursor & cur, FuncRequest const & cmd,
- FuncStatus & status) const;
+ void plaintextPrintCell(odocstringstream &,
+ OutputParams const &,
+ idx_type cell, row_type row, col_type column,
+ std::vector<unsigned int> const &,
+ bool onlydata, size_t max_length) const;
+
///
- void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
+ // helper function for LaTeX
///
- void setContentAlignment(LyXAlignment al) {contentAlign = al; }
- /// writes the contents of the cell as a string, optionally
- /// descending into insets
- docstring asString(bool intoInsets = true);
-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
+ void TeXTopHLine(otexstream &, row_type row, std::list<col_type>,
+ std::list<col_type>) const;
///
- bool isFixedWidth;
- // FIXME: Here the thoughts from the comment above also apply.
+ void TeXBottomHLine(otexstream &, row_type row, std::list<col_type>,
+ std::list<col_type>) const;
///
- LyXAlignment contentAlign;
- /// should paragraph indendation be omitted in any case?
- bool neverIndent() const { return true; }
+ void TeXCellPreamble(otexstream &, idx_type cell, bool & ismulticol, bool & ismultirow,
+ bool const bidi) const;
///
- LyXAlignment contentAlignment() const { return contentAlign; }
+ void TeXCellPostamble(otexstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
///
- 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; }
-};
+ void TeXLongtableHeaderFooter(otexstream &, OutputParams const &, std::list<col_type>,
+ std::list<col_type>) const;
+
+}; // Tabular
class InsetTabular : public Inset
{
public:
///
- InsetTabular(Buffer &, row_type rows = 1,
+ InsetTabular(Buffer *, row_type rows = 1,
col_type columns = 1);
///
~InsetTabular();
///
- void setBuffer(Buffer & buffer);
+ void setBuffer(Buffer & buffer) override;
///
static void string2params(std::string const &, InsetTabular &);
///
static std::string params2string(InsetTabular const &);
///
- void read(Lexer &);
+ void read(Lexer &) override;
///
- void write(std::ostream &) const;
+ void write(std::ostream &) const override;
///
- void metrics(MetricsInfo &, Dimension &) const;
+ void metrics(MetricsInfo &, Dimension &) const override;
///
- void draw(PainterInfo & pi, int x, int y) const;
+ void draw(PainterInfo & pi, int x, int y) const override;
///
- void drawSelection(PainterInfo & pi, int x, int y) const;
+ void drawSelection(PainterInfo & pi, int x, int y) const override;
///
- docstring editMessage() const;
+ void drawBackground(PainterInfo & pi, int x, int y) const override;
///
- EDITABLE editable() const { return HIGHLY_EDITABLE; }
+ bool editable() const override { return true; }
///
- bool insetAllowed(InsetCode code) const;
+ bool hasSettings() const override { return true; }
///
- bool allowSpellCheck() const { return true; }
+ bool insetAllowed(InsetCode code) const override;
///
- bool canTrackChanges() const { return true; }
- /** returns true 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 allowSpellCheck() const override { return true; }
///
- DisplayType display() const { return tabular.is_long_tabular ? AlignCenter : Inline; }
+ bool canTrackChanges() const override { return true; }
///
- int latex(odocstream &, OutputParams const &) const;
+ bool canPaintChange(BufferView const &) const override { return true; }
///
- int plaintext(odocstream &, OutputParams const &) const;
+ bool inheritFont() const override { return false; }
///
- int docbook(odocstream &, OutputParams const &) const;
+ bool allowMultiPar() const override;
///
- void validate(LaTeXFeatures & features) const;
+ bool allowsCaptionVariation(std::string const &) const override;
+ //
+ bool isTable() const override { return true; }
///
- InsetCode lyxCode() const { return TABULAR_CODE; }
+ int rowFlags() const override;
///
- docstring contextMenu(BufferView const & bv, int x, int y) 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 latex(otexstream &, OutputParams const &) const override;
///
- bool tabularFeatures(Cursor & cur, std::string const & what);
+ int plaintext(odocstringstream & ods, OutputParams const & op,
+ size_t max_length = INT_MAX) const override;
///
- void tabularFeatures(Cursor & cur, Tabular::Feature feature,
- std::string const & val = std::string());
+ void docbook(XMLStream &, OutputParams const &) const override;
+ ///
+ docstring xhtml(XMLStream &, OutputParams const &) const override;
+ ///
+ void validate(LaTeXFeatures & features) const override;
+ ///
+ InsetCode lyxCode() const override { return TABULAR_CODE; }
///
- void openLayoutDialog(BufferView *) const;
+ std::string contextMenu(BufferView const &, int, int) const override;
///
- bool showInsetDialog(BufferView *) const;
+ std::string contextMenuName() const override;
+ /// 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 override;
+ /// Executes a space-separated sequence of tabular-features requests
+ void tabularFeatures(Cursor & cur, std::string const & what);
+ /// Change a single tabular feature; does not handle undo.
+ void tabularFeatures(Cursor & cur, Tabular::Feature feature,
+ std::string const & val = std::string());
/// number of cells
- size_t nargs() const { return tabular.numberofcells; }
+ size_t nargs() const override { return tabular.numberofcells; }
///
- boost::shared_ptr<InsetTableCell const> cell(idx_type) const;
+ std::shared_ptr<InsetTableCell const> cell(idx_type) const;
///
- boost::shared_ptr<InsetTableCell> cell(idx_type);
+ std::shared_ptr<InsetTableCell> cell(idx_type);
///
- Text * getText(int) const;
+ Text * getText(int) const override;
+ /// does the inset contain changes ?
+ bool isChanged() const override;
/// set the change for the entire inset
- void setChange(Change const & change);
+ void setChange(Change const & change) override;
/// accept the changes within the inset
- void acceptChanges(BufferParams const & bparams);
+ void acceptChanges() override;
/// reject the changes within the inset
- void rejectChanges(BufferParams const & bparams);
+ void rejectChanges() override;
// this should return true if we have a "normal" cell, otherwise false.
// "normal" means without width set!
/// should all paragraphs be output with "Standard" layout?
- virtual bool allowParagraphCustomization(idx_type cell = 0) const;
+ bool allowParagraphCustomization(idx_type cell = 0) const override;
///
- virtual bool forcePlainLayout(idx_type cell = 0) const;
- ///
- virtual bool usePlainLayout() { return true; }
- ///
- void addPreview(graphics::PreviewLoader &) const;
+ void addPreview(DocIterator const & inset_pos,
+ graphics::PreviewLoader &) const override;
/// lock cell with given index
- void edit(Cursor & cur, bool front, EntryDirection entry_from);
+ void edit(Cursor & cur, bool front, EntryDirection entry_from) override;
/// get table row from x coordinate
int rowFromY(Cursor & cur, int y) const;
/// get table column from y coordinate
int columnFromX(Cursor & cur, int x) const;
///
- Inset * editXY(Cursor & cur, int x, int y);
+ Inset * editXY(Cursor & cur, int x, int y) override;
/// can we go further down on mouse click?
- bool descendable() const { return true; }
- // Update the counters of this inset and of its contents
- void updateLabels(ParIterator const &);
+ bool descendable(BufferView const &) const override { return true; }
+ /// Update the counters of this inset and of its contents
+ void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false) override;
+ ///
+ void addToToc(DocIterator const & di, bool output_active,
+ UpdateType utype, TocBackend & backend) const override;
///
- bool completionSupported(Cursor const &) const;
+ bool completionSupported(Cursor const &) const override;
///
- bool inlineCompletionSupported(Cursor const & cur) const;
+ bool inlineCompletionSupported(Cursor const & cur) const override;
///
- bool automaticInlineCompletion() const;
+ bool automaticInlineCompletion() const override;
///
- bool automaticPopupCompletion() const;
+ bool automaticPopupCompletion() const override;
///
- bool showCompletionCursor() const;
+ bool showCompletionCursor() const override;
///
- CompletionList const * createCompletionList(Cursor const & cur) const;
+ CompletionList const * createCompletionList(Cursor const & cur) const override;
///
- docstring completionPrefix(Cursor const & cur) const;
+ docstring completionPrefix(Cursor const & cur) const override;
///
- bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
+ bool insertCompletion(Cursor & cur, docstring const & s, bool /*finished*/) override;
///
- void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
+ void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const override;
///
- virtual bool usePlainLayout() const { return true; }
+ bool usePlainLayout() const override { return true; }
+ ///
+ docstring layoutName() const override { return from_ascii("Tabular"); }
+
///
- virtual InsetTabular * asInsetTabular() { return this; }
+ InsetTabular * asInsetTabular() override { return this; }
///
- virtual InsetTabular const * asInsetTabular() const { return this; }
+ InsetTabular const * asInsetTabular() const override { return this; }
///
bool isRightToLeft(Cursor & cur) const;
/// writes the cells between stidx and enidx as a string, optionally
/// descending into the insets
docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
-
+ ///
+ ParagraphList asParList(idx_type stidx, idx_type enidx);
+ ///
+ bool confirmDeletion() const override { return true; }
/// Returns whether the cell in the specified row and column is selected.
bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
+ ///
+ void setLayoutForHiddenCells(DocumentClass const & dc);
//
// Public structures and variables
///
///
InsetTabular(InsetTabular const &);
///
- void doDispatch(Cursor & cur, FuncRequest & cmd);
+ void doDispatch(Cursor & cur, FuncRequest & cmd) override;
///
- bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
+ bool getFeatureStatus(Cursor & cur, std::string const & s,
+ std::string const & argument, FuncStatus & status) const;
///
- int scroll() const { return scx_; }
+ bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const override;
///
- Inset * clone() const { return new InsetTabular(*this); }
+ Inset * clone() const override { return new InsetTabular(*this); }
///
- void drawCellLines(frontend::Painter &, int x, int y, row_type row,
- idx_type cell, bool erased) const;
+ bool hitSelectRow(BufferView const & bv, int x) const;
+ ///
+ bool hitSelectColumn(BufferView const & bv, int y) const;
+ /// Returns true if coordinates are on row/column selection zones
+ bool clickable(BufferView const &, int x, int y) const override;
+
+ ///
+ void drawCellLines(PainterInfo &, int x, int y, row_type row,
+ idx_type cell) const;
///
void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
///
- void moveNextCell(Cursor & cur,
+ void moveNextCell(Cursor & cur,
EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
///
void movePrevCell(Cursor & cur,
///
int cellXPos(idx_type cell) const;
///
- void resetPos(Cursor & cur) const;
- ///
- void removeTabularRow();
+ int cellYPos(idx_type cell) const;
///
bool copySelection(Cursor & cur);
///
/// return the cell nearest to x, y
idx_type getNearestCell(BufferView &, int x, int y) const;
- /// test the rotation state of the give cell range.
+ /// test the rotation state of the given cell range.
bool oneCellHasRotationState(bool rotated,
row_type row_start, row_type row_end,
col_type col_start, col_type col_end) const;
- ///
- mutable idx_type first_visible_cell;
- ///
- mutable int scx_;
+
/// 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