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 rowHeight(idx_type cell) const;
291 int rowAscent(row_type row) const;
293 int rowDescent(row_type row) const;
295 void setRowAscent(row_type row, int height);
297 void setRowDescent(row_type row, int height);
299 void setCellWidth(idx_type cell, int new_width);
301 void setTopLine(idx_type cell, bool line);
303 void setBottomLine(idx_type cell, bool line);
305 void setLeftLine(idx_type cell, bool line);
307 void setRightLine(idx_type cell, bool line);
309 bool rowTopLine(row_type row) const;
311 bool rowBottomLine(row_type row) const;
313 bool columnLeftLine(col_type column) const;
315 bool columnRightLine(col_type column) const;
317 void setAlignment(idx_type cell, LyXAlignment align,
318 bool onlycolumn = false);
320 void setVAlignment(idx_type cell, VAlignment align,
321 bool onlycolumn = false);
323 void setColumnPWidth(Cursor &, idx_type, Length const &);
325 bool setMColumnPWidth(Cursor &, idx_type, Length const &);
327 void setAlignSpecial(idx_type cell, docstring const & special,
330 LyXAlignment getAlignment(idx_type cell,
331 bool onlycolumn = false) const;
333 VAlignment getVAlignment(idx_type cell,
334 bool onlycolumn = false) const;
336 Length const getPWidth(idx_type cell) const;
338 int cellWidth(idx_type cell) const;
340 int textHOffset(idx_type cell) const;
342 int textVOffset(idx_type cell) const;
344 void appendRow(idx_type cell);
346 void deleteRow(row_type row);
348 void copyRow(row_type);
350 void appendColumn(idx_type cell);
352 void deleteColumn(col_type column);
354 void copyColumn(col_type);
356 idx_type getFirstCellInRow(row_type row) const;
358 idx_type getLastCellInRow(row_type row) const;
360 idx_type numberOfCellsInRow(row_type row) const;
362 void write(std::ostream &) const;
366 int latex(odocstream &, OutputParams const &) const;
368 int docbook(odocstream & os, OutputParams const &) const;
370 docstring xhtml(XHTMLStream & os, OutputParams const &) const;
372 void plaintext(odocstream &,
373 OutputParams const & runparams, int const depth,
374 bool onlydata, char_type delim) const;
376 bool isMultiColumn(idx_type cell) const;
378 void setMultiColumn(idx_type cell, idx_type number);
380 void unsetMultiColumn(idx_type cell);
382 bool isPartOfMultiColumn(row_type row, col_type column) const;
384 bool isPartOfMultiRow(row_type row, col_type column) const;
386 bool isMultiRow(idx_type cell) const;
388 void setMultiRow(idx_type cell, idx_type number);
390 void unsetMultiRow(idx_type cell);
392 row_type cellRow(idx_type cell) const;
394 col_type cellColumn(idx_type cell) const;
396 void setRotateCell(idx_type cell, bool);
398 bool getRotateCell(idx_type cell) const;
400 bool needRotating() const;
402 bool isLastCell(idx_type cell) const;
404 idx_type cellAbove(idx_type cell) const;
406 idx_type cellBelow(idx_type cell) const;
408 idx_type cellIndex(row_type row, col_type column) const;
410 void setUsebox(idx_type cell, BoxType);
412 BoxType getUsebox(idx_type cell) const;
414 // Long Tabular Options support functions
416 bool checkLTType(row_type row, ltType const &) const;
418 void setLTHead(row_type row, bool flag, ltType const &, bool first);
420 bool getRowOfLTHead(row_type row, ltType &) const;
422 bool getRowOfLTFirstHead(row_type row, ltType &) const;
424 void setLTFoot(row_type row, bool flag, ltType const &, bool last);
426 bool getRowOfLTFoot(row_type row, ltType &) const;
428 bool getRowOfLTLastFoot(row_type row, ltType &) const;
430 void setLTNewPage(row_type row, bool what);
432 bool getLTNewPage(row_type row) const;
434 idx_type setLTCaption(row_type row, bool what);
436 bool ltCaption(row_type row) const;
438 bool haveLTHead() const;
440 bool haveLTFirstHead() const;
442 bool haveLTFoot() const;
444 bool haveLTLastFoot() const;
446 bool haveLTCaption() const;
448 // end longtable support
450 boost::shared_ptr<InsetTableCell> cellInset(idx_type cell) const;
452 boost::shared_ptr<InsetTableCell> cellInset(row_type row,
453 col_type column) const;
455 void setCellInset(row_type row, col_type column,
456 boost::shared_ptr<InsetTableCell>) const;
457 /// Search for \param inset in the tabular, with the
459 void validate(LaTeXFeatures &) const;
461 // FIXME Now that cells have an InsetTableCell as their insets, rather
462 // than an InsetText, it'd be possible to reverse the relationship here,
463 // so that cell_vector was a vector<InsetTableCell> rather than a
464 // vector<CellData>, and an InsetTableCell had a CellData as a member,
465 // or perhaps just had its members as members.
472 CellData(CellData const &);
474 CellData & operator=(CellData);
476 void swap(CellData & rhs);
486 LyXAlignment alignment;
488 VAlignment valignment;
502 docstring align_special;
504 Length p_width; // this is only set for multicolumn!!!
506 boost::shared_ptr<InsetTableCell> inset;
508 CellData & cellInfo(idx_type cell) const;
510 typedef std::vector<CellData> cell_vector;
512 typedef std::vector<cell_vector> cell_vvector;
523 /// Extra space between the top line and this row
525 /// Ignore top_space if true and use the default top space
526 bool top_space_default;
527 /// Extra space between this row and the bottom line
529 /// Ignore bottom_space if true and use the default bottom space
530 bool bottom_space_default;
531 /// Extra space between the bottom line and the next top line
532 Length interline_space;
533 /// Ignore interline_space if true and use the default interline space
534 bool interline_space_default;
535 /// This are for longtabulars only
538 /// a row of endfirsthead
542 /// row of endlastfoot
544 /// row for a newpage
550 typedef std::vector<RowData> row_vector;
558 LyXAlignment alignment;
560 VAlignment valignment;
566 docstring align_special;
569 typedef std::vector<ColumnData> column_vector;
572 idx_type numberofcells;
574 std::vector<row_type> rowofcell;
576 std::vector<col_type> columnofcell;
580 column_vector column_info;
582 mutable cell_vvector cell_info;
588 VAlignment tabular_valignment;
592 HAlignment longtabular_alignment;
594 bool is_long_tabular;
597 /// endfirsthead data
605 void init(Buffer *, row_type rows_arg,
606 col_type columns_arg);
608 void updateIndexes();
610 bool setFixedWidth(row_type r, col_type c);
612 void updateContentAlignment(row_type r, col_type c);
613 /// return true of update is needed
614 bool updateColumnWidths();
616 idx_type columnSpan(idx_type cell) const;
618 idx_type rowSpan(idx_type cell) const;
620 BoxType useParbox(idx_type cell) const;
622 // helper function for Latex returns number of newlines
624 int TeXTopHLine(odocstream &, row_type row, std::string const lang) const;
626 int TeXBottomHLine(odocstream &, row_type row, std::string const lang) const;
628 int TeXCellPreamble(odocstream &, idx_type cell, bool & ismulticol, bool & ismultirow) const;
630 int TeXCellPostamble(odocstream &, idx_type cell, bool ismulticol, bool ismultirow) const;
632 int TeXLongtableHeaderFooter(odocstream &, OutputParams const &) const;
634 bool isValidRow(row_type const row) const;
636 int TeXRow(odocstream &, row_type const row,
637 OutputParams const &) const;
639 // helper functions for plain text
641 bool plaintextTopHLine(odocstream &, row_type row,
642 std::vector<unsigned int> const &) const;
644 bool plaintextBottomHLine(odocstream &, row_type row,
645 std::vector<unsigned int> const &) const;
647 void plaintextPrintCell(odocstream &,
648 OutputParams const &,
649 idx_type cell, row_type row, col_type column,
650 std::vector<unsigned int> const &,
651 bool onlydata) const;
652 /// auxiliary function for docbook
653 int docbookRow(odocstream & os, row_type, OutputParams const &) const;
655 docstring xhtmlRow(XHTMLStream & xs, row_type, OutputParams const &) const;
657 /// change associated Buffer
658 void setBuffer(Buffer & buffer);
659 /// retrieve associated Buffer
660 Buffer & buffer() const { return *buffer_; }
669 class InsetTableCell : public InsetText
673 InsetTableCell(Buffer * buf);
675 InsetCode lyxCode() const { return CELL_CODE; }
677 Inset * clone() { return new InsetTableCell(*this); }
679 bool getStatus(Cursor & cur, FuncRequest const & cmd,
680 FuncStatus & status) const;
682 void toggleFixedWidth(bool fw) { isFixedWidth = fw; }
684 void setContentAlignment(LyXAlignment al) {contentAlign = al; }
685 /// writes the contents of the cell as a string, optionally
686 /// descending into insets
687 docstring asString(bool intoInsets = true);
689 docstring xhtml(XHTMLStream &, OutputParams const &) const;
694 void operator=(InsetTableCell const &);
696 // This boolean is supposed to track whether the cell has had its
697 // width explicitly set. We need to know this to determine whether
698 // layout changes and paragraph customization are allowed---that is,
699 // we need it in forcePlainLayout() and allowParagraphCustomization().
700 // Unfortunately, that information is not readily available in
701 // InsetTableCell. In the case of multicolumn cells, it is present
702 // in CellData, and so would be available here if CellData were to
703 // become a member of InsetTableCell. But in the other case, it isn't
704 // even available there, but is held in Tabular::ColumnData.
705 // So, the present solution uses this boolean to track the information
706 // we need to track, and tries to keep it updated. This is not ideal,
707 // but the other solutions are no better. These are:
708 // (i) Keep a pointer in InsetTableCell to the table;
709 // (ii) Find the table by iterating over the Buffer's insets.
710 // Solution (i) raises the problem of updating the pointer when an
711 // InsetTableCell is copied, and we'd therefore need a copy constructor
712 // in InsetTabular and then in Tabular, which seems messy, given how
713 // complicated those classes are. Solution (ii) involves a lot of
714 // iterating, since this information is needed quite often, and so may
716 // So, well, if someone can do better, please do!
720 // FIXME: Here the thoughts from the comment above also apply.
722 LyXAlignment contentAlign;
723 /// should paragraph indendation be omitted in any case?
724 bool neverIndent() const { return true; }
726 LyXAlignment contentAlignment() const { return contentAlign; }
728 virtual bool usePlainLayout() const { return true; }
730 virtual bool forcePlainLayout(idx_type = 0) const;
732 virtual bool allowParagraphCustomization(idx_type = 0) const;
733 /// Is the width forced to some value?
734 bool hasFixedWidth() const { return isFixedWidth; }
738 class InsetTabular : public Inset
742 InsetTabular(Buffer *, row_type rows = 1,
743 col_type columns = 1);
747 void setBuffer(Buffer & buffer);
750 static void string2params(std::string const &, InsetTabular &);
752 static std::string params2string(InsetTabular const &);
756 void write(std::ostream &) const;
758 void metrics(MetricsInfo &, Dimension &) const;
760 void draw(PainterInfo & pi, int x, int y) const;
762 void drawSelection(PainterInfo & pi, int x, int y) const;
764 bool editable() const { return true; }
766 bool hasSettings() const { return true; }
768 bool insetAllowed(InsetCode code) const;
770 bool allowSpellCheck() const { return true; }
772 bool canTrackChanges() const { return true; }
773 /** returns true if, when outputing LaTeX, font changes should
774 be closed before generating this inset. This is needed for
775 insets that may contain several paragraphs */
776 bool noFontChange() const { return true; }
778 DisplayType display() const;
780 int latex(odocstream &, OutputParams const &) const;
782 int plaintext(odocstream &, OutputParams const &) const;
784 int docbook(odocstream &, OutputParams const &) const;
786 docstring xhtml(XHTMLStream &, OutputParams const &) const;
788 void validate(LaTeXFeatures & features) const;
790 InsetCode lyxCode() const { return TABULAR_CODE; }
792 docstring contextMenu(BufferView const & bv, int x, int y) const;
793 /// get offset of this cursor slice relative to our upper left corner
794 void cursorPos(BufferView const & bv, CursorSlice const & sl,
795 bool boundary, int & x, int & y) const;
797 bool tabularFeatures(Cursor & cur, std::string const & what);
799 void tabularFeatures(Cursor & cur, Tabular::Feature feature,
800 std::string const & val = std::string());
802 size_t nargs() const { return tabular.numberofcells; }
804 boost::shared_ptr<InsetTableCell const> cell(idx_type) const;
806 boost::shared_ptr<InsetTableCell> cell(idx_type);
808 Text * getText(int) const;
810 /// set the change for the entire inset
811 void setChange(Change const & change);
812 /// accept the changes within the inset
813 void acceptChanges();
814 /// reject the changes within the inset
815 void rejectChanges();
817 // this should return true if we have a "normal" cell, otherwise false.
818 // "normal" means without width set!
819 /// should all paragraphs be output with "Standard" layout?
820 virtual bool allowParagraphCustomization(idx_type cell = 0) const;
822 virtual bool forcePlainLayout(idx_type cell = 0) const;
824 void addPreview(DocIterator const & inset_pos,
825 graphics::PreviewLoader &) const;
827 /// lock cell with given index
828 void edit(Cursor & cur, bool front, EntryDirection entry_from);
829 /// get table row from x coordinate
830 int rowFromY(Cursor & cur, int y) const;
831 /// get table column from y coordinate
832 int columnFromX(Cursor & cur, int x) const;
834 Inset * editXY(Cursor & cur, int x, int y);
835 /// can we go further down on mouse click?
836 bool descendable(BufferView const &) const { return true; }
837 /// Update the counters of this inset and of its contents
838 void updateBuffer(ParIterator const &, UpdateType);
840 void addToToc(DocIterator const &);
843 bool completionSupported(Cursor const &) const;
845 bool inlineCompletionSupported(Cursor const & cur) const;
847 bool automaticInlineCompletion() const;
849 bool automaticPopupCompletion() const;
851 bool showCompletionCursor() const;
853 CompletionList const * createCompletionList(Cursor const & cur) const;
855 docstring completionPrefix(Cursor const & cur) const;
857 bool insertCompletion(Cursor & cur, docstring const & s, bool finished);
859 void completionPosAndDim(Cursor const &, int & x, int & y, Dimension & dim) const;
861 virtual bool usePlainLayout() const { return true; }
864 virtual InsetTabular * asInsetTabular() { return this; }
866 virtual InsetTabular const * asInsetTabular() const { return this; }
868 bool isRightToLeft(Cursor & cur) const;
869 /// writes the cells between stidx and enidx as a string, optionally
870 /// descending into the insets
871 docstring asString(idx_type stidx, idx_type enidx, bool intoInsets = true);
873 /// Returns whether the cell in the specified row and column is selected.
874 bool isCellSelected(Cursor & cur, row_type row, col_type col) const;
876 // Public structures and variables
878 mutable Tabular tabular;
882 InsetTabular(InsetTabular const &);
884 void doDispatch(Cursor & cur, FuncRequest & cmd);
886 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
888 int scroll() const { return scx_; }
890 Inset * clone() const { return new InsetTabular(*this); }
893 void drawCellLines(frontend::Painter &, int x, int y, row_type row,
894 idx_type cell, Change const & change) const;
896 void setCursorFromCoordinates(Cursor & cur, int x, int y) const;
899 void moveNextCell(Cursor & cur,
900 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
902 void movePrevCell(Cursor & cur,
903 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
905 int cellXPos(idx_type cell) const;
907 void resetPos(Cursor & cur) const;
909 void removeTabularRow();
911 bool copySelection(Cursor & cur);
913 bool pasteClipboard(Cursor & cur);
915 void cutSelection(Cursor & cur);
917 void getSelection(Cursor & cur, row_type & rs, row_type & re,
918 col_type & cs, col_type & ce) const;
920 bool insertPlaintextString(BufferView &, docstring const & buf, bool usePaste);
922 /// return the "Manhattan distance" to nearest corner
923 int dist(BufferView &, idx_type cell, int x, int y) const;
924 /// return the cell nearest to x, y
925 idx_type getNearestCell(BufferView &, int x, int y) const;
927 /// test the rotation state of the give cell range.
928 bool oneCellHasRotationState(bool rotated,
929 row_type row_start, row_type row_end,
930 col_type col_start, col_type col_end) const;
932 mutable idx_type first_visible_cell;
935 /// true when selecting rows with the mouse
937 /// true when selecting columns with the mouse
941 std::string const featureAsString(Tabular::Feature feature);
945 #endif // INSET_TABULAR_H