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"
62 class InsetTabular : public UpdatableInset {
73 InsetTabular(Buffer const &, int rows = 1, int columns = 1);
75 InsetTabular(InsetTabular const &);
79 InsetBase * clone() const;
81 void read(Buffer const *, LyXLex &);
83 void write(Buffer const *, std::ostream &) const;
85 void metrics(MetricsInfo &, Dimension &) const;
87 void draw(PainterInfo & pi, int x, int y) const;
89 string const editMessage() const;
91 void insetUnlock(BufferView *);
93 void updateLocal(BufferView *, UpdateCodes) const;
95 bool lockInsetInInset(BufferView *, UpdatableInset *);
97 bool unlockInsetInInset(BufferView *, UpdatableInset *,
100 bool updateInsetInInset(BufferView *, Inset *);
102 int insetInInsetY() const;
104 UpdatableInset * getLockingInset() const;
106 UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
108 bool insertInset(BufferView *, Inset *);
110 bool insetAllowed(Inset::Code code) const;
112 bool isTextInset() const { return true; }
113 /** returns true if, when outputing LaTeX, font changes should
114 be closed before generating this inset. This is needed for
115 insets that may contain several paragraphs */
116 bool noFontChange() const { return true; }
118 bool display() const { return tabular.isLongTabular(); }
120 RESULT localDispatch(FuncRequest const &);
122 int latex(Buffer const *, std::ostream &,
123 LatexRunParams const &) const;
125 int ascii(Buffer const *, std::ostream &, int linelen) const;
127 int linuxdoc(Buffer const *, std::ostream &) const;
129 int docbook(Buffer const *, std::ostream &, bool mixcont) const;
131 void validate(LaTeXFeatures & features) const;
133 Inset::Code lyxCode() const { return Inset::TABULAR_CODE; }
135 void getCursorPos(BufferView *, int & x, int & y) const;
136 /// Get the absolute document x,y of the cursor
137 virtual void getCursor(BufferView &, int &, int &) const;
139 bool tabularFeatures(BufferView * bv, string const & what);
141 void tabularFeatures(BufferView * bv, LyXTabular::Feature feature,
142 string const & val = string());
144 int getActCell() const { return actcell; }
146 void setFont(BufferView *, LyXFont const &, bool toggleall = false,
147 bool selectall = false);
149 LyXText * getLyXText(BufferView const *,
150 bool const recursive = false) const;
152 void deleteLyXText(BufferView *, bool recursive = true) const;
154 void resizeLyXText(BufferView *, bool force = false) const;
156 void openLayoutDialog(BufferView *) const;
158 bool showInsetDialog(BufferView *) const;
160 FuncStatus getStatus(string const & argument) const;
162 void getLabelList(std::vector<string> &) const;
164 void nodraw(bool b) const {
165 UpdatableInset::nodraw(b);
169 int scroll(bool recursive=true) const;
171 void scroll(BufferView *bv, float sx) const {
172 UpdatableInset::scroll(bv, sx);
175 void scroll(BufferView *bv, int offset) const {
176 UpdatableInset::scroll(bv, offset);
179 Inset * getInsetFromID(int id) const;
181 ParagraphList * getParagraphs(int) const;
183 LyXCursor const & cursor(BufferView *) const;
185 bool allowSpellcheck() const { return true; }
188 selectNextWordToSpellcheck(BufferView *, float & value) const;
190 void selectSelectedWord(BufferView *);
192 void toggleSelection(BufferView *, bool kill_selection);
197 bool nextChange(BufferView *, lyx::pos_type & length);
199 bool searchForward(BufferView *, string const &,
200 bool = true, bool = false);
201 bool searchBackward(BufferView *, string const &,
202 bool = true, bool = false);
204 // this should return true if we have a "normal" cell, otherwise true.
205 // "normal" means without width set!
206 bool forceDefaultParagraphs(Inset const * in) const;
209 void addPreview(lyx::graphics::PreviewLoader &) const;
212 // Public structures and variables
214 mutable LyXTabular tabular;
216 /// are some cells selected ?
217 bool hasSelection() const {
218 return has_selection;
222 virtual BufferView * view() const;
224 Buffer const * buffer() const;
226 /// set the owning buffer
227 void buffer(Buffer * b);
231 void lfunMousePress(FuncRequest const &);
233 // the bool return is used to see if we opened a dialog so that we can
234 // check this from an outer inset and open the dialog of the outer inset
235 // if that one has one!
237 bool lfunMouseRelease(FuncRequest const &);
239 void lfunMouseMotion(FuncRequest const &);
241 void calculate_dimensions_of_cells(MetricsInfo & mi) const;
243 void drawCellLines(Painter &, int x, int baseline,
244 int row, int cell) const;
246 void drawCellSelection(Painter &, int x, int baseline,
247 int row, int column, int cell) const;
249 void fitInsetCursor(BufferView *) const;
251 void setPos(BufferView *, int x, int y) const;
253 RESULT moveRight(BufferView *, bool lock = true);
255 RESULT moveLeft(BufferView *, bool lock = true);
257 RESULT moveUp(BufferView *, bool lock = true);
259 RESULT moveDown(BufferView *, bool lock = true);
261 bool moveNextCell(BufferView *, bool lock = false);
263 bool movePrevCell(BufferView *, bool lock = false);
265 int getCellXPos(int cell) const;
267 void resetPos(BufferView *) const;
269 void removeTabularRow();
271 void clearSelection() const {
272 sel_cell_start = sel_cell_end = 0;
273 has_selection = false;
275 void setSelection(int start, int end) const {
276 sel_cell_start = start;
278 has_selection = true;
281 bool activateCellInset(BufferView *, int x = 0, int y = 0,
282 mouse_button::state button = mouse_button::none,
283 bool behind = false);
285 bool activateCellInsetAbs(BufferView *, int x = 0, int y = 0,
286 mouse_button::state button = mouse_button::none);
288 bool insetHit(BufferView * bv, int x, int y) const;
290 bool hasPasteBuffer() const;
292 bool copySelection(BufferView *);
294 bool pasteSelection(BufferView *);
296 bool cutSelection(BufferParams const & bp);
298 bool isRightToLeft(BufferView *);
300 void getSelection(int & scol, int & ecol,
301 int & srow, int & erow) const;
303 WordLangTuple selectNextWordInt(BufferView *, float & value) const;
305 bool insertAsciiString(BufferView *, string const & buf, bool usePaste);
308 // Private structures and variables
310 InsetText * the_locking_inset;
312 InsetText * old_locking_inset;
314 Buffer const * buffer_;
316 mutable LyXCursor cursor_;
318 mutable unsigned int inset_x;
320 mutable unsigned int inset_y;
321 /// true if a set of cells are selected
322 mutable bool has_selection;
323 /// the starting cell selection nr
324 mutable int sel_cell_start;
325 /// the ending cell selection nr
326 mutable int sel_cell_end;
336 mutable int first_visible_cell;
342 mutable UpdateCodes need_update;
344 mutable int in_reset_pos;
348 #include "mailinset.h"
351 class InsetTabularMailer : public MailInset {
354 InsetTabularMailer(InsetTabular const & inset);
356 virtual InsetBase & inset() const { return inset_; }
358 virtual string const & name() const { return name_; }
360 virtual string const inset2string() const;
361 /// Returns the active cell if successful, else -1.
362 static int string2params(string const &, InsetTabular &);
364 static string const params2string(InsetTabular const &);
367 static string const name_;
369 InsetTabular & inset_;
372 string const featureAsString(LyXTabular::Feature feature);