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
51 #include "lyxcursor.h"
52 #include "FuncStatus.h"
53 #include "frontends/mouse_state.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 &);
83 Inset * clone(Buffer const &) const;
85 void read(Buffer const *, LyXLex &);
87 void write(Buffer const *, std::ostream &) const;
89 void dimension(BufferView *, LyXFont const &, Dimension &) const;
91 void draw(PainterInfo & pi, int x, int y) const;
93 void update(BufferView *, bool = false);
95 string const editMessage() const;
97 void insetUnlock(BufferView *);
99 void updateLocal(BufferView *, UpdateCodes) const;
101 bool lockInsetInInset(BufferView *, UpdatableInset *);
103 bool unlockInsetInInset(BufferView *, UpdatableInset *,
106 bool updateInsetInInset(BufferView *, Inset *);
108 int insetInInsetY() const;
110 UpdatableInset * getLockingInset() const;
112 UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
114 bool insertInset(BufferView *, Inset *);
116 bool insetAllowed(Inset::Code code) const;
118 bool isTextInset() const { return true; }
119 /** returns true if, when outputing LaTeX, font changes should
120 be closed before generating this inset. This is needed for
121 insets that may contain several paragraphs */
122 bool noFontChange() const { return true; }
124 bool display() const { return tabular->IsLongTabular(); }
126 RESULT localDispatch(FuncRequest const &);
128 int latex(Buffer const *, std::ostream &,
129 LatexRunParams const &) const;
131 int ascii(Buffer const *, std::ostream &, int linelen) const;
133 int linuxdoc(Buffer const *, std::ostream &) const;
135 int docbook(Buffer const *, std::ostream &, bool mixcont) const;
137 void validate(LaTeXFeatures & features) const;
139 Inset::Code lyxCode() const { return Inset::TABULAR_CODE; }
141 void getCursorPos(BufferView *, int & x, int & y) const;
142 /// Get the absolute document x,y of the cursor
143 virtual void getCursor(BufferView &, int &, int &) const;
145 bool tabularFeatures(BufferView * bv, string const & what);
147 void tabularFeatures(BufferView * bv, LyXTabular::Feature feature,
148 string const & val = string());
150 int getActCell() const { return actcell; }
152 void setFont(BufferView *, LyXFont const &, bool toggleall = false,
153 bool selectall = false);
155 int getMaxWidth(BufferView *, UpdatableInset const *) const;
157 LyXText * getLyXText(BufferView const *,
158 bool const recursive = false) const;
160 void deleteLyXText(BufferView *, bool recursive = true) const;
162 void resizeLyXText(BufferView *, bool force = false) const;
164 void openLayoutDialog(BufferView *) const;
166 bool showInsetDialog(BufferView *) const;
168 FuncStatus getStatus(string const & argument) const;
170 std::vector<string> const getLabelList() const;
172 void nodraw(bool b) const {
173 UpdatableInset::nodraw(b);
177 int scroll(bool recursive=true) const;
179 void scroll(BufferView *bv, float sx) const {
180 UpdatableInset::scroll(bv, sx);
183 void scroll(BufferView *bv, int offset) const {
184 UpdatableInset::scroll(bv, offset);
187 Inset * getInsetFromID(int id) const;
189 ParagraphList * getParagraphs(int) const;
191 LyXCursor const & cursor(BufferView *) const;
193 bool allowSpellcheck() const { return true; }
196 selectNextWordToSpellcheck(BufferView *, float & value) const;
198 void selectSelectedWord(BufferView *);
200 void toggleSelection(BufferView *, bool kill_selection);
205 bool nextChange(BufferView *, lyx::pos_type & length);
207 bool searchForward(BufferView *, string const &,
208 bool = true, bool = false);
209 bool searchBackward(BufferView *, string const &,
210 bool = true, bool = false);
212 // this should return true if we have a "normal" cell, otherwise true.
213 // "normal" means without width set!
214 bool forceDefaultParagraphs(Inset const * in) const;
217 void addPreview(grfx::PreviewLoader &) const;
220 // Public structures and variables
222 boost::scoped_ptr<LyXTabular> tabular;
224 /// are some cells selected ?
225 bool hasSelection() const {
226 return has_selection;
230 virtual BufferView * view() const;
233 void lfunMousePress(FuncRequest const &);
235 // the bool return is used to see if we opened a dialog so that we can
236 // check this from an outer inset and open the dialog of the outer inset
237 // if that one has one!
239 bool lfunMouseRelease(FuncRequest const &);
241 void lfunMouseMotion(FuncRequest const &);
243 bool calculate_dimensions_of_cells(BufferView *, bool = false) const;
245 void drawCellLines(Painter &, int x, int baseline,
246 int row, int cell) const;
248 void drawCellSelection(Painter &, int x, int baseline,
249 int row, int column, int cell) const;
251 void fitInsetCursor(BufferView *) const;
253 void setPos(BufferView *, int x, int y) const;
255 RESULT moveRight(BufferView *, bool lock = true);
257 RESULT moveLeft(BufferView *, bool lock = true);
259 RESULT moveUp(BufferView *, bool lock = true);
261 RESULT moveDown(BufferView *, bool lock = true);
263 bool moveNextCell(BufferView *, bool lock = false);
265 bool movePrevCell(BufferView *, bool lock = false);
267 int getCellXPos(int cell) const;
269 void resetPos(BufferView *) const;
271 void removeTabularRow();
273 void clearSelection() const {
274 sel_cell_start = sel_cell_end = 0;
275 has_selection = false;
277 void setSelection(int start, int end) const {
278 sel_cell_start = start;
280 has_selection = true;
283 bool activateCellInset(BufferView *, int x = 0, int y = 0,
284 mouse_button::state button = mouse_button::none,
285 bool behind = false);
287 bool activateCellInsetAbs(BufferView *, int x = 0, int y = 0,
288 mouse_button::state button = mouse_button::none);
290 bool insetHit(BufferView * bv, int x, int y) const;
292 int getMaxWidthOfCell(BufferView * bv, int cell) const;
294 bool hasPasteBuffer() const;
296 bool copySelection(BufferView *);
298 bool pasteSelection(BufferView *);
300 bool cutSelection(BufferParams const & bp);
302 bool isRightToLeft(BufferView *);
304 void getSelection(int & scol, int & ecol,
305 int & srow, int & erow) const;
307 WordLangTuple selectNextWordInt(BufferView *, float & value) const;
309 bool insertAsciiString(BufferView *, string const & buf, bool usePaste);
312 // Private structures and variables
314 InsetText * the_locking_inset;
316 InsetText * old_locking_inset;
318 Buffer const * buffer;
320 mutable LyXCursor cursor_;
322 mutable unsigned int inset_x;
324 mutable unsigned int inset_y;
325 /// true if a set of cells are selected
326 mutable bool has_selection;
327 /// the starting cell selection nr
328 mutable int sel_cell_start;
329 /// the ending cell selection nr
330 mutable int sel_cell_end;
340 mutable int first_visible_cell;
346 mutable UpdateCodes need_update;
350 mutable int in_reset_pos;
354 #include "mailinset.h"
357 class InsetTabularMailer : public MailInset {
360 InsetTabularMailer(InsetTabular & inset);
362 virtual InsetBase & inset() const { return inset_; }
364 virtual string const & name() const { return name_; }
366 virtual string const inset2string() const;
367 /// Returns the active cell if successful, else -1.
368 static int string2params(string const &, InsetTabular &);
370 static string const params2string(InsetTabular const &);
373 static string const name_;
375 InsetTabular & inset_;
378 string const featureAsString(LyXTabular::Feature feature);