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
337 // we have this header type (is set in the getLT... functions)
339 // double borders on top
341 // double borders on bottom
343 // used for FirstHeader & LastFooter and if this is true
344 // all the rows marked as FirstHeader or LastFooter are
345 // ignored in the output and it is set to be empty!
349 /// type for row numbers
350 typedef size_t row_type;
351 /// type for column numbers
352 typedef size_t col_type;
353 /// type for cell indices
354 typedef size_t idx_type;
355 /// index indicating an invalid position
356 static const idx_type npos = static_cast<idx_type>(-1);
359 Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
361 /// Returns true if there is a topline, returns false if not
362 bool topLine(idx_type cell) const;
363 /// Returns true if there is a topline, returns false if not
364 bool bottomLine(idx_type cell) const;
365 /// Returns true if there is a topline, returns false if not
366 bool leftLine(idx_type cell) const;
367 /// Returns true if there is a topline, returns false if not
368 bool rightLine(idx_type cell) const;
370 /// return space occupied by the second horizontal line and
371 /// interline space above row \p row in pixels
372 int interRowSpace(row_type row) const;
374 int interColumnSpace(idx_type cell) const;
376 /* returns the maximum over all rows */
378 int cellWidth(idx_type cell) const;
380 int cellHeight(idx_type cell) const;
386 row_type nrows() const {return row_info.size();}
388 col_type ncols() const {return column_info.size();}
390 int rowAscent(row_type row) const;
392 int rowDescent(row_type row) const;
394 void setRowAscent(row_type row, int height);
396 void setRowDescent(row_type row, int height);
398 void setTopLine(idx_type cell, bool line);
400 void setBottomLine(idx_type cell, bool line);
402 void setLeftLine(idx_type cell, bool line);
404 void setRightLine(idx_type cell, bool line);
406 bool rowTopLine(row_type row) const;
408 bool rowBottomLine(row_type row) const;
410 bool columnLeftLine(col_type column) const;
412 bool columnRightLine(col_type column) const;
414 void setAlignment(idx_type cell, LyXAlignment align,
415 bool onlycolumn = false);
417 void setVAlignment(idx_type cell, VAlignment align,
418 bool onlycolumn = false);
420 void setTabularWidth(Length const & l) { tabular_width = l; }
422 Length tabularWidth() const { return tabular_width; }
424 void setColumnPWidth(Cursor &, idx_type, Length const &);
426 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
428 bool setMROffset(Cursor &, idx_type, Length const &);
430 void setAlignSpecial(idx_type cell, docstring const & special,
433 LyXAlignment getAlignment(idx_type cell,
434 bool onlycolumn = false) const;
436 VAlignment getVAlignment(idx_type cell,
437 bool onlycolumn = false) const;
439 Length const getPWidth(idx_type cell) const;
441 Length const getMROffset(idx_type cell) const;
443 int textHOffset(idx_type cell) const;
445 int textVOffset(idx_type cell) const;
447 void appendRow(idx_type cell);
449 void deleteRow(row_type row);
451 void copyRow(row_type);
453 void appendColumn(idx_type cell);
455 void deleteColumn(col_type column);
457 void copyColumn(col_type);
459 idx_type getFirstCellInRow(row_type row) const;
461 idx_type getLastCellInRow(row_type row) const;
463 idx_type numberOfCellsInRow(row_type row) const;
465 void write(std::ostream &) const;
469 void latex(otexstream &, OutputParams const &) const;
471 int docbook(odocstream & os, OutputParams const &) const;
473 docstring xhtml(XHTMLStream & os, OutputParams const &) const;
475 void plaintext(odocstream &,
476 OutputParams const & runparams, int const depth,
477 bool onlydata, char_type delim) const;
479 bool isMultiColumn(idx_type cell) const;
481 idx_type setMultiColumn(idx_type cell, idx_type number,
482 bool const right_border);
484 void unsetMultiColumn(idx_type cell);
486 bool isPartOfMultiColumn(row_type row, col_type column) const;
488 bool isPartOfMultiRow(row_type row, col_type column) const;
490 bool isMultiRow(idx_type cell) const;
492 idx_type setMultiRow(idx_type cell, idx_type number,
493 bool const bottom_border);
495 void unsetMultiRow(idx_type cell);
497 row_type cellRow(idx_type cell) const;
499 col_type cellColumn(idx_type cell) const;
501 void setRotateCell(idx_type cell, bool);
503 bool getRotateCell(idx_type cell) const;
505 bool needRotating() const;
507 bool isLastCell(idx_type cell) const;
509 idx_type cellAbove(idx_type cell) const;
511 idx_type cellBelow(idx_type cell) const;
513 idx_type cellIndex(row_type row, col_type column) const;
515 void setUsebox(idx_type cell, BoxType);
517 BoxType getUsebox(idx_type cell) const;
519 // Long Tabular Options support functions
521 void setLTHead(row_type row, bool flag, ltType const &, bool first);
523 bool getRowOfLTHead(row_type row, ltType &) const;
525 bool getRowOfLTFirstHead(row_type row, ltType &) const;
527 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
529 bool getRowOfLTFoot(row_type row, ltType &) const;
531 bool getRowOfLTLastFoot(row_type row, ltType &) const;
533 void setLTNewPage(row_type row, bool what);
535 bool getLTNewPage(row_type row) const;
537 idx_type setLTCaption(row_type row, bool what);
539 bool ltCaption(row_type row) const;
541 bool haveLTHead(bool withcaptions = true) const;
543 bool haveLTFirstHead(bool withcaptions = true) const;
545 bool haveLTFoot(bool withcaptions = true) const;
547 bool haveLTLastFoot(bool withcaptions = true) const;
549 bool haveLTCaption(CaptionType captiontype = CAPTION_ANY) const;
551 // end longtable support
553 shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
555 shared_ptr<InsetTableCell> cellInset(row_type row,
556 col_type column) const;
558 void setCellInset(row_type row, col_type column,
559 shared_ptr<InsetTableCell>) const;
560 /// Search for \param inset in the tabular, with the
562 void validate(LaTeXFeatures &) const;
564 // FIXME Now that cells have an InsetTableCell as their insets, rather
565 // than an InsetText, it'd be possible to reverse the relationship here,
566 // so that cell_vector was a vector<InsetTableCell> rather than a
567 // vector<CellData>, and an InsetTableCell had a CellData as a member,
568 // or perhaps just had its members as members.
575 CellData(CellData const &);
577 CellData & operator=(CellData);
579 void swap(CellData & rhs);
591 LyXAlignment alignment;
593 VAlignment valignment;
594 /// width of the part before the decimal
596 /// width of the decimal part
613 docstring align_special;
615 Length p_width; // this is only set for multicolumn!!!
617 shared_ptr<InsetTableCell> inset;
619 CellData & cellInfo(idx_type cell) const;
621 typedef std::vector<CellData> cell_vector;
623 typedef std::vector<cell_vector> cell_vvector;
634 /// Extra space between the top line and this row
636 /// Ignore top_space if true and use the default top space
637 bool top_space_default;
638 /// Extra space between this row and the bottom line
640 /// Ignore bottom_space if true and use the default bottom space
641 bool bottom_space_default;
642 /// Extra space between the bottom line and the next top line
643 Length interline_space;
644 /// Ignore interline_space if true and use the default interline space
645 bool interline_space_default;
646 /// This are for longtabulars only
649 /// a row of endfirsthead
653 /// row of endlastfoot
655 /// row for a newpage
661 typedef std::vector<RowData> row_vector;
669 LyXAlignment alignment;
671 VAlignment valignment;
677 docstring align_special;
679 docstring decimal_point;
682 typedef std::vector<ColumnData> column_vector;
685 idx_type numberofcells;
687 std::vector<row_type> rowofcell;
689 std::vector<col_type> columnofcell;
693 column_vector column_info;
695 mutable cell_vvector cell_info;
697 Length tabular_width;
703 VAlignment tabular_valignment;
707 HAlignment longtabular_alignment;
709 bool is_long_tabular;
712 /// endfirsthead data
720 void init(Buffer *, row_type rows_arg,
721 col_type columns_arg);
723 void updateIndexes();
725 bool setFixedWidth(row_type r, col_type c);
726 /// return true of update is needed
727 bool updateColumnWidths();
729 idx_type columnSpan(idx_type cell) const;
731 idx_type rowSpan(idx_type cell) const;
733 BoxType useParbox(idx_type cell) const;
735 // helper function for Latex
737 void TeXTopHLine(otexstream &, row_type row, std::string const lang) const;
739 void TeXBottomHLine(otexstream &, row_type row, std::string const lang) const;
741 void TeXCellPreamble(otexstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const;
743 void TeXCellPostamble(otexstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
745 void TeXLongtableHeaderFooter(otexstream &, OutputParams const &) const;
747 bool isValidRow(row_type const row) const;
749 void TeXRow(otexstream &, row_type const row,
750 OutputParams const &) const;
752 // helper functions for plain text
754 bool plaintextTopHLine(odocstream &, row_type row,
755 std::vector<unsigned int> const &) const;
757 bool plaintextBottomHLine(odocstream &, row_type row,
758 std::vector<unsigned int> const &) const;
760 void plaintextPrintCell(odocstream &,
761 OutputParams const &,
762 idx_type cell, row_type row, col_type column,
763 std::vector<unsigned int> const &,
764 bool onlydata) const;
765 /// auxiliary function for docbook
766 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
768 docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &,
769 bool header = false) const;
771 /// change associated Buffer
772 void setBuffer(Buffer & buffer);
773 /// retrieve associated Buffer
774 Buffer & buffer() const { return *buffer_; }
782 class InsetTabular : public Inset
786 InsetTabular(Buffer *, row_type rows = 1,
787 col_type columns = 1);
791 void setBuffer(Buffer & buffer);
794 static void string2params(std::string const &, InsetTabular &);
796 static std::string params2string(InsetTabular const &);
800 void write(std::ostream &) const;
802 void metrics(MetricsInfo &, Dimension &) const;
804 void draw(PainterInfo & pi, int x, int y) const;
806 void drawSelection(PainterInfo & pi, int x, int y) const;
808 void drawBackground(PainterInfo & pi, int x, int y) const;
810 bool editable() const { return true; }
812 bool hasSettings() const { return true; }
814 bool insetAllowed(InsetCode code) const;
816 bool allowSpellCheck() const { return true; }
818 bool canTrackChanges() const { return true; }
819 /** returns false if, when outputing LaTeX, font changes should
820 be closed before generating this inset. This is needed for
821 insets that may contain several paragraphs */
822 bool inheritFont() const { return false; }
824 DisplayType display() const;
826 void latex(otexstream &, OutputParams const &) const;
828 int plaintext(odocstream &, OutputParams const &) const;
830 int docbook(odocstream &, OutputParams const &) const;
832 docstring xhtml(XHTMLStream &, OutputParams const &) const;
834 void validate(LaTeXFeatures & features) const;
836 InsetCode lyxCode() const { return TABULAR_CODE; }
838 std::string contextMenu(BufferView const &, int, int) const;
840 std::string contextMenuName() const;
841 /// get offset of this cursor slice relative to our upper left corner
842 void cursorPos(BufferView const & bv, CursorSlice const & sl,
843 bool boundary, int & x, int & y) const;
845 bool tabularFeatures(Cursor & cur, std::string const & what);
847 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
848 std::string const & val = std::string());
850 size_t nargs() const { return tabular.numberofcells; }
852 shared_ptr<InsetTableCell const> cell(idx_type) const;
854 shared_ptr<InsetTableCell> cell(idx_type);
856 Text * getText(int) const;
858 /// set the change for the entire inset
859 void setChange(Change const & change);
860 /// accept the changes within the inset
861 void acceptChanges();
862 /// reject the changes within the inset
863 void rejectChanges();
865 // this should return true if we have a "normal" cell, otherwise false.
866 // "normal" means without width set!
867 /// should all paragraphs be output with "Standard" layout?
868 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
870 virtual bool forcePlainLayout(idx_type cell = 0) const;
872 void addPreview(DocIterator const & inset_pos,
873 graphics::PreviewLoader &) const;
875 /// lock cell with given index
876 void edit(Cursor & cur, bool front, EntryDirection entry_from);
877 /// get table row from x coordinate
878 int rowFromY(Cursor & cur, int y) const;
879 /// get table column from y coordinate
880 int columnFromX(Cursor & cur, int x) const;
882 Inset * editXY(Cursor & cur, int x, int y);
883 /// can we go further down on mouse click?
884 bool descendable(BufferView const &) const { return true; }
885 /// Update the counters of this inset and of its contents
886 void updateBuffer(ParIterator const &, UpdateType);
888 void addToToc(DocIterator const &) const;
891 bool completionSupported(Cursor const &) const;
893 bool inlineCompletionSupported(Cursor const & cur) const;
895 bool automaticInlineCompletion() const;
897 bool automaticPopupCompletion() const;
899 bool showCompletionCursor() const;
901 CompletionList const * createCompletionList(Cursor const & cur) const;
903 docstring completionPrefix(Cursor const & cur) const;
905 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
907 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
909 virtual bool usePlainLayout() const { return true; }
912 InsetTabular * asInsetTabular() { return this; }
914 InsetTabular const * asInsetTabular() const { return this; }
916 bool isRightToLeft(Cursor & cur) const;
917 /// writes the cells between stidx and enidx as a string, optionally
918 /// descending into the insets
919 docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
921 /// Returns whether the cell in the specified row and column is selected.
922 bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
924 // Public structures and variables
926 mutable Tabular tabular;
930 InsetTabular(InsetTabular const &);
932 void doDispatch(Cursor & cur, FuncRequest & cmd);
934 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
936 Inset * clone() const { return new InsetTabular(*this); }
939 void drawCellLines(PainterInfo &, int x, int y, row_type row,
940 idx_type cell) const;
942 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
945 void moveNextCell(Cursor & cur,
946 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
948 void movePrevCell(Cursor & cur,
949 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
951 int cellXPos(idx_type cell) const;
953 int cellYPos(idx_type cell) const;
955 void resetPos(Cursor & cur) const;
957 bool copySelection(Cursor & cur);
959 bool pasteClipboard(Cursor & cur);
961 void cutSelection(Cursor & cur);
963 void getSelection(Cursor & cur, row_type & rs, row_type & re,
964 col_type & cs, col_type & ce) const;
966 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
968 /// return the "Manhattan distance" to nearest corner
969 int dist(BufferView &, idx_type cell, int x, int y) const;
970 /// return the cell nearest to x, y
971 idx_type getNearestCell(BufferView &, int x, int y) const;
973 /// test the rotation state of the give cell range.
974 bool oneCellHasRotationState(bool rotated,
975 row_type row_start, row_type row_end,
976 col_type col_start, col_type col_end) const;
978 mutable idx_type first_visible_cell;
981 /// The vertical offset of the table due to the vertical
982 /// alignment with respect to the baseline.
983 mutable int offset_valign_;
984 /// true when selecting rows with the mouse
986 /// true when selecting columns with the mouse
990 std::string const featureAsString(Tabular::Feature feature);
992 /// Split cell on decimal symbol
993 InsetTableCell splitCell(InsetTableCell & head, docstring const decimal_sym, bool & hassep);
997 #endif // INSET_TABULAR_H