X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ftabular.h;h=b972d0aa3c7bc4b5330790c1e45e74048625bd95;hb=ba62665f966508db5a4de6864f4aa7374c5a5356;hp=5d1ec5b74f2ec588e5f0cccdefb75882c2d2b800;hpb=485313c6d77eaddfdbc1a44f7e7e019927733d16;p=lyx.git diff --git a/src/tabular.h b/src/tabular.h index 5d1ec5b74f..b972d0aa3c 100644 --- a/src/tabular.h +++ b/src/tabular.h @@ -1,32 +1,34 @@ // -*- C++ -*- -/* This file is part of - * ====================================================== +/** + * \file tabular.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * LyX, The Document Processor + * \author Lars Gullik Bjønnes + * \author Matthias Ettrich + * \author André Pönitz + * \author Jürgen Vigna * - * Copyright 2000-2001 The LyX Team. - * - * @author: Jürgen Vigna - * - * ====================================================== */ + * Full author contact details are available in file CREDITS. + */ + #ifndef TABULAR_H #define TABULAR_H -#include "layout.h" -#include "LString.h" #include "lyxlength.h" - #include "insets/insettext.h" +#include + #include #include + +namespace lyx { + class InsetTabular; -class BufferParams; -class LaTeXFeatures; -class LatexRunParams; -class Buffer; -class LyXLex; +class LCursor; +class OutputParams; /* The features the text class offers for tables */ @@ -44,6 +46,10 @@ public: /// DELETE_COLUMN, /// + COPY_ROW, + /// + COPY_COLUMN, + /// TOGGLE_LINE_TOP, /// TOGGLE_LINE_BOTTOM, @@ -64,7 +70,7 @@ public: /// VALIGN_BOTTOM, /// - VALIGN_CENTER, + VALIGN_MIDDLE, /// M_TOGGLE_LINE_TOP, /// @@ -84,7 +90,7 @@ public: /// M_VALIGN_BOTTOM, /// - M_VALIGN_CENTER, + M_VALIGN_MIDDLE, /// MULTICOLUMN, /// @@ -128,6 +134,16 @@ public: /// SET_SPECIAL_MULTI, /// + SET_BOOKTABS, + /// + UNSET_BOOKTABS, + /// + SET_TOP_SPACE, + /// + SET_BOTTOM_SPACE, + /// + SET_INTERLINE_SPACE, + /// LAST_ACTION }; /// @@ -147,7 +163,7 @@ public: /// LYX_VALIGN_BOTTOM = 1, /// - LYX_VALIGN_CENTER = 2 + LYX_VALIGN_MIDDLE = 2 }; enum BoxType { @@ -159,7 +175,8 @@ public: BOX_MINIPAGE = 2 }; - struct ltType { + class ltType { + public: // constructor ltType(); // we have this header type (is set in the getLT... functions) @@ -174,140 +191,155 @@ public: 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(-1); + /// constructor - LyXTabular(BufferParams const &, - InsetTabular *, int columns_arg, int rows_arg); - /// sort of copy constructor - LyXTabular(BufferParams const &, - InsetTabular *, LyXTabular const &); - /// - explicit - LyXTabular(Buffer const *, InsetTabular *, LyXLex & lex); - /// - LyXTabular * clone(BufferParams const &, InsetTabular *); + LyXTabular(BufferParams const &, col_type columns_arg, + row_type rows_arg); /// Returns true if there is a topline, returns false if not - bool topLine(int cell, bool onlycolumn = false) const; + bool topLine(idx_type cell, bool wholerow = false) const; /// Returns true if there is a topline, returns false if not - bool bottomLine(int cell, bool onlycolumn = false) const; + bool bottomLine(idx_type cell, bool wholerow = false) const; /// Returns true if there is a topline, returns false if not - bool leftLine(int cell, bool onlycolumn = false) const; + bool leftLine(idx_type cell, bool wholecolumn = false) const; /// Returns true if there is a topline, returns false if not - bool rightLine(int cell, bool onlycolumn = false) const; + bool rightLine(idx_type cell, bool wholecolumn = false) const; /// - bool topAlreadyDrawn(int cell) const; + bool topAlreadyDrawn(idx_type cell) const; /// - bool leftAlreadyDrawn(int cell) const; + bool leftAlreadyDrawn(idx_type cell) const; /// - bool isLastRow(int 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 getAdditionalHeight(int row) const; - /// - int getAdditionalWidth(int cell) const; + int getAdditionalWidth(idx_type cell) const; /* returns the maximum over all rows */ /// - int getWidthOfColumn(int cell) const; + int getWidthOfColumn(idx_type cell) const; /// int getWidthOfTabular() const; /// - int getAscentOfRow(int row) const; + int getAscentOfRow(row_type row) const; /// - int getDescentOfRow(int row) const; + int getDescentOfRow(row_type row) const; /// int getHeightOfTabular() const; - /// Returns true if a complete update is necessary, otherwise false - bool setAscentOfRow(int row, int height); - /// Returns true if a complete update is necessary, otherwise false - bool setDescentOfRow(int row, int height); - /// Returns true if a complete update is necessary, otherwise false - bool setWidthOfCell(int cell, int new_width); - /// Returns true if a complete update is necessary, otherwise false - bool setAllLines(int cell, bool line); - /// Returns true if a complete update is necessary, otherwise false - bool setTopLine(int cell, bool line, bool onlycolumn = false); - /// Returns true if a complete update is necessary, otherwise false - bool setBottomLine(int cell, bool line, bool onlycolumn = false); - /// Returns true if a complete update is necessary, otherwise false - bool setLeftLine(int cell, bool line, bool onlycolumn = false); - /// Returns true if a complete update is necessary, otherwise false - bool setRightLine(int cell, bool line, bool onlycolumn = false); - /// Returns true if a complete update is necessary, otherwise false - bool setAlignment(int cell, LyXAlignment align, + /// + void setAscentOfRow(row_type row, int height); + /// + void setDescentOfRow(row_type row, int height); + /// + void setWidthOfCell(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); - /// Returns true if a complete update is necessary, otherwise false - bool setVAlignment(int cell, VAlignment align, + /// + void setVAlignment(idx_type cell, VAlignment align, bool onlycolumn = false); /// - bool setColumnPWidth(int cell, LyXLength const & width); + void setColumnPWidth(LCursor &, idx_type, LyXLength const &); /// - bool setMColumnPWidth(int cell, LyXLength const & width); + bool setMColumnPWidth(LCursor &, idx_type, LyXLength const &); /// - bool setAlignSpecial(int cell, string const & special, Feature what); + void setAlignSpecial(idx_type cell, docstring const & special, + Feature what); /// - LyXAlignment getAlignment(int cell, bool onlycolumn = false) const; + LyXAlignment getAlignment(idx_type cell, + bool onlycolumn = false) const; /// - VAlignment getVAlignment(int cell, bool onlycolumn = false) const; + VAlignment getVAlignment(idx_type cell, + bool onlycolumn = false) const; /// - LyXLength const getPWidth(int cell) const; + LyXLength const getPWidth(idx_type cell) const; /// - LyXLength const getColumnPWidth(int cell) const; + LyXLength const getColumnPWidth(idx_type cell) const; /// - LyXLength const getMColumnPWidth(int cell) const; + LyXLength const getMColumnPWidth(idx_type cell) const; /// - string const getAlignSpecial(int cell, int what) const; + docstring const getAlignSpecial(idx_type cell, int what) const; /// - int getWidthOfCell(int cell) const; + int getWidthOfCell(idx_type cell) const; /// - int getBeginningOfTextInCell(int cell) const; + int getBeginningOfTextInCell(idx_type cell) const; /// - void appendRow(BufferParams const &, int cell); + void appendRow(BufferParams const &, idx_type cell); /// - void deleteRow(int row); + void deleteRow(row_type row); /// - void appendColumn(BufferParams const &, int cell); + void copyRow(BufferParams const &, row_type); /// - void deleteColumn(int column); + void appendColumn(BufferParams const &, idx_type cell); /// - bool isFirstCellInRow(int cell) const; + void deleteColumn(col_type column); /// - int getFirstCellInRow(int row) const; + void copyColumn(BufferParams const &, col_type); /// - bool isLastCellInRow(int cell) const; + bool isFirstCellInRow(idx_type cell) const; /// - int getLastCellInRow(int row) const; + idx_type getFirstCellInRow(row_type row) const; /// - int getNumberOfCells() const; + bool isLastCellInRow(idx_type cell) const; /// - int numberOfCellsInRow(int cell) const; + idx_type getLastCellInRow(row_type row) const; /// - void write(Buffer const *, std::ostream &) const; + idx_type getNumberOfCells() const; /// - void read(Buffer const *, LyXLex &); + idx_type numberOfCellsInRow(idx_type cell) const; /// - int latex(Buffer const *, std::ostream &, - LatexRunParams const &) const; + void write(Buffer const &, std::ostream &) const; /// - int docbook(Buffer const * buf, std::ostream & os, bool mixcont) const; + void read(Buffer const &, LyXLex &); /// - int ascii(Buffer const *, std::ostream &, int const depth, - bool onlydata, unsigned char delim) const; + 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, unsigned char delim) const; + /// + bool isMultiColumn(idx_type cell) const; + /// + bool isMultiColumnReal(idx_type cell) const; /// - bool isMultiColumn(int cell, bool real = false) const; + void setMultiColumn(Buffer *, idx_type cell, idx_type number); /// - void setMultiColumn(Buffer *, int cell, int number); + idx_type unsetMultiColumn(idx_type cell); // returns number of new cells /// - int unsetMultiColumn(int cell); // returns number of new cells + bool isPartOfMultiColumn(row_type row, col_type column) const; /// - bool isPartOfMultiColumn(int row, int column) const; + row_type row_of_cell(idx_type cell) const; /// - int row_of_cell(int cell) const; + col_type column_of_cell(idx_type cell) const; /// - int column_of_cell(int cell) const; + col_type right_column_of_cell(idx_type cell) const; /// - int right_column_of_cell(int cell) const; + void setBookTabs(bool); + /// + bool useBookTabs() const; /// void setLongTabular(bool); /// @@ -317,47 +349,47 @@ public: /// bool getRotateTabular() const; /// - void setRotateCell(int cell, bool); + void setRotateCell(idx_type cell, bool); /// - bool getRotateCell(int cell) const; + bool getRotateCell(idx_type cell) const; /// bool needRotating() const; /// - bool isLastCell(int cell) const; + bool isLastCell(idx_type cell) const; /// - int getCellAbove(int cell) const; + idx_type getCellAbove(idx_type cell) const; /// - int getCellBelow(int cell) const; + idx_type getCellBelow(idx_type cell) const; /// - int getLastCellAbove(int cell) const; + idx_type getLastCellAbove(idx_type cell) const; /// - int getLastCellBelow(int cell) const; + idx_type getLastCellBelow(idx_type cell) const; /// - int getCellNumber(int row, int column) const; + idx_type getCellNumber(row_type row, col_type column) const; /// - void setUsebox(int cell, BoxType); + void setUsebox(idx_type cell, BoxType); /// - BoxType getUsebox(int cell) const; + BoxType getUsebox(idx_type cell) const; // // Long Tabular Options support functions /// - bool checkLTType(int row, ltType const &) const; + bool checkLTType(row_type row, ltType const &) const; /// - void setLTHead(int row, bool flag, ltType const &, bool first); + void setLTHead(row_type row, bool flag, ltType const &, bool first); /// - bool getRowOfLTHead(int row, ltType &) const; + bool getRowOfLTHead(row_type row, ltType &) const; /// - bool getRowOfLTFirstHead(int row, ltType &) const; + bool getRowOfLTFirstHead(row_type row, ltType &) const; /// - void setLTFoot(int row, bool flag, ltType const &, bool last); + void setLTFoot(row_type row, bool flag, ltType const &, bool last); /// - bool getRowOfLTFoot(int row, ltType &) const; + bool getRowOfLTFoot(row_type row, ltType &) const; /// - bool getRowOfLTLastFoot(int row, ltType &) const; + bool getRowOfLTLastFoot(row_type row, ltType &) const; /// - void setLTNewPage(int row, bool what); + void setLTNewPage(row_type row, bool what); /// - bool getLTNewPage(int row) const; + bool getLTNewPage(row_type row) const; /// bool haveLTHead() const; /// @@ -369,33 +401,37 @@ public: /// // end longtable support /// - InsetText * getCellInset(int cell) const; + boost::shared_ptr getCellInset(idx_type cell) const; /// - InsetText * getCellInset(int row, int column) const; - /// Search for \param inset in the tabular, with the - /// additional hint that it could be at \param maybe_cell - int getCellFromInset(Inset const * inset, int maybe_cell = -1) const; + boost::shared_ptr getCellInset(row_type row, + col_type column) const; /// - int rows() const { return rows_; } + void setCellInset(row_type row, col_type column, + boost::shared_ptr) const; + /// Search for \param inset in the tabular, with the /// - int columns() const { return columns_;} + idx_type getCellFromInset(InsetBase const * inset) const; /// - void validate(LaTeXFeatures &) const; + row_type rows() const { return rows_; } /// - void getLabelList(std::vector &) const; + col_type columns() const { return columns_;} /// - /// recalculate the widths/heights only! - void reinit(); + void validate(LaTeXFeatures &) const; /// //private: /// - mutable int cur_cell; - /// - struct cellstruct { + class cellstruct { + public: /// cellstruct(BufferParams const &); /// - int cellno; + cellstruct(cellstruct const &); + /// + cellstruct & operator=(cellstruct); + /// + void swap(cellstruct & rhs); + /// + idx_type cellno; /// int width_of_cell; /// @@ -417,20 +453,21 @@ public: /// bool rotate; /// - string align_special; + docstring align_special; /// LyXLength p_width; // this is only set for multicolumn!!! /// - InsetText inset; + boost::shared_ptr inset; }; - cellstruct * cellinfo_of_cell(int cell) const; + cellstruct & cellinfo_of_cell(idx_type cell) const; /// typedef std::vector cell_vector; /// typedef std::vector cell_vvector; /// - struct rowstruct { + class rowstruct { + public: /// rowstruct(); /// @@ -441,6 +478,18 @@ public: bool top_line; /// bool bottom_line; + /// Extra space between the top line and this row + LyXLength 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 + LyXLength 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 + LyXLength 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; @@ -457,7 +506,8 @@ public: typedef std::vector row_vector; /// - struct columnstruct { + class columnstruct { + public: /// columnstruct(); /// @@ -473,21 +523,21 @@ public: /// LyXLength p_width; /// - string align_special; + docstring align_special; }; /// typedef std::vector column_vector; /// - int rows_; + row_type rows_; /// - int columns_; + col_type columns_; /// - int numberofcells; + idx_type numberofcells; /// - std::vector rowofcell; + std::vector rowofcell; /// - std::vector columnofcell; + std::vector columnofcell; /// row_vector row_info; /// @@ -497,6 +547,8 @@ public: /// int width_of_tabular; /// + bool use_booktabs; + /// bool rotate; // // for long tabulars @@ -510,70 +562,70 @@ public: ltType endfoot; /// endlastfoot data ltType endlastfoot; - // - /// - InsetTabular * owner_; /// - void init(BufferParams const &, - int columns_arg, int rows_arg, LyXTabular const * lt = 0); - /// - void Reinit(bool reset_widths = true); + void init(BufferParams const &, row_type rows_arg, + col_type columns_arg); /// - LyXTabular & operator=(LyXTabular const &); - /// - void set_row_column_number_info(bool oldformat = false); + void set_row_column_number_info(); /// Returns true if a complete update is necessary, otherwise false - bool setWidthOfMulticolCell(int cell, int new_width); + bool setWidthOfMulticolCell(idx_type cell, int new_width); /// - void recalculateMulticolumnsOfColumn(int column); + void recalculateMulticolumnsOfColumn(col_type column); /// Returns true if change - bool calculate_width_of_column(int column); + void calculate_width_of_column(col_type column); /// - bool calculate_width_of_column_NMC(int column); // no multi cells + bool calculate_width_of_column_NMC(col_type column); // no multi cells /// void calculate_width_of_tabular(); /// - void delete_column(int column); - /// - int cells_in_multicolumn(int cell) const; + void delete_column(col_type column); /// - BoxType useParbox(int cell) const; + idx_type cells_in_multicolumn(idx_type cell) const; /// - void setHeaderFooterRows(int header, int fheader, int footer, int lfooter); + BoxType useParbox(idx_type cell) const; /// // helper function for Latex returns number of newlines /// - int TeXTopHLine(std::ostream &, int row) const; + int TeXTopHLine(odocstream &, row_type row) const; /// - int TeXBottomHLine(std::ostream &, int row) const; + int TeXBottomHLine(odocstream &, row_type row) const; /// - int TeXCellPreamble(std::ostream &, int cell) const; + int TeXCellPreamble(odocstream &, idx_type cell) const; /// - int TeXCellPostamble(std::ostream &, int cell) const; + int TeXCellPostamble(odocstream &, idx_type cell) const; /// - int TeXLongtableHeaderFooter(std::ostream &, Buffer const * buf, - LatexRunParams const &) const; + int TeXLongtableHeaderFooter(odocstream &, Buffer const & buf, + OutputParams const &) const; /// - bool isValidRow(int const row) const; + bool isValidRow(row_type const row) const; /// - int TeXRow(std::ostream &, int const row, Buffer const * buf, - LatexRunParams const &) const; + int TeXRow(odocstream &, row_type const row, Buffer const & buf, + OutputParams const &) const; /// - // helper function for ASCII returns number of newlines + // helper functions for plain text /// - int asciiTopHLine(std::ostream &, int row, - std::vector const &) const; + bool plaintextTopHLine(odocstream &, row_type row, + std::vector const &) const; /// - int asciiBottomHLine(std::ostream &, int row, - std::vector const &) const; + bool plaintextBottomHLine(odocstream &, row_type row, + std::vector const &) const; /// - int asciiPrintCell(Buffer const *, std::ostream &, - int cell, int row, int column, - std::vector const &, - bool onlydata) const; + void plaintextPrintCell(Buffer const &, odocstream &, + OutputParams const &, + idx_type cell, row_type row, col_type column, + std::vector const &, + bool onlydata) const; /// auxiliary function for docbook - int docbookRow(Buffer const * buf, std::ostream & os, int row) const; + int docbookRow(Buffer const & buf, odocstream & os, row_type, + OutputParams const &) const; + +private: + /// renumber cells after structural changes + void fixCellNums(); }; + +} // namespace lyx + #endif