X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetTabular.h;h=ddb02763fcb2a5e409156c77a36dba56eac5170d;hb=7986ac2f322aeb9c764d1c518cedd159d62f32d7;hp=00124eab7ad73c075be10455028c80c3dfff9368;hpb=f176a18434d40eead5f5a64234db9445053cbf76;p=lyx.git diff --git a/src/insets/InsetTabular.h b/src/insets/InsetTabular.h index 00124eab7a..ddb02763fc 100644 --- a/src/insets/InsetTabular.h +++ b/src/insets/InsetTabular.h @@ -10,6 +10,7 @@ * \author Jürgen Vigna * \author Edwin Leuven * \author Uwe Stöhr + * \author Scott Kostyshak * * Full author contact details are available in file CREDITS. */ @@ -23,15 +24,15 @@ #ifndef INSET_TABULAR_H #define INSET_TABULAR_H -#include "Inset.h" #include "InsetText.h" #include "Length.h" -#include "support/shared_ptr.h" - +#include #include +#include #include + namespace lyx { class Buffer; @@ -55,7 +56,7 @@ public: /// 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; @@ -68,6 +69,9 @@ public: docstring asString(bool intoInsets = true); /// docstring xhtml(XHTMLStream &, OutputParams const &) const; + /// + void addToToc(DocIterator const & di, bool output_active, + UpdateType utype, TocBackend & backend) const; private: /// unimplemented InsetTableCell(); @@ -77,8 +81,8 @@ private: // 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 + // 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 @@ -88,10 +92,10 @@ private: // 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! @@ -107,12 +111,20 @@ private: 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? + /** FIXME this is wrong for multirows, that are limited to one + * paragraph. However, we cannot test for this (see the big + * comment above). + */ + bool allowMultiPar() const { return isFixedWidth; } }; @@ -136,6 +148,14 @@ public: /// COPY_COLUMN, /// + MOVE_COLUMN_RIGHT, + /// + MOVE_COLUMN_LEFT, + /// + MOVE_ROW_DOWN, + /// + MOVE_ROW_UP, + /// SET_LINE_TOP, /// SET_LINE_BOTTOM, @@ -198,6 +218,8 @@ public: /// UNSET_ALL_LINES, /// + TOGGLE_LONGTABULAR, + /// SET_LONGTABULAR, /// UNSET_LONGTABULAR, @@ -233,6 +255,7 @@ public: UNSET_LTLASTFOOT, /// SET_LTNEWPAGE, + UNSET_LTNEWPAGE, /// TOGGLE_LTCAPTION, /// @@ -244,6 +267,8 @@ public: /// SET_SPECIAL_MULTICOLUMN, /// + TOGGLE_BOOKTABS, + /// SET_BOOKTABS, /// UNSET_BOOKTABS, @@ -272,6 +297,8 @@ public: /// SET_TABULAR_WIDTH, /// + SET_INNER_LINES, + /// LAST_ACTION }; /// @@ -296,7 +323,7 @@ public: LYX_VALIGN_MIDDLE = 1, /// LYX_VALIGN_BOTTOM = 2 - + }; /// enum HAlignment { @@ -314,7 +341,32 @@ public: /// 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 { @@ -350,9 +402,13 @@ public: /// 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; + /// 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; /// return space occupied by the second horizontal line and /// interline space above row \p row in pixels @@ -422,6 +478,9 @@ public: /// 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; /// @@ -431,17 +490,25 @@ public: /// 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 moveColumn(col_type col, ColDirection direction); + /// + void moveRow(row_type row, RowDirection direction); /// - void appendColumn(idx_type cell); + 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; /// @@ -459,13 +526,16 @@ public: /// 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; + /// + idx_type setMultiColumn(idx_type cell, idx_type number, + bool const right_border); /// void unsetMultiColumn(idx_type cell); /// @@ -475,7 +545,11 @@ public: /// bool isMultiRow(idx_type cell) const; /// - idx_type setMultiRow(idx_type cell, idx_type number); + bool hasMultiRow(row_type r) const; + /// + idx_type setMultiRow(idx_type cell, idx_type number, + bool const bottom_border, + LyXAlignment const halign); /// void unsetMultiRow(idx_type cell); /// @@ -483,9 +557,9 @@ public: /// 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; /// @@ -494,7 +568,9 @@ public: 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); @@ -503,8 +579,6 @@ public: // // 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; @@ -525,34 +599,44 @@ public: /// 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 cellInset(idx_type cell) const; - /// - shared_ptr 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 cellInset(idx_type cell); + std::shared_ptr cellInset(row_type row, col_type column); + InsetTableCell const * cellInset(idx_type cell) const; + //@} /// void setCellInset(row_type row, col_type column, - shared_ptr) const; + std::shared_ptr); /// 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 rather than a - // vector, 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 rather than a + // vector, and an InsetTableCell had a CellData as a member, + // or perhaps just had its members as members. /// class CellData { public: @@ -561,9 +645,7 @@ public: /// CellData(CellData const &); /// - CellData & operator=(CellData); - /// - void swap(CellData & rhs); + CellData & operator=(CellData const &); /// idx_type cellno; /// @@ -595,15 +677,18 @@ public: /// BoxType usebox; /// - bool rotate; + int rotate; /// docstring align_special; /// Length p_width; // this is only set for multicolumn!!! /// - shared_ptr inset; + std::shared_ptr inset; }; - CellData & cellInfo(idx_type cell) const; + /// + CellData const & cellInfo(idx_type cell) const; + /// + CellData & cellInfo(idx_type cell); /// typedef std::vector cell_vector; /// @@ -679,13 +764,13 @@ public: /// 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; // @@ -721,34 +806,37 @@ public: /// // helper function for Latex /// - void TeXTopHLine(otexstream &, row_type row, std::string const lang) const; + void TeXTopHLine(otexstream &, row_type row, std::string const & lang, + std::list) const; /// - void TeXBottomHLine(otexstream &, row_type row, std::string const lang) const; + void TeXBottomHLine(otexstream &, row_type row, std::string const & lang, + std::list) const; /// - void TeXCellPreamble(otexstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const; + void TeXCellPreamble(otexstream &, idx_type cell, bool & ismulticol, bool & ismultirow, + bool const bidi) const; /// void TeXCellPostamble(otexstream &, idx_type cell, bool ismulticol, bool ismultirow) const; /// - void TeXLongtableHeaderFooter(otexstream &, OutputParams const &) const; + void TeXLongtableHeaderFooter(otexstream &, OutputParams const &, std::list) const; /// bool isValidRow(row_type const row) const; /// void TeXRow(otexstream &, row_type const row, - OutputParams const &) const; + OutputParams const &, std::list) const; /// // helper functions for plain text /// - bool plaintextTopHLine(odocstream &, row_type row, + bool plaintextTopHLine(odocstringstream &, row_type row, std::vector const &) const; /// - bool plaintextBottomHLine(odocstream &, row_type row, + bool plaintextBottomHLine(odocstringstream &, row_type row, std::vector const &) const; /// - void plaintextPrintCell(odocstream &, + void plaintextPrintCell(odocstringstream &, OutputParams const &, idx_type cell, row_type row, col_type column, std::vector const &, - bool onlydata) const; + bool onlydata, size_t max_length) const; /// auxiliary function for docbook int docbookRow(odocstream & os, row_type, OutputParams const &) const; /// @@ -758,7 +846,9 @@ public: /// 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_; @@ -803,16 +893,23 @@ public: bool allowSpellCheck() const { return true; } /// bool canTrackChanges() const { return true; } + /// + 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 inheritFont() const { return false; } /// + bool allowsCaptionVariation(std::string const &) const; + // + bool isTable() const { return true; } + /// DisplayType display() 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; /// @@ -822,23 +919,23 @@ public: /// InsetCode lyxCode() const { return TABULAR_CODE; } /// - docstring contextMenu(BufferView const &, int, int) const; + std::string contextMenu(BufferView const &, int, int) const; /// - docstring contextMenuName() 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 cell(idx_type) const; + std::shared_ptr cell(idx_type) const; /// - shared_ptr cell(idx_type); + std::shared_ptr cell(idx_type); /// Text * getText(int) const; @@ -872,7 +969,8 @@ public: /// Update the counters of this inset and of its contents void updateBuffer(ParIterator const &, UpdateType); /// - void addToToc(DocIterator const &) const; + void addToToc(DocIterator const & di, bool output_active, + UpdateType utype, TocBackend & backend) const; /// bool completionSupported(Cursor const &) const; @@ -894,6 +992,9 @@ public: 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; } @@ -907,6 +1008,8 @@ public: /// 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 /// @@ -918,10 +1021,20 @@ private: /// void doDispatch(Cursor & cur, FuncRequest & cmd); /// + bool getFeatureStatus(Cursor & cur, std::string const & s, + std::string const & argument, FuncStatus & status) const; + /// 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; @@ -929,7 +1042,7 @@ private: 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, @@ -939,8 +1052,6 @@ private: /// int cellYPos(idx_type cell) const; /// - void resetPos(Cursor & cur) const; - /// bool copySelection(Cursor & cur); /// bool pasteClipboard(Cursor & cur); @@ -957,17 +1068,11 @@ private: /// 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_; - /// The vertical offset of the table due to the vertical - /// alignment with respect to the baseline. - mutable int offset_valign_; + /// true when selecting rows with the mouse bool rowselect_; /// true when selecting columns with the mouse @@ -977,7 +1082,7 @@ private: 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