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.
11 // This is the rewrite of the tabular (table) support.
13 // It will probably be a lot of work.
15 // One first goal could be to make the inset read the old table format
16 // and just output it again... no viewing at all.
18 // When making the internal structure of tabular support I really think
19 // that STL containers should be used. This will separate the container from
20 // the rest of the code, which is a good thing.
22 // Ideally the tabular support should do as the mathed and use
23 // LaTeX in the .lyx file too.
25 // Things to think of when desingning the new tabular support:
26 // - color support (colortbl, color)
27 // - decimal alignment (dcloumn)
28 // - custom lines (hhline)
34 // This is what I have written about tabular support in the LyX3-Tasks file:
36 // o rewrite of table code. Should probably be written as some
37 // kind of an inset. At least get the code out of the kernel.
38 // - colortbl -multirow
39 // - hhline -multicolumn
41 // o enhance longtable support
45 #ifndef INSETTABULAR_H
46 #define INSETTABULAR_H
50 #include "frontends/mouse_state.h"
60 class InsetTabular : public UpdatableInset {
63 InsetTabular(Buffer const &, int rows = 1, int columns = 1);
65 InsetTabular(InsetTabular const &);
69 virtual std::auto_ptr<InsetBase> clone() const;
71 void read(Buffer const &, LyXLex &);
73 void write(Buffer const &, std::ostream &) const;
75 void metrics(MetricsInfo &, Dimension &) const;
77 void draw(PainterInfo & pi, int x, int y) const;
79 std::string const editMessage() const;
81 void updateLocal(BufferView *) const;
83 bool insetAllowed(InsetOld::Code code) const;
85 bool isTextInset() const { return true; }
86 /** returns true if, when outputing LaTeX, font changes should
87 be closed before generating this inset. This is needed for
88 insets that may contain several paragraphs */
89 bool noFontChange() const { return true; }
91 bool display() const { return tabular.isLongTabular(); }
93 int latex(Buffer const &, std::ostream &,
94 OutputParams const &) const;
96 int plaintext(Buffer const &, std::ostream &,
97 OutputParams const &) const;
99 int linuxdoc(Buffer const &, std::ostream &,
100 OutputParams const &) const;
102 int docbook(Buffer const &, std::ostream &,
103 OutputParams const &) const;
105 void validate(LaTeXFeatures & features) const;
107 InsetOld::Code lyxCode() const { return InsetOld::TABULAR_CODE; }
108 /// get the absolute screen x,y of the cursor
109 void getCursorPos(int & x, int & y) const;
111 bool tabularFeatures(BufferView * bv, std::string const & what);
113 void tabularFeatures(BufferView * bv, LyXTabular::Feature feature,
114 std::string const & val = std::string());
116 int getActCell() const { return actcell; }
118 void openLayoutDialog(BufferView *) const;
120 bool showInsetDialog(BufferView *) const;
122 FuncStatus getStatus(std::string const & argument) const;
123 /// Appends \c list with all labels found within this inset.
124 void getLabelList(Buffer const &, std::vector<std::string> & list) const;
126 int numParagraphs() const;
128 LyXText * getText(int) const;
133 // this should return true if we have a "normal" cell, otherwise true.
134 // "normal" means without width set!
135 bool forceDefaultParagraphs(InsetOld const * in) const;
138 void addPreview(lyx::graphics::PreviewLoader &) const;
140 /// are some cells selected ?
141 bool hasSelection() const { return has_selection; }
143 Buffer const & buffer() const;
145 /// set the owning buffer
146 void buffer(Buffer * buf);
147 /// lock cell with given index
148 void edit(BufferView * bv, bool);
150 void edit(BufferView * bv, int, int);
151 /// can we go further down on mouse click?
152 bool descendable() const { return true; }
155 // Public structures and variables
157 mutable LyXTabular tabular;
163 priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
166 void lfunMousePress(FuncRequest const &);
168 void lfunMouseRelease(FuncRequest const &);
170 void lfunMouseMotion(FuncRequest const &);
172 void calculate_dimensions_of_cells(MetricsInfo & mi) const;
174 void drawCellLines(Painter &, int x, int baseline,
175 int row, int cell) const;
177 void drawCellSelection(Painter &, int x, int baseline,
178 int row, int column, int cell) const;
180 void setPos(BufferView *, int x, int y) const;
182 DispatchResult moveRight(BufferView *);
184 DispatchResult moveLeft(BufferView *);
186 DispatchResult moveUp(BufferView *);
188 DispatchResult moveDown(BufferView *);
191 DispatchResult moveRightLock(BufferView *);
193 DispatchResult moveLeftLock(BufferView *);
195 DispatchResult moveUpLock(BufferView *);
197 DispatchResult moveDownLock(BufferView *);
200 bool moveNextCell(BufferView *);
202 bool movePrevCell(BufferView *);
206 int getCellXPos(int cell) const;
208 void resetPos(BufferView *) const;
210 void removeTabularRow();
212 void clearSelection() const {
213 sel_cell_start = sel_cell_end = 0;
214 has_selection = false;
216 void setSelection(int start, int end) const {
217 sel_cell_start = start;
219 has_selection = true;
222 void activateCellInset(BufferView *, int cell, int x, int y);
224 void activateCellInset(BufferView *, int cell, bool behind);
226 bool hasPasteBuffer() const;
228 bool copySelection(BufferView *);
230 bool pasteSelection(BufferView *);
232 bool cutSelection(BufferParams const & bp);
234 bool isRightToLeft(BufferView *);
236 void getSelection(int & scol, int & ecol, int & srow, int & erow) const;
238 bool insertAsciiString(BufferView *, std::string const & buf, bool usePaste);
241 // Private structures and variables
243 Buffer const * buffer_;
245 mutable int cursorx_;
247 mutable int cursory_;
248 /// true if a set of cells are selected
249 mutable bool has_selection;
250 /// the starting cell selection nr
251 mutable int sel_cell_start;
252 /// the ending cell selection nr
253 mutable int sel_cell_end;
261 mutable int first_visible_cell;
263 mutable int in_reset_pos;
267 #include "mailinset.h"
270 class InsetTabularMailer : public MailInset {
273 InsetTabularMailer(InsetTabular const & inset);
275 virtual InsetBase & inset() const { return inset_; }
277 virtual std::string const & name() const { return name_; }
279 virtual std::string const inset2string(Buffer const &) const;
280 /// Returns the active cell if successful, else -1.
281 static int string2params(std::string const &, InsetTabular &);
283 static std::string const params2string(InsetTabular const &);
286 static std::string const name_;
288 InsetTabular & inset_;
291 std::string const featureAsString(LyXTabular::Feature feature);