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
13 * \author Scott Kostyshak
15 * Full author contact details are available in file CREDITS.
18 // Things to think of when designing the new tabular support:
19 // - color support (colortbl, color)
20 // - decimal alignment (dcloumn)
21 // - custom lines (hhline)
24 #ifndef INSET_TABULAR_H
25 #define INSET_TABULAR_H
28 #include "InsetText.h"
31 #include "support/shared_ptr.h"
51 class InsetTableCell : public InsetText
55 InsetTableCell(Buffer * buf);
57 InsetCode lyxCode() const { return CELL_CODE; }
59 Inset * clone() { return new InsetTableCell(*this); }
61 bool getStatus(Cursor & cur, FuncRequest const & cmd,
62 FuncStatus & status) const;
64 void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
66 void setContentAlignment(LyXAlignment al) {contentAlign = al; }
67 /// writes the contents of the cell as a string, optionally
68 /// descending into insets
69 docstring asString(bool intoInsets = true);
71 docstring xhtml(XHTMLStream &, OutputParams const &) const;
76 void operator=(InsetTableCell const &);
78 // This boolean is supposed to track whether the cell has had its
79 // width explicitly set. We need to know this to determine whether
80 // layout changes and paragraph customization are allowed---that is,
81 // we need it in forcePlainLayout() and allowParagraphCustomization().
82 // Unfortunately, that information is not readily available in
83 // InsetTableCell. In the case of multicolumn cells, it is present
84 // in CellData, and so would be available here if CellData were to
85 // become a member of InsetTableCell. But in the other case, it isn't
86 // even available there, but is held in Tabular::ColumnData.
87 // So, the present solution uses this boolean to track the information
88 // we need to track, and tries to keep it updated. This is not ideal,
89 // but the other solutions are no better. These are:
90 // (i) Keep a pointer in InsetTableCell to the table;
91 // (ii) Find the table by iterating over the Buffer's insets.
92 // Solution (i) raises the problem of updating the pointer when an
93 // InsetTableCell is copied, and we'd therefore need a copy constructor
94 // in InsetTabular and then in Tabular, which seems messy, given how
95 // complicated those classes are. Solution (ii) involves a lot of
96 // iterating, since this information is needed quite often, and so may
98 // So, well, if someone can do better, please do!
102 // FIXME: Here the thoughts from the comment above also apply.
104 LyXAlignment contentAlign;
105 /// should paragraph indendation be omitted in any case?
106 bool neverIndent() const { return true; }
108 LyXAlignment contentAlignment() const { return contentAlign; }
110 virtual bool usePlainLayout() const { return true; }
112 virtual bool forcePlainLayout(idx_type = 0) const;
114 virtual bool allowParagraphCustomization(idx_type = 0) const;
115 /// Is the width forced to some value?
116 bool hasFixedWidth() const { return isFixedWidth; }
121 // A helper struct for tables
220 UNSET_ROTATE_TABULAR,
222 TOGGLE_ROTATE_TABULAR,
255 SET_SPECIAL_MULTICOLUMN,
271 TABULAR_VALIGN_MIDDLE,
273 TABULAR_VALIGN_BOTTOM,
275 LONGTABULAR_ALIGN_LEFT,
277 LONGTABULAR_ALIGN_CENTER,
279 LONGTABULAR_ALIGN_RIGHT,
292 CELL_BEGIN_OF_MULTICOLUMN,
294 CELL_PART_OF_MULTICOLUMN,
296 CELL_BEGIN_OF_MULTIROW,
298 CELL_PART_OF_MULTIROW
306 LYX_VALIGN_MIDDLE = 1,
308 LYX_VALIGN_BOTTOM = 2
314 LYX_LONGTABULAR_ALIGN_LEFT = 0,
316 LYX_LONGTABULAR_ALIGN_CENTER = 1,
318 LYX_LONGTABULAR_ALIGN_RIGHT = 2
357 // we have this header type (is set in the getLT... functions)
359 // double borders on top
361 // double borders on bottom
363 // used for FirstHeader & LastFooter and if this is true
364 // all the rows marked as FirstHeader or LastFooter are
365 // ignored in the output and it is set to be empty!
369 /// type for row numbers
370 typedef size_t row_type;
371 /// type for column numbers
372 typedef size_t col_type;
373 /// type for cell indices
374 typedef size_t idx_type;
375 /// index indicating an invalid position
376 static const idx_type npos = static_cast<idx_type>(-1);
379 Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
381 /// Returns true if there is a topline, returns false if not
382 bool topLine(idx_type cell) const;
383 /// Returns true if there is a topline, returns false if not
384 bool bottomLine(idx_type cell) const;
385 /// Returns true if there is a topline, returns false if not
386 bool leftLine(idx_type cell) const;
387 /// Returns true if there is a topline, returns false if not
388 bool rightLine(idx_type cell) const;
390 /// return space occupied by the second horizontal line and
391 /// interline space above row \p row in pixels
392 int interRowSpace(row_type row) const;
394 int interColumnSpace(idx_type cell) const;
396 /* returns the maximum over all rows */
398 int cellWidth(idx_type cell) const;
400 int cellHeight(idx_type cell) const;
406 row_type nrows() const {return row_info.size();}
408 col_type ncols() const {return column_info.size();}
410 int rowAscent(row_type row) const;
412 int rowDescent(row_type row) const;
414 void setRowAscent(row_type row, int height);
416 void setRowDescent(row_type row, int height);
418 void setTopLine(idx_type cell, bool line);
420 void setBottomLine(idx_type cell, bool line);
422 void setLeftLine(idx_type cell, bool line);
424 void setRightLine(idx_type cell, bool line);
426 bool rowTopLine(row_type row) const;
428 bool rowBottomLine(row_type row) const;
430 bool columnLeftLine(col_type column) const;
432 bool columnRightLine(col_type column) const;
434 void setAlignment(idx_type cell, LyXAlignment align,
435 bool onlycolumn = false);
437 void setVAlignment(idx_type cell, VAlignment align,
438 bool onlycolumn = false);
440 void setTabularWidth(Length const & l) { tabular_width = l; }
442 Length tabularWidth() const { return tabular_width; }
444 void setColumnPWidth(Cursor &, idx_type, Length const &);
446 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
448 bool setMROffset(Cursor &, idx_type, Length const &);
450 void setAlignSpecial(idx_type cell, docstring const & special,
453 LyXAlignment getAlignment(idx_type cell,
454 bool onlycolumn = false) const;
456 VAlignment getVAlignment(idx_type cell,
457 bool onlycolumn = false) const;
459 Length const getPWidth(idx_type cell) const;
461 Length const getMROffset(idx_type cell) const;
463 int textHOffset(idx_type cell) const;
465 int textVOffset(idx_type cell) const;
467 void appendRow(row_type row);
469 void deleteRow(row_type row);
471 void copyRow(row_type row);
473 void insertRow(row_type row, bool copy);
475 void moveColumn(col_type col, ColDirection direction);
477 void moveRow(row_type row, RowDirection direction);
479 void appendColumn(col_type column);
481 void deleteColumn(col_type column);
483 void copyColumn(col_type column);
485 void insertColumn(col_type column, bool copy);
487 idx_type getFirstCellInRow(row_type row) const;
489 idx_type getLastCellInRow(row_type row) const;
491 idx_type numberOfCellsInRow(row_type row) const;
493 void write(std::ostream &) const;
497 void latex(otexstream &, OutputParams const &) const;
499 int docbook(odocstream & os, OutputParams const &) const;
501 docstring xhtml(XHTMLStream & os, OutputParams const &) const;
503 void plaintext(odocstream &,
504 OutputParams const & runparams, int const depth,
505 bool onlydata, char_type delim) const;
507 bool isMultiColumn(idx_type cell) const;
509 bool hasMultiColumn(col_type cell) const;
511 idx_type setMultiColumn(idx_type cell, idx_type number,
512 bool const right_border);
514 void unsetMultiColumn(idx_type cell);
516 bool isPartOfMultiColumn(row_type row, col_type column) const;
518 bool isPartOfMultiRow(row_type row, col_type column) const;
520 bool isMultiRow(idx_type cell) const;
522 bool hasMultiRow(row_type r) const;
524 idx_type setMultiRow(idx_type cell, idx_type number,
525 bool const bottom_border);
527 void unsetMultiRow(idx_type cell);
529 row_type cellRow(idx_type cell) const;
531 col_type cellColumn(idx_type cell) const;
533 void setRotateCell(idx_type cell, int);
535 int getRotateCell(idx_type cell) const;
537 bool needRotating() const;
539 bool isLastCell(idx_type cell) const;
541 idx_type cellAbove(idx_type cell) const;
543 idx_type cellBelow(idx_type cell) const;
545 idx_type cellIndex(row_type row, col_type column) const;
547 void setUsebox(idx_type cell, BoxType);
549 BoxType getUsebox(idx_type cell) const;
551 // Long Tabular Options support functions
553 void setLTHead(row_type row, bool flag, ltType const &, bool first);
555 bool getRowOfLTHead(row_type row, ltType &) const;
557 bool getRowOfLTFirstHead(row_type row, ltType &) const;
559 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
561 bool getRowOfLTFoot(row_type row, ltType &) const;
563 bool getRowOfLTLastFoot(row_type row, ltType &) const;
565 void setLTNewPage(row_type row, bool what);
567 bool getLTNewPage(row_type row) const;
569 idx_type setLTCaption(row_type row, bool what);
571 bool ltCaption(row_type row) const;
573 bool haveLTHead(bool withcaptions = true) const;
575 bool haveLTFirstHead(bool withcaptions = true) const;
577 bool haveLTFoot(bool withcaptions = true) const;
579 bool haveLTLastFoot(bool withcaptions = true) const;
581 bool haveLTCaption(CaptionType captiontype = CAPTION_ANY) const;
583 // end longtable support
585 shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
587 shared_ptr<InsetTableCell> cellInset(row_type row,
588 col_type column) const;
590 void setCellInset(row_type row, col_type column,
591 shared_ptr<InsetTableCell>) const;
592 /// Search for \param inset in the tabular, with the
594 void validate(LaTeXFeatures &) const;
596 // FIXME Now that cells have an InsetTableCell as their insets, rather
597 // than an InsetText, it'd be possible to reverse the relationship here,
598 // so that cell_vector was a vector<InsetTableCell> rather than a
599 // vector<CellData>, and an InsetTableCell had a CellData as a member,
600 // or perhaps just had its members as members.
607 CellData(CellData const &);
609 CellData & operator=(CellData);
611 void swap(CellData & rhs);
623 LyXAlignment alignment;
625 VAlignment valignment;
626 /// width of the part before the decimal
628 /// width of the decimal part
645 docstring align_special;
647 Length p_width; // this is only set for multicolumn!!!
649 shared_ptr<InsetTableCell> inset;
651 CellData & cellInfo(idx_type cell) const;
653 typedef std::vector<CellData> cell_vector;
655 typedef std::vector<cell_vector> cell_vvector;
666 /// Extra space between the top line and this row
668 /// Ignore top_space if true and use the default top space
669 bool top_space_default;
670 /// Extra space between this row and the bottom line
672 /// Ignore bottom_space if true and use the default bottom space
673 bool bottom_space_default;
674 /// Extra space between the bottom line and the next top line
675 Length interline_space;
676 /// Ignore interline_space if true and use the default interline space
677 bool interline_space_default;
678 /// This are for longtabulars only
681 /// a row of endfirsthead
685 /// row of endlastfoot
687 /// row for a newpage
693 typedef std::vector<RowData> row_vector;
701 LyXAlignment alignment;
703 VAlignment valignment;
709 docstring align_special;
711 docstring decimal_point;
714 typedef std::vector<ColumnData> column_vector;
717 idx_type numberofcells;
719 std::vector<row_type> rowofcell;
721 std::vector<col_type> columnofcell;
725 column_vector column_info;
727 mutable cell_vvector cell_info;
729 Length tabular_width;
735 VAlignment tabular_valignment;
739 HAlignment longtabular_alignment;
741 bool is_long_tabular;
744 /// endfirsthead data
752 void init(Buffer *, row_type rows_arg,
753 col_type columns_arg);
755 void updateIndexes();
757 bool setFixedWidth(row_type r, col_type c);
758 /// return true of update is needed
759 bool updateColumnWidths();
761 idx_type columnSpan(idx_type cell) const;
763 idx_type rowSpan(idx_type cell) const;
765 BoxType useParbox(idx_type cell) const;
767 // helper function for Latex
769 void TeXTopHLine(otexstream &, row_type row, std::string const lang) const;
771 void TeXBottomHLine(otexstream &, row_type row, std::string const lang) const;
773 void TeXCellPreamble(otexstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const;
775 void TeXCellPostamble(otexstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
777 void TeXLongtableHeaderFooter(otexstream &, OutputParams const &) const;
779 bool isValidRow(row_type const row) const;
781 void TeXRow(otexstream &, row_type const row,
782 OutputParams const &) const;
784 // helper functions for plain text
786 bool plaintextTopHLine(odocstream &, row_type row,
787 std::vector<unsigned int> const &) const;
789 bool plaintextBottomHLine(odocstream &, row_type row,
790 std::vector<unsigned int> const &) const;
792 void plaintextPrintCell(odocstream &,
793 OutputParams const &,
794 idx_type cell, row_type row, col_type column,
795 std::vector<unsigned int> const &,
796 bool onlydata) const;
797 /// auxiliary function for docbook
798 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
800 docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &,
801 bool header = false) const;
803 /// change associated Buffer
804 void setBuffer(Buffer & buffer);
805 /// retrieve associated Buffer
806 Buffer & buffer() const { return *buffer_; }
814 class InsetTabular : public Inset
818 InsetTabular(Buffer *, row_type rows = 1,
819 col_type columns = 1);
823 void setBuffer(Buffer & buffer);
826 static void string2params(std::string const &, InsetTabular &);
828 static std::string params2string(InsetTabular const &);
832 void write(std::ostream &) const;
834 void metrics(MetricsInfo &, Dimension &) const;
836 void draw(PainterInfo & pi, int x, int y) const;
838 void drawSelection(PainterInfo & pi, int x, int y) const;
840 void drawBackground(PainterInfo & pi, int x, int y) const;
842 bool editable() const { return true; }
844 bool hasSettings() const { return true; }
846 bool insetAllowed(InsetCode code) const;
848 bool allowSpellCheck() const { return true; }
850 bool canTrackChanges() const { return true; }
851 /** returns false if, when outputing LaTeX, font changes should
852 be closed before generating this inset. This is needed for
853 insets that may contain several paragraphs */
854 bool inheritFont() const { return false; }
856 DisplayType display() const;
858 void latex(otexstream &, OutputParams const &) const;
860 int plaintext(odocstream &, OutputParams const &) const;
862 int docbook(odocstream &, OutputParams const &) const;
864 docstring xhtml(XHTMLStream &, OutputParams const &) const;
866 void validate(LaTeXFeatures & features) const;
868 InsetCode lyxCode() const { return TABULAR_CODE; }
870 std::string contextMenu(BufferView const &, int, int) const;
872 std::string contextMenuName() const;
873 /// get offset of this cursor slice relative to our upper left corner
874 void cursorPos(BufferView const & bv, CursorSlice const & sl,
875 bool boundary, int & x, int & y) const;
877 bool tabularFeatures(Cursor & cur, std::string const & what);
879 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
880 std::string const & val = std::string());
882 size_t nargs() const { return tabular.numberofcells; }
884 shared_ptr<InsetTableCell const> cell(idx_type) const;
886 shared_ptr<InsetTableCell> cell(idx_type);
888 Text * getText(int) const;
890 /// set the change for the entire inset
891 void setChange(Change const & change);
892 /// accept the changes within the inset
893 void acceptChanges();
894 /// reject the changes within the inset
895 void rejectChanges();
897 // this should return true if we have a "normal" cell, otherwise false.
898 // "normal" means without width set!
899 /// should all paragraphs be output with "Standard" layout?
900 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
902 virtual bool forcePlainLayout(idx_type cell = 0) const;
904 void addPreview(DocIterator const & inset_pos,
905 graphics::PreviewLoader &) const;
907 /// lock cell with given index
908 void edit(Cursor & cur, bool front, EntryDirection entry_from);
909 /// get table row from x coordinate
910 int rowFromY(Cursor & cur, int y) const;
911 /// get table column from y coordinate
912 int columnFromX(Cursor & cur, int x) const;
914 Inset * editXY(Cursor & cur, int x, int y);
915 /// can we go further down on mouse click?
916 bool descendable(BufferView const &) const { return true; }
917 /// Update the counters of this inset and of its contents
918 void updateBuffer(ParIterator const &, UpdateType);
920 void addToToc(DocIterator const &) const;
923 bool completionSupported(Cursor const &) const;
925 bool inlineCompletionSupported(Cursor const & cur) const;
927 bool automaticInlineCompletion() const;
929 bool automaticPopupCompletion() const;
931 bool showCompletionCursor() const;
933 CompletionList const * createCompletionList(Cursor const & cur) const;
935 docstring completionPrefix(Cursor const & cur) const;
937 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
939 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
941 virtual bool usePlainLayout() const { return true; }
944 InsetTabular * asInsetTabular() { return this; }
946 InsetTabular const * asInsetTabular() const { return this; }
948 bool isRightToLeft(Cursor & cur) const;
949 /// writes the cells between stidx and enidx as a string, optionally
950 /// descending into the insets
951 docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
953 /// Returns whether the cell in the specified row and column is selected.
954 bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
956 // Public structures and variables
958 mutable Tabular tabular;
962 InsetTabular(InsetTabular const &);
964 void doDispatch(Cursor & cur, FuncRequest & cmd);
966 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
968 Inset * clone() const { return new InsetTabular(*this); }
971 void drawCellLines(PainterInfo &, int x, int y, row_type row,
972 idx_type cell) const;
974 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
977 void moveNextCell(Cursor & cur,
978 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
980 void movePrevCell(Cursor & cur,
981 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
983 int cellXPos(idx_type cell) const;
985 int cellYPos(idx_type cell) const;
987 void resetPos(Cursor & cur) const;
989 bool copySelection(Cursor & cur);
991 bool pasteClipboard(Cursor & cur);
993 void cutSelection(Cursor & cur);
995 void getSelection(Cursor & cur, row_type & rs, row_type & re,
996 col_type & cs, col_type & ce) const;
998 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
1000 /// return the "Manhattan distance" to nearest corner
1001 int dist(BufferView &, idx_type cell, int x, int y) const;
1002 /// return the cell nearest to x, y
1003 idx_type getNearestCell(BufferView &, int x, int y) const;
1005 /// test the rotation state of the give cell range.
1006 bool oneCellHasRotationState(bool rotated,
1007 row_type row_start, row_type row_end,
1008 col_type col_start, col_type col_end) const;
1010 mutable idx_type first_visible_cell;
1013 /// The vertical offset of the table due to the vertical
1014 /// alignment with respect to the baseline.
1015 mutable int offset_valign_;
1016 /// true when selecting rows with the mouse
1018 /// true when selecting columns with the mouse
1022 std::string const featureAsString(Tabular::Feature feature);
1024 /// Split cell on decimal symbol
1025 InsetTableCell splitCell(InsetTableCell & head, docstring const decimal_sym, bool & hassep);
1029 #endif // INSET_TABULAR_H