]> git.lyx.org Git - lyx.git/blobdiff - src/tabular.h
Allows editing when the Prefs dialog is opened; fix bug 3140:
[lyx.git] / src / tabular.h
index f4cdf9cf80bc488aa3f412d8a91acc6a26846728..163f33a2b746aa364181e4bd20f9b6f967078b52 100644 (file)
 #include "lyxlength.h"
 #include "insets/insettext.h"
 
+#include <boost/shared_ptr.hpp>
+
 #include <iosfwd>
 #include <vector>
 
+
+namespace lyx {
+
 class InsetTabular;
+class LCursor;
 class OutputParams;
 
 /* The features the text class offers for tables */
@@ -40,6 +46,10 @@ public:
                ///
                DELETE_COLUMN,
                ///
+               COPY_ROW,
+               ///
+               COPY_COLUMN,
+               ///
                TOGGLE_LINE_TOP,
                ///
                TOGGLE_LINE_BOTTOM,
@@ -124,6 +134,16 @@ public:
                ///
                SET_SPECIAL_MULTI,
                ///
+               SET_BOOKTABS,
+               ///
+               UNSET_BOOKTABS,
+               ///
+               SET_TOP_SPACE,
+               ///
+               SET_BOTTOM_SPACE,
+               ///
+               SET_INTERLINE_SPACE,
+               ///
                LAST_ACTION
        };
        ///
@@ -155,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)
@@ -170,139 +191,156 @@ 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<idx_type>(-1);
+
        /// constructor
-       LyXTabular(BufferParams const &, int columns_arg, int rows_arg);
+       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;
        ///
-       void setAscentOfRow(int row, int height);
+       void setAscentOfRow(row_type row, int height);
        ///
-       void setDescentOfRow(int row, int height);
+       void setDescentOfRow(row_type row, int height);
        ///
-       void setWidthOfCell(int cell, int new_width);
+       void setWidthOfCell(idx_type cell, int new_width);
        ///
-       void setAllLines(int cell, bool line);
+       void setAllLines(idx_type cell, bool line);
        ///
-       void setTopLine(int cell, bool line, bool onlycolumn = false);
+       void setTopLine(idx_type cell, bool line, bool wholerow = false);
        ///
-       void setBottomLine(int cell, bool line, bool onlycolumn = false);
+       void setBottomLine(idx_type cell, bool line, bool wholerow = false);
        ///
-       void setLeftLine(int cell, bool line, bool onlycolumn = false);
+       void setLeftLine(idx_type cell, bool line, bool wholecolumn = false);
        ///
-       void setRightLine(int cell, bool line, bool onlycolumn = false);
+       void setRightLine(idx_type cell, bool line, bool wholecolumn = false);
        ///
