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"
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
202 UNSET_ROTATE_TABULAR,
204 TOGGLE_ROTATE_TABULAR,
232 SET_SPECIAL_MULTICOLUMN,
234 SET_SPECIAL_MULTIROW,
250 TABULAR_VALIGN_MIDDLE,
252 TABULAR_VALIGN_BOTTOM,
254 LONGTABULAR_ALIGN_LEFT,
256 LONGTABULAR_ALIGN_CENTER,
258 LONGTABULAR_ALIGN_RIGHT,
269 CELL_BEGIN_OF_MULTICOLUMN,
271 CELL_PART_OF_MULTICOLUMN,
273 CELL_BEGIN_OF_MULTIROW,
275 CELL_PART_OF_MULTIROW
283 LYX_VALIGN_MIDDLE = 1,
285 LYX_VALIGN_BOTTOM = 2
291 LYX_LONGTABULAR_ALIGN_LEFT = 0,
293 LYX_LONGTABULAR_ALIGN_CENTER = 1,
295 LYX_LONGTABULAR_ALIGN_RIGHT = 2
311 // we have this header type (is set in the getLT... functions)
313 // double borders on top
315 // double borders on bottom
317 // used for FirstHeader & LastFooter and if this is true
318 // all the rows marked as FirstHeader or LastFooter are
319 // ignored in the output and it is set to be empty!
323 /// type for row numbers
324 typedef size_t row_type;
325 /// type for column numbers
326 typedef size_t col_type;
327 /// type for cell indices
328 typedef size_t idx_type;
329 /// index indicating an invalid position
330 static const idx_type npos = static_cast<idx_type>(-1);
333 Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
335 /// Returns true if there is a topline, returns false if not
336 bool topLine(idx_type cell) const;
337 /// Returns true if there is a topline, returns false if not
338 bool bottomLine(idx_type cell) const;
339 /// Returns true if there is a topline, returns false if not
340 bool leftLine(idx_type cell) const;
341 /// Returns true if there is a topline, returns false if not
342 bool rightLine(idx_type cell) const;
344 /// return space occupied by the second horizontal line and
345 /// interline space above row \p row in pixels
346 int interRowSpace(row_type row) const;
348 int interColumnSpace(idx_type cell) const;
350 /* returns the maximum over all rows */
352 int cellWidth(idx_type cell) const;
354 int cellHeight(idx_type cell) const;
360 row_type nrows() const {return row_info.size();}
362 col_type ncols() const {return column_info.size();}
364 int rowAscent(row_type row) const;
366 int rowDescent(row_type row) const;
368 void setRowAscent(row_type row, int height);
370 void setRowDescent(row_type row, int height);
372 void setTopLine(idx_type cell, bool line);
374 void setBottomLine(idx_type cell, bool line);
376 void setLeftLine(idx_type cell, bool line);
378 void setRightLine(idx_type cell, bool line);
380 bool rowTopLine(row_type row) const;
382 bool rowBottomLine(row_type row) const;
384 bool columnLeftLine(col_type column) const;
386 bool columnRightLine(col_type column) const;
388 void setAlignment(idx_type cell, LyXAlignment align,
389 bool onlycolumn = false);
391 void setVAlignment(idx_type cell, VAlignment align,
392 bool onlycolumn = false);
394 void setColumnPWidth(Cursor &, idx_type, Length const &);
396 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
398 void setAlignSpecial(idx_type cell, docstring const & special,
401 LyXAlignment getAlignment(idx_type cell,
402 bool onlycolumn = false) const;
404 VAlignment getVAlignment(idx_type cell,
405 bool onlycolumn = false) const;
407 Length const getPWidth(idx_type cell) const;
409 int textHOffset(idx_type cell) const;
411 int textVOffset(idx_type cell) const;
413 void appendRow(idx_type cell);
415 void deleteRow(row_type row);
417 void copyRow(row_type);
419 void appendColumn(idx_type cell);
421 void deleteColumn(col_type column);
423 void copyColumn(col_type);
425 idx_type getFirstCellInRow(row_type row) const;
427 idx_type getLastCellInRow(row_type row) const;
429 idx_type numberOfCellsInRow(row_type row) const;
431 void write(std::ostream &) const;
435 int latex(odocstream &, OutputParams const &) const;
437 int docbook(odocstream & os, OutputParams const &) const;
439 docstring xhtml(XHTMLStream & os, OutputParams const &) const;
441 void plaintext(odocstream &,
442 OutputParams const & runparams, int const depth,
443 bool onlydata, char_type delim) const;
445 bool isMultiColumn(idx_type cell) const;
447 idx_type setMultiColumn(idx_type cell, idx_type number);
449 void unsetMultiColumn(idx_type cell);
451 bool isPartOfMultiColumn(row_type row, col_type column) const;
453 bool isPartOfMultiRow(row_type row, col_type column) const;
455 bool isMultiRow(idx_type cell) const;
457 idx_type setMultiRow(idx_type cell, idx_type number);
459 void unsetMultiRow(idx_type cell);
461 row_type cellRow(idx_type cell) const;
463 col_type cellColumn(idx_type cell) const;
465 void setRotateCell(idx_type cell, bool);
467 bool getRotateCell(idx_type cell) const;
469 bool needRotating() const;
471 bool isLastCell(idx_type cell) const;
473 idx_type cellAbove(idx_type cell) const;
475 idx_type cellBelow(idx_type cell) const;
477 idx_type cellIndex(row_type row, col_type column) const;
479 void setUsebox(idx_type cell, BoxType);
481 BoxType getUsebox(idx_type cell) const;
483 // Long Tabular Options support functions
485 bool checkLTType(row_type row, ltType const &) const;
487 void setLTHead(row_type row, bool flag, ltType const &, bool first);
489 bool getRowOfLTHead(row_type row, ltType &) const;
491 bool getRowOfLTFirstHead(row_type row, ltType &) const;
493 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
495 bool getRowOfLTFoot(row_type row, ltType &) const;
497 bool getRowOfLTLastFoot(row_type row, ltType &) const;
499 void setLTNewPage(row_type row, bool what);
501 bool getLTNewPage(row_type row) const;
503 idx_type setLTCaption(row_type row, bool what);
505 bool ltCaption(row_type row) const;
507 bool haveLTHead() const;
509 bool haveLTFirstHead() const;
511 bool haveLTFoot() const;
513 bool haveLTLastFoot() const;
515 bool haveLTCaption() const;
517 // end longtable support
519 shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
521 shared_ptr<InsetTableCell> cellInset(row_type row,
522 col_type column) const;
524 void setCellInset(row_type row, col_type column,
525 shared_ptr<InsetTableCell>) const;
526 /// Search for \param inset in the tabular, with the
528 void validate(LaTeXFeatures &) const;
530 // FIXME Now that cells have an InsetTableCell as their insets, rather
531 // than an InsetText, it'd be possible to reverse the relationship here,
532 // so that cell_vector was a vector<InsetTableCell> rather than a
533 // vector<CellData>, and an InsetTableCell had a CellData as a member,
534 // or perhaps just had its members as members.
541 CellData(CellData const &);
543 CellData & operator=(CellData);
545 void swap(CellData & rhs);
555 LyXAlignment alignment;
557 VAlignment valignment;
558 /// width of the part before the decimal
560 /// width of the decimal part
577 docstring align_special;
579 Length p_width; // this is only set for multicolumn!!!
581 shared_ptr<InsetTableCell> inset;
583 CellData & cellInfo(idx_type cell) const;
585 typedef std::vector<CellData> cell_vector;
587 typedef std::vector<cell_vector> cell_vvector;
598 /// Extra space between the top line and this row
600 /// Ignore top_space if true and use the default top space
601 bool top_space_default;
602 /// Extra space between this row and the bottom line
604 /// Ignore bottom_space if true and use the default bottom space
605 bool bottom_space_default;
606 /// Extra space between the bottom line and the next top line
607 Length interline_space;
608 /// Ignore interline_space if true and use the default interline space
609 bool interline_space_default;
610 /// This are for longtabulars only
613 /// a row of endfirsthead
617 /// row of endlastfoot
619 /// row for a newpage
625 typedef std::vector<RowData> row_vector;
633 LyXAlignment alignment;
635 VAlignment valignment;
641 docstring align_special;
643 docstring decimal_point;
646 typedef std::vector<ColumnData> column_vector;
649 idx_type numberofcells;
651 std::vector<row_type> rowofcell;
653 std::vector<col_type> columnofcell;
657 column_vector column_info;
659 mutable cell_vvector cell_info;
665 VAlignment tabular_valignment;
669 HAlignment longtabular_alignment;
671 bool is_long_tabular;
674 /// endfirsthead data
682 void init(Buffer *, row_type rows_arg,
683 col_type columns_arg);
685 void updateIndexes();
687 bool setFixedWidth(row_type r, col_type c);
688 /// return true of update is needed
689 bool updateColumnWidths();
691 idx_type columnSpan(idx_type cell) const;
693 idx_type rowSpan(idx_type cell) const;
695 BoxType useParbox(idx_type cell) const;
697 // helper function for Latex returns number of newlines
699 int TeXTopHLine(odocstream &, row_type row, std::string const lang) const;
701 int TeXBottomHLine(odocstream &, row_type row, std::string const lang) const;
703 int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const;
705 int TeXCellPostamble(odocstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
707 int TeXLongtableHeaderFooter(odocstream &, OutputParams const &) const;
709 bool isValidRow(row_type const row) const;
711 int TeXRow(odocstream &, row_type const row,
712 OutputParams const &) const;
714 // helper functions for plain text
716 bool plaintextTopHLine(odocstream &, row_type row,
717 std::vector<unsigned int> const &) const;
719 bool plaintextBottomHLine(odocstream &, row_type row,
720 std::vector<unsigned int> const &) const;
722 void plaintextPrintCell(odocstream &,
723 OutputParams const &,
724 idx_type cell, row_type row, col_type column,
725 std::vector<unsigned int> const &,
726 bool onlydata) const;
727 /// auxiliary function for docbook
728 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
730 docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &) const;
732 /// change associated Buffer
733 void setBuffer(Buffer & buffer);
734 /// retrieve associated Buffer
735 Buffer & buffer() const { return *buffer_; }
743 class InsetTabular : public Inset
747 InsetTabular(Buffer *, row_type rows = 1,
748 col_type columns = 1);
752 void setBuffer(Buffer & buffer);
755 static void string2params(std::string const &, InsetTabular &);
757 static std::string params2string(InsetTabular const &);
761 void write(std::ostream &) const;
763 void metrics(MetricsInfo &, Dimension &) const;
765 void draw(PainterInfo & pi, int x, int y) const;
767 void drawSelection(PainterInfo & pi, int x, int y) const;
769 bool editable() const { return true; }
771 bool hasSettings() const { return true; }
773 bool insetAllowed(InsetCode code) const;
775 bool allowSpellCheck() const { return true; }
777 bool canTrackChanges() const { return true; }
778 /** returns true if, when outputing LaTeX, font changes should
779 be closed before generating this inset. This is needed for
780 insets that may contain several paragraphs */
781 bool noFontChange() const { return true; }
783 DisplayType display() const;
785 int latex(odocstream &, OutputParams const &) const;
787 int plaintext(odocstream &, OutputParams const &) const;
789 int docbook(odocstream &, OutputParams const &) const;
791 docstring xhtml(XHTMLStream &, OutputParams const &) const;
793 void validate(LaTeXFeatures & features) const;
795 InsetCode lyxCode() const { return TABULAR_CODE; }
797 docstring contextMenu(BufferView const & bv, int x, int y) const;
798 /// get offset of this cursor slice relative to our upper left corner
799 void cursorPos(BufferView const & bv, CursorSlice const & sl,
800 bool boundary, int & x, int & y) const;
802 bool tabularFeatures(Cursor & cur, std::string const & what);
804 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
805 std::string const & val = std::string());
807 size_t nargs() const { return tabular.numberofcells; }
809 shared_ptr<InsetTableCell const> cell(idx_type) const;
811 shared_ptr<InsetTableCell> cell(idx_type);
813 Text * getText(int) const;
815 /// set the change for the entire inset
816 void setChange(Change const & change);
817 /// accept the changes within the inset
818 void acceptChanges();
819 /// reject the changes within the inset
820 void rejectChanges();
822 // this should return true if we have a "normal" cell, otherwise false.
823 // "normal" means without width set!
824 /// should all paragraphs be output with "Standard" layout?
825 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
827 virtual bool forcePlainLayout(idx_type cell = 0) const;
829 void addPreview(DocIterator const & inset_pos,
830 graphics::PreviewLoader &) const;
832 /// lock cell with given index
833 void edit(Cursor & cur, bool front, EntryDirection entry_from);
834 /// get table row from x coordinate
835 int rowFromY(Cursor & cur, int y) const;
836 /// get table column from y coordinate
837 int columnFromX(Cursor & cur, int x) const;
839 Inset * editXY(Cursor & cur, int x, int y);
840 /// can we go further down on mouse click?
841 bool descendable(BufferView const &) const { return true; }
842 /// Update the counters of this inset and of its contents
843 void updateBuffer(ParIterator const &, UpdateType);
845 void addToToc(DocIterator const &);
848 bool completionSupported(Cursor const &) const;
850 bool inlineCompletionSupported(Cursor const & cur) const;
852 bool automaticInlineCompletion() const;
854 bool automaticPopupCompletion() const;
856 bool showCompletionCursor() const;
858 CompletionList const * createCompletionList(Cursor const & cur) const;
860 docstring completionPrefix(Cursor const & cur) const;
862 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
864 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
866 virtual bool usePlainLayout() const { return true; }
869 InsetTabular * asInsetTabular() { return this; }
871 InsetTabular const * asInsetTabular() const { return this; }
873 bool isRightToLeft(Cursor & cur) const;
874 /// writes the cells between stidx and enidx as a string, optionally
875 /// descending into the insets
876 docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
878 /// Returns whether the cell in the specified row and column is selected.
879 bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
881 // Public structures and variables
883 mutable Tabular tabular;
887 InsetTabular(InsetTabular const &);
889 void doDispatch(Cursor & cur, FuncRequest & cmd);
891 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
893 int scroll() const { return scx_; }
895 Inset * clone() const { return new InsetTabular(*this); }
898 void drawCellLines(frontend::Painter &, int x, int y, row_type row,
899 idx_type cell, Change const & change) const;
901 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
904 void moveNextCell(Cursor & cur,
905 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
907 void movePrevCell(Cursor & cur,
908 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
910 int cellXPos(idx_type cell) const;
912 void resetPos(Cursor & cur) const;
914 bool copySelection(Cursor & cur);
916 bool pasteClipboard(Cursor & cur);
918 void cutSelection(Cursor & cur);
920 void getSelection(Cursor & cur, row_type & rs, row_type & re,
921 col_type & cs, col_type & ce) const;
923 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
925 /// return the "Manhattan distance" to nearest corner
926 int dist(BufferView &, idx_type cell, int x, int y) const;
927 /// return the cell nearest to x, y
928 idx_type getNearestCell(BufferView &, int x, int y) const;
930 /// test the rotation state of the give cell range.
931 bool oneCellHasRotationState(bool rotated,
932 row_type row_start, row_type row_end,
933 col_type col_start, col_type col_end) const;
935 mutable idx_type first_visible_cell;
938 /// true when selecting rows with the mouse
940 /// true when selecting columns with the mouse
944 std::string const featureAsString(Tabular::Feature feature);
946 /// Split cell on decimal symbol
947 InsetTableCell splitCell(InsetTableCell & head, docstring const decimal_sym, bool & hassep);
951 #endif // INSET_TABULAR_H