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
209 UNSET_ROTATE_TABULAR,
211 TOGGLE_ROTATE_TABULAR,
243 SET_SPECIAL_MULTICOLUMN,
259 TABULAR_VALIGN_MIDDLE,
261 TABULAR_VALIGN_BOTTOM,
263 LONGTABULAR_ALIGN_LEFT,
265 LONGTABULAR_ALIGN_CENTER,
267 LONGTABULAR_ALIGN_RIGHT,
278 CELL_BEGIN_OF_MULTICOLUMN,
280 CELL_PART_OF_MULTICOLUMN,
282 CELL_BEGIN_OF_MULTIROW,
284 CELL_PART_OF_MULTIROW
292 LYX_VALIGN_MIDDLE = 1,
294 LYX_VALIGN_BOTTOM = 2
300 LYX_LONGTABULAR_ALIGN_LEFT = 0,
302 LYX_LONGTABULAR_ALIGN_CENTER = 1,
304 LYX_LONGTABULAR_ALIGN_RIGHT = 2
320 // we have this header type (is set in the getLT... functions)
322 // double borders on top
324 // double borders on bottom
326 // used for FirstHeader & LastFooter and if this is true
327 // all the rows marked as FirstHeader or LastFooter are
328 // ignored in the output and it is set to be empty!
332 /// type for row numbers
333 typedef size_t row_type;
334 /// type for column numbers
335 typedef size_t col_type;
336 /// type for cell indices
337 typedef size_t idx_type;
338 /// index indicating an invalid position
339 static const idx_type npos = static_cast<idx_type>(-1);
342 Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
344 /// Returns true if there is a topline, returns false if not
345 bool topLine(idx_type cell) const;
346 /// Returns true if there is a topline, returns false if not
347 bool bottomLine(idx_type cell) const;
348 /// Returns true if there is a topline, returns false if not
349 bool leftLine(idx_type cell) const;
350 /// Returns true if there is a topline, returns false if not
351 bool rightLine(idx_type cell) const;
353 /// return space occupied by the second horizontal line and
354 /// interline space above row \p row in pixels
355 int interRowSpace(row_type row) const;
357 int interColumnSpace(idx_type cell) const;
359 /* returns the maximum over all rows */
361 int cellWidth(idx_type cell) const;
363 int cellHeight(idx_type cell) const;
369 row_type nrows() const {return row_info.size();}
371 col_type ncols() const {return column_info.size();}
373 int rowAscent(row_type row) const;
375 int rowDescent(row_type row) const;
377 void setRowAscent(row_type row, int height);
379 void setRowDescent(row_type row, int height);
381 void setTopLine(idx_type cell, bool line);
383 void setBottomLine(idx_type cell, bool line);
385 void setLeftLine(idx_type cell, bool line);
387 void setRightLine(idx_type cell, bool line);
389 bool rowTopLine(row_type row) const;
391 bool rowBottomLine(row_type row) const;
393 bool columnLeftLine(col_type column) const;
395 bool columnRightLine(col_type column) const;
397 void setAlignment(idx_type cell, LyXAlignment align,
398 bool onlycolumn = false);
400 void setVAlignment(idx_type cell, VAlignment align,
401 bool onlycolumn = false);
403 void setColumnPWidth(Cursor &, idx_type, Length const &);
405 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
407 void setAlignSpecial(idx_type cell, docstring const & special,
410 LyXAlignment getAlignment(idx_type cell,
411 bool onlycolumn = false) const;
413 VAlignment getVAlignment(idx_type cell,
414 bool onlycolumn = false) const;
416 Length const getPWidth(idx_type cell) const;
418 int textHOffset(idx_type cell) const;
420 int textVOffset(idx_type cell) const;
422 void appendRow(idx_type cell);
424 void deleteRow(row_type row);
426 void copyRow(row_type);
428 void appendColumn(idx_type cell);
430 void deleteColumn(col_type column);
432 void copyColumn(col_type);
434 idx_type getFirstCellInRow(row_type row) const;
436 idx_type getLastCellInRow(row_type row) const;
438 idx_type numberOfCellsInRow(row_type row) const;
440 void write(std::ostream &) const;
444 int latex(odocstream &, OutputParams const &) const;
446 int docbook(odocstream & os, OutputParams const &) const;
448 docstring xhtml(XHTMLStream & os, OutputParams const &) const;
450 void plaintext(odocstream &,
451 OutputParams const & runparams, int const depth,
452 bool onlydata, char_type delim) const;
454 bool isMultiColumn(idx_type cell) const;
456 idx_type setMultiColumn(idx_type cell, idx_type number);
458 void unsetMultiColumn(idx_type cell);
460 bool isPartOfMultiColumn(row_type row, col_type column) const;
462 bool isPartOfMultiRow(row_type row, col_type column) const;
464 bool isMultiRow(idx_type cell) const;
466 idx_type setMultiRow(idx_type cell, idx_type number);
468 void unsetMultiRow(idx_type cell);
470 row_type cellRow(idx_type cell) const;
472 col_type cellColumn(idx_type cell) const;
474 void setRotateCell(idx_type cell, bool);
476 bool getRotateCell(idx_type cell) const;
478 bool needRotating() const;
480 bool isLastCell(idx_type cell) const;
482 idx_type cellAbove(idx_type cell) const;
484 idx_type cellBelow(idx_type cell) const;
486 idx_type cellIndex(row_type row, col_type column) const;
488 void setUsebox(idx_type cell, BoxType);
490 BoxType getUsebox(idx_type cell) const;
492 // Long Tabular Options support functions
494 bool checkLTType(row_type row, ltType const &) const;
496 void setLTHead(row_type row, bool flag, ltType const &, bool first);
498 bool getRowOfLTHead(row_type row, ltType &) const;
500 bool getRowOfLTFirstHead(row_type row, ltType &) const;
502 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
504 bool getRowOfLTFoot(row_type row, ltType &) const;
506 bool getRowOfLTLastFoot(row_type row, ltType &) const;
508 void setLTNewPage(row_type row, bool what);
510 bool getLTNewPage(row_type row) const;
512 idx_type setLTCaption(row_type row, bool what);
514 bool ltCaption(row_type row) const;
516 bool haveLTHead() const;
518 bool haveLTFirstHead() const;
520 bool haveLTFoot() const;
522 bool haveLTLastFoot() const;
524 bool haveLTCaption() const;
526 // end longtable support
528 shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
530 shared_ptr<InsetTableCell> cellInset(row_type row,
531 col_type column) const;
533 void setCellInset(row_type row, col_type column,
534 shared_ptr<InsetTableCell>) const;
535 /// Search for \param inset in the tabular, with the
537 void validate(LaTeXFeatures &) const;
539 // FIXME Now that cells have an InsetTableCell as their insets, rather
540 // than an InsetText, it'd be possible to reverse the relationship here,
541 // so that cell_vector was a vector<InsetTableCell> rather than a
542 // vector<CellData>, and an InsetTableCell had a CellData as a member,
543 // or perhaps just had its members as members.
550 CellData(CellData const &);
552 CellData & operator=(CellData);
554 void swap(CellData & rhs);
564 LyXAlignment alignment;
566 VAlignment valignment;
567 /// width of the part before the decimal
569 /// width of the decimal part
586 docstring align_special;
588 Length p_width; // this is only set for multicolumn!!!
590 shared_ptr<InsetTableCell> inset;
592 CellData & cellInfo(idx_type cell) const;
594 typedef std::vector<CellData> cell_vector;
596 typedef std::vector<cell_vector> cell_vvector;
607 /// Extra space between the top line and this row
609 /// Ignore top_space if true and use the default top space
610 bool top_space_default;
611 /// Extra space between this row and the bottom line
613 /// Ignore bottom_space if true and use the default bottom space
614 bool bottom_space_default;
615 /// Extra space between the bottom line and the next top line
616 Length interline_space;
617 /// Ignore interline_space if true and use the default interline space
618 bool interline_space_default;
619 /// This are for longtabulars only
622 /// a row of endfirsthead
626 /// row of endlastfoot
628 /// row for a newpage
634 typedef std::vector<RowData> row_vector;
642 LyXAlignment alignment;
644 VAlignment valignment;
650 docstring align_special;
652 docstring decimal_point;
655 typedef std::vector<ColumnData> column_vector;
658 idx_type numberofcells;
660 std::vector<row_type> rowofcell;
662 std::vector<col_type> columnofcell;
666 column_vector column_info;
668 mutable cell_vvector cell_info;
674 VAlignment tabular_valignment;
678 HAlignment longtabular_alignment;
680 bool is_long_tabular;
683 /// endfirsthead data
691 void init(Buffer *, row_type rows_arg,
692 col_type columns_arg);
694 void updateIndexes();
696 bool setFixedWidth(row_type r, col_type c);
697 /// return true of update is needed
698 bool updateColumnWidths();
700 idx_type columnSpan(idx_type cell) const;
702 idx_type rowSpan(idx_type cell) const;
704 BoxType useParbox(idx_type cell) const;
706 // helper function for Latex returns number of newlines
708 int TeXTopHLine(odocstream &, row_type row, std::string const lang) const;
710 int TeXBottomHLine(odocstream &, row_type row, std::string const lang) const;
712 int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const;
714 int TeXCellPostamble(odocstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
716 int TeXLongtableHeaderFooter(odocstream &, OutputParams const &) const;
718 bool isValidRow(row_type const row) const;
720 int TeXRow(odocstream &, row_type const row,
721 OutputParams const &) const;
723 // helper functions for plain text
725 bool plaintextTopHLine(odocstream &, row_type row,
726 std::vector<unsigned int> const &) const;
728 bool plaintextBottomHLine(odocstream &, row_type row,
729 std::vector<unsigned int> const &) const;
731 void plaintextPrintCell(odocstream &,
732 OutputParams const &,
733 idx_type cell, row_type row, col_type column,
734 std::vector<unsigned int> const &,
735 bool onlydata) const;
736 /// auxiliary function for docbook
737 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
739 docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &) const;
741 /// change associated Buffer
742 void setBuffer(Buffer & buffer);
743 /// retrieve associated Buffer
744 Buffer & buffer() const { return *buffer_; }
752 class InsetTabular : public Inset
756 InsetTabular(Buffer *, row_type rows = 1,
757 col_type columns = 1);
761 void setBuffer(Buffer & buffer);
764 static void string2params(std::string const &, InsetTabular &);
766 static std::string params2string(InsetTabular const &);
770 void write(std::ostream &) const;
772 void metrics(MetricsInfo &, Dimension &) const;
774 void draw(PainterInfo & pi, int x, int y) const;
776 void drawSelection(PainterInfo & pi, int x, int y) const;
778 bool editable() const { return true; }
780 bool hasSettings() const { return true; }
782 bool insetAllowed(InsetCode code) const;
784 bool allowSpellCheck() const { return true; }
786 bool canTrackChanges() const { return true; }
787 /** returns true if, when outputing LaTeX, font changes should
788 be closed before generating this inset. This is needed for
789 insets that may contain several paragraphs */
790 bool noFontChange() const { return true; }
792 DisplayType display() const;
794 int latex(odocstream &, OutputParams const &) const;
796 int plaintext(odocstream &, OutputParams const &) const;
798 int docbook(odocstream &, OutputParams const &) const;
800 docstring xhtml(XHTMLStream &, OutputParams const &) const;
802 void validate(LaTeXFeatures & features) const;
804 InsetCode lyxCode() const { return TABULAR_CODE; }
806 docstring contextMenu(BufferView const & bv, int x, int y) const;
807 /// get offset of this cursor slice relative to our upper left corner
808 void cursorPos(BufferView const & bv, CursorSlice const & sl,
809 bool boundary, int & x, int & y) const;
811 bool tabularFeatures(Cursor & cur, std::string const & what);
813 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
814 std::string const & val = std::string());
816 size_t nargs() const { return tabular.numberofcells; }
818 shared_ptr<InsetTableCell const> cell(idx_type) const;
820 shared_ptr<InsetTableCell> cell(idx_type);
822 Text * getText(int) const;
824 /// set the change for the entire inset
825 void setChange(Change const & change);
826 /// accept the changes within the inset
827 void acceptChanges();
828 /// reject the changes within the inset
829 void rejectChanges();
831 // this should return true if we have a "normal" cell, otherwise false.
832 // "normal" means without width set!
833 /// should all paragraphs be output with "Standard" layout?
834 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
836 virtual bool forcePlainLayout(idx_type cell = 0) const;
838 void addPreview(DocIterator const & inset_pos,
839 graphics::PreviewLoader &) const;
841 /// lock cell with given index
842 void edit(Cursor & cur, bool front, EntryDirection entry_from);
843 /// get table row from x coordinate
844 int rowFromY(Cursor & cur, int y) const;
845 /// get table column from y coordinate
846 int columnFromX(Cursor & cur, int x) const;
848 Inset * editXY(Cursor & cur, int x, int y);
849 /// can we go further down on mouse click?
850 bool descendable(BufferView const &) const { return true; }
851 /// Update the counters of this inset and of its contents
852 void updateBuffer(ParIterator const &, UpdateType);
854 void addToToc(DocIterator const &);
857 bool completionSupported(Cursor const &) const;
859 bool inlineCompletionSupported(Cursor const & cur) const;
861 bool automaticInlineCompletion() const;
863 bool automaticPopupCompletion() const;
865 bool showCompletionCursor() const;
867 CompletionList const * createCompletionList(Cursor const & cur) const;
869 docstring completionPrefix(Cursor const & cur) const;
871 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
873 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
875 virtual bool usePlainLayout() const { return true; }
878 InsetTabular * asInsetTabular() { return this; }
880 InsetTabular const * asInsetTabular() const { return this; }
882 bool isRightToLeft(Cursor & cur) const;
883 /// writes the cells between stidx and enidx as a string, optionally
884 /// descending into the insets
885 docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
887 /// Returns whether the cell in the specified row and column is selected.
888 bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
890 // Public structures and variables
892 mutable Tabular tabular;
896 InsetTabular(InsetTabular const &);
898 void doDispatch(Cursor & cur, FuncRequest & cmd);
900 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
902 int scroll() const { return scx_; }
904 Inset * clone() const { return new InsetTabular(*this); }
907 void drawCellLines(PainterInfo &, int x, int y, row_type row,
908 idx_type cell) const;
910 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
913 void moveNextCell(Cursor & cur,
914 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
916 void movePrevCell(Cursor & cur,
917 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
919 int cellXPos(idx_type cell) const;
921 void resetPos(Cursor & cur) const;
923 bool copySelection(Cursor & cur);
925 bool pasteClipboard(Cursor & cur);
927 void cutSelection(Cursor & cur);
929 void getSelection(Cursor & cur, row_type & rs, row_type & re,
930 col_type & cs, col_type & ce) const;
932 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
934 /// return the "Manhattan distance" to nearest corner
935 int dist(BufferView &, idx_type cell, int x, int y) const;
936 /// return the cell nearest to x, y
937 idx_type getNearestCell(BufferView &, int x, int y) const;
939 /// test the rotation state of the give cell range.
940 bool oneCellHasRotationState(bool rotated,
941 row_type row_start, row_type row_end,
942 col_type col_start, col_type col_end) const;
944 mutable idx_type first_visible_cell;
947 /// true when selecting rows with the mouse
949 /// true when selecting columns with the mouse
953 std::string const featureAsString(Tabular::Feature feature);
955 /// Split cell on decimal symbol
956 InsetTableCell splitCell(InsetTableCell & head, docstring const decimal_sym, bool & hassep);
960 #endif // INSET_TABULAR_H