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);
470 void unsetMultiColumn(idx_type cell);
472 bool isPartOfMultiColumn(row_type row, col_type column) const;
474 bool isPartOfMultiRow(row_type row, col_type column) const;
476 bool isMultiRow(idx_type cell) const;
478 idx_type setMultiRow(idx_type cell, idx_type number,
479 bool const bottom_border);
481 void unsetMultiRow(idx_type cell);
483 row_type cellRow(idx_type cell) const;
485 col_type cellColumn(idx_type cell) const;
487 void setRotateCell(idx_type cell, bool);
489 bool getRotateCell(idx_type cell) const;
491 bool needRotating() const;
493 bool isLastCell(idx_type cell) const;
495 idx_type cellAbove(idx_type cell) const;
497 idx_type cellBelow(idx_type cell) const;
499 idx_type cellIndex(row_type row, col_type column) const;
501 void setUsebox(idx_type cell, BoxType);
503 BoxType getUsebox(idx_type cell) const;
505 // Long Tabular Options support functions
507 bool checkLTType(row_type row, ltType const &) const;
509 void setLTHead(row_type row, bool flag, ltType const &, bool first);
511 bool getRowOfLTHead(row_type row, ltType &) const;
513 bool getRowOfLTFirstHead(row_type row, ltType &) const;
515 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
517 bool getRowOfLTFoot(row_type row, ltType &) const;
519 bool getRowOfLTLastFoot(row_type row, ltType &) const;
521 void setLTNewPage(row_type row, bool what);
523 bool getLTNewPage(row_type row) const;
525 idx_type setLTCaption(row_type row, bool what);
527 bool ltCaption(row_type row) const;
529 bool haveLTHead() const;
531 bool haveLTFirstHead() const;
533 bool haveLTFoot() const;
535 bool haveLTLastFoot() const;
537 bool haveLTCaption() const;
539 // end longtable support
541 shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
543 shared_ptr<InsetTableCell> cellInset(row_type row,
544 col_type column) const;
546 void setCellInset(row_type row, col_type column,
547 shared_ptr<InsetTableCell>) const;
548 /// Search for \param inset in the tabular, with the
550 void validate(LaTeXFeatures &) const;
552 // FIXME Now that cells have an InsetTableCell as their insets, rather
553 // than an InsetText, it'd be possible to reverse the relationship here,
554 // so that cell_vector was a vector<InsetTableCell> rather than a
555 // vector<CellData>, and an InsetTableCell had a CellData as a member,
556 // or perhaps just had its members as members.
563 CellData(CellData const &);
565 CellData & operator=(CellData);
567 void swap(CellData & rhs);
579 LyXAlignment alignment;
581 VAlignment valignment;
582 /// width of the part before the decimal
584 /// width of the decimal part
601 docstring align_special;
603 Length p_width; // this is only set for multicolumn!!!
605 shared_ptr<InsetTableCell> inset;
607 CellData & cellInfo(idx_type cell) const;
609 typedef std::vector<CellData> cell_vector;
611 typedef std::vector<cell_vector> cell_vvector;
622 /// Extra space between the top line and this row
624 /// Ignore top_space if true and use the default top space
625 bool top_space_default;
626 /// Extra space between this row and the bottom line
628 /// Ignore bottom_space if true and use the default bottom space
629 bool bottom_space_default;
630 /// Extra space between the bottom line and the next top line
631 Length interline_space;
632 /// Ignore interline_space if true and use the default interline space
633 bool interline_space_default;
634 /// This are for longtabulars only
637 /// a row of endfirsthead
641 /// row of endlastfoot
643 /// row for a newpage
649 typedef std::vector<RowData> row_vector;
657 LyXAlignment alignment;
659 VAlignment valignment;
665 docstring align_special;
667 docstring decimal_point;
670 typedef std::vector<ColumnData> column_vector;
673 idx_type numberofcells;
675 std::vector<row_type> rowofcell;
677 std::vector<col_type> columnofcell;
681 column_vector column_info;
683 mutable cell_vvector cell_info;
685 Length tabular_width;
691 VAlignment tabular_valignment;
695 HAlignment longtabular_alignment;
697 bool is_long_tabular;
700 /// endfirsthead data
708 void init(Buffer *, row_type rows_arg,
709 col_type columns_arg);
711 void updateIndexes();
713 bool setFixedWidth(row_type r, col_type c);
714 /// return true of update is needed
715 bool updateColumnWidths();
717 idx_type columnSpan(idx_type cell) const;
719 idx_type rowSpan(idx_type cell) const;
721 BoxType useParbox(idx_type cell) const;
723 // helper function for Latex
725 void TeXTopHLine(otexstream &, row_type row, std::string const lang) const;
727 void TeXBottomHLine(otexstream &, row_type row, std::string const lang) const;
729 void TeXCellPreamble(otexstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const;
731 void TeXCellPostamble(otexstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
733 void TeXLongtableHeaderFooter(otexstream &, OutputParams const &) const;
735 bool isValidRow(row_type const row) const;
737 void TeXRow(otexstream &, row_type const row,
738 OutputParams const &) const;
740 // helper functions for plain text
742 bool plaintextTopHLine(odocstream &, row_type row,
743 std::vector<unsigned int> const &) const;
745 bool plaintextBottomHLine(odocstream &, row_type row,
746 std::vector<unsigned int> const &) const;
748 void plaintextPrintCell(odocstream &,
749 OutputParams const &,
750 idx_type cell, row_type row, col_type column,
751 std::vector<unsigned int> const &,
752 bool onlydata) const;
753 /// auxiliary function for docbook
754 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
756 docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &,
757 bool header = false) const;
759 /// change associated Buffer
760 void setBuffer(Buffer & buffer);
761 /// retrieve associated Buffer
762 Buffer & buffer() const { return *buffer_; }
770 class InsetTabular : public Inset
774 InsetTabular(Buffer *, row_type rows = 1,
775 col_type columns = 1);
779 void setBuffer(Buffer & buffer);
782 static void string2params(std::string const &, InsetTabular &);
784 static std::string params2string(InsetTabular const &);
788 void write(std::ostream &) const;
790 void metrics(MetricsInfo &, Dimension &) const;
792 void draw(PainterInfo & pi, int x, int y) const;
794 void drawSelection(PainterInfo & pi, int x, int y) const;
796 void drawBackground(PainterInfo & pi, int x, int y) const;
798 bool editable() const { return true; }
800 bool hasSettings() const { return true; }
802 bool insetAllowed(InsetCode code) const;
804 bool allowSpellCheck() const { return true; }
806 bool canTrackChanges() const { return true; }
807 /** returns false if, when outputing LaTeX, font changes should
808 be closed before generating this inset. This is needed for
809 insets that may contain several paragraphs */
810 bool inheritFont() const { return false; }
812 DisplayType display() const;
814 void latex(otexstream &, OutputParams const &) const;
816 int plaintext(odocstream &, OutputParams const &) const;
818 int docbook(odocstream &, OutputParams const &) const;
820 docstring xhtml(XHTMLStream &, OutputParams const &) const;
822 void validate(LaTeXFeatures & features) const;
824 InsetCode lyxCode() const { return TABULAR_CODE; }
826 docstring contextMenu(BufferView const &, int, int) const;
828 docstring contextMenuName() const;
829 /// get offset of this cursor slice relative to our upper left corner
830 void cursorPos(BufferView const & bv, CursorSlice const & sl,
831 bool boundary, int & x, int & y) const;
833 bool tabularFeatures(Cursor & cur, std::string const & what);
835 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
836 std::string const & val = std::string());
838 size_t nargs() const { return tabular.numberofcells; }
840 shared_ptr<InsetTableCell const> cell(idx_type) const;
842 shared_ptr<InsetTableCell> cell(idx_type);
844 Text * getText(int) const;
846 /// set the change for the entire inset
847 void setChange(Change const & change);
848 /// accept the changes within the inset
849 void acceptChanges();
850 /// reject the changes within the inset
851 void rejectChanges();
853 // this should return true if we have a "normal" cell, otherwise false.
854 // "normal" means without width set!
855 /// should all paragraphs be output with "Standard" layout?
856 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
858 virtual bool forcePlainLayout(idx_type cell = 0) const;
860 void addPreview(DocIterator const & inset_pos,
861 graphics::PreviewLoader &) const;
863 /// lock cell with given index
864 void edit(Cursor & cur, bool front, EntryDirection entry_from);
865 /// get table row from x coordinate
866 int rowFromY(Cursor & cur, int y) const;
867 /// get table column from y coordinate
868 int columnFromX(Cursor & cur, int x) const;
870 Inset * editXY(Cursor & cur, int x, int y);
871 /// can we go further down on mouse click?
872 bool descendable(BufferView const &) const { return true; }
873 /// Update the counters of this inset and of its contents
874 void updateBuffer(ParIterator const &, UpdateType);
876 void addToToc(DocIterator const &) const;
879 bool completionSupported(Cursor const &) const;
881 bool inlineCompletionSupported(Cursor const & cur) const;
883 bool automaticInlineCompletion() const;
885 bool automaticPopupCompletion() const;
887 bool showCompletionCursor() const;
889 CompletionList const * createCompletionList(Cursor const & cur) const;
891 docstring completionPrefix(Cursor const & cur) const;
893 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
895 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
897 virtual bool usePlainLayout() const { return true; }
900 InsetTabular * asInsetTabular() { return this; }
902 InsetTabular const * asInsetTabular() const { return this; }
904 bool isRightToLeft(Cursor & cur) const;
905 /// writes the cells between stidx and enidx as a string, optionally
906 /// descending into the insets
907 docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
909 /// Returns whether the cell in the specified row and column is selected.
910 bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
912 // Public structures and variables
914 mutable Tabular tabular;
918 InsetTabular(InsetTabular const &);
920 void doDispatch(Cursor & cur, FuncRequest & cmd);
922 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
924 Inset * clone() const { return new InsetTabular(*this); }
927 void drawCellLines(PainterInfo &, int x, int y, row_type row,
928 idx_type cell) const;
930 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
933 void moveNextCell(Cursor & cur,
934 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
936 void movePrevCell(Cursor & cur,
937 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
939 int cellXPos(idx_type cell) const;
941 int cellYPos(idx_type cell) const;
943 void resetPos(Cursor & cur) const;
945 bool copySelection(Cursor & cur);
947 bool pasteClipboard(Cursor & cur);
949 void cutSelection(Cursor & cur);
951 void getSelection(Cursor & cur, row_type & rs, row_type & re,
952 col_type & cs, col_type & ce) const;
954 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
956 /// return the "Manhattan distance" to nearest corner
957 int dist(BufferView &, idx_type cell, int x, int y) const;
958 /// return the cell nearest to x, y
959 idx_type getNearestCell(BufferView &, int x, int y) const;
961 /// test the rotation state of the give cell range.
962 bool oneCellHasRotationState(bool rotated,
963 row_type row_start, row_type row_end,
964 col_type col_start, col_type col_end) const;
966 mutable idx_type first_visible_cell;
969 /// The vertical offset of the table due to the vertical
970 /// alignment with respect to the baseline.
971 mutable int offset_valign_;
972 /// true when selecting rows with the mouse
974 /// true when selecting columns with the mouse
978 std::string const featureAsString(Tabular::Feature feature);
980 /// Split cell on decimal symbol
981 InsetTableCell splitCell(InsetTableCell & head, docstring const decimal_sym, bool & hassep);
985 #endif // INSET_TABULAR_H