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"
54 #include <boost/scoped_ptr.hpp>
55 #include <boost/weak_ptr.hpp>
64 class InsetTabular : public UpdatableInset {
76 InsetTabular(Buffer const &, int rows = 1, int columns = 1);
78 InsetTabular(InsetTabular const &, Buffer const &, bool same_id = false);
82 Inset * clone(Buffer const &, bool same_id = false) const;
84 void read(Buffer const *, LyXLex &);
86 void write(Buffer const *, std::ostream &) const;
88 int ascent(BufferView *, LyXFont const &) const;
90 int descent(BufferView *, LyXFont const &) const;
92 int width(BufferView *, LyXFont const & f) const;
94 void draw(BufferView *, const LyXFont &, int , float &) const;
96 void update(BufferView *, bool = false);
98 string const editMessage() const;
100 void insetUnlock(BufferView *);
102 void updateLocal(BufferView *, UpdateCodes) const;
104 bool lockInsetInInset(BufferView *, UpdatableInset *);
106 bool unlockInsetInInset(BufferView *, UpdatableInset *,
109 bool updateInsetInInset(BufferView *, Inset *);
111 int insetInInsetY() const;
113 UpdatableInset * getLockingInset() const;
115 UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
117 bool insertInset(BufferView *, Inset *);
119 bool insetAllowed(Inset::Code code) const;
121 bool isTextInset() const { return true; }
122 /** returns true if, when outputing LaTeX, font changes should
123 be closed before generating this inset. This is needed for
124 insets that may contain several paragraphs */
125 bool noFontChange() const { return true; }
127 bool display() const { return tabular->IsLongTabular(); }
129 RESULT localDispatch(FuncRequest const &);
131 int latex(Buffer const *, std::ostream &, bool, bool) const;
133 int ascii(Buffer const *, std::ostream &, int linelen) const;
135 int linuxdoc(Buffer const *, std::ostream &) const;
137 int docbook(Buffer const *, std::ostream &, bool mixcont) const;
139 void validate(LaTeXFeatures & features) const;
141 Inset::Code lyxCode() const { return Inset::TABULAR_CODE; }
143 void getCursorPos(BufferView *, int & x, int & y) const;
144 /// Get the absolute document x,y of the cursor
145 virtual void getCursor(BufferView &, int &, int &) const;
147 bool tabularFeatures(BufferView * bv, string const & what);
149 void tabularFeatures(BufferView * bv, LyXTabular::Feature feature,
150 string const & val = string());
152 int getActCell() const { return actcell; }
154 void setFont(BufferView *, LyXFont const &, bool toggleall = false,
155 bool selectall = false);
157 int getMaxWidth(BufferView *, UpdatableInset const *) const;
159 Buffer * bufferOwner() const { return const_cast<Buffer *>(buffer); }
161 LyXText * getLyXText(BufferView const *,
162 bool const recursive = false) const;
164 void deleteLyXText(BufferView *, bool recursive = true) const;
166 void resizeLyXText(BufferView *, bool force = false) const;
168 void openLayoutDialog(BufferView *) const;
170 bool showInsetDialog(BufferView *) const;
172 FuncStatus getStatus(string const & argument) const;
174 std::vector<string> const getLabelList() const;
176 void nodraw(bool b) const {
177 UpdatableInset::nodraw(b);
181 int scroll(bool recursive=true) const;
183 void scroll(BufferView *bv, float sx) const {
184 UpdatableInset::scroll(bv, sx);
187 void scroll(BufferView *bv, int offset) const {
188 UpdatableInset::scroll(bv, offset);
191 Inset * getInsetFromID(int id) const;
193 ParagraphList * getParagraphs(int) const;
195 LyXCursor const & cursor(BufferView *) const;
197 bool allowSpellcheck() const { return true; }
200 selectNextWordToSpellcheck(BufferView *, float & value) const;
202 void selectSelectedWord(BufferView *);
204 void toggleSelection(BufferView *, bool kill_selection);
209 bool nextChange(BufferView *, lyx::pos_type & length);
211 bool searchForward(BufferView *, string const &,
212 bool = true, bool = false);
213 bool searchBackward(BufferView *, string const &,
214 bool = true, bool = false);
216 // this should return true if we have a "normal" cell, otherwise true.
217 // "normal" means without width set!
218 bool forceDefaultParagraphs(Inset const * in) const;
221 void addPreview(grfx::PreviewLoader &) const;
224 // Public structures and variables
226 boost::scoped_ptr<LyXTabular> tabular;
228 /// are some cells selected ?
229 bool hasSelection() const {
230 return has_selection;
234 virtual BufferView * view() const;
237 void lfunMousePress(FuncRequest const &);
239 // the bool return is used to see if we opened a dialog so that we can
240 // check this from an outer inset and open the dialog of the outer inset
241 // if that one has one!
243 bool lfunMouseRelease(FuncRequest const &);
245 void lfunMouseMotion(FuncRequest const &);
247 bool calculate_dimensions_of_cells(BufferView *, bool = false) const;
249 void drawCellLines(Painter &, int x, int baseline,
250 int row, int cell) const;
252 void drawCellSelection(Painter &, int x, int baseline,
253 int row, int column, int cell) const;
255 void fitInsetCursor(BufferView *) const;
257 void setPos(BufferView *, int x, int y) const;
259 RESULT moveRight(BufferView *, bool lock = true);
261 RESULT moveLeft(BufferView *, bool lock = true);
263 RESULT moveUp(BufferView *, bool lock = true);
265 RESULT moveDown(BufferView *, bool lock = true);
267 bool moveNextCell(BufferView *, bool lock = false);
269 bool movePrevCell(BufferView *, bool lock = false);
271 int getCellXPos(int cell) const;
273 void resetPos(BufferView *) const;
275 void removeTabularRow();
277 void clearSelection() const {
278 sel_cell_start = sel_cell_end = 0;
279 has_selection = false;
281 void setSelection(int start, int end) const {
282 sel_cell_start = start;
284 has_selection = true;
287 bool activateCellInset(BufferView *, int x = 0, int y = 0,
288 mouse_button::state button = mouse_button::none,
289 bool behind = false);
291 bool activateCellInsetAbs(BufferView *, int x = 0, int y = 0,
292 mouse_button::state button = mouse_button::none);
294 bool insetHit(BufferView * bv, int x, int y) const;
296 int getMaxWidthOfCell(BufferView * bv, int cell) const;
298 bool hasPasteBuffer() const;
300 bool copySelection(BufferView *);
302 bool pasteSelection(BufferView *);
304 bool cutSelection(BufferParams const & bp);
306 bool isRightToLeft(BufferView *);
308 void getSelection(int & scol, int & ecol,
309 int & srow, int & erow) const;
311 WordLangTuple selectNextWordInt(BufferView *, float & value) const;
313 bool insertAsciiString(BufferView *, string const & buf, bool usePaste);
316 // Private structures and variables
318 InsetText * the_locking_inset;
320 InsetText * old_locking_inset;
322 Buffer const * buffer;
324 mutable LyXCursor cursor_;
326 mutable unsigned int inset_x;
328 mutable unsigned int inset_y;
329 /// true if a set of cells are selected
330 mutable bool has_selection;
331 /// the starting cell selection nr
332 mutable int sel_cell_start;
333 /// the ending cell selection nr
334 mutable int sel_cell_end;
344 mutable int first_visible_cell;
350 mutable UpdateCodes need_update;
354 mutable int in_reset_pos;
358 #include "mailinset.h"
361 class InsetTabularMailer : public MailInset {
364 InsetTabularMailer(InsetTabular & inset);
366 virtual InsetBase & inset() const { return inset_; }
368 virtual string const & name() const { return name_; }
370 virtual string const inset2string() const;
371 /// Returns the active cell if successful, else -1.
372 static int string2params(string const &, InsetTabular &);
374 static string const params2string(InsetTabular const &);
377 static string const name_;
379 InsetTabular & inset_;
382 string const featureAsString(LyXTabular::Feature feature);