2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995-2001 The LyX Team.
9 *======================================================
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
48 #include <sigc++/signal_system.h>
49 #include <boost/smart_ptr.hpp>
58 #include "lyxcursor.h"
59 #include "func_status.h"
66 class InsetTabular : public UpdatableInset {
78 InsetTabular(Buffer const &, int rows = 1, int columns = 1);
80 InsetTabular(InsetTabular const &, Buffer const &);
84 Inset * clone(Buffer const &) const;
86 void read(Buffer const *, LyXLex &);
88 void write(Buffer const *, std::ostream &) const;
90 int ascent(BufferView *, LyXFont const &) const;
92 int descent(BufferView *, LyXFont const &) const;
94 int width(BufferView *, LyXFont const & f) const;
96 void draw(BufferView *, const LyXFont &, int , float &, bool) const;
98 void update(BufferView *, LyXFont const &, bool = false);
100 string const editMessage() const;
102 void edit(BufferView *, int x, int y, unsigned int);
104 bool doClearArea() const;
106 void insetUnlock(BufferView *);
108 void updateLocal(BufferView *, UpdateCodes, bool mark_dirty) const;
110 bool lockInsetInInset(BufferView *, UpdatableInset *);
112 bool unlockInsetInInset(BufferView *, UpdatableInset *,
115 bool updateInsetInInset(BufferView *, Inset *);
117 unsigned int insetInInsetY();
119 UpdatableInset * getLockingInset();
121 UpdatableInset * getFirstLockingInsetOfType(Inset::Code);
123 bool insertInset(BufferView *, Inset *);
125 bool isTextInset() const { return true; }
127 bool display() const { return tabular->IsLongTabular(); }
129 void insetButtonRelease(BufferView *, int, int, int);
131 void insetButtonPress(BufferView *, int, int, int);
133 void insetMotionNotify(BufferView *, int, int, int);
135 void insetKeyPress(XKeyEvent *);
137 UpdatableInset::RESULT localDispatch(BufferView *, kb_action,
140 int latex(Buffer const *, std::ostream &, bool, bool) const;
142 int ascii(Buffer const *, std::ostream &, int linelen) const;
144 int linuxdoc(Buffer const *, std::ostream &) const;
146 int docBook(Buffer const *, std::ostream &) const;
148 void validate(LaTeXFeatures & features) const;
150 Inset::Code lyxCode() const { return Inset::TABULAR_CODE; }
152 void getCursorPos(BufferView *, int & x, int & y) const;
154 void toggleInsetCursor(BufferView *);
156 bool tabularFeatures(BufferView * bv, string const & what);
158 void tabularFeatures(BufferView * bv, LyXTabular::Feature feature,
159 string const & val = string());
161 int getActCell() const { return actcell; }
163 void setFont(BufferView *, LyXFont const &, bool toggleall = false,
164 bool selectall = false);
166 int getMaxWidth(BufferView *, UpdatableInset const *) const;
168 Buffer * bufferOwner() const { return const_cast<Buffer *>(buffer); }
170 LyXText * getLyXText(BufferView const *,
171 bool const recursive = false) const;
173 void deleteLyXText(BufferView *, bool recursive = true) const;
175 void resizeLyXText(BufferView *, bool force = false) const;
177 void openLayoutDialog(BufferView *) const;
179 bool showInsetDialog(BufferView *) const;
181 func_status::value_type getStatus(string const & argument) const;
183 std::vector<string> const getLabelList() const;
185 void nodraw(bool b) {
186 UpdatableInset::nodraw(b);
190 int scroll(bool recursive=true) const;
192 void scroll(BufferView *bv, float sx) const {
193 UpdatableInset::scroll(bv, sx);
196 void scroll(BufferView *bv, int offset) const {
197 UpdatableInset::scroll(bv, offset);
201 // Public structures and variables
203 boost::scoped_ptr<LyXTabular> tabular;
205 SigC::Signal0<void> hideDialog;
209 bool calculate_dimensions_of_cells(BufferView *, LyXFont const &,
212 void drawCellLines(Painter &, int x, int baseline,
213 int row, int cell) const;
215 void drawCellSelection(Painter &, int x, int baseline,
216 int row, int column, int cell) const;
218 void showInsetCursor(BufferView *, bool show=true);
220 void hideInsetCursor(BufferView *);
222 void setPos(BufferView *, int x, int y) const;
224 UpdatableInset::RESULT moveRight(BufferView *, bool lock = true);
226 UpdatableInset::RESULT moveLeft(BufferView *, bool lock = true);
228 UpdatableInset::RESULT moveUp(BufferView *, bool lock = true);
230 UpdatableInset::RESULT moveDown(BufferView *, bool lock = true);
232 bool moveNextCell(BufferView *, bool lock = false);
234 bool movePrevCell(BufferView *, bool lock = false);
238 int getCellXPos(int cell) const;
240 void resetPos(BufferView *) const;
242 void removeTabularRow();
244 bool hasSelection() const {
245 return sel_cell_start != sel_cell_end;
248 void clearSelection() const {
249 sel_cell_start = sel_cell_end = 0;
252 bool activateCellInset(BufferView *, int x = 0, int y = 0,
254 bool behind = false);
256 bool activateCellInsetAbs(BufferView *, int x = 0, int y = 0,
259 bool insetHit(BufferView * bv, int x, int y) const;
261 int getMaxWidthOfCell(BufferView * bv, int cell) const;
263 bool hasPasteBuffer() const;
265 bool copySelection(BufferView *);
267 bool pasteSelection(BufferView *);
271 bool isRightToLeft(BufferView *);
273 void getSelection(int & scol, int & ecol, int & srow, int & erow) const;
276 // Private structures and variables
278 InsetText * the_locking_inset;
280 InsetText * old_locking_inset;
282 Buffer const * buffer;
284 mutable LyXCursor cursor;
286 mutable unsigned int inset_x;
288 mutable unsigned int inset_y;
290 mutable int sel_cell_start;
292 mutable int sel_cell_end;
302 mutable int first_visible_cell;
308 mutable UpdateCodes need_update;