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 int latex(Buffer const &, std::ostream &,
109 LatexRunParams const &) const;
111 int ascii(Buffer const &, std::ostream &,
112 LatexRunParams const &) const;
114 int linuxdoc(Buffer const &, std::ostream &,
115 LatexRunParams const &) const;
117 int docbook(Buffer const &, std::ostream &,
118 LatexRunParams const &) const;
120 void validate(LaTeXFeatures & features) const;
122 InsetOld::Code lyxCode() const { return InsetOld::TABULAR_CODE; }
124 void getCursorPos(BufferView *, int & x, int & y) const;
125 /// Get the absolute document x,y of the cursor
126 virtual void getCursor(BufferView &, int &, int &) const;
128 bool tabularFeatures(BufferView * bv, std::string const & what);
130 void tabularFeatures(BufferView * bv, LyXTabular::Feature feature,
131 std::string const & val = std::string());
133 int getActCell() const { return actcell; }
135 void setFont(BufferView *, LyXFont const &, bool toggleall = false,
136 bool selectall = false);
138 LyXText * getLyXText(BufferView const *,
139 bool const recursive = false) const;
141 void deleteLyXText(BufferView *, bool recursive = true) const;
143 void openLayoutDialog(BufferView *) const;
145 bool showInsetDialog(BufferView *) const;
147 FuncStatus getStatus(std::string const & argument) const;
148 /// Appends \c list with all labels found within this inset.
149 void getLabelList(Buffer const &, std::vector<std::string> & list) const;
151 int scroll(bool recursive=true) const;
153 void scroll(BufferView *bv, float sx) const {
154 UpdatableInset::scroll(bv, sx);
157 void scroll(BufferView *bv, int offset) const {
158 UpdatableInset::scroll(bv, offset);
161 InsetOld * getInsetFromID(int id) const;
163 ParagraphList * getParagraphs(int) const;
165 LyXText * getText(int) const;
167 LyXCursor const & cursor(BufferView *) const;
169 bool allowSpellcheck() const { return true; }
172 selectNextWordToSpellcheck(BufferView *, float & value) const;
174 void selectSelectedWord(BufferView *);
179 bool nextChange(BufferView *, lyx::pos_type & length);
181 bool searchForward(BufferView *, std::string const &,
182 bool = true, bool = false);
183 bool searchBackward(BufferView *, std::string const &,
184 bool = true, bool = false);
186 // this should return true if we have a "normal" cell, otherwise true.
187 // "normal" means without width set!
188 bool forceDefaultParagraphs(InsetOld const * in) const;
191 void addPreview(lyx::graphics::PreviewLoader &) const;
194 // Public structures and variables
196 mutable LyXTabular tabular;
198 /// are some cells selected ?
199 bool hasSelection() const {
200 return has_selection;
204 virtual BufferView * view() const;
206 Buffer const & buffer() const;
208 /// set the owning buffer
209 void buffer(Buffer * buf);
214 priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
216 /// lock cell with given index
217 void edit(BufferView * bv, int index);
219 void lfunMousePress(FuncRequest const &);
221 // the bool return is used to see if we opened a dialog so that we can
222 // check this from an outer inset and open the dialog of the outer inset
223 // if that one has one!
225 bool lfunMouseRelease(FuncRequest const &);
227 void lfunMouseMotion(FuncRequest const &);
229 void calculate_dimensions_of_cells(MetricsInfo & mi) const;
231 void drawCellLines(Painter &, int x, int baseline,
232 int row, int cell) const;
234 void drawCellSelection(Painter &, int x, int baseline,
235 int row, int column, int cell) const;
237 void fitInsetCursor(BufferView *) const;
239 void setPos(BufferView *, int x, int y) const;
241 DispatchResult moveRight(BufferView *, bool lock = true);
243 DispatchResult moveLeft(BufferView *, bool lock = true);
245 DispatchResult moveUp(BufferView *, bool lock = true);
247 DispatchResult moveDown(BufferView *, bool lock = true);
249 bool moveNextCell(BufferView *, bool lock = false);
251 bool movePrevCell(BufferView *, bool lock = false);
253 int getCellXPos(int cell) const;
255 void resetPos(BufferView *) const;
257 void removeTabularRow();
259 void clearSelection() const {
260 sel_cell_start = sel_cell_end = 0;
261 has_selection = false;
263 void setSelection(int start, int end) const {
264 sel_cell_start = start;
266 has_selection = true;
269 bool activateCellInset(BufferView *, int x = 0, int y = 0,
270 mouse_button::state button = mouse_button::none,
271 bool behind = false);
273 bool insetHit(BufferView * bv, int x, int y) const;
275 bool hasPasteBuffer() const;
277 bool copySelection(BufferView *);
279 bool pasteSelection(BufferView *);
281 bool cutSelection(BufferParams const & bp);
283 bool isRightToLeft(BufferView *);
285 void getSelection(int & scol, int & ecol,
286 int & srow, int & erow) const;
288 WordLangTuple selectNextWordInt(BufferView *, float & value) const;
290 bool insertAsciiString(BufferView *, std::string const & buf, bool usePaste);
293 // Private structures and variables
295 InsetText * the_locking_inset;
297 InsetText * old_locking_inset;
299 Buffer const * buffer_;
301 mutable int cursorx_;
303 mutable int cursory_;
305 mutable unsigned int inset_x;
307 mutable unsigned int inset_y;
308 /// true if a set of cells are selected
309 mutable bool has_selection;
310 /// the starting cell selection nr
311 mutable int sel_cell_start;
312 /// the ending cell selection nr
313 mutable int sel_cell_end;
323 mutable int first_visible_cell;
329 mutable int in_reset_pos;
333 #include "mailinset.h"
336 class InsetTabularMailer : public MailInset {
339 InsetTabularMailer(InsetTabular const & inset);
341 virtual InsetBase & inset() const { return inset_; }
343 virtual std::string const & name() const { return name_; }
345 virtual std::string const inset2string(Buffer const &) const;
346 /// Returns the active cell if successful, else -1.
347 static int string2params(std::string const &, InsetTabular &);
349 static std::string const params2string(InsetTabular const &);
352 static std::string const name_;
354 InsetTabular & inset_;
357 std::string const featureAsString(LyXTabular::Feature feature);