// -*- C++ -*- /** * \file tabular.h * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * * \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. */ #ifndef TABULAR_H #define TABULAR_H #include "lyxlength.h" #include "insets/insettext.h" #include #include #include namespace lyx { class InsetTabular; class LCursor; class OutputParams; /* The features the text class offers for tables */ /// class LyXTabular { 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, /// SET_ROTATE_CELL, /// UNSET_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(-1); /// constructor LyXTabular(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 getWidthOfColumn(idx_type cell) const; /// int getWidthOfTabular() const; /// int getAscentOfRow(row_type row) const; /// int getDescentOfRow(row_type row) const; /// int getHeightOfTabular() const; /// 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); /// void setVAlignment(idx_type cell, VAlignment align, bool onlycolumn = false); /// void setColumnPWidth(LCursor &, idx_type, LyXLength const &); /// bool setMColumnPWidth(LCursor &, idx_type, LyXLength const &); /// void setAlignSpecial(idx_type cell, std::string const & special, Feature what); /// LyXAlignment getAlignment(idx_type cell, bool onlycolumn = false) const; /// VAlignment getVAlignment(idx_type cell, bool onlycolumn = false) const; /// LyXLength const getPWidth(idx_type cell) const; /// LyXLength const getColumnPWidth(idx_type cell) const; /// LyXLength const getMColumnPWidth(idx_type cell) const; /// std::string const getAlignSpecial(idx_type cell, int what) const; /// int getWidthOfCell(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 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 &, odocstream &, OutputParams const &) const; // int docbook(Buffer const & buf, odocstream & os, OutputParams const &) const; /// int 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; /// 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 row_of_cell(idx_type cell) const; /// col_type column_of_cell(idx_type cell) const; /// col_type right_column_of_cell(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 getCellNumber(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 getCellInset(idx_type cell) const; /// boost::shared_ptr getCellInset(row_type row, col_type column) const; /// void setCellInset(row_type row, col_type column, boost::shared_ptr) const; /// Search for \param inset in the tabular, with the /// idx_type getCellFromInset(InsetBase const * inset) const; /// row_type rows() const { return rows_; } /// col_type columns() const { return columns_;} /// 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_of_cell; /// int multicolumn; /// LyXAlignment alignment; /// VAlignment valignment; /// bool top_line; /// bool bottom_line; /// bool left_line; /// bool right_line; /// BoxType usebox; /// bool rotate; /// std::string align_special; /// LyXLength p_width; // this is only set for multicolumn!!! /// boost::shared_ptr inset; }; cellstruct & cellinfo_of_cell(idx_type cell) const; /// typedef std::vector cell_vector; /// typedef std::vector cell_vvector; /// class rowstruct { public: /// rowstruct(); /// int ascent_of_row; /// int descent_of_row; /// 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; /// a row of endfirsthead bool endfirsthead; /// a row of endfoot bool endfoot; /// row of endlastfoot bool endlastfoot; /// row for a pagebreak bool newpage; }; /// typedef std::vector row_vector; /// class columnstruct { public: /// columnstruct(); /// LyXAlignment alignment; /// VAlignment valignment; /// bool left_line; /// bool right_line; /// int width_of_column; /// LyXLength p_width; /// std::string align_special; }; /// typedef std::vector column_vector; /// row_type rows_; /// col_type columns_; /// idx_type numberofcells; /// std::vector rowofcell; /// std::vector columnofcell; /// row_vector row_info; /// column_vector column_info; /// mutable cell_vvector cell_info; /// int width_of_tabular; /// 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 set_row_column_number_info(); /// 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 /// void calculate_width_of_tabular(); /// void delete_column(col_type column); /// 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 function for ASCII returns number of newlines /// int asciiTopHLine(odocstream &, row_type row, std::vector const &) const; /// int asciiBottomHLine(odocstream &, row_type row, std::vector const &) const; /// int asciiPrintCell(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, odocstream & os, row_type, OutputParams const &) const; private: /// renumber cells after structural changes void fixCellNums(); }; } // namespace lyx #endif