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
53 class InsetTabular : public InsetOld {
56 InsetTabular(Buffer const &, row_type rows = 1,
57 col_type columns = 1);
61 void read(Buffer const &, LyXLex &);
63 void write(Buffer const &, std::ostream &) const;
65 void metrics(MetricsInfo &, Dimension &) const;
67 void draw(PainterInfo & pi, int x, int y) const;
69 void drawSelection(PainterInfo & pi, int x, int y) const;
71 std::string const editMessage() const;
73 EDITABLE editable() const { return HIGHLY_EDITABLE; }
75 bool insetAllowed(InsetBase::Code) const { return true; }
77 bool allowSpellCheck() const { return true; }
79 bool canTrackChanges() const { return true; }
80 /** returns true if, when outputing LaTeX, font changes should
81 be closed before generating this inset. This is needed for
82 insets that may contain several paragraphs */
83 bool noFontChange() const { return true; }
85 bool display() const { return tabular.isLongTabular(); }
87 int latex(Buffer const &, std::ostream &,
88 OutputParams const &) const;
90 int plaintext(Buffer const &, std::ostream &,
91 OutputParams const &) const;
93 int linuxdoc(Buffer const &, std::ostream &,
94 OutputParams const &) const;
96 int docbook(Buffer const &, std::ostream &,
97 OutputParams const &) const;
99 void validate(LaTeXFeatures & features) const;
101 Code lyxCode() const { return InsetBase::TABULAR_CODE; }
102 /// get offset of this cursor slice relative to our upper left corner
103 void cursorPos(CursorSlice const & sl, bool boundary, int & x, int & y) const;
105 bool tabularFeatures(LCursor & cur, std::string const & what);
107 void tabularFeatures(LCursor & cur, LyXTabular::Feature feature,
108 std::string const & val = std::string());
110 void openLayoutDialog(BufferView *) const;
112 bool showInsetDialog(BufferView *) const;
114 size_t nargs() const { return tabular.getNumberOfCells(); }
116 boost::shared_ptr<InsetText const> cell(idx_type) const;
118 boost::shared_ptr<InsetText> cell(idx_type);
120 LyXText * getText(int) const;
123 void markErased(bool);
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(lyx::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(lyx::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 &, std::string 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(idx_type cell, int x, int y) const;
199 /// return the cell nearest to x, y
200 idx_type getNearestCell(int x, int y) const;
203 Buffer const * buffer_;
205 mutable idx_type first_visible_cell;
211 #include "mailinset.h"
214 class InsetTabularMailer : public MailInset {
217 InsetTabularMailer(InsetTabular const & inset);
219 virtual InsetBase & inset() const { return inset_; }
221 virtual std::string const & name() const { return name_; }
223 virtual std::string const inset2string(Buffer const &) const;
225 static void string2params(std::string const &, InsetTabular &);
227 static std::string const params2string(InsetTabular const &);
230 static std::string const name_;
232 InsetTabular & inset_;
235 std::string const featureAsString(LyXTabular::Feature feature);