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 <boost/shared_ptr.hpp>
48 namespace frontend { class Painter; }
56 // A helper struct for tables
127 UNSET_ROTATE_TABULAR,
129 TOGGLE_ROTATE_TABULAR,
157 SET_SPECIAL_MULTICOLUMN,
159 SET_SPECIAL_MULTIROW,
175 TABULAR_VALIGN_MIDDLE,
177 TABULAR_VALIGN_BOTTOM,
179 LONGTABULAR_ALIGN_LEFT,
181 LONGTABULAR_ALIGN_CENTER,
183 LONGTABULAR_ALIGN_RIGHT,
192 CELL_BEGIN_OF_MULTICOLUMN,
194 CELL_PART_OF_MULTICOLUMN,
196 CELL_BEGIN_OF_MULTIROW,
198 CELL_PART_OF_MULTIROW
206 LYX_VALIGN_MIDDLE = 1,
208 LYX_VALIGN_BOTTOM = 2
214 LYX_LONGTABULAR_ALIGN_LEFT = 0,
216 LYX_LONGTABULAR_ALIGN_CENTER = 1,
218 LYX_LONGTABULAR_ALIGN_RIGHT = 2
234 // we have this header type (is set in the getLT... functions)
236 // double borders on top
238 // double borders on bottom
240 // used for FirstHeader & LastFooter and if this is true
241 // all the rows marked as FirstHeader or LastFooter are
242 // ignored in the output and it is set to be empty!
246 /// type for row numbers
247 typedef size_t row_type;
248 /// type for column numbers
249 typedef size_t col_type;
250 /// type for cell indices
251 typedef size_t idx_type;
252 /// index indicating an invalid position
253 static const idx_type npos = static_cast<idx_type>(-1);
256 Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
258 /// Returns true if there is a topline, returns false if not
259 bool topLine(idx_type cell) const;
260 /// Returns true if there is a topline, returns false if not
261 bool bottomLine(idx_type cell) const;
262 /// Returns true if there is a topline, returns false if not
263 bool leftLine(idx_type cell) const;
264 /// Returns true if there is a topline, returns false if not
265 bool rightLine(idx_type cell) const;
268 bool topAlreadyDrawn(idx_type cell) const;
270 bool leftAlreadyDrawn(idx_type cell) const;
272 bool isLastRow(idx_type cell) const;
274 /// return space occupied by the second horizontal line and
275 /// interline space above row \p row in pixels
276 int interRowSpace(row_type row) const;
278 int interColumnSpace(idx_type cell) const;
280 /* returns the maximum over all rows */
282 int columnWidth(idx_type cell) const;
284 int rowHeight(idx_type cell) const;
290 int rowAscent(row_type row) const;
292 int rowDescent(row_type row) const;
294 void setRowAscent(row_type row, int height);
296 void setRowDescent(row_type row, int height);
298 void setCellWidth(idx_type cell, int new_width);
300 void setAllLines(idx_type cell, bool line);
302 void setTopLine(idx_type cell, bool line);
304 void setBottomLine(idx_type cell, bool line);
306 void setLeftLine(idx_type cell, bool line);
308 void setRightLine(idx_type cell, bool line);
310 bool rowTopLine(row_type row) const;
312 bool rowBottomLine(row_type row) const;
314 bool columnLeftLine(col_type column) const;
316 bool columnRightLine(col_type column) const;
318 void setAlignment(idx_type cell, LyXAlignment align,
319 bool onlycolumn = false);
321 void setVAlignment(idx_type cell, VAlignment align,
322 bool onlycolumn = false);
324 void setColumnPWidth(Cursor &, idx_type, Length const &);
326 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
328 void setAlignSpecial(idx_type cell, docstring const & special,
331 LyXAlignment getAlignment(idx_type cell,
332 bool onlycolumn = false) const;
334 VAlignment getVAlignment(idx_type cell,
335 bool onlycolumn = false) const;
337 Length const getPWidth(idx_type cell) const;
339 int cellWidth(idx_type cell) const;
341 int textHOffset(idx_type cell) const;
343 int textVOffset(idx_type cell) const;
345 void appendRow(idx_type cell);
347 void deleteRow(row_type row);
349 void copyRow(row_type);
351 void appendColumn(idx_type cell);
353 void deleteColumn(col_type column);
355 void copyColumn(col_type);
357 idx_type getFirstCellInRow(row_type row) const;
359 bool isLastCellInRow(idx_type cell) const;
361 idx_type getLastCellInRow(row_type row) const;
363 idx_type numberOfCellsInRow(idx_type cell) const;
365 void write(std::ostream &) const;
369 int latex(odocstream &, OutputParams const &) const;
371 int docbook(odocstream & os, OutputParams const &) const;
373 docstring xhtml(XHTMLStream & os, OutputParams const &) const;
375 void plaintext(odocstream &,
376 OutputParams const & runparams, int const depth,
377 bool onlydata, char_type delim) const;
379 bool isMultiColumn(idx_type cell) const;
381 bool isMultiColumnReal(idx_type cell) const;
383 void setMultiColumn(idx_type cell, idx_type number);
385 void unsetMultiColumn(idx_type cell);
387 bool isPartOfMultiColumn(row_type row, col_type column) const;
389 bool isPartOfMultiRow(row_type row, col_type column) const;
391 bool isMultiRow(idx_type cell) const;
393 void setMultiRow(idx_type cell, idx_type number);
395 void unsetMultiRow(idx_type cell);
397 row_type cellRow(idx_type cell) const;
399 col_type cellColumn(idx_type cell) const;
401 col_type cellRightColumn(idx_type cell) const;
403 void setRotateCell(idx_type cell, bool);
405 bool getRotateCell(idx_type cell) const;
407 bool needRotating() const;
409 bool isLastCell(idx_type cell) const;
411 idx_type cellAbove(idx_type cell) const;
413 idx_type cellBelow(idx_type cell) const;
415 idx_type cellIndex(row_type row, col_type column) const;
417 void setUsebox(idx_type cell, BoxType);
419 BoxType getUsebox(idx_type cell) const;
421 // Long Tabular Options support functions
423 bool checkLTType(row_type row, ltType const &) const;
425 void setLTHead(row_type row, bool flag, ltType const &, bool first);
427 bool getRowOfLTHead(row_type row, ltType &) const;
429 bool getRowOfLTFirstHead(row_type row, ltType &) const;
431 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
433 bool getRowOfLTFoot(row_type row, ltType &) const;
435 bool getRowOfLTLastFoot(row_type row, ltType &) const;
437 void setLTNewPage(row_type row, bool what);
439 bool getLTNewPage(row_type row) const;
441 idx_type setLTCaption(row_type row, bool what);
443 bool ltCaption(row_type row) const;
445 bool haveLTHead() const;
447 bool haveLTFirstHead() const;
449 bool haveLTFoot() const;
451 bool haveLTLastFoot() const;
453 bool haveLTCaption() const;
455 // end longtable support
457 boost::shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
459 boost::shared_ptr<InsetTableCell> cellInset(row_type row,
460 col_type column) const;
462 void setCellInset(row_type row, col_type column,
463 boost::shared_ptr<InsetTableCell>) const;
464 /// Search for \param inset in the tabular, with the
466 void validate(LaTeXFeatures &) const;
468 // FIXME Now that cells have an InsetTableCell as their insets, rather
469 // than an InsetText, it'd be possible to reverse the relationship here,
470 // so that cell_vector was a vector<InsetTableCell> rather than a
471 // vector<CellData>, and an InsetTableCell had a CellData as a member,
472 // or perhaps just had its members as members.
479 CellData(CellData const &);
481 CellData & operator=(CellData);
483 void swap(CellData & rhs);
493 LyXAlignment alignment;
495 VAlignment valignment;
509 docstring align_special;
511 Length p_width; // this is only set for multicolumn!!!
513 boost::shared_ptr<InsetTableCell> inset;
515 CellData & cellInfo(idx_type cell) const;
517 typedef std::vector<CellData> cell_vector;
519 typedef std::vector<cell_vector> cell_vvector;
530 /// Extra space between the top line and this row
532 /// Ignore top_space if true and use the default top space
533 bool top_space_default;
534 /// Extra space between this row and the bottom line
536 /// Ignore bottom_space if true and use the default bottom space
537 bool bottom_space_default;
538 /// Extra space between the bottom line and the next top line
539 Length interline_space;
540 /// Ignore interline_space if true and use the default interline space
541 bool interline_space_default;
542 /// This are for longtabulars only
545 /// a row of endfirsthead
549 /// row of endlastfoot
551 /// row for a newpage
557 typedef std::vector<RowData> row_vector;
565 LyXAlignment alignment;
567 VAlignment valignment;
573 docstring align_special;
576 typedef std::vector<ColumnData> column_vector;
579 idx_type numberofcells;
581 std::vector<row_type> rowofcell;
583 std::vector<col_type> columnofcell;
587 column_vector column_info;
589 mutable cell_vvector cell_info;
595 VAlignment tabular_valignment;
599 HAlignment longtabular_alignment;
601 bool is_long_tabular;
604 /// endfirsthead data
612 void init(Buffer *, row_type rows_arg,
613 col_type columns_arg);
615 void updateIndexes();
617 bool setFixedWidth(row_type r, col_type c);
619 void updateContentAlignment(row_type r, col_type c);
620 /// return true of update is needed
621 bool updateColumnWidths();
623 idx_type columnSpan(idx_type cell) const;
625 idx_type rowSpan(idx_type cell) const;
627 BoxType useParbox(idx_type cell) const;
629 // helper function for Latex returns number of newlines
631 int TeXTopHLine(odocstream &, row_type row, std::string const lang) const;
633 int TeXBottomHLine(odocstream &, row_type row, std::string const lang) const;
635 int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const;
637 int TeXCellPostamble(odocstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
639 int TeXLongtableHeaderFooter(odocstream &, OutputParams const &) const;
641 bool isValidRow(row_type const row) const;
643 int TeXRow(odocstream &, row_type const row,
644 OutputParams const &) const;
646 // helper functions for plain text
648 bool plaintextTopHLine(odocstream &, row_type row,
649 std::vector<unsigned int> const &) const;
651 bool plaintextBottomHLine(odocstream &, row_type row,
652 std::vector<unsigned int> const &) const;
654 void plaintextPrintCell(odocstream &,
655 OutputParams const &,
656 idx_type cell, row_type row, col_type column,
657 std::vector<unsigned int> const &,
658 bool onlydata) const;
659 /// auxiliary function for docbook
660 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
662 docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &) const;
664 /// change associated Buffer
665 void setBuffer(Buffer & buffer);
666 /// retrieve associated Buffer
667 Buffer & buffer() const { return *buffer_; }
676 class InsetTableCell : public InsetText
680 InsetTableCell(Buffer * buf);
682 InsetCode lyxCode() const { return CELL_CODE; }
684 Inset * clone() { return new InsetTableCell(*this); }
686 bool getStatus(Cursor & cur, FuncRequest const & cmd,
687 FuncStatus & status) const;
689 void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
691 void setContentAlignment(LyXAlignment al) {contentAlign = al; }
692 /// writes the contents of the cell as a string, optionally
693 /// descending into insets
694 docstring asString(bool intoInsets = true);
696 docstring xhtml(XHTMLStream &, OutputParams const &) const;
701 void operator=(InsetTableCell const &);
703 // This boolean is supposed to track whether the cell has had its
704 // width explicitly set. We need to know this to determine whether
705 // layout changes and paragraph customization are allowed---that is,
706 // we need it in forcePlainLayout() and allowParagraphCustomization().
707 // Unfortunately, that information is not readily available in
708 // InsetTableCell. In the case of multicolumn cells, it is present
709 // in CellData, and so would be available here if CellData were to
710 // become a member of InsetTableCell. But in the other case, it isn't
711 // even available there, but is held in Tabular::ColumnData.
712 // So, the present solution uses this boolean to track the information
713 // we need to track, and tries to keep it updated. This is not ideal,
714 // but the other solutions are no better. These are:
715 // (i) Keep a pointer in InsetTableCell to the table;
716 // (ii) Find the table by iterating over the Buffer's insets.
717 // Solution (i) raises the problem of updating the pointer when an
718 // InsetTableCell is copied, and we'd therefore need a copy constructor
719 // in InsetTabular and then in Tabular, which seems messy, given how
720 // complicated those classes are. Solution (ii) involves a lot of
721 // iterating, since this information is needed quite often, and so may
723 // So, well, if someone can do better, please do!
727 // FIXME: Here the thoughts from the comment above also apply.
729 LyXAlignment contentAlign;
730 /// should paragraph indendation be omitted in any case?
731 bool neverIndent() const { return true; }
733 LyXAlignment contentAlignment() const { return contentAlign; }
735 virtual bool usePlainLayout() const { return true; }
737 virtual bool forcePlainLayout(idx_type = 0) const;
739 virtual bool allowParagraphCustomization(idx_type = 0) const;
740 /// Is the width forced to some value?
741 bool hasFixedWidth() const { return isFixedWidth; }
745 class InsetTabular : public Inset
749 InsetTabular(Buffer *, row_type rows = 1,
750 col_type columns = 1);
754 void setBuffer(Buffer & buffer);
757 static void string2params(std::string const &, InsetTabular &);
759 static std::string params2string(InsetTabular const &);
763 void write(std::ostream &) const;
765 void metrics(MetricsInfo &, Dimension &) const;
767 void draw(PainterInfo & pi, int x, int y) const;
769 void drawSelection(PainterInfo & pi, int x, int y) const;
771 bool editable() const { return true; }
773 bool hasSettings() const { return true; }
775 bool insetAllowed(InsetCode code) const;
777 bool allowSpellCheck() const { return true; }
779 bool canTrackChanges() const { return true; }
780 /** returns true if, when outputing LaTeX, font changes should
781 be closed before generating this inset. This is needed for
782 insets that may contain several paragraphs */
783 bool noFontChange() const { return true; }
785 DisplayType display() const;
787 int latex(odocstream &, OutputParams const &) const;
789 int plaintext(odocstream &, OutputParams const &) const;
791 int docbook(odocstream &, OutputParams const &) const;
793 docstring xhtml(XHTMLStream &, OutputParams const &) const;
795 void validate(LaTeXFeatures & features) const;
797 InsetCode lyxCode() const { return TABULAR_CODE; }
799 docstring contextMenu(BufferView const & bv, int x, int y) const;
800 /// get offset of this cursor slice relative to our upper left corner
801 void cursorPos(BufferView const & bv, CursorSlice const & sl,
802 bool boundary, int & x, int & y) const;
804 bool tabularFeatures(Cursor & cur, std::string const & what);
806 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
807 std::string const & val = std::string());
809 void openLayoutDialog(BufferView *) const;
811 bool showInsetDialog(BufferView *) const;
813 size_t nargs() const { return tabular.numberofcells; }
815 boost::shared_ptr<InsetTableCell const> cell(idx_type) const;
817 boost::shared_ptr<InsetTableCell> cell(idx_type);
819 Text * getText(int) const;
821 /// set the change for the entire inset
822 void setChange(Change const & change);
823 /// accept the changes within the inset
824 void acceptChanges();
825 /// reject the changes within the inset
826 void rejectChanges();
828 // this should return true if we have a "normal" cell, otherwise false.
829 // "normal" means without width set!
830 /// should all paragraphs be output with "Standard" layout?
831 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
833 virtual bool forcePlainLayout(idx_type cell = 0) const;
835 void addPreview(DocIterator const & inset_pos,
836 graphics::PreviewLoader &) const;
838 /// lock cell with given index
839 void edit(Cursor & cur, bool front, EntryDirection entry_from);
840 /// get table row from x coordinate
841 int rowFromY(Cursor & cur, int y) const;
842 /// get table column from y coordinate
843 int columnFromX(Cursor & cur, int x) const;
845 Inset * editXY(Cursor & cur, int x, int y);
846 /// can we go further down on mouse click?
847 bool descendable(BufferView const &) const { return true; }
848 /// Update the counters of this inset and of its contents
849 void updateLabels(ParIterator const &, UpdateType);
851 void addToToc(DocIterator const &);
854 bool completionSupported(Cursor const &) const;
856 bool inlineCompletionSupported(Cursor const & cur) const;
858 bool automaticInlineCompletion() const;
860 bool automaticPopupCompletion() const;
862 bool showCompletionCursor() const;
864 CompletionList const * createCompletionList(Cursor const & cur) const;
866 docstring completionPrefix(Cursor const & cur) const;
868 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
870 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
872 virtual bool usePlainLayout() const { return true; }
875 virtual InsetTabular * asInsetTabular() { return this; }
877 virtual InsetTabular const * asInsetTabular() const { return this; }
879 bool isRightToLeft(Cursor & cur) const;
880 /// writes the cells between stidx and enidx as a string, optionally
881 /// descending into the insets
882 docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
884 /// Returns whether the cell in the specified row and column is selected.
885 bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
887 // Public structures and variables
889 mutable Tabular tabular;
893 InsetTabular(InsetTabular const &);
895 void doDispatch(Cursor & cur, FuncRequest & cmd);
897 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
899 int scroll() const { return scx_; }
901 Inset * clone() const { return new InsetTabular(*this); }
904 void drawCellLines(frontend::Painter &, int x, int y, row_type row,
905 idx_type cell, Change const & change) const;
907 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
910 void moveNextCell(Cursor & cur,
911 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
913 void movePrevCell(Cursor & cur,
914 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
916 int cellXPos(idx_type cell) const;
918 void resetPos(Cursor & cur) const;
920 void removeTabularRow();
922 bool copySelection(Cursor & cur);
924 bool pasteClipboard(Cursor & cur);
926 void cutSelection(Cursor & cur);
928 void getSelection(Cursor & cur, row_type & rs, row_type & re,
929 col_type & cs, col_type & ce) const;
931 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
933 /// return the "Manhattan distance" to nearest corner
934 int dist(BufferView &, idx_type cell, int x, int y) const;
935 /// return the cell nearest to x, y
936 idx_type getNearestCell(BufferView &, int x, int y) const;
938 /// test the rotation state of the give cell range.
939 bool oneCellHasRotationState(bool rotated,
940 row_type row_start, row_type row_end,
941 col_type col_start, col_type col_end) const;
943 mutable idx_type first_visible_cell;
946 /// true when selecting rows with the mouse
948 /// true when selecting columns with the mouse
952 std::string const featureAsString(Tabular::Feature feature);
956 #endif // INSET_TABULAR_H