X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetTabular.h;h=96db31a934a7be437137145ef5374f3cf9f191e9;hb=2203d7aa0a8e9d64666498fb26eb17f699c2f52b;hp=3275e8b8bfcbdd6c1b76514af746cd5a253d59b4;hpb=884bb0c4bce9dc151dc9c69b30bffeb3db8accd6;p=lyx.git diff --git a/src/insets/InsetTabular.h b/src/insets/InsetTabular.h index 3275e8b8bf..96db31a934 100644 --- a/src/insets/InsetTabular.h +++ b/src/insets/InsetTabular.h @@ -4,34 +4,22 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * \author Matthias Ettrich - * \author André Pönitz - * \author Jürgen Vigna + * \author André Pönitz + * \author Jürgen Vigna + * \author Edwin Leuven + * \author Uwe Stöhr * * 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 @@ -40,7 +28,7 @@ #include "Layout.h" #include "Length.h" -#include +#include "support/shared_ptr.h" #include #include @@ -48,7 +36,6 @@ namespace lyx { class Buffer; -class BufferParams; class BufferView; class CompletionList; class CursorSlice; @@ -56,6 +43,7 @@ class InsetTableCell; class FuncStatus; class Lexer; class Paragraph; +class XHTMLStream; namespace frontend { class Painter; } @@ -84,12 +72,20 @@ public: /// COPY_COLUMN, /// - TOGGLE_LINE_TOP, + SET_LINE_TOP, /// - TOGGLE_LINE_BOTTOM, + SET_LINE_BOTTOM, /// - TOGGLE_LINE_LEFT, + 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, @@ -100,6 +96,8 @@ public: /// ALIGN_BLOCK, /// + ALIGN_DECIMAL, + /// VALIGN_TOP, /// VALIGN_BOTTOM, @@ -120,6 +118,8 @@ public: /// MULTICOLUMN, /// + MULTIROW, + /// SET_ALL_LINES, /// UNSET_ALL_LINES, @@ -160,9 +160,13 @@ public: /// SET_LTNEWPAGE, /// + TOGGLE_LTCAPTION, + /// SET_SPECIAL_COLUMN, /// - SET_SPECIAL_MULTI, + SET_SPECIAL_MULTICOLUMN, + /// + SET_SPECIAL_MULTIROW, /// SET_BOOKTABS, /// @@ -176,6 +180,20 @@ public: /// SET_BORDER_LINES, /// + TABULAR_VALIGN_TOP, + /// + TABULAR_VALIGN_MIDDLE, + /// + TABULAR_VALIGN_BOTTOM, + /// + LONGTABULAR_ALIGN_LEFT, + /// + LONGTABULAR_ALIGN_CENTER, + /// + LONGTABULAR_ALIGN_RIGHT, + /// + SET_DECIMAL_POINT, + /// LAST_ACTION }; /// @@ -185,7 +203,11 @@ public: /// CELL_BEGIN_OF_MULTICOLUMN, /// - CELL_PART_OF_MULTICOLUMN + CELL_PART_OF_MULTICOLUMN, + /// + CELL_BEGIN_OF_MULTIROW, + /// + CELL_PART_OF_MULTIROW }; /// @@ -193,9 +215,19 @@ public: /// LYX_VALIGN_TOP = 0, /// - LYX_VALIGN_BOTTOM = 1, + LYX_VALIGN_MIDDLE = 1, + /// + LYX_VALIGN_BOTTOM = 2 + + }; + /// + enum HAlignment { + /// + LYX_LONGTABULAR_ALIGN_LEFT = 0, + /// + LYX_LONGTABULAR_ALIGN_CENTER = 1, /// - LYX_VALIGN_MIDDLE = 2 + LYX_LONGTABULAR_ALIGN_RIGHT = 2 }; enum BoxType { @@ -233,7 +265,7 @@ public: static const idx_type npos = static_cast(-1); /// constructor - Tabular(Buffer const &, 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; @@ -244,27 +276,26 @@ public: /// 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 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; @@ -273,10 +304,6 @@ public: /// 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); @@ -314,15 +341,9 @@ public: /// Length const getPWidth(idx_type cell) const; /// - Length const getColumnPWidth(idx_type cell) const; - /// - Length const getMColumnPWidth(idx_type cell) const; + int textHOffset(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; + int textVOffset(idx_type cell) const; /// void appendRow(idx_type cell); /// @@ -336,44 +357,46 @@ public: /// void copyColumn(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 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; - // + /// int docbook(odocstream & os, OutputParams const &) const; /// + docstring xhtml(XHTMLStream & os, OutputParams const &) const; + /// void plaintext(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(idx_type cell, idx_type number); + idx_type setMultiColumn(idx_type cell, idx_type number); /// - idx_type unsetMultiColumn(idx_type cell); // returns number of new cells + 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; + /// + idx_type setMultiRow(idx_type cell, idx_type number); + /// + 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); /// bool getRotateCell(idx_type cell) const; @@ -412,6 +435,10 @@ public: /// bool getLTNewPage(row_type row) const; /// + idx_type setLTCaption(row_type row, bool what); + /// + bool ltCaption(row_type row) const; + /// bool haveLTHead() const; /// bool haveLTFirstHead() const; @@ -420,27 +447,31 @@ public: /// bool haveLTLastFoot() const; /// + bool haveLTCaption() const; + /// // end longtable support /// - boost::shared_ptr cellInset(idx_type cell) const; + shared_ptr cellInset(idx_type cell) const; /// - boost::shared_ptr cellInset(row_type row, + shared_ptr cellInset(row_type row, col_type column) const; /// void setCellInset(row_type row, col_type column, - boost::shared_ptr) const; + shared_ptr) const; /// Search for \param inset in the tabular, with the /// - idx_type cellFromInset(Inset const * inset) const; - /// 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 rather than a + // vector, and an InsetTableCell had a CellData as a member, + // or perhaps just had its members as members. /// class CellData { public: /// - CellData(Buffer const &, Tabular const &); + CellData(Buffer *); /// CellData(CellData const &); /// @@ -454,9 +485,17 @@ public: /// int multicolumn; /// + int multirow; + /// 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; /// @@ -474,7 +513,7 @@ public: /// Length p_width; // this is only set for multicolumn!!! /// - boost::shared_ptr inset; + shared_ptr inset; }; CellData & cellInfo(idx_type cell) const; /// @@ -491,10 +530,6 @@ public: 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 @@ -518,6 +553,8 @@ public: bool endlastfoot; /// row for a newpage bool newpage; + /// caption + bool caption; }; /// typedef std::vector row_vector; @@ -532,15 +569,13 @@ public: /// VAlignment valignment; /// - bool left_line; - /// - bool right_line; - /// int width; /// Length p_width; /// docstring align_special; + /// + docstring decimal_point; }; /// typedef std::vector column_vector; @@ -561,8 +596,12 @@ public: bool use_booktabs; /// bool rotate; + /// + VAlignment tabular_valignment; // // for long tabulars + /// + HAlignment longtabular_alignment; // bool is_long_tabular; /// endhead data @@ -575,26 +614,30 @@ public: ltType endlastfoot; /// - void init(Buffer const &, 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); /// return true of update is needed bool updateColumnWidths(); /// idx_type columnSpan(idx_type cell) const; /// + idx_type rowSpan(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 TeXTopHLine(odocstream &, row_type row, std::string const lang) const; /// - int TeXBottomHLine(odocstream &, row_type row) const; + int TeXBottomHLine(odocstream &, row_type row, std::string const lang) const; /// - int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol) const; + int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const; /// - int TeXCellPostamble(odocstream &, idx_type cell, bool ismulticol) const; + int TeXCellPostamble(odocstream &, idx_type cell, bool ismulticol, bool ismultirow) const; /// int TeXLongtableHeaderFooter(odocstream &, OutputParams const &) const; /// @@ -618,14 +661,16 @@ public: bool onlydata) const; /// auxiliary function for docbook int docbookRow(odocstream & os, row_type, OutputParams const &) const; + /// + docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &) const; /// change associated Buffer - void setBuffer(Buffer const & buffer) { buffer_ = &buffer; } + void setBuffer(Buffer & buffer); /// retrieve associated Buffer - Buffer const & buffer() const { return *buffer_; } + Buffer & buffer() const { return *buffer_; } private: - Buffer const * buffer_; + Buffer * buffer_; }; // Tabular @@ -635,37 +680,68 @@ class InsetTableCell : public InsetText { public: /// - InsetTableCell(Buffer const & buf, - Tabular::CellData const * cd, Tabular const * t); + InsetTableCell(Buffer * buf); /// InsetCode lyxCode() const { return CELL_CODE; } /// Inset * clone() { return new InsetTableCell(*this); } /// - virtual bool useEmptyLayout() const { return true; } - /// - virtual bool forceEmptyLayout(idx_type = 0) const; - /// - virtual bool allowParagraphCustomization(idx_type = 0) const; - /// bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus & status) const; /// - virtual bool neverIndent() { return true; } + void toggleFixedWidth(bool fw) { isFixedWidth = fw; } /// - void setCellData(Tabular::CellData const * cd) { cell_data_ = cd; } + void setContentAlignment(LyXAlignment al) {contentAlign = al; } + /// writes the contents of the cell as a string, optionally + /// descending into insets + docstring asString(bool intoInsets = true); /// - void setTabular(Tabular const * t) { table_ = t; } + 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; } /// - Tabular::CellData const * cell_data_; + virtual bool forcePlainLayout(idx_type = 0) const; /// - Tabular const * table_; + virtual bool allowParagraphCustomization(idx_type = 0) const; + /// Is the width forced to some value? + bool hasFixedWidth() const { return isFixedWidth; } }; @@ -673,10 +749,13 @@ class InsetTabular : public Inset { public: /// - InsetTabular(Buffer const &, row_type rows = 1, + InsetTabular(Buffer *, row_type rows = 1, col_type columns = 1); /// ~InsetTabular(); + /// + void setBuffer(Buffer & buffer); + /// static void string2params(std::string const &, InsetTabular &); /// @@ -692,9 +771,9 @@ public: /// void drawSelection(PainterInfo & pi, int x, int y) const; /// - docstring editMessage() const; + bool editable() const { return true; } /// - EDITABLE editable() const { return HIGHLY_EDITABLE; } + bool hasSettings() const { return true; } /// bool insetAllowed(InsetCode code) const; /// @@ -706,7 +785,7 @@ public: insets that may contain several paragraphs */ bool noFontChange() const { return true; } /// - DisplayType display() const { return tabular.is_long_tabular ? AlignCenter : Inline; } + DisplayType display() const; /// int latex(odocstream &, OutputParams const &) const; /// @@ -714,6 +793,8 @@ public: /// int docbook(odocstream &, OutputParams const &) const; /// + docstring xhtml(XHTMLStream &, OutputParams const &) const; + /// void validate(LaTeXFeatures & features) const; /// InsetCode lyxCode() const { return TABULAR_CODE; } @@ -727,36 +808,31 @@ public: /// 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 cell(idx_type) const; + shared_ptr cell(idx_type) const; /// - boost::shared_ptr cell(idx_type); + shared_ptr cell(idx_type); /// Text * getText(int) const; /// set the change for the entire inset void setChange(Change const & change); /// accept the changes within the inset - void acceptChanges(BufferParams const & bparams); + void acceptChanges(); /// reject the changes within the inset - void rejectChanges(BufferParams const & bparams); + void rejectChanges(); // 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; /// - virtual bool forceEmptyLayout(idx_type cell = 0) const; + virtual bool forcePlainLayout(idx_type cell = 0) const; /// - virtual bool useEmptyLayout() { return true; } - /// - void addPreview(graphics::PreviewLoader &) const; + void addPreview(DocIterator const & inset_pos, + graphics::PreviewLoader &) const; /// lock cell with given index void edit(Cursor & cur, bool front, EntryDirection entry_from); @@ -767,9 +843,11 @@ public: /// 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 - void updateLabels(ParIterator const &); + bool descendable(BufferView const &) const { return true; } + /// Update the counters of this inset and of its contents + void updateBuffer(ParIterator const &, UpdateType); + /// + void addToToc(DocIterator const &); /// bool completionSupported(Cursor const &) const; @@ -789,14 +867,21 @@ public: bool insertCompletion(Cursor & cur, docstring const & s, bool finished); /// void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) 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 + /// descending into the insets + docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true); + /// Returns whether the cell in the specified row and column is selected. + bool isCellSelected(Cursor & cur, row_type row, col_type col) const; // // Public structures and variables /// @@ -816,7 +901,7 @@ private: /// void drawCellLines(frontend::Painter &, int x, int y, row_type row, - idx_type cell, bool erased) const; + idx_type cell, Change const & change) const; /// void setCursorFromCoordinates(Cursor & cur, int x, int y) const; @@ -831,8 +916,6 @@ private: /// void resetPos(Cursor & cur) const; /// - void removeTabularRow(); - /// bool copySelection(Cursor & cur); /// bool pasteClipboard(Cursor & cur); @@ -843,8 +926,6 @@ private: col_type & cs, col_type & ce) const; /// bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste); - /// are we operating on several cells? - bool tablemode(Cursor & cur) const; /// return the "Manhattan distance" to nearest corner int dist(BufferView &, idx_type cell, int x, int y) const; @@ -867,6 +948,9 @@ private: 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