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