4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Matthias Ettrich
10 * \author Jürgen Vigna
11 * \author Edwin Leuven
14 * Full author contact details are available in file CREDITS.
17 // Things to think of when designing the new tabular support:
18 // - color support (colortbl, color)
19 // - decimal alignment (dcloumn)
20 // - custom lines (hhline)
23 #ifndef INSET_TABULAR_H
24 #define INSET_TABULAR_H
27 #include "InsetText.h"
30 #include "support/shared_ptr.h"
50 class InsetTableCell : public InsetText
54 InsetTableCell(Buffer * buf);
56 InsetCode lyxCode() const { return CELL_CODE; }
58 Inset * clone() { return new InsetTableCell(*this); }
60 bool getStatus(Cursor & cur, FuncRequest const & cmd,
61 FuncStatus & status) const;
63 void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
65 void setContentAlignment(LyXAlignment al) {contentAlign = al; }
66 /// writes the contents of the cell as a string, optionally
67 /// descending into insets
68 docstring asString(bool intoInsets = true);
70 docstring xhtml(XHTMLStream &, OutputParams const &) const;
75 void operator=(InsetTableCell const &);
77 // This boolean is supposed to track whether the cell has had its
78 // width explicitly set. We need to know this to determine whether
79 // layout changes and paragraph customization are allowed---that is,
80 // we need it in forcePlainLayout() and allowParagraphCustomization().
81 // Unfortunately, that information is not readily available in
82 // InsetTableCell. In the case of multicolumn cells, it is present
83 // in CellData, and so would be available here if CellData were to
84 // become a member of InsetTableCell. But in the other case, it isn't
85 // even available there, but is held in Tabular::ColumnData.
86 // So, the present solution uses this boolean to track the information
87 // we need to track, and tries to keep it updated. This is not ideal,
88 // but the other solutions are no better. These are:
89 // (i) Keep a pointer in InsetTableCell to the table;
90 // (ii) Find the table by iterating over the Buffer's insets.
91 // Solution (i) raises the problem of updating the pointer when an
92 // InsetTableCell is copied, and we'd therefore need a copy constructor
93 // in InsetTabular and then in Tabular, which seems messy, given how
94 // complicated those classes are. Solution (ii) involves a lot of
95 // iterating, since this information is needed quite often, and so may
97 // So, well, if someone can do better, please do!
101 // FIXME: Here the thoughts from the comment above also apply.
103 LyXAlignment contentAlign;
104 /// should paragraph indendation be omitted in any case?
105 bool neverIndent() const { return true; }
107 LyXAlignment contentAlignment() const { return contentAlign; }
109 virtual bool usePlainLayout() const { return true; }
111 virtual bool forcePlainLayout(idx_type = 0) const;
113 virtual bool allowParagraphCustomization(idx_type = 0) const;
114 /// Is the width forced to some value?
115 bool hasFixedWidth() const { return isFixedWidth; }
120 // A helper struct for tables
211 UNSET_ROTATE_TABULAR,
213 TOGGLE_ROTATE_TABULAR,
245 SET_SPECIAL_MULTICOLUMN,
261 TABULAR_VALIGN_MIDDLE,
263 TABULAR_VALIGN_BOTTOM,
265 LONGTABULAR_ALIGN_LEFT,
267 LONGTABULAR_ALIGN_CENTER,
269 LONGTABULAR_ALIGN_RIGHT,
282 CELL_BEGIN_OF_MULTICOLUMN,
284 CELL_PART_OF_MULTICOLUMN,
286 CELL_BEGIN_OF_MULTIROW,
288 CELL_PART_OF_MULTIROW
296 LYX_VALIGN_MIDDLE = 1,
298 LYX_VALIGN_BOTTOM = 2
304 LYX_LONGTABULAR_ALIGN_LEFT = 0,
306 LYX_LONGTABULAR_ALIGN_CENTER = 1,
308 LYX_LONGTABULAR_ALIGN_RIGHT = 2
324 // we have this header type (is set in the getLT... functions)
326 // double borders on top
328 // double borders on bottom
330 // used for FirstHeader & LastFooter and if this is true
331 // all the rows marked as FirstHeader or LastFooter are
332 // ignored in the output and it is set to be empty!
336 /// type for row numbers
337 typedef size_t row_type;
338 /// type for column numbers
339 typedef size_t col_type;
340 /// type for cell indices
341 typedef size_t idx_type;
342 /// index indicating an invalid position
343 static const idx_type npos = static_cast<idx_type>(-1);
346 Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
348 /// Returns true if there is a topline, returns false if not
349 bool topLine(idx_type cell) const;
350 /// Returns true if there is a topline, returns false if not
351 bool bottomLine(idx_type cell) const;
352 /// Returns true if there is a topline, returns false if not
353 bool leftLine(idx_type cell) const;
354 /// Returns true if there is a topline, returns false if not
355 bool rightLine(idx_type cell) const;
357 /// return space occupied by the second horizontal line and
358 /// interline space above row \p row in pixels
359 int interRowSpace(row_type row) const;
361 int interColumnSpace(idx_type cell) const;
363 /* returns the maximum over all rows */
365 int cellWidth(idx_type cell) const;
367 int cellHeight(idx_type cell) const;
373 row_type nrows() const {return row_info.size();}
375 col_type ncols() const {return column_info.size();}
377 int rowAscent(row_type row) const;
379 int rowDescent(row_type row) const;
381 void setRowAscent(row_type row, int height);
383 void setRowDescent(row_type row, int height);
385 void setTopLine(idx_type cell, bool line);
387 void setBottomLine(idx_type cell, bool line);
389 void setLeftLine(idx_type cell, bool line);
391 void setRightLine(idx_type cell, bool line);
393 bool rowTopLine(row_type row) const;
395 bool rowBottomLine(row_type row) const;
397 bool columnLeftLine(col_type column) const;
399 bool columnRightLine(col_type column) const;
401 void setAlignment(idx_type cell, LyXAlignment align,
402 bool onlycolumn = false);
404 void setVAlignment(idx_type cell, VAlignment align,
405 bool onlycolumn = false);
407 void setTabularWidth(Length const & l) { tabular_width = l; }
409 Length tabularWidth() const { return tabular_width; }
411 void setColumnPWidth(Cursor &, idx_type, Length const &);
413 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
415 bool setMROffset(Cursor &, idx_type, Length const &);
417 void setAlignSpecial(idx_type cell, docstring const & special,
420 LyXAlignment getAlignment(idx_type cell,
421 bool onlycolumn = false) const;
423 VAlignment getVAlignment(idx_type cell,
424 bool onlycolumn = false) const;
426 Length const getPWidth(idx_type cell) const;
428 Length const getMROffset(idx_type cell) const;
430 int textHOffset(idx_type cell) const;
432 int textVOffset(idx_type cell) const;
434 void appendRow(idx_type cell);
436 void deleteRow(row_type row);
438 void copyRow(row_type);
440 void appendColumn(idx_type cell);
442 void deleteColumn(col_type column);
444 void copyColumn(col_type);
446 idx_type getFirstCellInRow(row_type row) const;
448 idx_type getLastCellInRow(row_type row) const;
450 idx_type numberOfCellsInRow(row_type row) const;
452 void write(std::ostream &) const;
456 void latex(otexstream &, OutputParams const &) const;
458 int docbook(odocstream & os, OutputParams const &) const;
460 docstring xhtml(XHTMLStream & os, OutputParams const &) const;
462 void plaintext(odocstream &,
463 OutputParams const & runparams, int const depth,
464 bool onlydata, char_type delim) const;
466 bool isMultiColumn(idx_type cell) const;
468 idx_type setMultiColumn(idx_type cell, idx_type number,
469 bool const right_border);
471 void unsetMultiColumn(idx_type cell);
473 bool isPartOfMultiColumn(row_type row, col_type column) const;
475 bool isPartOfMultiRow(row_type row, col_type column) const;
477 bool isMultiRow(idx_type cell) const;
479 idx_type setMultiRow(idx_type cell, idx_type number,
480 bool const bottom_border);
482 void unsetMultiRow(idx_type cell);
484 row_type cellRow(idx_type cell) const;
486 col_type cellColumn(idx_type cell) const;
488 void setRotateCell(idx_type cell, bool);
490 bool getRotateCell(idx_type cell) const;
492 bool needRotating() const;
494 bool isLastCell(idx_type cell) const;
496 idx_type cellAbove(idx_type cell) const;
498 idx_type cellBelow(idx_type cell) const;
500 idx_type cellIndex(row_type row, col_type column) const;
502 void setUsebox(idx_type cell, BoxType);
504 BoxType getUsebox(idx_type cell) const;
506 // Long Tabular Options support functions
508 bool checkLTType(row_type row, ltType const &) const;
510 void setLTHead(row_type row, bool flag, ltType const &, bool first);
512 bool getRowOfLTHead(row_type row, ltType &) const;
514 bool getRowOfLTFirstHead(row_type row, ltType &) const;
516 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
518 bool getRowOfLTFoot(row_type row, ltType &) const;
520 bool getRowOfLTLastFoot(row_type row, ltType &) const;
522 void setLTNewPage(row_type row, bool what);
524 bool getLTNewPage(row_type row) const;
526 idx_type setLTCaption(row_type row, bool what);
528 bool ltCaption(row_type row) const;
530 bool haveLTHead() const;
532 bool haveLTFirstHead() const;
534 bool haveLTFoot() const;
536 bool haveLTLastFoot() const;
538 bool haveLTCaption() const;
540 // end longtable support
542 shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
544 shared_ptr<InsetTableCell> cellInset(row_type row,
545 col_type column) const;
547 void setCellInset(row_type row, col_type column,
548 shared_ptr<InsetTableCell>) const;
549 /// Search for \param inset in the tabular, with the
551 void validate(LaTeXFeatures &) const;
553 // FIXME Now that cells have an InsetTableCell as their insets, rather
554 // than an InsetText, it'd be possible to reverse the relationship here,
555 // so that cell_vector was a vector<InsetTableCell> rather than a
556 // vector<CellData>, and an InsetTableCell had a CellData as a member,
557 // or perhaps just had its members as members.
564 CellData(CellData const &);
566 CellData & operator=(CellData);
568 void swap(CellData & rhs);
580 LyXAlignment alignment;
582 VAlignment valignment;
583 /// width of the part before the decimal
585 /// width of the decimal part
602 docstring align_special;
604 Length p_width; // this is only set for multicolumn!!!
606 shared_ptr<InsetTableCell> inset;
608 CellData & cellInfo(idx_type cell) const;
610 typedef std::vector<CellData> cell_vector;
612 typedef std::vector<cell_vector> cell_vvector;
623 /// Extra space between the top line and this row
625 /// Ignore top_space if true and use the default top space
626 bool top_space_default;
627 /// Extra space between this row and the bottom line
629 /// Ignore bottom_space if true and use the default bottom space
630 bool bottom_space_default;
631 /// Extra space between the bottom line and the next top line
632 Length interline_space;
633 /// Ignore interline_space if true and use the default interline space
634 bool interline_space_default;
635 /// This are for longtabulars only
638 /// a row of endfirsthead
642 /// row of endlastfoot
644 /// row for a newpage
650 typedef std::vector<RowData> row_vector;
658 LyXAlignment alignment;
660 VAlignment valignment;
666 docstring align_special;
668 docstring decimal_point;
671 typedef std::vector<ColumnData> column_vector;
674 idx_type numberofcells;
676 std::vector<row_type> rowofcell;
678 std::vector<col_type> columnofcell;
682 column_vector column_info;
684 mutable cell_vvector cell_info;
686 Length tabular_width;
692 VAlignment tabular_valignment;
696 HAlignment longtabular_alignment;
698 bool is_long_tabular;
701 /// endfirsthead data
709 void init(Buffer *, row_type rows_arg,
710 col_type columns_arg);
712 void updateIndexes();
714 bool setFixedWidth(row_type r, col_type c);
715 /// return true of update is needed
716 bool updateColumnWidths();
718 idx_type columnSpan(idx_type cell) const;
720 idx_type rowSpan(idx_type cell) const;
722 BoxType useParbox(idx_type cell) const;
724 // helper function for Latex
726 void TeXTopHLine(otexstream &, row_type row, std::string const lang) const;
728 void TeXBottomHLine(otexstream &, row_type row, std::string const lang) const;
730 void TeXCellPreamble(otexstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const;
732 void TeXCellPostamble(otexstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
734 void TeXLongtableHeaderFooter(otexstream &, OutputParams const &) const;
736 bool isValidRow(row_type const row) const;
738 void TeXRow(otexstream &, row_type const row,
739 OutputParams const &) const;
741 // helper functions for plain text
743 bool plaintextTopHLine(odocstream &, row_type row,
744 std::vector<unsigned int> const &) const;
746 bool plaintextBottomHLine(odocstream &, row_type row,
747 std::vector<unsigned int> const &) const;
749 void plaintextPrintCell(odocstream &,
750 OutputParams const &,
751 idx_type cell, row_type row, col_type column,
752 std::vector<unsigned int> const &,
753 bool onlydata) const;
754 /// auxiliary function for docbook
755 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
757 docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &,
758 bool header = false) const;
760 /// change associated Buffer
761 void setBuffer(Buffer & buffer);
762 /// retrieve associated Buffer
763 Buffer & buffer() const { return *buffer_; }
771 class InsetTabular : public Inset
775 InsetTabular(Buffer *, row_type rows = 1,
776 col_type columns = 1);
780 void setBuffer(Buffer & buffer);
783 static void string2params(std::string const &, InsetTabular &);
785 static std::string params2string(InsetTabular const &);
789 void write(std::ostream &) const;
791 void metrics(MetricsInfo &, Dimension &) const;
793 void draw(PainterInfo & pi, int x, int y) const;
795 void drawSelection(PainterInfo & pi, int x, int y) const;
797 void drawBackground(PainterInfo & pi, int x, int y) const;
799 bool editable() const { return true; }
801 bool hasSettings() const { return true; }
803 bool insetAllowed(InsetCode code) const;
805 bool allowSpellCheck() const { return true; }
807 bool canTrackChanges() const { return true; }
808 /** returns false if, when outputing LaTeX, font changes should
809 be closed before generating this inset. This is needed for
810 insets that may contain several paragraphs */
811 bool inheritFont() const { return false; }
813 DisplayType display() const;
815 void latex(otexstream &, OutputParams const &) const;
817 int plaintext(odocstream &, OutputParams const &) const;
819 int docbook(odocstream &, OutputParams const &) const;
821 docstring xhtml(XHTMLStream &, OutputParams const &) const;
823 void validate(LaTeXFeatures & features) const;
825 InsetCode lyxCode() const { return TABULAR_CODE; }
827 docstring contextMenu(BufferView const &, int, int) const;
829 docstring contextMenuName() const;
830 /// get offset of this cursor slice relative to our upper left corner
831 void cursorPos(BufferView const & bv, CursorSlice const & sl,
832 bool boundary, int & x, int & y) const;
834 bool tabularFeatures(Cursor & cur, std::string const & what);
836 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
837 std::string const & val = std::string());
839 size_t nargs() const { return tabular.numberofcells; }
841 shared_ptr<InsetTableCell const> cell(idx_type) const;
843 shared_ptr<InsetTableCell> cell(idx_type);
845 Text * getText(int) const;
847 /// set the change for the entire inset
848 void setChange(Change const & change);
849 /// accept the changes within the inset
850 void acceptChanges();
851 /// reject the changes within the inset
852 void rejectChanges();
854 // this should return true if we have a "normal" cell, otherwise false.
855 // "normal" means without width set!
856 /// should all paragraphs be output with "Standard" layout?
857 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
859 virtual bool forcePlainLayout(idx_type cell = 0) const;
861 void addPreview(DocIterator const & inset_pos,
862 graphics::PreviewLoader &) const;
864 /// lock cell with given index
865 void edit(Cursor & cur, bool front, EntryDirection entry_from);
866 /// get table row from x coordinate
867 int rowFromY(Cursor & cur, int y) const;
868 /// get table column from y coordinate
869 int columnFromX(Cursor & cur, int x) const;
871 Inset * editXY(Cursor & cur, int x, int y);
872 /// can we go further down on mouse click?
873 bool descendable(BufferView const &) const { return true; }
874 /// Update the counters of this inset and of its contents
875 void updateBuffer(ParIterator const &, UpdateType);
877 void addToToc(DocIterator const &) const;
880 bool completionSupported(Cursor const &) const;
882 bool inlineCompletionSupported(Cursor const & cur) const;
884 bool automaticInlineCompletion() const;
886 bool automaticPopupCompletion() const;
888 bool showCompletionCursor() const;
890 CompletionList const * createCompletionList(Cursor const & cur) const;
892 docstring completionPrefix(Cursor const & cur) const;
894 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
896 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
898 virtual bool usePlainLayout() const { return true; }
901 InsetTabular * asInsetTabular() { return this; }
903 InsetTabular const * asInsetTabular() const { return this; }
905 bool isRightToLeft(Cursor & cur) const;
906 /// writes the cells between stidx and enidx as a string, optionally
907 /// descending into the insets
908 docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
910 /// Returns whether the cell in the specified row and column is selected.
911 bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
913 // Public structures and variables
915 mutable Tabular tabular;
919 InsetTabular(InsetTabular const &);
921 void doDispatch(Cursor & cur, FuncRequest & cmd);
923 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
925 Inset * clone() const { return new InsetTabular(*this); }
928 void drawCellLines(PainterInfo &, int x, int y, row_type row,
929 idx_type cell) const;
931 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
934 void moveNextCell(Cursor & cur,
935 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
937 void movePrevCell(Cursor & cur,
938 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
940 int cellXPos(idx_type cell) const;
942 int cellYPos(idx_type cell) const;
944 void resetPos(Cursor & cur) const;
946 bool copySelection(Cursor & cur);
948 bool pasteClipboard(Cursor & cur);
950 void cutSelection(Cursor & cur);
952 void getSelection(Cursor & cur, row_type & rs, row_type & re,
953 col_type & cs, col_type & ce) const;
955 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
957 /// return the "Manhattan distance" to nearest corner
958 int dist(BufferView &, idx_type cell, int x, int y) const;
959 /// return the cell nearest to x, y
960 idx_type getNearestCell(BufferView &, int x, int y) const;
962 /// test the rotation state of the give cell range.
963 bool oneCellHasRotationState(bool rotated,
964 row_type row_start, row_type row_end,
965 col_type col_start, col_type col_end) const;
967 mutable idx_type first_visible_cell;
970 /// The vertical offset of the table due to the vertical
971 /// alignment with respect to the baseline.
972 mutable int offset_valign_;
973 /// true when selecting rows with the mouse
975 /// true when selecting columns with the mouse
979 std::string const featureAsString(Tabular::Feature feature);
981 /// Split cell on decimal symbol
982 InsetTableCell splitCell(InsetTableCell & head, docstring const decimal_sym, bool & hassep);
986 #endif // INSET_TABULAR_H