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
50 #include "frontends/mouse_state.h"
60 class InsetTabular : public UpdatableInset {
63 InsetTabular(Buffer const &, int rows = 1, int columns = 1);
65 InsetTabular(InsetTabular const &);
69 virtual std::auto_ptr<InsetBase> clone() const;
71 void read(Buffer const &, LyXLex &);
73 void write(Buffer const &, std::ostream &) const;
75 void metrics(MetricsInfo &, Dimension &) const;
77 void draw(PainterInfo & pi, int x, int y) const;
79 std::string const editMessage() const;
81 void insetUnlock(BufferView *);
83 void updateLocal(BufferView *) const;
85 bool lockInsetInInset(BufferView *, UpdatableInset *);
87 bool unlockInsetInInset(BufferView *, UpdatableInset *,
90 int insetInInsetY() const;
92 UpdatableInset * getLockingInset() const;
94 UpdatableInset * getFirstLockingInsetOfType(InsetOld::Code);
96 bool insertInset(BufferView *, InsetOld *);
98 bool insetAllowed(InsetOld::Code code) const;
100 bool isTextInset() const { return true; }
101 /** returns true if, when outputing LaTeX, font changes should
102 be closed before generating this inset. This is needed for
103 insets that may contain several paragraphs */
104 bool noFontChange() const { return true; }
106 bool display() const { return tabular.isLongTabular(); }
108 dispatch_result localDispatch(FuncRequest const &);
110 int latex(Buffer const &, std::ostream &,
111 LatexRunParams const &) const;
113 int ascii(Buffer const &, std::ostream &, int linelen) const;
115 int linuxdoc(Buffer const &, std::ostream &) const;
117 int docbook(Buffer const &, std::ostream &, bool mixcont) const;
119 void validate(LaTeXFeatures & features) const;
121 InsetOld::Code lyxCode() const { return InsetOld::TABULAR_CODE; }
123 void getCursorPos(BufferView *, int & x, int & y) const;
124 /// Get the absolute document x,y of the cursor
125 virtual void getCursor(BufferView &, int &, int &) const;
127 bool tabularFeatures(BufferView * bv, std::string const & what);
129 void tabularFeatures(BufferView * bv, LyXTabular::Feature feature,
130 std::string const & val = std::string());
132 int getActCell() const { return actcell; }
134 void setFont(BufferView *, LyXFont const &, bool toggleall = false,
135 bool selectall = false);
137 LyXText * getLyXText(BufferView const *,
138 bool const recursive = false) const;
140 void deleteLyXText(BufferView *, bool recursive = true) const;
142 void openLayoutDialog(BufferView *) const;
144 bool showInsetDialog(BufferView *) const;
146 FuncStatus getStatus(std::string const & argument) const;
147 /// Appends \c list with all labels found within this inset.
148 void getLabelList(Buffer const &, std::vector<std::string> & list) const;
150 int scroll(bool recursive=true) const;
152 void scroll(BufferView *bv, float sx) const {
153 UpdatableInset::scroll(bv, sx);
156 void scroll(BufferView *bv, int offset) const {
157 UpdatableInset::scroll(bv, offset);
160 InsetOld * getInsetFromID(int id) const;
162 ParagraphList * getParagraphs(int) const;
164 LyXCursor const & cursor(BufferView *) const;
166 bool allowSpellcheck() const { return true; }
169 selectNextWordToSpellcheck(BufferView *, float & value) const;
171 void selectSelectedWord(BufferView *);
176 bool nextChange(BufferView *, lyx::pos_type & length);
178 bool searchForward(BufferView *, std::string const &,
179 bool = true, bool = false);
180 bool searchBackward(BufferView *, std::string const &,
181 bool = true, bool = false);
183 // this should return true if we have a "normal" cell, otherwise true.
184 // "normal" means without width set!
185 bool forceDefaultParagraphs(InsetOld const * in) const;
188 void addPreview(lyx::graphics::PreviewLoader &) const;
191 // Public structures and variables
193 mutable LyXTabular tabular;
195 /// are some cells selected ?
196 bool hasSelection() const {
197 return has_selection;
201 virtual BufferView * view() const;
203 Buffer const & buffer() const;
205 /// set the owning buffer
206 void buffer(Buffer * b);
210 void lfunMousePress(FuncRequest const &);
212 // the bool return is used to see if we opened a dialog so that we can
213 // check this from an outer inset and open the dialog of the outer inset
214 // if that one has one!
216 bool lfunMouseRelease(FuncRequest const &);
218 void lfunMouseMotion(FuncRequest const &);
220 void calculate_dimensions_of_cells(MetricsInfo & mi) const;
222 void drawCellLines(Painter &, int x, int baseline,
223 int row, int cell) const;
225 void drawCellSelection(Painter &, int x, int baseline,
226 int row, int column, int cell) const;
228 void fitInsetCursor(BufferView *) const;
230 void setPos(BufferView *, int x, int y) const;
232 dispatch_result moveRight(BufferView *, bool lock = true);
234 dispatch_result moveLeft(BufferView *, bool lock = true);
236 dispatch_result moveUp(BufferView *, bool lock = true);
238 dispatch_result moveDown(BufferView *, bool lock = true);
240 bool moveNextCell(BufferView *, bool lock = false);
242 bool movePrevCell(BufferView *, bool lock = false);
244 int getCellXPos(int cell) const;
246 void resetPos(BufferView *) const;
248 void removeTabularRow();
250 void clearSelection() const {
251 sel_cell_start = sel_cell_end = 0;
252 has_selection = false;
254 void setSelection(int start, int end) const {
255 sel_cell_start = start;
257 has_selection = true;
260 bool activateCellInset(BufferView *, int x = 0, int y = 0,
261 mouse_button::state button = mouse_button::none,
262 bool behind = false);
264 bool activateCellInsetAbs(BufferView *, int x = 0, int y = 0,
265 mouse_button::state button = mouse_button::none);
267 bool insetHit(BufferView * bv, int x, int y) const;
269 bool hasPasteBuffer() const;
271 bool copySelection(BufferView *);
273 bool pasteSelection(BufferView *);
275 bool cutSelection(BufferParams const & bp);
277 bool isRightToLeft(BufferView *);
279 void getSelection(int & scol, int & ecol,
280 int & srow, int & erow) const;
282 WordLangTuple selectNextWordInt(BufferView *, float & value) const;
284 bool insertAsciiString(BufferView *, std::string const & buf, bool usePaste);
287 // Private structures and variables
289 InsetText * the_locking_inset;
291 InsetText * old_locking_inset;
293 Buffer const * buffer_;
295 mutable int cursorx_;
297 mutable int cursory_;
299 mutable unsigned int inset_x;
301 mutable unsigned int inset_y;
302 /// true if a set of cells are selected
303 mutable bool has_selection;
304 /// the starting cell selection nr
305 mutable int sel_cell_start;
306 /// the ending cell selection nr
307 mutable int sel_cell_end;
317 mutable int first_visible_cell;
323 mutable int in_reset_pos;
327 #include "mailinset.h"
330 class InsetTabularMailer : public MailInset {
333 InsetTabularMailer(InsetTabular const & inset);
335 virtual InsetBase & inset() const { return inset_; }
337 virtual std::string const & name() const { return name_; }
339 virtual std::string const inset2string(Buffer const &) const;
340 /// Returns the active cell if successful, else -1.
341 static int string2params(std::string const &, InsetTabular &);
343 static std::string const params2string(InsetTabular const &);
346 static std::string const name_;
348 InsetTabular & inset_;
351 std::string const featureAsString(LyXTabular::Feature feature);