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
55 #include "lyxcursor.h"
56 #include "FuncStatus.h"
58 #include <boost/scoped_ptr.hpp>
60 #include <boost/signals/signal0.hpp>
68 class InsetTabular : public UpdatableInset {
80 InsetTabular(Buffer const &, int rows = 1, int columns = 1);
82 InsetTabular(InsetTabular const &, Buffer const &, bool same_id = false);
86 Inset * clone(Buffer const &, bool same_id = false) const;
88 void read(Buffer const *, LyXLex &);
90 void write(Buffer const *, std::ostream &) const;
92 int ascent(BufferView *, LyXFont const &) const;
94 int descent(BufferView *, LyXFont const &) const;
96 int width(BufferView *, LyXFont const & f) const;
98 void draw(BufferView *, const LyXFont &, int , float &, bool) const;
100 void update(BufferView *, LyXFont const &, bool = false);
102 string const editMessage() const;
104 void edit(BufferView *, int x, int y, mouse_button::state);
106 void edit(BufferView * bv, bool front = true);
108 bool doClearArea() const;
110 void insetUnlock(BufferView *);
112 void updateLocal(BufferView *, UpdateCodes, bool mark_dirty) const;
114 bool lockInsetInInset(BufferView *, UpdatableInset *);
116 bool unlockInsetInInset(BufferView *, UpdatableInset *,
119 bool updateInsetInInset(BufferView *, Inset *);
121 int insetInInsetY() const;
123 UpdatableInset * getLockingInset() const;
125 UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
127 bool insertInset(BufferView *, Inset *);
129 bool insetAllowed(Inset::Code code) const;
131 bool isTextInset() const { return true; }
132 /** returns true if, when outputing LaTeX, font changes should
133 be closed before generating this inset. This is needed for
134 insets that may contain several paragraphs */
135 bool noFontChange() const { return true; }
137 bool display() const { return tabular->IsLongTabular(); }
139 RESULT localDispatch(FuncRequest const &);
141 int latex(Buffer const *, std::ostream &, bool, bool) const;
143 int ascii(Buffer const *, std::ostream &, int linelen) const;
145 int linuxdoc(Buffer const *, std::ostream &) const;
147 int docbook(Buffer const *, std::ostream &, bool mixcont) const;
149 void validate(LaTeXFeatures & features) const;
151 Inset::Code lyxCode() const { return Inset::TABULAR_CODE; }
153 void getCursorPos(BufferView *, int & x, int & y) const;
155 void toggleInsetCursor(BufferView *);
157 bool tabularFeatures(BufferView * bv, string const & what);
159 void tabularFeatures(BufferView * bv, LyXTabular::Feature feature,
160 string const & val = string());
162 int getActCell() const { return actcell; }
164 void setFont(BufferView *, LyXFont const &, bool toggleall = false,
165 bool selectall = false);
167 int getMaxWidth(BufferView *, UpdatableInset const *) const;
169 Buffer * bufferOwner() const { return const_cast<Buffer *>(buffer); }
171 LyXText * getLyXText(BufferView const *,
172 bool const recursive = false) const;
174 void deleteLyXText(BufferView *, bool recursive = true) const;
176 void resizeLyXText(BufferView *, bool force = false) const;
178 void openLayoutDialog(BufferView *) const;
180 bool showInsetDialog(BufferView *) const;
182 FuncStatus getStatus(string const & argument) const;
184 std::vector<string> const getLabelList() const;
186 void nodraw(bool b) const {
187 UpdatableInset::nodraw(b);
191 int scroll(bool recursive=true) const;
193 void scroll(BufferView *bv, float sx) const {
194 UpdatableInset::scroll(bv, sx);
197 void scroll(BufferView *bv, int offset) const {
198 UpdatableInset::scroll(bv, offset);
201 Paragraph * getParFromID(int id) const;
203 Inset * getInsetFromID(int id) const;
205 Paragraph * firstParagraph() const;
207 Paragraph * getFirstParagraph(int) const;
209 LyXCursor const & cursor(BufferView *) const;
211 bool allowSpellcheck() { return true; }
214 selectNextWordToSpellcheck(BufferView *, float & value) const;
216 void selectSelectedWord(BufferView *);
218 void toggleSelection(BufferView *, bool kill_selection);
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 boost::signal0<void> hideDialog;
239 /// are some cells selected ?
240 bool hasSelection() const {
241 return has_selection;
245 void lfunMousePress(FuncRequest const &);
247 // the bool return is used to see if we opened a dialog so that we can
248 // check this from an outer inset and open the dialog of the outer inset
249 // if that one has one!
251 bool lfunMouseRelease(FuncRequest const &);
253 void lfunMouseMotion(FuncRequest const &);
255 bool calculate_dimensions_of_cells(BufferView *, LyXFont const &,
258 void drawCellLines(Painter &, int x, int baseline,
259 int row, int cell) const;
261 void drawCellSelection(Painter &, int x, int baseline,
262 int row, int column, int cell) const;
264 void showInsetCursor(BufferView *, bool show=true);
266 void hideInsetCursor(BufferView *);
268 void fitInsetCursor(BufferView *) const;
270 void setPos(BufferView *, int x, int y) const;
272 RESULT moveRight(BufferView *, bool lock = true);
274 RESULT moveLeft(BufferView *, bool lock = true);
276 RESULT moveUp(BufferView *, bool lock = true);
278 RESULT moveDown(BufferView *, bool lock = true);
280 bool moveNextCell(BufferView *, bool lock = false);
282 bool movePrevCell(BufferView *, bool lock = false);
284 bool deletable() const;
286 int getCellXPos(int cell) const;
288 void resetPos(BufferView *) const;
290 void removeTabularRow();
292 void clearSelection() const {
293 sel_cell_start = sel_cell_end = 0;
294 has_selection = false;
296 void setSelection(int start, int end) const {
297 sel_cell_start = start;
299 has_selection = true;
302 bool activateCellInset(BufferView *, int x = 0, int y = 0,
303 mouse_button::state button = mouse_button::none,
304 bool behind = false);
306 bool activateCellInsetAbs(BufferView *, int x = 0, int y = 0,
307 mouse_button::state button = mouse_button::none);
309 bool insetHit(BufferView * bv, int x, int y) const;
311 int getMaxWidthOfCell(BufferView * bv, int cell) const;
313 bool hasPasteBuffer() const;
315 bool copySelection(BufferView *);
317 bool pasteSelection(BufferView *);
321 bool isRightToLeft(BufferView *);
323 void getSelection(int & scol, int & ecol,
324 int & srow, int & erow) const;
326 WordLangTuple selectNextWordInt(BufferView *, float & value) const;
328 bool insertAsciiString(BufferView *, string const & buf, bool usePaste);
331 // Private structures and variables
333 InsetText * the_locking_inset;
335 InsetText * old_locking_inset;
337 Buffer const * buffer;
339 mutable LyXCursor cursor_;
341 mutable unsigned int inset_x;
343 mutable unsigned int inset_y;
344 /// true if a set of cells are selected
345 mutable bool has_selection;
346 /// the starting cell selection nr
347 mutable int sel_cell_start;
348 /// the ending cell selection nr
349 mutable int sel_cell_end;
359 mutable int first_visible_cell;
365 mutable UpdateCodes need_update;
369 mutable int in_reset_pos;