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
12 * Full author contact details are available in file CREDITS.
16 // This is Juergen's rewrite of the tabular (table) support.
18 // Things to think of when designing the new tabular support:
19 // - color support (colortbl, color)
20 // - decimal alignment (dcloumn)
21 // - custom lines (hhline)
27 // This is what I have written about tabular support in the LyX3-Tasks file:
29 // o rewrite of table code. Should probably be written as some
30 // kind of an inset. [Done]
31 // o enhance longtable support
35 #ifndef INSET_TABULAR_H
36 #define INSET_TABULAR_H
39 #include "InsetText.h"
43 #include <boost/shared_ptr.hpp>
60 namespace frontend { class Painter; }
68 // A helper struct for tables
137 UNSET_ROTATE_TABULAR,
139 TOGGLE_ROTATE_TABULAR,
186 CELL_BEGIN_OF_MULTICOLUMN,
188 CELL_PART_OF_MULTICOLUMN
196 LYX_VALIGN_BOTTOM = 1,
198 LYX_VALIGN_MIDDLE = 2
214 // we have this header type (is set in the getLT... functions)
216 // double borders on top
218 // double borders on bottom
220 // used for FirstHeader & LastFooter and if this is true
221 // all the rows marked as FirstHeader or LastFooter are
222 // ignored in the output and it is set to be empty!
226 /// type for row numbers
227 typedef size_t row_type;
228 /// type for column numbers
229 typedef size_t col_type;
230 /// type for cell indices
231 typedef size_t idx_type;
232 /// index indicating an invalid position
233 static const idx_type npos = static_cast<idx_type>(-1);
236 Tabular(Buffer const &, col_type columns_arg, row_type rows_arg);
238 /// Returns true if there is a topline, returns false if not
239 bool topLine(idx_type cell) const;
240 /// Returns true if there is a topline, returns false if not
241 bool bottomLine(idx_type cell) const;
242 /// Returns true if there is a topline, returns false if not
243 bool leftLine(idx_type cell) const;
244 /// Returns true if there is a topline, returns false if not
245 bool rightLine(idx_type cell) const;
248 bool topAlreadyDrawn(idx_type cell) const;
250 bool leftAlreadyDrawn(idx_type cell) const;
252 bool isLastRow(idx_type cell) const;
254 /// return space occupied by the second horizontal line and
255 /// interline space above row \p row in pixels
256 int getAdditionalHeight(row_type row) const;
258 int getAdditionalWidth(idx_type cell) const;
260 /* returns the maximum over all rows */
262 int columnWidth(idx_type cell) const;
268 int rowAscent(row_type row) const;
270 int rowDescent(row_type row) const;
272 void setRowAscent(row_type row, int height);
274 void setRowDescent(row_type row, int height);
276 void setCellWidth(idx_type cell, int new_width);
278 void setAllLines(idx_type cell, bool line);
280 void setTopLine(idx_type cell, bool line);
282 void setBottomLine(idx_type cell, bool line);
284 void setLeftLine(idx_type cell, bool line);
286 void setRightLine(idx_type cell, bool line);
288 bool rowTopLine(row_type row) const;
290 bool rowBottomLine(row_type row) const;
292 bool columnLeftLine(col_type column) const;
294 bool columnRightLine(col_type column) const;
296 void setAlignment(idx_type cell, LyXAlignment align,
297 bool onlycolumn = false);
299 void setVAlignment(idx_type cell, VAlignment align,
300 bool onlycolumn = false);
302 void setColumnPWidth(Cursor &, idx_type, Length const &);
304 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
306 void setAlignSpecial(idx_type cell, docstring const & special,
309 LyXAlignment getAlignment(idx_type cell,
310 bool onlycolumn = false) const;
312 VAlignment getVAlignment(idx_type cell,
313 bool onlycolumn = false) const;
315 Length const getPWidth(idx_type cell) const;
317 int cellWidth(idx_type cell) const;
319 int getBeginningOfTextInCell(idx_type cell) const;
321 void appendRow(idx_type cell);
323 void deleteRow(row_type row);
325 void copyRow(row_type);
327 void appendColumn(idx_type cell);
329 void deleteColumn(col_type column);
331 void copyColumn(col_type);
333 bool isFirstCellInRow(idx_type cell) const;
335 idx_type getFirstCellInRow(row_type row) const;
337 bool isLastCellInRow(idx_type cell) const;
339 idx_type getLastCellInRow(row_type row) const;
341 idx_type numberOfCellsInRow(idx_type cell) const;
343 void write(std::ostream &) const;
347 int latex(odocstream &, OutputParams const &) const;
349 int docbook(odocstream & os, OutputParams const &) const;
351 void plaintext(odocstream &,
352 OutputParams const & runparams, int const depth,
353 bool onlydata, char_type delim) const;
355 bool isMultiColumn(idx_type cell) const;
357 bool isMultiColumnReal(idx_type cell) const;
359 void setMultiColumn(idx_type cell, idx_type number);
361 idx_type unsetMultiColumn(idx_type cell); // returns number of new cells
363 bool isPartOfMultiColumn(row_type row, col_type column) const;
365 row_type cellRow(idx_type cell) const;
367 col_type cellColumn(idx_type cell) const;
369 col_type cellRightColumn(idx_type cell) const;
371 void setRotateCell(idx_type cell, bool);
373 bool getRotateCell(idx_type cell) const;
375 bool needRotating() const;
377 bool isLastCell(idx_type cell) const;
379 idx_type cellAbove(idx_type cell) const;
381 idx_type cellBelow(idx_type cell) const;
383 idx_type cellIndex(row_type row, col_type column) const;
385 void setUsebox(idx_type cell, BoxType);
387 BoxType getUsebox(idx_type cell) const;
389 // Long Tabular Options support functions
391 bool checkLTType(row_type row, ltType const &) const;
393 void setLTHead(row_type row, bool flag, ltType const &, bool first);
395 bool getRowOfLTHead(row_type row, ltType &) const;
397 bool getRowOfLTFirstHead(row_type row, ltType &) const;
399 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
401 bool getRowOfLTFoot(row_type row, ltType &) const;
403 bool getRowOfLTLastFoot(row_type row, ltType &) const;
405 void setLTNewPage(row_type row, bool what);
407 bool getLTNewPage(row_type row) const;
409 bool haveLTHead() const;
411 bool haveLTFirstHead() const;
413 bool haveLTFoot() const;
415 bool haveLTLastFoot() const;
417 // end longtable support
419 boost::shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
421 boost::shared_ptr<InsetTableCell> cellInset(row_type row,
422 col_type column) const;
424 void setCellInset(row_type row, col_type column,
425 boost::shared_ptr<InsetTableCell>) const;
426 /// Search for \param inset in the tabular, with the
428 idx_type cellFromInset(Inset const * inset) const;
430 void validate(LaTeXFeatures &) const;
437 CellData(Buffer const &, Tabular const &);
439 CellData(CellData const &);
441 CellData & operator=(CellData);
443 void swap(CellData & rhs);
451 LyXAlignment alignment;
453 VAlignment valignment;
467 docstring align_special;
469 Length p_width; // this is only set for multicolumn!!!
471 boost::shared_ptr<InsetTableCell> inset;
473 CellData & cellInfo(idx_type cell) const;
475 typedef std::vector<CellData> cell_vector;
477 typedef std::vector<cell_vector> cell_vvector;
488 /// Extra space between the top line and this row
490 /// Ignore top_space if true and use the default top space
491 bool top_space_default;
492 /// Extra space between this row and the bottom line
494 /// Ignore bottom_space if true and use the default bottom space
495 bool bottom_space_default;
496 /// Extra space between the bottom line and the next top line
497 Length interline_space;
498 /// Ignore interline_space if true and use the default interline space
499 bool interline_space_default;
500 /// This are for longtabulars only
503 /// a row of endfirsthead
507 /// row of endlastfoot
509 /// row for a newpage
513 typedef std::vector<RowData> row_vector;
521 LyXAlignment alignment;
523 VAlignment valignment;
529 docstring align_special;
532 typedef std::vector<ColumnData> column_vector;
535 idx_type numberofcells;
537 std::vector<row_type> rowofcell;
539 std::vector<col_type> columnofcell;
543 column_vector column_info;
545 mutable cell_vvector cell_info;
553 bool is_long_tabular;
556 /// endfirsthead data
564 void init(Buffer const &, row_type rows_arg,
565 col_type columns_arg);
567 void updateIndexes();
568 /// return true of update is needed
569 bool updateColumnWidths();
571 idx_type columnSpan(idx_type cell) const;
573 BoxType useParbox(idx_type cell) const;
575 // helper function for Latex returns number of newlines
577 int TeXTopHLine(odocstream &, row_type row) const;
579 int TeXBottomHLine(odocstream &, row_type row) const;
581 int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol) const;
583 int TeXCellPostamble(odocstream &, idx_type cell, bool ismulticol) const;
585 int TeXLongtableHeaderFooter(odocstream &, OutputParams const &) const;
587 bool isValidRow(row_type const row) const;
589 int TeXRow(odocstream &, row_type const row,
590 OutputParams const &) const;
592 // helper functions for plain text
594 bool plaintextTopHLine(odocstream &, row_type row,
595 std::vector<unsigned int> const &) const;
597 bool plaintextBottomHLine(odocstream &, row_type row,
598 std::vector<unsigned int> const &) const;
600 void plaintextPrintCell(odocstream &,
601 OutputParams const &,
602 idx_type cell, row_type row, col_type column,
603 std::vector<unsigned int> const &,
604 bool onlydata) const;
605 /// auxiliary function for docbook
606 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
608 /// change associated Buffer
609 void setBuffer(Buffer const & buffer) { buffer_ = &buffer; }
610 /// retrieve associated Buffer
611 Buffer const & buffer() const { return *buffer_; }
614 Buffer const * buffer_;
620 class InsetTableCell : public InsetText
624 InsetTableCell(Buffer const & buf,
625 Tabular::CellData const * cd, Tabular const * t);
627 InsetCode lyxCode() const { return CELL_CODE; }
629 Inset * clone() { return new InsetTableCell(*this); }
631 virtual bool useEmptyLayout() const { return true; }
633 virtual bool forceEmptyLayout(idx_type = 0) const;
635 virtual bool allowParagraphCustomization(idx_type = 0) const;
637 bool getStatus(Cursor & cur, FuncRequest const & cmd,
638 FuncStatus & status) const;
640 virtual bool neverIndent() { return true; }
642 void setCellData(Tabular::CellData const * cd) { cell_data_ = cd; }
644 void setTabular(Tabular const * t) { table_ = t; }
649 void operator=(InsetTableCell const &);
652 Tabular::CellData const * cell_data_;
654 Tabular const * table_;
658 class InsetTabular : public Inset
662 InsetTabular(Buffer const &, row_type rows = 1,
663 col_type columns = 1);
667 static void string2params(std::string const &, InsetTabular &);
669 static std::string params2string(InsetTabular const &);
673 void write(std::ostream &) const;
675 void metrics(MetricsInfo &, Dimension &) const;
677 void draw(PainterInfo & pi, int x, int y) const;
679 void drawSelection(PainterInfo & pi, int x, int y) const;
681 docstring editMessage() const;
683 EDITABLE editable() const { return HIGHLY_EDITABLE; }
685 bool insetAllowed(InsetCode code) const;
687 bool allowSpellCheck() const { return true; }
689 bool canTrackChanges() const { return true; }
690 /** returns true if, when outputing LaTeX, font changes should
691 be closed before generating this inset. This is needed for
692 insets that may contain several paragraphs */
693 bool noFontChange() const { return true; }
695 DisplayType display() const { return tabular.is_long_tabular ? AlignCenter : Inline; }
697 int latex(odocstream &, OutputParams const &) const;
699 int plaintext(odocstream &, OutputParams const &) const;
701 int docbook(odocstream &, OutputParams const &) const;
703 void validate(LaTeXFeatures & features) const;
705 InsetCode lyxCode() const { return TABULAR_CODE; }
707 docstring contextMenu(BufferView const & bv, int x, int y) const;
708 /// get offset of this cursor slice relative to our upper left corner
709 void cursorPos(BufferView const & bv, CursorSlice const & sl,
710 bool boundary, int & x, int & y) const;
712 bool tabularFeatures(Cursor & cur, std::string const & what);
714 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
715 std::string const & val = std::string());
717 void openLayoutDialog(BufferView *) const;
719 bool showInsetDialog(BufferView *) const;
721 size_t nargs() const { return tabular.numberofcells; }
723 boost::shared_ptr<InsetTableCell const> cell(idx_type) const;
725 boost::shared_ptr<InsetTableCell> cell(idx_type);
727 Text * getText(int) const;
729 /// set the change for the entire inset
730 void setChange(Change const & change);
731 /// accept the changes within the inset
732 void acceptChanges(BufferParams const & bparams);
733 /// reject the changes within the inset
734 void rejectChanges(BufferParams const & bparams);
736 // this should return true if we have a "normal" cell, otherwise false.
737 // "normal" means without width set!
738 /// should all paragraphs be output with "Standard" layout?
739 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
741 virtual bool forceEmptyLayout(idx_type cell = 0) const;
743 virtual bool useEmptyLayout() { return true; }
745 void addPreview(graphics::PreviewLoader &) const;
747 /// lock cell with given index
748 void edit(Cursor & cur, bool front, EntryDirection entry_from);
749 /// get table row from x coordinate
750 int rowFromY(Cursor & cur, int y) const;
751 /// get table column from y coordinate
752 int columnFromX(Cursor & cur, int x) const;
754 Inset * editXY(Cursor & cur, int x, int y);
755 /// can we go further down on mouse click?
756 bool descendable() const { return true; }
757 // Update the counters of this inset and of its contents
758 void updateLabels(ParIterator const &);
761 bool completionSupported(Cursor const &) const;
763 bool inlineCompletionSupported(Cursor const & cur) const;
765 bool automaticInlineCompletion() const;
767 bool automaticPopupCompletion() const;
769 bool showCompletionCursor() const;
771 CompletionList const * createCompletionList(Cursor const & cur) const;
773 docstring completionPrefix(Cursor const & cur) const;
775 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
777 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
780 virtual InsetTabular * asInsetTabular() { return this; }
782 virtual InsetTabular const * asInsetTabular() const { return this; }
784 bool isRightToLeft(Cursor & cur) const;
787 // Public structures and variables
789 mutable Tabular tabular;
793 InsetTabular(InsetTabular const &);
795 void doDispatch(Cursor & cur, FuncRequest & cmd);
797 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
799 int scroll() const { return scx_; }
801 Inset * clone() const { return new InsetTabular(*this); }
804 void drawCellLines(frontend::Painter &, int x, int y, row_type row,
805 idx_type cell, bool erased) const;
807 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
810 void moveNextCell(Cursor & cur,
811 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
813 void movePrevCell(Cursor & cur,
814 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
816 int cellXPos(idx_type cell) const;
818 void resetPos(Cursor & cur) const;
820 void removeTabularRow();
822 bool copySelection(Cursor & cur);
824 bool pasteClipboard(Cursor & cur);
826 void cutSelection(Cursor & cur);
828 void getSelection(Cursor & cur, row_type & rs, row_type & re,
829 col_type & cs, col_type & ce) const;
831 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
832 /// are we operating on several cells?
833 bool tablemode(Cursor & cur) const;
835 /// return the "Manhattan distance" to nearest corner
836 int dist(BufferView &, idx_type cell, int x, int y) const;
837 /// return the cell nearest to x, y
838 idx_type getNearestCell(BufferView &, int x, int y) const;
840 /// test the rotation state of the give cell range.
841 bool oneCellHasRotationState(bool rotated,
842 row_type row_start, row_type row_end,
843 col_type col_start, col_type col_end) const;
845 mutable idx_type first_visible_cell;
848 /// true when selecting rows with the mouse
850 /// true when selecting columns with the mouse
854 std::string const featureAsString(Tabular::Feature feature);
858 #endif // INSET_TABULAR_H