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
52 #include "lyxcursor.h"
53 #include "FuncStatus.h"
55 #include <boost/scoped_ptr.hpp>
56 #include <boost/weak_ptr.hpp>
65 class InsetTabular : public UpdatableInset {
77 InsetTabular(Buffer const &, int rows = 1, int columns = 1);
79 InsetTabular(InsetTabular const &, Buffer const &, bool same_id = false);
83 Inset * clone(Buffer const &, bool same_id = false) const;
85 void read(Buffer const *, LyXLex &);
87 void write(Buffer const *, std::ostream &) const;
89 int ascent(BufferView *, LyXFont const &) const;
91 int descent(BufferView *, LyXFont const &) const;
93 int width(BufferView *, LyXFont const & f) const;
95 void draw(BufferView *, const LyXFont &, int , float &, bool) const;
97 void update(BufferView *, LyXFont const &, bool = false);
99 string const editMessage() const;
101 void edit(BufferView *, int x, int y, mouse_button::state);
103 void edit(BufferView * bv, bool front = true);
105 bool doClearArea() const;
107 void insetUnlock(BufferView *);
109 void updateLocal(BufferView *, UpdateCodes, bool mark_dirty) const;
111 bool lockInsetInInset(BufferView *, UpdatableInset *);
113 bool unlockInsetInInset(BufferView *, UpdatableInset *,
116 bool updateInsetInInset(BufferView *, Inset *);
118 int insetInInsetY() const;
120 UpdatableInset * getLockingInset() const;
122 UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
124 bool insertInset(BufferView *, Inset *);
126 bool insetAllowed(Inset::Code code) const;
128 bool isTextInset() const { return true; }
129 /** returns true if, when outputing LaTeX, font changes should
130 be closed before generating this inset. This is needed for
131 insets that may contain several paragraphs */
132 bool noFontChange() const { return true; }
134 bool display() const { return tabular->IsLongTabular(); }
136 RESULT localDispatch(FuncRequest const &);
138 int latex(Buffer const *, std::ostream &, bool, bool) const;
140 int ascii(Buffer const *, std::ostream &, int linelen) const;
142 int linuxdoc(Buffer const *, std::ostream &) const;
144 int docbook(Buffer const *, std::ostream &, bool mixcont) const;
146 void validate(LaTeXFeatures & features) const;
148 Inset::Code lyxCode() const { return Inset::TABULAR_CODE; }
150 void getCursorPos(BufferView *, int & x, int & y) const;
152 void toggleInsetCursor(BufferView *);
154 bool tabularFeatures(BufferView * bv, string const & what);
156 void tabularFeatures(BufferView * bv, LyXTabular::Feature feature,
157 string const & val = string());
159 int getActCell() const { return actcell; }
161 void setFont(BufferView *, LyXFont const &, bool toggleall = false,
162 bool selectall = false);
164 int getMaxWidth(BufferView *, UpdatableInset const *) const;
166 Buffer * bufferOwner() const { return const_cast<Buffer *>(buffer); }
168 LyXText * getLyXText(BufferView const *,
169 bool const recursive = false) const;
171 void deleteLyXText(BufferView *, bool recursive = true) const;
173 void resizeLyXText(BufferView *, bool force = false) const;
175 void openLayoutDialog(BufferView *) const;
177 bool showInsetDialog(BufferView *) const;
179 FuncStatus getStatus(string const & argument) const;
181 std::vector<string> const getLabelList() const;
183 void nodraw(bool b) const {
184 UpdatableInset::nodraw(b);
188 int scroll(bool recursive=true) const;
190 void scroll(BufferView *bv, float sx) const {
191 UpdatableInset::scroll(bv, sx);
194 void scroll(BufferView *bv, int offset) const {
195 UpdatableInset::scroll(bv, offset);
198 Inset * getInsetFromID(int id) const;
200 Paragraph * firstParagraph() const;
202 Paragraph * getFirstParagraph(int) const;
204 LyXCursor const & cursor(BufferView *) const;
206 bool allowSpellcheck() const { return true; }
209 selectNextWordToSpellcheck(BufferView *, float & value) const;
211 void selectSelectedWord(BufferView *);
213 void toggleSelection(BufferView *, bool kill_selection);
218 bool nextChange(BufferView *, lyx::pos_type & length);
220 bool searchForward(BufferView *, string const &,
221 bool = true, bool = false);
222 bool searchBackward(BufferView *, string const &,
223 bool = true, bool = false);
225 // this should return true if we have a "normal" cell, otherwise true.
226 // "normal" means without width set!
227 bool forceDefaultParagraphs(Inset const * in) const;
230 void addPreview(grfx::PreviewLoader &) const;
233 // Public structures and variables
235 boost::scoped_ptr<LyXTabular> tabular;
237 /// are some cells selected ?
238 bool hasSelection() const {
239 return has_selection;
243 virtual BufferView * view() const;
246 void lfunMousePress(FuncRequest const &);
248 // the bool return is used to see if we opened a dialog so that we can
249 // check this from an outer inset and open the dialog of the outer inset
250 // if that one has one!
252 bool lfunMouseRelease(FuncRequest const &);
254 void lfunMouseMotion(FuncRequest const &);
256 bool calculate_dimensions_of_cells(BufferView *, LyXFont const &,
259 void drawCellLines(Painter &, int x, int baseline,
260 int row, int cell) const;
262 void drawCellSelection(Painter &, int x, int baseline,
263 int row, int column, int cell) const;
265 void showInsetCursor(BufferView *, bool show=true);
267 void hideInsetCursor(BufferView *);
269 void fitInsetCursor(BufferView *) const;
271 void setPos(BufferView *, int x, int y) const;
273 RESULT moveRight(BufferView *, bool lock = true);
275 RESULT moveLeft(BufferView *, bool lock = true);
277 RESULT moveUp(BufferView *, bool lock = true);
279 RESULT moveDown(BufferView *, bool lock = true);
281 bool moveNextCell(BufferView *, bool lock = false);
283 bool movePrevCell(BufferView *, bool lock = false);
285 int getCellXPos(int cell) const;
287 void resetPos(BufferView *) const;
289 void removeTabularRow();
291 void clearSelection() const {
292 sel_cell_start = sel_cell_end = 0;
293 has_selection = false;
295 void setSelection(int start, int end) const {
296 sel_cell_start = start;
298 has_selection = true;
301 bool activateCellInset(BufferView *, int x = 0, int y = 0,
302 mouse_button::state button = mouse_button::none,
303 bool behind = false);
305 bool activateCellInsetAbs(BufferView *, int x = 0, int y = 0,
306 mouse_button::state button = mouse_button::none);
308 bool insetHit(BufferView * bv, int x, int y) const;
310 int getMaxWidthOfCell(BufferView * bv, int cell) const;
312 bool hasPasteBuffer() const;
314 bool copySelection(BufferView *);
316 bool pasteSelection(BufferView *);
318 bool cutSelection(BufferParams const & bp);
320 bool isRightToLeft(BufferView *);
322 void getSelection(int & scol, int & ecol,
323 int & srow, int & erow) const;
325 WordLangTuple selectNextWordInt(BufferView *, float & value) const;
327 bool insertAsciiString(BufferView *, string const & buf, bool usePaste);
330 // Private structures and variables
332 InsetText * the_locking_inset;
334 InsetText * old_locking_inset;
336 Buffer const * buffer;
338 mutable LyXCursor cursor_;
340 mutable unsigned int inset_x;
342 mutable unsigned int inset_y;
343 /// true if a set of cells are selected
344 mutable bool has_selection;
345 /// the starting cell selection nr
346 mutable int sel_cell_start;
347 /// the ending cell selection nr
348 mutable int sel_cell_end;
358 mutable int first_visible_cell;
364 mutable UpdateCodes need_update;
368 mutable int in_reset_pos;
372 #include "mailinset.h"
375 class InsetTabularMailer : public MailInset {
378 InsetTabularMailer(InsetTabular & inset);
380 virtual Inset & inset() const { return inset_; }
382 virtual string const & name() const { return name_; }
384 virtual string const inset2string() const;
385 /// Returns the active cell if successful, else -1.
386 static int string2params(string const &, InsetTabular &);
388 static string const params2string(InsetTabular const &);
391 static string const name_;
393 InsetTabular & inset_;
396 string const featureAsString(LyXTabular::Feature feature);