* Licence details can be found in the file COPYING.
*
* \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
+ * \author Matthias Ettrich
+ * \author André Pönitz
+ * \author Jürgen Vigna
*
* Full author contact details are available in file CREDITS.
*/
#define INSETTABULAR_H
#include "Inset.h"
-#include "tabular.h"
+#include "InsetText.h"
+#include "Layout.h"
+#include "Length.h"
#include "MailInset.h"
+#include <boost/shared_ptr.hpp>
+
+#include <iosfwd>
+#include <vector>
+
namespace lyx {
class FuncStatus;
-class LyXLex;
+class Lexer;
class BufferView;
class Buffer;
class BufferParams;
namespace frontend { class Painter; }
-class InsetTabular : public InsetOld {
+
+class InsetTabular;
+class Cursor;
+class OutputParams;
+
+//
+// A helper struct for tables
+//
+class Tabular {
+public:
+ ///
+ enum Feature {
+ ///
+ APPEND_ROW = 0,
+ ///
+ APPEND_COLUMN,
+ ///
+ DELETE_ROW,
+ ///
+ DELETE_COLUMN,
+ ///
+ COPY_ROW,
+ ///
+ COPY_COLUMN,
+ ///
+ TOGGLE_LINE_TOP,
+ ///
+ TOGGLE_LINE_BOTTOM,
+ ///
+ TOGGLE_LINE_LEFT,
+ ///
+ TOGGLE_LINE_RIGHT,
+ ///
+ ALIGN_LEFT,
+ ///
+ ALIGN_RIGHT,
+ ///
+ ALIGN_CENTER,
+ ///
+ ALIGN_BLOCK,
+ ///
+ VALIGN_TOP,
+ ///
+ VALIGN_BOTTOM,
+ ///
+ VALIGN_MIDDLE,
+ ///
+ M_TOGGLE_LINE_TOP,
+ ///
+ M_TOGGLE_LINE_BOTTOM,
+ ///
+ M_TOGGLE_LINE_LEFT,
+ ///
+ M_TOGGLE_LINE_RIGHT,
+ ///
+ M_ALIGN_LEFT,
+ ///
+ M_ALIGN_RIGHT,
+ ///
+ M_ALIGN_CENTER,
+ ///
+ M_VALIGN_TOP,
+ ///
+ M_VALIGN_BOTTOM,
+ ///
+ M_VALIGN_MIDDLE,
+ ///
+ MULTICOLUMN,
+ ///
+ SET_ALL_LINES,
+ ///
+ UNSET_ALL_LINES,
+ ///
+ SET_LONGTABULAR,
+ ///
+ UNSET_LONGTABULAR,
+ ///
+ SET_PWIDTH,
+ ///
+ SET_MPWIDTH,
+ ///
+ SET_ROTATE_TABULAR,
+ ///
+ UNSET_ROTATE_TABULAR,
+ ///
+ TOGGLE_ROTATE_TABULAR,
+ ///
+ SET_ROTATE_CELL,
+ ///
+ UNSET_ROTATE_CELL,
+ ///
+ TOGGLE_ROTATE_CELL,
+ ///
+ SET_USEBOX,
+ ///
+ SET_LTHEAD,
+ UNSET_LTHEAD,
+ ///
+ SET_LTFIRSTHEAD,
+ UNSET_LTFIRSTHEAD,
+ ///
+ SET_LTFOOT,
+ UNSET_LTFOOT,
+ ///
+ SET_LTLASTFOOT,
+ UNSET_LTLASTFOOT,
+ ///
+ SET_LTNEWPAGE,
+ ///
+ SET_SPECIAL_COLUMN,
+ ///
+ SET_SPECIAL_MULTI,
+ ///
+ SET_BOOKTABS,
+ ///
+ UNSET_BOOKTABS,
+ ///
+ SET_TOP_SPACE,
+ ///
+ SET_BOTTOM_SPACE,
+ ///
+ SET_INTERLINE_SPACE,
+ ///
+ LAST_ACTION
+ };
+ ///
+ enum {
+ ///
+ CELL_NORMAL = 0,
+ ///
+ CELL_BEGIN_OF_MULTICOLUMN,
+ ///
+ CELL_PART_OF_MULTICOLUMN
+ };
+
+ ///
+ enum VAlignment {
+ ///
+ LYX_VALIGN_TOP = 0,
+ ///
+ LYX_VALIGN_BOTTOM = 1,
+ ///
+ LYX_VALIGN_MIDDLE = 2
+ };
+
+ enum BoxType {
+ ///
+ BOX_NONE = 0,
+ ///
+ BOX_PARBOX = 1,
+ ///
+ BOX_MINIPAGE = 2
+ };
+
+ class ltType {
+ public:
+ // constructor
+ ltType();
+ // we have this header type (is set in the getLT... functions)
+ bool set;
+ // double borders on top
+ bool topDL;
+ // double borders on bottom
+ bool bottomDL;
+ // used for FirstHeader & LastFooter and if this is true
+ // all the rows marked as FirstHeader or LastFooter are
+ // ignored in the output and it is set to be empty!
+ 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();
+ /// constructor
+ Tabular(BufferParams const &, col_type columns_arg,
+ row_type rows_arg);
+
+ /// Returns true if there is a topline, returns false if not
+ bool topLine(idx_type cell, bool wholerow = false) const;
+ /// Returns true if there is a topline, returns false if not
+ bool bottomLine(idx_type cell, bool wholerow = false) const;
+ /// Returns true if there is a topline, returns false if not
+ bool leftLine(idx_type cell, bool wholecolumn = false) const;
+ /// Returns true if there is a topline, returns false if not
+ bool rightLine(idx_type cell, bool wholecolumn = false) 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 getAdditionalHeight(row_type row) const;
+ ///
+ int getAdditionalWidth(idx_type cell) const;
+
+ /* returns the maximum over all rows */
+ ///
+ int columnWidth(idx_type cell) const;
+ ///
+ int width() const;
+ ///
+ int height() const;
+ ///
+ int rowAscent(row_type row) const;
+ ///
+ int rowDescent(row_type row) const;
+ ///
+ void setRowAscent(row_type row, int height);
+ ///
+ 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, bool wholerow = false);
+ ///
+ void setBottomLine(idx_type cell, bool line, bool wholerow = false);
+ ///
+ void setLeftLine(idx_type cell, bool line, bool wholecolumn = false);
+ ///
+ void setRightLine(idx_type cell, bool line, bool wholecolumn = false);
+ ///
+ void setAlignment(idx_type cell, LyXAlignment align,
+ bool onlycolumn = false);
+ ///
+ void setVAlignment(idx_type cell, VAlignment align,
+ bool onlycolumn = false);
+ ///
+ void setColumnPWidth(Cursor &, idx_type, Length const &);
+ ///
+ bool setMColumnPWidth(Cursor &, idx_type, Length const &);
+ ///
+ void setAlignSpecial(idx_type cell, docstring const & special,
+ Feature what);
+ ///
+ LyXAlignment getAlignment(idx_type cell,
+ bool onlycolumn = false) const;
+ ///
+ VAlignment getVAlignment(idx_type cell,
+ bool onlycolumn = false) const;
+ ///
+ Length const getPWidth(idx_type cell) const;
+ ///
+ Length const getColumnPWidth(idx_type cell) const;
+ ///
+ Length const getMColumnPWidth(idx_type cell) const;
+ ///
+ docstring const getAlignSpecial(idx_type cell, int what) const;
+ ///
+ int cellWidth(idx_type cell) const;
+ ///
+ int getBeginningOfTextInCell(idx_type cell) const;
+ ///
+ void appendRow(BufferParams const &, idx_type cell);
+ ///
+ void deleteRow(row_type row);
+ ///
+ void copyRow(BufferParams const &, row_type);
+ ///
+ void appendColumn(BufferParams const &, idx_type cell);
+ ///
+ void deleteColumn(col_type column);
+ ///
+ void copyColumn(BufferParams const &, col_type);
+ ///
+ bool isFirstCellInRow(idx_type cell) const;
+ ///
+ idx_type getFirstCellInRow(row_type row) const;
+ ///
+ bool isLastCellInRow(idx_type cell) const;
+ ///
+ idx_type getLastCellInRow(row_type row) const;
+ ///
+ idx_type cellCount() const;
+ ///
+ idx_type numberOfCellsInRow(idx_type cell) const;
+ ///
+ void write(Buffer const &, std::ostream &) const;
+ ///
+ void read(Buffer const &, Lexer &);
+ ///
+ int latex(Buffer const &, odocstream &, OutputParams const &) const;
+ //
+ int docbook(Buffer const & buf, odocstream & os, OutputParams const &) const;
+ ///
+ void plaintext(Buffer const &, odocstream &,
+ OutputParams const & runparams, int const depth,
+ bool onlydata, char_type delim) const;
+ ///
+ bool isMultiColumn(idx_type cell) const;
+ ///
+ bool isMultiColumnReal(idx_type cell) const;
+ ///
+ void setMultiColumn(Buffer *, idx_type cell, idx_type number);
+ ///
+ idx_type unsetMultiColumn(idx_type cell); // returns number of new cells
+ ///
+ bool isPartOfMultiColumn(row_type row, col_type column) const;
+ ///
+ row_type cellRow(idx_type cell) const;
+ ///
+ col_type cellColumn(idx_type cell) const;
+ ///
+ col_type cellRightColumn(idx_type cell) const;
+ ///
+ void setBookTabs(bool);
+ ///
+ bool useBookTabs() const;
+ ///
+ void setLongTabular(bool);
+ ///
+ bool isLongTabular() const;
+ ///
+ void setRotateTabular(bool);
+ ///
+ bool getRotateTabular() const;
+ ///
+ void setRotateCell(idx_type cell, bool);
+ ///
+ bool getRotateCell(idx_type cell) const;
+ ///
+ bool needRotating() const;
+ ///
+ bool isLastCell(idx_type cell) const;
+ ///
+ idx_type getCellAbove(idx_type cell) const;
+ ///
+ idx_type getCellBelow(idx_type cell) const;
+ ///
+ idx_type getLastCellAbove(idx_type cell) const;
+ ///
+ idx_type getLastCellBelow(idx_type cell) const;
+ ///
+ idx_type cellIndex(row_type row, col_type column) const;
+ ///
+ void setUsebox(idx_type cell, BoxType);
+ ///
+ BoxType getUsebox(idx_type cell) 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 getRowOfLTFirstHead(row_type row, ltType &) const;
+ ///
+ void setLTFoot(row_type row, bool flag, ltType const &, bool last);
+ ///
+ bool getRowOfLTFoot(row_type row, ltType &) const;
+ ///
+ bool getRowOfLTLastFoot(row_type row, ltType &) const;
+ ///
+ void setLTNewPage(row_type row, bool what);
+ ///
+ bool getLTNewPage(row_type row) const;
+ ///
+ bool haveLTHead() const;
+ ///
+ bool haveLTFirstHead() const;
+ ///
+ bool haveLTFoot() const;
+ ///
+ bool haveLTLastFoot() const;
+ ///
+ // end longtable support
+ ///
+ boost::shared_ptr<InsetText> getCellInset(idx_type cell) const;
+ ///
+ boost::shared_ptr<InsetText> getCellInset(row_type row,
+ col_type column) const;
+ ///
+ void setCellInset(row_type row, col_type column,
+ boost::shared_ptr<InsetText>) const;
+ /// Search for \param inset in the tabular, with the
+ ///
+ idx_type getCellFromInset(Inset const * inset) const;
+ ///
+ row_type rowCount() const { return row_info.size(); }
+ ///
+ col_type columnCount() const { return column_info.size();}
+ ///
+ void validate(LaTeXFeatures &) const;
+ ///
+//private:
+ ///
+ class cellstruct {
+ public:
+ ///
+ cellstruct(BufferParams const &);
+ ///
+ cellstruct(cellstruct const &);
+ ///
+ cellstruct & operator=(cellstruct);
+ ///
+ void swap(cellstruct & rhs);
+ ///
+ idx_type cellno;
+ ///
+ int width;
+ ///
+ int multicolumn;
+ ///
+ LyXAlignment alignment;
+ ///
+ VAlignment valignment;
+ ///
+ bool top_line;
+ ///
+ bool bottom_line;
+ ///
+ bool left_line;
+ ///
+ bool right_line;
+ ///
+ BoxType usebox;
+ ///
+ bool rotate;
+ ///
+ docstring align_special;
+ ///
+ Length p_width; // this is only set for multicolumn!!!
+ ///
+ boost::shared_ptr<InsetText> inset;
+ };
+ cellstruct & cellinfo_of_cell(idx_type cell) const;
+ ///
+ typedef std::vector<cellstruct> cell_vector;
+ ///
+ typedef std::vector<cell_vector> cell_vvector;
+
+ ///
+ class rowstruct {
+ public:
+ ///
+ rowstruct();
+ ///
+ int ascent;
+ ///
+ int descent;
+ ///
+ bool top_line;
+ ///
+ bool bottom_line;
+ /// Extra space between the top line and this row
+ Length top_space;
+ /// Ignore top_space if true and use the default top space
+ bool top_space_default;
+ /// Extra space between this row and the bottom line
+ Length bottom_space;
+ /// Ignore bottom_space if true and use the default bottom space
+ bool bottom_space_default;
+ /// Extra space between the bottom line and the next top line
+ Length interline_space;
+ /// Ignore interline_space if true and use the default interline space
+ bool interline_space_default;
+ /// This are for longtabulars only
+ /// a row of endhead
+ bool endhead;
+ /// a row of endfirsthead
+ bool endfirsthead;
+ /// a row of endfoot
+ bool endfoot;
+ /// row of endlastfoot
+ bool endlastfoot;
+ /// row for a newpage
+ bool newpage;
+ };
+ ///
+ typedef std::vector<rowstruct> row_vector;
+
+ ///
+ class columnstruct {
+ public:
+ ///
+ columnstruct();
+ ///
+ LyXAlignment alignment;
+ ///
+ VAlignment valignment;
+ ///
+ bool left_line;
+ ///
+ bool right_line;
+ ///
+ int width;
+ ///
+ Length p_width;
+ ///
+ docstring align_special;
+ };
+ ///
+ typedef std::vector<columnstruct> column_vector;
+
+ ///
+ idx_type numberofcells;
+ ///
+ std::vector<row_type> rowofcell;
+ ///
+ std::vector<col_type> columnofcell;
+ ///
+ row_vector row_info;
+ ///
+ column_vector column_info;
+ ///
+ mutable cell_vvector cell_info;
+ ///
+ bool use_booktabs;
+ ///
+ bool rotate;
+ //
+ // for long tabulars
+ //
+ bool is_long_tabular;
+ /// endhead data
+ ltType endhead;
+ /// endfirsthead data
+ ltType endfirsthead;
+ /// endfoot data
+ ltType endfoot;
+ /// endlastfoot data
+ ltType endlastfoot;
+
+ ///
+ void init(BufferParams const &, row_type rows_arg,
+ col_type columns_arg);
+ ///
+ void updateIndexes();
+ /// Returns true if a complete update is necessary, otherwise false
+ bool setWidthOfMulticolCell(idx_type cell, int new_width);
+ ///
+ void recalculateMulticolumnsOfColumn(col_type column);
+ /// Returns true if change
+ void calculate_width_of_column(col_type column);
+ ///
+ bool calculate_width_of_column_NMC(col_type column); // no multi cells
+ ///
+ idx_type cells_in_multicolumn(idx_type cell) const;
+ ///
+ BoxType useParbox(idx_type cell) const;
+ ///
+ // helper function for Latex returns number of newlines
+ ///
+ int TeXTopHLine(odocstream &, row_type row) const;
+ ///
+ int TeXBottomHLine(odocstream &, row_type row) const;
+ ///
+ int TeXCellPreamble(odocstream &, idx_type cell) const;
+ ///
+ int TeXCellPostamble(odocstream &, idx_type cell) const;
+ ///
+ int TeXLongtableHeaderFooter(odocstream &, Buffer const & buf,
+ OutputParams const &) const;
+ ///
+ bool isValidRow(row_type const row) const;
+ ///
+ int TeXRow(odocstream &, row_type const row, Buffer const & buf,
+ 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(Buffer const &, 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(Buffer const & buf, odocstream & os, row_type,
+ OutputParams const &) const;
+
+private:
+ /// renumber cells after structural changes
+ void fixCellNums();
+};
+
+
+
+class InsetTabular : public Inset {
public:
///
InsetTabular(Buffer const &, row_type rows = 1,
///
~InsetTabular();
///
- void read(Buffer const &, LyXLex &);
+ void read(Buffer const &, Lexer &);
///
void write(Buffer const &, std::ostream &) const;
///
- bool metrics(MetricsInfo &, Dimension &) const;
+ void metrics(MetricsInfo &, Dimension &) const;
///
void draw(PainterInfo & pi, int x, int y) const;
///
///
EDITABLE editable() const { return HIGHLY_EDITABLE; }
///
- bool insetAllowed(InsetBase::Code) const { return true; }
+ bool insetAllowed(InsetCode code) const;
///
bool allowSpellCheck() const { return true; }
///
insets that may contain several paragraphs */
bool noFontChange() const { return true; }
///
- bool display() const { return tabular.isLongTabular(); }
+ DisplayType display() const { return tabular.isLongTabular() ? AlignCenter : Inline; }
///
int latex(Buffer const &, odocstream &,
- OutputParams const &) const;
+ OutputParams const &) const;
///
int plaintext(Buffer const &, odocstream &,
- OutputParams const &) const;
+ OutputParams const &) const;
///
int docbook(Buffer const &, odocstream &,
- OutputParams const &) const;
+ OutputParams const &) const;
///
void validate(LaTeXFeatures & features) const;
///
- Code lyxCode() const { return InsetBase::TABULAR_CODE; }
+ InsetCode lyxCode() const { return TABULAR_CODE; }
/// 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(LCursor & cur, std::string const & what);
+ bool tabularFeatures(Cursor & cur, std::string const & what);
///
- void tabularFeatures(LCursor & cur, LyXTabular::Feature feature,
+ 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.getNumberOfCells(); }
+ size_t nargs() const { return tabular.cellCount(); }
///
boost::shared_ptr<InsetText const> cell(idx_type) const;
///
boost::shared_ptr<InsetText> cell(idx_type);
///
- LyXText * getText(int) const;
+ Text * getText(int) const;
/// set the change for the entire inset
void setChange(Change const & change);
// 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?
- bool forceDefaultParagraphs(idx_type cell = 0) const;
-
+ virtual bool allowParagraphCustomization(idx_type cell = 0) const;
+ ///
+ virtual bool forceEmptyLayout() { return true; }
///
void addPreview(graphics::PreviewLoader &) const;
/// set the owning buffer
void buffer(Buffer const * buf);
/// lock cell with given index
- void edit(LCursor & cur, bool left);
+ void edit(Cursor & cur, bool front, EntryDirection entry_from);
///
- InsetBase * editXY(LCursor & cur, int x, int y);
+ Inset * editXY(Cursor & cur, int x, int y);
/// can we go further down on mouse click?
bool descendable() const { return true; }
+ // Update the counters of this inset and of its contents
+ virtual void updateLabels(Buffer const &, ParIterator const &);
//
// Public structures and variables
///
- mutable LyXTabular tabular;
+ mutable Tabular tabular;
protected:
///
InsetTabular(InsetTabular const &);
///
- virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
+ virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
///
- bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
+ bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
///
int scroll() const { return scx_; }
private:
- virtual std::auto_ptr<InsetBase> doClone() const;
+ virtual Inset * clone() const;
///
void drawCellLines(frontend::Painter &, int x, int y, row_type row,
idx_type cell, bool erased) const;
///
- void setCursorFromCoordinates(LCursor & cur, int x, int y) const;
+ void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
///
- void moveNextCell(LCursor & cur);
+ void moveNextCell(Cursor & cur);
///
- void movePrevCell(LCursor & cur);
+ void movePrevCell(Cursor & cur);
///
int getCellXPos(idx_type cell) const;
///
- void resetPos(LCursor & cur) const;
+ void resetPos(Cursor & cur) const;
///
void removeTabularRow();
///
- bool copySelection(LCursor & cur);
+ bool copySelection(Cursor & cur);
///
- bool pasteClipboard(LCursor & cur);
+ bool pasteClipboard(Cursor & cur);
///
- void cutSelection(LCursor & cur);
+ void cutSelection(Cursor & cur);
///
- bool isRightToLeft(LCursor & cur) const;
+ bool isRightToLeft(Cursor & cur) const;
///
- void getSelection(LCursor & cur, row_type & rs, row_type & re,
+ void getSelection(Cursor & cur, row_type & rs, row_type & re,
col_type & cs, col_type & ce) const;
///
bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
/// are we operating on several cells?
- bool tablemode(LCursor & cur) const;
+ bool tablemode(Cursor & cur) const;
/// return the "Manhattan distance" to nearest corner
int dist(BufferView &, idx_type cell, int x, int y) const;
/// 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.
+ bool oneCellHasRotationState(bool rotated,
+ row_type row_start, row_type row_end,
+ col_type col_start, col_type col_end) const;
///
Buffer const * buffer_;
///
mutable idx_type first_visible_cell;
///
mutable int scx_;
- /// Ugly boolean used when this inset is dissolved and
- /// InsetTabularMailer should not be used.
- bool is_deleted_;
};
///
InsetTabularMailer(InsetTabular const & inset);
///
- virtual InsetBase & inset() const { return inset_; }
+ virtual Inset & inset() const { return inset_; }
///
virtual std::string const & name() const { return name_; }
///
InsetTabular & inset_;
};
-std::string const featureAsString(LyXTabular::Feature feature);
+std::string const featureAsString(Tabular::Feature feature);
} // namespace lyx
projects / lyx.git / blobdiff