* \author Jürgen Vigna
* \author Edwin Leuven
* \author Uwe Stöhr
+ * \author Scott Kostyshak
*
* Full author contact details are available in file CREDITS.
*/
#ifndef INSET_TABULAR_H
#define INSET_TABULAR_H
-#include "Inset.h"
#include "InsetText.h"
-#include "Layout.h"
#include "Length.h"
-#include "support/shared_ptr.h"
-
+#include <climits>
#include <iosfwd>
+#include <memory>
#include <vector>
+
namespace lyx {
class Buffer;
///
InsetCode lyxCode() const { return CELL_CODE; }
///
- Inset * clone() { return new InsetTableCell(*this); }
+ Inset * clone() const { return new InsetTableCell(*this); }
///
bool getStatus(Cursor & cur, FuncRequest const & cmd,
FuncStatus & status) const;
///
void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
///
+ 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(XHTMLStream &, OutputParams const &) const;
+ ///
+ void addToToc(DocIterator const & di, bool output_active,
+ UpdateType utype, TocBackend & backend) const;
+ ///
+ void metrics(MetricsInfo &, Dimension &) 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
+ // 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
+ // 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
// 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
+ // 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
+ // 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;
+ ///
+ bool isMultiColumn;
+ ///
+ bool isMultiRow;
// FIXME: Here the thoughts from the comment above also apply.
///
LyXAlignment contentAlign;
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;
+ ///
+ virtual bool forceLocalFontSwitch() const;
/// Is the width forced to some value?
bool hasFixedWidth() const { return isFixedWidth; }
+ /// Can the cell contain several paragraphs?
+ bool allowMultiPar() const { return !isMultiRow && (!isMultiColumn || isFixedWidth); }
};
///
COPY_COLUMN,
///
+ MOVE_COLUMN_RIGHT,
+ ///
+ MOVE_COLUMN_LEFT,
+ ///
+ MOVE_ROW_DOWN,
+ ///
+ MOVE_ROW_UP,
+ ///
SET_LINE_TOP,
///
SET_LINE_BOTTOM,
///
UNSET_MULTIROW,
///
+ SET_MROFFSET,
+ ///
SET_ALL_LINES,
///
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_SPECIAL_MULTICOLUMN,
///
- SET_SPECIAL_MULTIROW,
+ TOGGLE_BOOKTABS,
///
SET_BOOKTABS,
///
///
SET_DECIMAL_POINT,
///
+ SET_TABULAR_WIDTH,
+ ///
LAST_ACTION
};
///
LYX_VALIGN_MIDDLE = 1,
///
LYX_VALIGN_BOTTOM = 2
-
+
};
///
enum HAlignment {
///
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 {
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;
///
+ 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);
+ ///
+ void insertColumn(col_type column, bool copy);
///
idx_type getFirstCellInRow(row_type row) 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;
///
- idx_type setMultiColumn(idx_type cell, idx_type number);
+ bool hasMultiColumn(col_type cell) const;
+ ///
+ bool hasVarwidthColumn() const;
+ ///
+ bool isVTypeColumn(col_type cell) const;
+ ///
+ idx_type setMultiColumn(Cursor & cur, idx_type cell, idx_type number,
+ bool const right_border);
///
void unsetMultiColumn(idx_type cell);
///
///
bool isMultiRow(idx_type cell) const;
///
- idx_type setMultiRow(idx_type cell, idx_type number);
+ 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);
///
///
col_type cellColumn(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;
///
- bool haveLTCaption() const;
+ bool haveLTCaption(CaptionType captiontype = CAPTION_ANY) const;
///
// end longtable support
- ///
- shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
- ///
- shared_ptr<InsetTableCell> cellInset(row_type row,
- col_type column) const;
+
+ //@{
+ /// 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 multicell.
+ 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,
- 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(CellData const &);
///
- CellData & operator=(CellData);
- ///
- void swap(CellData & rhs);
+ CellData & operator=(CellData const &);
///
idx_type cellno;
///
///
int multirow;
///
+ Length mroffset;
+ ///
LyXAlignment alignment;
///
VAlignment valignment;
///
BoxType usebox;
///
- bool rotate;
+ int rotate;
///
docstring align_special;
///
Length p_width; // this is only set for multicolumn!!!
///
- 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;
///
docstring align_special;
///
docstring decimal_point;
+ ///
+ bool varwidth;
};
///
typedef std::vector<ColumnData> column_vector;
///
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;
//
///
bool setFixedWidth(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;
///
idx_type rowSpan(idx_type cell) const;
///
- BoxType useParbox(idx_type cell) const;
+ BoxType useBox(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,
+ std::list<col_type>) const;
///
- int TeXBottomHLine(odocstream &, row_type row, std::string const lang) const;
+ void TeXBottomHLine(otexstream &, row_type row, std::string const & lang,
+ std::list<col_type>) const;
///
- int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const;
+ void TeXCellPreamble(otexstream &, idx_type cell, bool & ismulticol, bool & ismultirow,
+ bool const bidi) 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 &, std::list<col_type>) 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 &, std::list<col_type>) 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);
/// retrieve associated Buffer
- Buffer & buffer() const { return *buffer_; }
+ Buffer const & buffer() const { return *buffer_; }
+ /// retrieve associated Buffer
+ Buffer & buffer() { return *buffer_; }
private:
Buffer * buffer_;
///
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
+ ///
+ bool canPaintChange(BufferView const &) const { return true; }
+ /** 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;
+ //
+ bool isTable() const { return true; }
///
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;
- ///
- bool tabularFeatures(Cursor & cur, std::string const & what);
- ///
+ /// 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; }
///
- shared_ptr<InsetTableCell const> cell(idx_type) const;
+ std::shared_ptr<InsetTableCell const> cell(idx_type) const;
///
- shared_ptr<InsetTableCell> cell(idx_type);
+ std::shared_ptr<InsetTableCell> cell(idx_type);
///
Text * getText(int) const;
/// Update the counters of this inset and of its contents
void updateBuffer(ParIterator const &, UpdateType);
///
- void addToToc(DocIterator const &);
+ void addToToc(DocIterator const & di, bool output_active,
+ UpdateType utype, TocBackend & backend) const;
///
bool completionSupported(Cursor const &) const;
void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
///
virtual bool usePlainLayout() const { return true; }
+ ///
+ docstring layoutName() const { return from_ascii("Tabular"); }
+
///
InsetTabular * asInsetTabular() { return this; }
/// 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
///
///
void doDispatch(Cursor & cur, FuncRequest & cmd);
///
- 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;
///
Inset * clone() const { return new InsetTabular(*this); }
+ ///
+ 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;
+
///
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;
+ 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);
+InsetTableCell splitCell(InsetTableCell & head, docstring const & decimal_sym, bool & hassep);
} // namespace lyx
projects / lyx.git / blobdiff