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 insertInset(BufferView *, InsetOld *);
85 bool insetAllowed(InsetOld::Code code) const;
87 bool isTextInset() const { return true; }
88 /** returns true if, when outputing LaTeX, font changes should
89 be closed before generating this inset. This is needed for
90 insets that may contain several paragraphs */
91 bool noFontChange() const { return true; }
93 bool display() const { return tabular.isLongTabular(); }
95 int latex(Buffer const &, std::ostream &,
96 OutputParams const &) const;
98 int plaintext(Buffer const &, std::ostream &,
99 OutputParams const &) const;
101 int linuxdoc(Buffer const &, std::ostream &,
102 OutputParams const &) const;
104 int docbook(Buffer const &, std::ostream &,
105 OutputParams const &) const;
107 void validate(LaTeXFeatures & features) const;
109 InsetOld::Code lyxCode() const { return InsetOld::TABULAR_CODE; }
110 /// get the absolute screen x,y of the cursor
111 void getCursorPos(int & x, int & y) const;
113 bool tabularFeatures(BufferView * bv, std::string const & what);
115 void tabularFeatures(BufferView * bv, LyXTabular::Feature feature,
116 std::string const & val = std::string());
118 int getActCell() const { return actcell; }
120 void openLayoutDialog(BufferView *) const;
122 bool showInsetDialog(BufferView *) const;
124 FuncStatus getStatus(std::string const & argument) const;
125 /// Appends \c list with all labels found within this inset.
126 void getLabelList(Buffer const &, std::vector<std::string> & list) const;
128 int scroll(bool recursive=true) const;
130 void scroll(BufferView *bv, float sx) const {
131 UpdatableInset::scroll(bv, sx);
134 void scroll(BufferView *bv, int offset) const {
135 UpdatableInset::scroll(bv, offset);
138 ParagraphList * getParagraphs(int) const;
140 int numParagraphs() const;
142 LyXText * getText(int) const;
147 // this should return true if we have a "normal" cell, otherwise true.
148 // "normal" means without width set!
149 bool forceDefaultParagraphs(InsetOld const * in) const;
152 void addPreview(lyx::graphics::PreviewLoader &) const;
155 // Public structures and variables
157 mutable LyXTabular tabular;
159 /// are some cells selected ?
160 bool hasSelection() const { return has_selection; }
163 Buffer const & buffer() const;
165 /// set the owning buffer
166 void buffer(Buffer * buf);
167 /// lock cell with given index
168 void edit(BufferView * bv, bool);
170 void edit(BufferView * bv, int, int);
171 /// can we go further down on mouse click?
172 bool descendable() const { return true; }
177 priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
180 void lfunMousePress(FuncRequest const &);
182 void lfunMouseRelease(FuncRequest const &);
184 void lfunMouseMotion(FuncRequest const &);
186 void calculate_dimensions_of_cells(MetricsInfo & mi) const;
188 void drawCellLines(Painter &, int x, int baseline,
189 int row, int cell) const;
191 void drawCellSelection(Painter &, int x, int baseline,
192 int row, int column, int cell) const;
194 void setPos(BufferView *, int x, int y) const;
196 DispatchResult moveRight(BufferView *, bool lock);
198 DispatchResult moveLeft(BufferView *, bool lock);
200 DispatchResult moveUp(BufferView *, bool lock);
202 DispatchResult moveDown(BufferView *, bool lock);
204 bool moveNextCell(BufferView *, bool lock = false);
206 bool movePrevCell(BufferView *, bool lock = false);
208 int getCellXPos(int cell) const;
210 void resetPos(BufferView *) const;
212 void removeTabularRow();
214 void clearSelection() const {
215 sel_cell_start = sel_cell_end = 0;
216 has_selection = false;
218 void setSelection(int start, int end) const {
219 sel_cell_start = start;
221 has_selection = true;
224 bool activateCellInset(BufferView *, int x = 0, int y = 0,
225 bool behind = false);
227 bool hasPasteBuffer() const;
229 bool copySelection(BufferView *);
231 bool pasteSelection(BufferView *);
233 bool cutSelection(BufferParams const & bp);
235 bool isRightToLeft(BufferView *);
237 void getSelection(int & scol, int & ecol, int & srow, int & erow) const;
239 bool insertAsciiString(BufferView *, std::string const & buf, bool usePaste);
242 // Private structures and variables
244 InsetText * the_locking_inset;
246 Buffer const * buffer_;
248 mutable int cursorx_;
250 mutable int cursory_;
251 /// true if a set of cells are selected
252 mutable bool has_selection;
253 /// the starting cell selection nr
254 mutable int sel_cell_start;
255 /// the ending cell selection nr
256 mutable int sel_cell_end;
264 mutable int first_visible_cell;
266 mutable int in_reset_pos;
270 #include "mailinset.h"
273 class InsetTabularMailer : public MailInset {
276 InsetTabularMailer(InsetTabular const & inset);
278 virtual InsetBase & inset() const { return inset_; }
280 virtual std::string const & name() const { return name_; }
282 virtual std::string const inset2string(Buffer const &) const;
283 /// Returns the active cell if successful, else -1.
284 static int string2params(std::string const &, InsetTabular &);
286 static std::string const params2string(InsetTabular const &);
289 static std::string const name_;
291 InsetTabular & inset_;
294 std::string const featureAsString(LyXTabular::Feature feature);