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.
13 // This is Juergen's rewrite of the tabular (table) support.
15 // Things to think of when designing the new tabular support:
16 // - color support (colortbl, color)
17 // - decimal alignment (dcloumn)
18 // - custom lines (hhline)
24 // This is what I have written about tabular support in the LyX3-Tasks file:
26 // o rewrite of table code. Should probably be written as some
27 // kind of an inset. [Done]
28 // o enhance longtable support
32 #ifndef INSETTABULAR_H
33 #define INSETTABULAR_H
37 #include "mailinset.h"
49 namespace frontend { class Painter; }
51 class InsetTabular : public InsetOld {
54 InsetTabular(Buffer const &, row_type rows = 1,
55 col_type columns = 1);
59 void read(Buffer const &, LyXLex &);
61 void write(Buffer const &, std::ostream &) const;
63 bool metrics(MetricsInfo &, Dimension &) const;
65 void draw(PainterInfo & pi, int x, int y) const;
67 void drawSelection(PainterInfo & pi, int x, int y) const;
69 virtual docstring const editMessage() const;
71 EDITABLE editable() const { return HIGHLY_EDITABLE; }
73 bool insetAllowed(InsetBase::Code) const { return true; }
75 bool allowSpellCheck() const { return true; }
77 bool canTrackChanges() const { return true; }
78 /** returns true if, when outputing LaTeX, font changes should
79 be closed before generating this inset. This is needed for
80 insets that may contain several paragraphs */
81 bool noFontChange() const { return true; }
83 bool display() const { return tabular.isLongTabular(); }
85 int latex(Buffer const &, odocstream &,
86 OutputParams const &) const;
88 int plaintext(Buffer const &, odocstream &,
89 OutputParams const &) const;
91 int docbook(Buffer const &, odocstream &,
92 OutputParams const &) const;
94 void validate(LaTeXFeatures & features) const;
96 Code lyxCode() const { return InsetBase::TABULAR_CODE; }
97 /// get offset of this cursor slice relative to our upper left corner
98 void cursorPos(BufferView const & bv, CursorSlice const & sl,
99 bool boundary, int & x, int & y) const;
101 bool tabularFeatures(LCursor & cur, std::string const & what);
103 void tabularFeatures(LCursor & cur, LyXTabular::Feature feature,
104 std::string const & val = std::string());
106 void openLayoutDialog(BufferView *) const;
108 bool showInsetDialog(BufferView *) const;
110 size_t nargs() const { return tabular.getNumberOfCells(); }
112 boost::shared_ptr<InsetText const> cell(idx_type) const;
114 boost::shared_ptr<InsetText> cell(idx_type);
116 LyXText * getText(int) const;
118 /// set the change for the entire inset
119 void setChange(Change const & change);
120 /// accept the changes within the inset
121 void acceptChanges();
122 /// reject the changes within the inset
123 void rejectChanges();
125 // this should return true if we have a "normal" cell, otherwise false.
126 // "normal" means without width set!
127 /// should all paragraphs be output with "Standard" layout?
128 bool forceDefaultParagraphs(idx_type cell = 0) const;
131 void addPreview(graphics::PreviewLoader &) const;
134 Buffer const & buffer() const;
136 /// set the owning buffer
137 void buffer(Buffer const * buf);
138 /// lock cell with given index
139 void edit(LCursor & cur, bool left);
141 InsetBase * editXY(LCursor & cur, int x, int y);
142 /// can we go further down on mouse click?
143 bool descendable() const { return true; }
146 // Public structures and variables
148 mutable LyXTabular tabular;
152 InsetTabular(InsetTabular const &);
154 virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
156 bool getStatus(LCursor & cur, FuncRequest const & cmd, FuncStatus &) const;
158 int scroll() const { return scx_; }
161 virtual std::auto_ptr<InsetBase> doClone() const;
164 void drawCellLines(frontend::Painter &, int x, int y, row_type row,
165 idx_type cell, bool erased) const;
167 void setCursorFromCoordinates(LCursor & cur, int x, int y) const;
170 void moveNextCell(LCursor & cur);
172 void movePrevCell(LCursor & cur);
174 int getCellXPos(idx_type cell) const;
176 void resetPos(LCursor & cur) const;
178 void removeTabularRow();
180 bool hasPasteBuffer() const;
182 bool copySelection(LCursor & cur);
184 bool pasteSelection(LCursor & cur);
186 void cutSelection(LCursor & cur);
188 bool isRightToLeft(LCursor & cur) const;
190 void getSelection(LCursor & cur, row_type & rs, row_type & re,
191 col_type & cs, col_type & ce) const;
193 bool insertAsciiString(BufferView &, docstring const & buf, bool usePaste);
194 /// are we operating on several cells?
195 bool tablemode(LCursor & cur) const;
197 /// return the "Manhattan distance" to nearest corner
198 int dist(BufferView &, idx_type cell, int x, int y) const;
199 /// return the cell nearest to x, y
200 idx_type getNearestCell(BufferView &, int x, int y) const;
203 Buffer const * buffer_;
205 mutable idx_type first_visible_cell;
211 class InsetTabularMailer : public MailInset {
214 InsetTabularMailer(InsetTabular const & inset);
216 virtual InsetBase & inset() const { return inset_; }
218 virtual std::string const & name() const { return name_; }
220 virtual std::string const inset2string(Buffer const &) const;
222 static void string2params(std::string const &, InsetTabular &);
224 static std::string const params2string(InsetTabular const &);
227 static std::string const name_;
229 InsetTabular & inset_;
232 std::string const featureAsString(LyXTabular::Feature feature);