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
135 UNSET_ROTATE_TABULAR,
137 TOGGLE_ROTATE_TABULAR,
165 SET_SPECIAL_MULTICOLUMN,
167 SET_SPECIAL_MULTIROW,
183 TABULAR_VALIGN_MIDDLE,
185 TABULAR_VALIGN_BOTTOM,
187 LONGTABULAR_ALIGN_LEFT,
189 LONGTABULAR_ALIGN_CENTER,
191 LONGTABULAR_ALIGN_RIGHT,
200 CELL_BEGIN_OF_MULTICOLUMN,
202 CELL_PART_OF_MULTICOLUMN,
204 CELL_BEGIN_OF_MULTIROW,
206 CELL_PART_OF_MULTIROW
214 LYX_VALIGN_MIDDLE = 1,
216 LYX_VALIGN_BOTTOM = 2
222 LYX_LONGTABULAR_ALIGN_LEFT = 0,
224 LYX_LONGTABULAR_ALIGN_CENTER = 1,
226 LYX_LONGTABULAR_ALIGN_RIGHT = 2
242 // we have this header type (is set in the getLT... functions)
244 // double borders on top
246 // double borders on bottom
248 // used for FirstHeader & LastFooter and if this is true
249 // all the rows marked as FirstHeader or LastFooter are
250 // ignored in the output and it is set to be empty!
254 /// type for row numbers
255 typedef size_t row_type;
256 /// type for column numbers
257 typedef size_t col_type;
258 /// type for cell indices
259 typedef size_t idx_type;
260 /// index indicating an invalid position
261 static const idx_type npos = static_cast<idx_type>(-1);
264 Tabular(Buffer * buf, col_type columns_arg, row_type rows_arg);
266 /// Returns true if there is a topline, returns false if not
267 bool topLine(idx_type cell) const;
268 /// Returns true if there is a topline, returns false if not
269 bool bottomLine(idx_type cell) const;
270 /// Returns true if there is a topline, returns false if not
271 bool leftLine(idx_type cell) const;
272 /// Returns true if there is a topline, returns false if not
273 bool rightLine(idx_type cell) const;
275 /// return space occupied by the second horizontal line and
276 /// interline space above row \p row in pixels
277 int interRowSpace(row_type row) const;
279 int interColumnSpace(idx_type cell) const;
281 /* returns the maximum over all rows */
283 int columnWidth(idx_type cell) const;
285 int cellHeight(idx_type cell) const;
291 row_type nrows() const {return row_info.size();}
293 col_type ncols() const {return column_info.size();}
295 int rowAscent(row_type row) const;
297 int rowDescent(row_type row) const;
299 void setRowAscent(row_type row, int height);
301 void setRowDescent(row_type row, int height);
303 void setCellWidth(idx_type cell, int new_width);
305 void setTopLine(idx_type cell, bool line);
307 void setBottomLine(idx_type cell, bool line);
309 void setLeftLine(idx_type cell, bool line);
311 void setRightLine(idx_type cell, bool line);
313 bool rowTopLine(row_type row) const;
315 bool rowBottomLine(row_type row) const;
317 bool columnLeftLine(col_type column) const;
319 bool columnRightLine(col_type column) const;
321 void setAlignment(idx_type cell, LyXAlignment align,
322 bool onlycolumn = false);
324 void setVAlignment(idx_type cell, VAlignment align,
325 bool onlycolumn = false);
327 void setColumnPWidth(Cursor &, idx_type, Length const &);
329 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
331 void setAlignSpecial(idx_type cell, docstring const & special,
334 LyXAlignment getAlignment(idx_type cell,
335 bool onlycolumn = false) const;
337 VAlignment getVAlignment(idx_type cell,
338 bool onlycolumn = false) const;
340 Length const getPWidth(idx_type cell) const;
342 int cellWidth(idx_type cell) const;
344 int textHOffset(idx_type cell) const;
346 int textVOffset(idx_type cell) const;
348 void appendRow(idx_type cell);
350 void deleteRow(row_type row);
352 void copyRow(row_type);
354 void appendColumn(idx_type cell);
356 void deleteColumn(col_type column);
358 void copyColumn(col_type);
360 idx_type getFirstCellInRow(row_type row) const;
362 idx_type getLastCellInRow(row_type row) const;
364 idx_type numberOfCellsInRow(row_type row) const;
366 void write(std::ostream &) const;
370 int latex(odocstream &, OutputParams const &) const;
372 int docbook(odocstream & os, OutputParams const &) const;
374 docstring xhtml(XHTMLStream & os, OutputParams const &) const;
376 void plaintext(odocstream &,
377 OutputParams const & runparams, int const depth,
378 bool onlydata, char_type delim) const;
380 bool isMultiColumn(idx_type cell) const;
382 idx_type setMultiColumn(idx_type cell, idx_type number);
384 void unsetMultiColumn(idx_type cell);
386 bool isPartOfMultiColumn(row_type row, col_type column) const;
388 bool isPartOfMultiRow(row_type row, col_type column) const;
390 bool isMultiRow(idx_type cell) const;
392 idx_type setMultiRow(idx_type cell, idx_type number);
394 void unsetMultiRow(idx_type cell);
396 row_type cellRow(idx_type cell) const;
398 col_type cellColumn(idx_type cell) const;
400 void setRotateCell(idx_type cell, bool);
402 bool getRotateCell(idx_type cell) const;
404 bool needRotating() const;
406 bool isLastCell(idx_type cell) const;
408 idx_type cellAbove(idx_type cell) const;
410 idx_type cellBelow(idx_type cell) const;
412 idx_type cellIndex(row_type row, col_type column) const;
414 void setUsebox(idx_type cell, BoxType);
416 BoxType getUsebox(idx_type cell) const;
418 // Long Tabular Options support functions
420 bool checkLTType(row_type row, ltType const &) const;
422 void setLTHead(row_type row, bool flag, ltType const &, bool first);
424 bool getRowOfLTHead(row_type row, ltType &) const;
426 bool getRowOfLTFirstHead(row_type row, ltType &) const;
428 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
430 bool getRowOfLTFoot(row_type row, ltType &) const;
432 bool getRowOfLTLastFoot(row_type row, ltType &) const;
434 void setLTNewPage(row_type row, bool what);
436 bool getLTNewPage(row_type row) const;
438 idx_type setLTCaption(row_type row, bool what);
440 bool ltCaption(row_type row) const;
442 bool haveLTHead() const;
444 bool haveLTFirstHead() const;
446 bool haveLTFoot() const;
448 bool haveLTLastFoot() const;
450 bool haveLTCaption() const;
452 // end longtable support
454 boost::shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
456 boost::shared_ptr<InsetTableCell> cellInset(row_type row,
457 col_type column) const;
459 void setCellInset(row_type row, col_type column,
460 boost::shared_ptr<InsetTableCell>) const;
461 /// Search for \param inset in the tabular, with the
463 void validate(LaTeXFeatures &) const;
465 // FIXME Now that cells have an InsetTableCell as their insets, rather
466 // than an InsetText, it'd be possible to reverse the relationship here,
467 // so that cell_vector was a vector<InsetTableCell> rather than a
468 // vector<CellData>, and an InsetTableCell had a CellData as a member,
469 // or perhaps just had its members as members.
476 CellData(CellData const &);
478 CellData & operator=(CellData);
480 void swap(CellData & rhs);
496 LyXAlignment alignment;
498 VAlignment valignment;
512 docstring align_special;
514 Length p_width; // this is only set for multicolumn!!!
516 boost::shared_ptr<InsetTableCell> inset;
518 CellData & cellInfo(idx_type cell) const;
520 typedef std::vector<CellData> cell_vector;
522 typedef std::vector<cell_vector> cell_vvector;
533 /// Extra space between the top line and this row
535 /// Ignore top_space if true and use the default top space
536 bool top_space_default;
537 /// Extra space between this row and the bottom line
539 /// Ignore bottom_space if true and use the default bottom space
540 bool bottom_space_default;
541 /// Extra space between the bottom line and the next top line
542 Length interline_space;
543 /// Ignore interline_space if true and use the default interline space
544 bool interline_space_default;
545 /// This are for longtabulars only
548 /// a row of endfirsthead
552 /// row of endlastfoot
554 /// row for a newpage
559 VAlignment valignment;
564 typedef std::vector<RowData> row_vector;
572 LyXAlignment alignment;
574 VAlignment valignment;
580 docstring align_special;
583 typedef std::vector<ColumnData> column_vector;
586 idx_type numberofcells;
588 std::vector<row_type> rowofcell;
590 std::vector<col_type> columnofcell;
594 column_vector column_info;
596 mutable cell_vvector cell_info;
602 VAlignment tabular_valignment;
606 HAlignment longtabular_alignment;
608 bool is_long_tabular;
611 /// endfirsthead data
619 void init(Buffer *, row_type rows_arg,
620 col_type columns_arg);
622 void updateIndexes();
624 bool setFixedWidth(row_type r, col_type c);
626 void updateContentAlignment(row_type r, col_type c);
627 /// return true of update is needed
628 bool updateColumnWidths();
630 idx_type columnSpan(idx_type cell) const;
632 idx_type rowSpan(idx_type cell) const;
634 BoxType useParbox(idx_type cell) const;
636 // helper function for Latex returns number of newlines
638 int TeXTopHLine(odocstream &, row_type row, std::string const lang) const;
640 int TeXBottomHLine(odocstream &, row_type row, std::string const lang) const;
642 int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const;
644 int TeXCellPostamble(odocstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
646 int TeXLongtableHeaderFooter(odocstream &, OutputParams const &) const;
648 bool isValidRow(row_type const row) const;
650 int TeXRow(odocstream &, row_type const row,
651 OutputParams const &) const;
653 // helper functions for plain text
655 bool plaintextTopHLine(odocstream &, row_type row,
656 std::vector<unsigned int> const &) const;
658 bool plaintextBottomHLine(odocstream &, row_type row,
659 std::vector<unsigned int> const &) const;
661 void plaintextPrintCell(odocstream &,
662 OutputParams const &,
663 idx_type cell, row_type row, col_type column,
664 std::vector<unsigned int> const &,
665 bool onlydata) const;
666 /// auxiliary function for docbook
667 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
669 docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &) const;
671 /// change associated Buffer
672 void setBuffer(Buffer & buffer);
673 /// retrieve associated Buffer
674 Buffer & buffer() const { return *buffer_; }
683 class InsetTableCell : public InsetText
687 InsetTableCell(Buffer * buf);
689 InsetCode lyxCode() const { return CELL_CODE; }
691 Inset * clone() { return new InsetTableCell(*this); }
693 bool getStatus(Cursor & cur, FuncRequest const & cmd,
694 FuncStatus & status) const;
696 void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
698 void setContentAlignment(LyXAlignment al) {contentAlign = al; }
699 /// writes the contents of the cell as a string, optionally
700 /// descending into insets
701 docstring asString(bool intoInsets = true);
703 docstring xhtml(XHTMLStream &, OutputParams const &) const;
708 void operator=(InsetTableCell const &);
710 // This boolean is supposed to track whether the cell has had its
711 // width explicitly set. We need to know this to determine whether
712 // layout changes and paragraph customization are allowed---that is,
713 // we need it in forcePlainLayout() and allowParagraphCustomization().
714 // Unfortunately, that information is not readily available in
715 // InsetTableCell. In the case of multicolumn cells, it is present
716 // in CellData, and so would be available here if CellData were to
717 // become a member of InsetTableCell. But in the other case, it isn't
718 // even available there, but is held in Tabular::ColumnData.
719 // So, the present solution uses this boolean to track the information
720 // we need to track, and tries to keep it updated. This is not ideal,
721 // but the other solutions are no better. These are:
722 // (i) Keep a pointer in InsetTableCell to the table;
723 // (ii) Find the table by iterating over the Buffer's insets.
724 // Solution (i) raises the problem of updating the pointer when an
725 // InsetTableCell is copied, and we'd therefore need a copy constructor
726 // in InsetTabular and then in Tabular, which seems messy, given how
727 // complicated those classes are. Solution (ii) involves a lot of
728 // iterating, since this information is needed quite often, and so may
730 // So, well, if someone can do better, please do!
734 // FIXME: Here the thoughts from the comment above also apply.
736 LyXAlignment contentAlign;
737 /// should paragraph indendation be omitted in any case?
738 bool neverIndent() const { return true; }
740 LyXAlignment contentAlignment() const { return contentAlign; }
742 virtual bool usePlainLayout() const { return true; }
744 virtual bool forcePlainLayout(idx_type = 0) const;
746 virtual bool allowParagraphCustomization(idx_type = 0) const;
747 /// Is the width forced to some value?
748 bool hasFixedWidth() const { return isFixedWidth; }
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 boost::shared_ptr<InsetTableCell const> cell(idx_type) const;
820 boost::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 virtual InsetTabular * asInsetTabular() { return this; }
880 virtual 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(frontend::Painter &, int x, int y, row_type row,
908 idx_type cell, Change const & change) 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);
957 #endif // INSET_TABULAR_H