-       void setAlignment(int cell, LyXAlignment align,
+       void setAlignment(idx_type cell, LyXAlignment align,
                          bool onlycolumn = false);
        ///
-       void setVAlignment(int cell, VAlignment align,
+       void setVAlignment(idx_type cell, VAlignment align,
                           bool onlycolumn = false);
        ///
-       void setColumnPWidth(int cell, LyXLength const & width);
+       void setColumnPWidth(LCursor &, idx_type, LyXLength const &);
+       ///
+       bool setMColumnPWidth(LCursor &, idx_type, LyXLength const &);
        ///
-       bool setMColumnPWidth(int cell, LyXLength const & width);
+       void setAlignSpecial(idx_type cell, docstring const & special,
+                            Feature what);
        ///
-       void setAlignSpecial(int cell, std::string const & special, Feature what);
+       LyXAlignment getAlignment(idx_type cell,
+                                 bool onlycolumn = false) const;
        ///
-       LyXAlignment getAlignment(int cell, bool onlycolumn = false) const;
+       VAlignment getVAlignment(idx_type cell,
+                                bool onlycolumn = false) const;
        ///
-       VAlignment getVAlignment(int cell, bool onlycolumn = false) const;
+       LyXLength const getPWidth(idx_type cell) const;
        ///
-       LyXLength const getPWidth(int cell) const;
+       LyXLength const getColumnPWidth(idx_type cell) const;
        ///
-       LyXLength const getColumnPWidth(int cell) const;
+       LyXLength const getMColumnPWidth(idx_type cell) const;
        ///
-       LyXLength const getMColumnPWidth(int cell) const;
+       docstring const getAlignSpecial(idx_type cell, int what) const;
        ///
-       std::string const getAlignSpecial(int cell, int what) const;
+       int getWidthOfCell(idx_type cell) const;
        ///
-       int getWidthOfCell(int cell) const;
+       int getBeginningOfTextInCell(idx_type cell) const;
        ///
-       int getBeginningOfTextInCell(int cell) const;
+       void appendRow(BufferParams const &, idx_type cell);
        ///
-       void appendRow(BufferParams const &, int cell);
+       void deleteRow(row_type row);
        ///
-       void deleteRow(int row);
+       void copyRow(BufferParams const &, row_type);
        ///
-       void appendColumn(BufferParams const &, int cell);
+       void appendColumn(BufferParams const &, idx_type cell);
        ///
-       void deleteColumn(int column);
+       void deleteColumn(col_type column);
        ///
-       bool isFirstCellInRow(int cell) const;
+       void copyColumn(BufferParams const &, col_type);
        ///
-       int getFirstCellInRow(int row) const;
+       bool isFirstCellInRow(idx_type cell) const;
        ///
-       bool isLastCellInRow(int cell) const;
+       idx_type getFirstCellInRow(row_type row) const;
        ///
-       int getLastCellInRow(int row) const;
+       bool isLastCellInRow(idx_type cell) const;
        ///
-       int getNumberOfCells() const;
+       idx_type getLastCellInRow(row_type row) const;
        ///
-       int numberOfCellsInRow(int cell) const;
+       idx_type getNumberOfCells() const;
+       ///
+       idx_type numberOfCellsInRow(idx_type cell) const;
        ///
        void write(Buffer const &, std::ostream &) const;
        ///
        void read(Buffer const &, LyXLex &);
        ///
-       int latex(Buffer const &, std::ostream &,
-                 OutputParams const &) const;
+       int latex(Buffer const &, odocstream &, OutputParams const &) const;
        //
-       int linuxdoc(Buffer const & buf, std::ostream & os,
-                    OutputParams const &) const;
-       ///
-       int docbook(Buffer const & buf, std::ostream & os,
-                   OutputParams const &) const;
+       int docbook(Buffer const & buf, odocstream & os, OutputParams const &) const;
        ///
-       int plaintext(Buffer const &, std::ostream &,
+       int plaintext(Buffer const &, odocstream &,
                  OutputParams const & runparams,
                  int const depth,
                  bool onlydata, unsigned char delim) const;
        ///
-       bool isMultiColumn(int cell) const;
+       bool isMultiColumn(idx_type cell) const;
+       ///
+       bool isMultiColumnReal(idx_type cell) const;
        ///
-       bool isMultiColumnReal(int cell) 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);
        ///
@@ -312,47 +350,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;
        ///
@@ -364,28 +402,37 @@ public:
        ///
        // end longtable support
        ///
-       InsetText & getCellInset(int cell) const;
+       boost::shared_ptr<InsetText> getCellInset(idx_type cell) const;
+       ///
+       boost::shared_ptr<InsetText> getCellInset(row_type row,
+                                                 col_type column) const;
        ///
-       InsetText & getCellInset(int row, int column) const;
+       void setCellInset(row_type row, col_type column,
+                         boost::shared_ptr<InsetText>) const;
        /// Search for \param inset in the tabular, with the
        ///
-       int getCellFromInset(InsetBase const * inset) const;
+       idx_type getCellFromInset(InsetBase const * inset) const;
        ///
-       int rows() const { return rows_; }
+       row_type rows() const { return rows_; }
        ///
-       int columns() const { return columns_;}
+       col_type columns() const { return columns_;}
        ///
        void validate(LaTeXFeatures &) const;
-       /// Appends \c list with all labels found within this inset.
-       void getLabelList(Buffer const &, std::vector<std::string> & list) const;
        ///
 //private:
        ///
-       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;
                ///
@@ -407,20 +454,21 @@ public:
                ///
                bool rotate;
                ///
-               std::string align_special;
+               docstring align_special;
                ///
                LyXLength p_width; // this is only set for multicolumn!!!
                ///
-               InsetText inset;
+               boost::shared_ptr<InsetText> inset;
        };
-       cellstruct & cellinfo_of_cell(int cell) const;
+       cellstruct & cellinfo_of_cell(idx_type cell) const;
        ///
        typedef std::vector<cellstruct> cell_vector;
        ///
        typedef std::vector<cell_vector> cell_vvector;
 
        ///
-       struct rowstruct {
+       class rowstruct {
+       public:
                ///
                rowstruct();
                ///
@@ -431,6 +479,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;
@@ -447,7 +507,8 @@ public:
        typedef std::vector<rowstruct> row_vector;
 
        ///
-       struct columnstruct {
+       class columnstruct {
+               public:
                ///
                columnstruct();
                ///
@@ -463,21 +524,21 @@ public:
                ///
                LyXLength p_width;
                ///
-               std::string align_special;
+               docstring align_special;
        };
        ///
        typedef std::vector<columnstruct> column_vector;
 
        ///
-       int rows_;
+       row_type rows_;
        ///
-       int columns_;
+       col_type columns_;
        ///
-       int numberofcells;
+       idx_type numberofcells;
        ///
-       std::vector<int> rowofcell;
+       std::vector<row_type> rowofcell;
        ///
-       std::vector<int> columnofcell;
+       std::vector<col_type> columnofcell;
        ///
        row_vector row_info;
        ///
@@ -487,6 +548,8 @@ public:
        ///
        int width_of_tabular;
        ///
+       bool use_booktabs;
+       ///
        bool rotate;
        //
        // for long tabulars
@@ -502,61 +565,60 @@ public:
        ltType endlastfoot;
 
        ///
-       void init(BufferParams const &, int rows_arg, int columns_arg);
+       void init(BufferParams const &, row_type rows_arg,
+                 col_type columns_arg);
        ///
        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
-       void 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);
+       void delete_column(col_type column);
        ///
-       int cells_in_multicolumn(int cell) const;
+       idx_type cells_in_multicolumn(idx_type cell) const;
        ///
-       BoxType useParbox(int 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,
+       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,
+       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 return number of newlines
        ///
-       int asciiTopHLine(std::ostream &, int row,
-                         std::vector<unsigned int> const &) const;
+       int plaintextTopHLine(odocstream &, row_type row,
+                       std::vector<unsigned int> const &) const;
        ///
-       int asciiBottomHLine(std::ostream &, int row,
-                            std::vector<unsigned int> const &) const;
+       int plaintextBottomHLine(odocstream &, row_type row,
+                       std::vector<unsigned int> const &) const;
        ///
-       int asciiPrintCell(Buffer const &, std::ostream &,
-                          OutputParams const &,
-                          int cell, int row, int column,
-                          std::vector<unsigned int> const &,
+       int 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, std::ostream & os, int,
+       int docbookRow(Buffer const & buf, odocstream & os, row_type,
                       OutputParams const &) const;
 
 private:
@@ -564,4 +626,7 @@ private:
        void fixCellNums();
 };
 
+
+} // namespace lyx
+
 #endif