4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
13 // This is Juergen's rewrite of the tabular (table) support.
15 // Things to think of when designing the new tabular support:
16 // - color support (colortbl, color)
17 // - decimal alignment (dcloumn)
18 // - custom lines (hhline)
24 // This is what I have written about tabular support in the LyX3-Tasks file:
26 // o rewrite of table code. Should probably be written as some
27 // kind of an inset. [Done]
28 // o enhance longtable support
32 #ifndef INSETTABULAR_H
33 #define INSETTABULAR_H
48 class InsetTabular : public UpdatableInset {
51 InsetTabular(Buffer const &, row_type rows = 1,
52 col_type columns = 1);
56 void read(Buffer const &, LyXLex &);
58 void write(Buffer const &, std::ostream &) const;
60 void metrics(MetricsInfo &, Dimension &) const;
62 void draw(PainterInfo & pi, int x, int y) const;
64 void drawSelection(PainterInfo & pi, int x, int y) const;
66 std::string const editMessage() const;
68 bool insetAllowed(InsetBase::Code) const { return true; }
70 bool isTextInset() const { return true; }
71 /** returns true if, when outputing LaTeX, font changes should
72 be closed before generating this inset. This is needed for
73 insets that may contain several paragraphs */
74 bool noFontChange() const { return true; }
76 bool display() const { return tabular.isLongTabular(); }
78 int latex(Buffer const &, std::ostream &,
79 OutputParams const &) const;
81 int plaintext(Buffer const &, std::ostream &,
82 OutputParams const &) const;
84 int linuxdoc(Buffer const &, std::ostream &,
85 OutputParams const &) const;
87 int docbook(Buffer const &, std::ostream &,
88 OutputParams const &) const;
90 void validate(LaTeXFeatures & features) const;
92 Code lyxCode() const { return InsetBase::TABULAR_CODE; }
93 /// get offset of this cursor slice relative to our upper left corner
94 void getCursorPos(CursorSlice const & sl, int & x, int & y) const;
96 bool tabularFeatures(LCursor & cur, std::string const & what);
98 void tabularFeatures(LCursor & cur, LyXTabular::Feature feature,
99 std::string const & val = std::string());
101 void openLayoutDialog(BufferView *) const;
103 bool showInsetDialog(BufferView *) const;
104 /// Appends \c list with all labels found within this inset.
105 void getLabelList(Buffer const &, std::vector<std::string> & list) const;
107 size_t nargs() const;
109 boost::shared_ptr<InsetText const> cell(idx_type) const;
111 boost::shared_ptr<InsetText> cell(idx_type);
113 LyXText * getText(int) const;
118 // this should return true if we have a "normal" cell, otherwise true.
119 // "normal" means without width set!
120 bool forceDefaultParagraphs(InsetBase const * in) const;
123 void addPreview(lyx::graphics::PreviewLoader &) const;
126 Buffer const & buffer() const;
128 /// set the owning buffer
129 void buffer(Buffer const * buf);
130 /// lock cell with given index
131 void edit(LCursor & cur, bool left);
133 InsetBase * editXY(LCursor & cur, int x, int y) const;
134 /// can we go further down on mouse click?
135 bool descendable() const { return true; }
138 // Public structures and variables
140 mutable LyXTabular tabular;
143 InsetTabular(InsetTabular const &);
145 virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
148 bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
150 virtual std::auto_ptr<InsetBase> doClone() const;
153 void drawCellLines(Painter &, int x, int y, row_type row,
154 idx_type cell) const;
156 void setCursorFromCoordinates(LCursor & cur, int x, int y) const;
159 void moveNextCell(LCursor & cur);
161 void movePrevCell(LCursor & cur);
163 int getCellXPos(idx_type cell) const;
165 void resetPos(LCursor & cur) const;
167 void removeTabularRow();
169 bool hasPasteBuffer() const;
171 bool copySelection(LCursor & cur);
173 bool pasteSelection(LCursor & cur);
175 void cutSelection(LCursor & cur);
177 bool isRightToLeft(LCursor & cur) const;
179 void getSelection(LCursor & cur, row_type & rs, row_type & re,
180 col_type & cs, col_type & ce) const;
182 bool insertAsciiString(BufferView &, std::string const & buf, bool usePaste);
183 /// are we operating on several cells?
184 bool tablemode(LCursor & cur) const;
186 /// return the cell nearest to x, y
187 idx_type getNearestCell(int x, int y) const;
190 Buffer const * buffer_;
192 mutable int cursorx_;
194 mutable idx_type first_visible_cell;
198 #include "mailinset.h"
201 class InsetTabularMailer : public MailInset {
204 InsetTabularMailer(InsetTabular const & inset);
206 virtual InsetBase & inset() const { return inset_; }
208 virtual std::string const & name() const { return name_; }
210 virtual std::string const inset2string(Buffer const &) const;
212 static void string2params(std::string const &, InsetTabular &);
214 static std::string const params2string(InsetTabular const &);
217 static std::string const name_;
219 InsetTabular & inset_;
222 std::string const featureAsString(LyXTabular::Feature feature);