2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 2000-2001 The LyX Team.
9 * @author: Jürgen Vigna
11 * ====================================================== */
17 #include "lyxlength.h"
19 #include "insets/insettext.h"
31 /* The features the text class offers for tables */
105 UNSET_ROTATE_TABULAR,
138 CELL_BEGIN_OF_MULTICOLUMN,
140 CELL_PART_OF_MULTICOLUMN
148 LYX_VALIGN_BOTTOM = 1,
150 LYX_VALIGN_CENTER = 2
165 // we have this header type (is set in the GetLT... functions)
167 // double borders on top
169 // double borders on bottom
171 // used for FirstHeader & LastFooter and if this is true
172 // all the rows marked as FirstHeader or LastFooter are
173 // ignored in the output and it is set to be empty!
179 LyXTabular(BufferParams const &,
180 InsetTabular *, int columns_arg, int rows_arg);
182 LyXTabular(BufferParams const &,
183 InsetTabular *, LyXTabular const &, bool same_id = false);
186 LyXTabular(Buffer const *, InsetTabular *, LyXLex & lex);
188 LyXTabular & operator=(LyXTabular const &);
190 LyXTabular * clone(BufferParams const &,
191 InsetTabular *, bool same_id = false);
193 /// Returns true if there is a topline, returns false if not
194 bool TopLine(int cell, bool onlycolumn = false) const;
195 /// Returns true if there is a topline, returns false if not
196 bool BottomLine(int cell, bool onlycolumn = false) const;
197 /// Returns true if there is a topline, returns false if not
198 bool LeftLine(int cell, bool onlycolumn = false) const;
199 /// Returns true if there is a topline, returns false if not
200 bool RightLine(int cell, bool onlycolumn = false) const;
203 bool topAlreadyDrawn(int cell) const;
205 bool leftAlreadyDrawn(int cell) const;
207 bool IsLastRow(int cell) const;
210 int GetAdditionalHeight(int row) const;
212 int GetAdditionalWidth(int cell) const;
214 /* returns the maximum over all rows */
216 int GetWidthOfColumn(int cell) const;
218 int GetWidthOfTabular() const;
220 int GetAscentOfRow(int row) const;
222 int GetDescentOfRow(int row) const;
224 int GetHeightOfTabular() const;
225 /// Returns true if a complete update is necessary, otherwise false
226 bool SetAscentOfRow(int row, int height);
227 /// Returns true if a complete update is necessary, otherwise false
228 bool SetDescentOfRow(int row, int height);
229 /// Returns true if a complete update is necessary, otherwise false
230 bool SetWidthOfCell(int cell, int new_width);
231 /// Returns true if a complete update is necessary, otherwise false
232 bool SetAllLines(int cell, bool line);
233 /// Returns true if a complete update is necessary, otherwise false
234 bool SetTopLine(int cell, bool line, bool onlycolumn = false);
235 /// Returns true if a complete update is necessary, otherwise false
236 bool SetBottomLine(int cell, bool line, bool onlycolumn = false);
237 /// Returns true if a complete update is necessary, otherwise false
238 bool SetLeftLine(int cell, bool line, bool onlycolumn = false);
239 /// Returns true if a complete update is necessary, otherwise false
240 bool SetRightLine(int cell, bool line, bool onlycolumn = false);
241 /// Returns true if a complete update is necessary, otherwise false
242 bool SetAlignment(int cell, LyXAlignment align,
243 bool onlycolumn = false);
244 /// Returns true if a complete update is necessary, otherwise false
245 bool SetVAlignment(int cell, VAlignment align,
246 bool onlycolumn = false);
248 bool SetColumnPWidth(int cell, LyXLength const & width);
250 bool SetMColumnPWidth(int cell, LyXLength const & width);
252 bool SetAlignSpecial(int cell, string const & special, Feature what);
254 LyXAlignment GetAlignment(int cell, bool onlycolumn = false) const;
256 VAlignment GetVAlignment(int cell, bool onlycolumn = false) const;
258 LyXLength const GetPWidth(int cell) const;
260 LyXLength const GetColumnPWidth(int cell) const;
262 LyXLength const GetMColumnPWidth(int cell) const;
264 string const GetAlignSpecial(int cell, int what) const;
266 int GetWidthOfCell(int cell) const;
268 int GetBeginningOfTextInCell(int cell) const;
270 void AppendRow(BufferParams const &, int cell);
272 void DeleteRow(int row);
274 void AppendColumn(BufferParams const &, int cell);
276 void DeleteColumn(int column);
278 bool IsFirstCellInRow(int cell) const;
280 int GetFirstCellInRow(int row) const;
282 bool IsLastCellInRow(int cell) const;
284 int GetLastCellInRow(int row) const;
286 int GetNumberOfCells() const;
288 int NumberOfCellsInRow(int cell) const;
290 void Write(Buffer const *, std::ostream &) const;
292 void Read(Buffer const *, LyXLex &);
294 int latex(Buffer const *, std::ostream &,
295 LatexRunParams const &) const;
297 int docbook(Buffer const * buf, std::ostream & os, bool mixcont) const;
299 int ascii(Buffer const *, std::ostream &, int const depth,
300 bool onlydata, unsigned char delim) const;
302 bool IsMultiColumn(int cell, bool real = false) const;
304 void SetMultiColumn(Buffer *, int cell, int number);
306 int UnsetMultiColumn(int cell); // returns number of new cells
308 bool IsPartOfMultiColumn(int row, int column) const;
310 int row_of_cell(int cell) const;
312 int column_of_cell(int cell) const;
314 int right_column_of_cell(int cell) const;
316 void SetLongTabular(bool);
318 bool IsLongTabular() const;
320 void SetRotateTabular(bool);
322 bool GetRotateTabular() const;
324 void SetRotateCell(int cell, bool);
326 bool GetRotateCell(int cell) const;
328 bool NeedRotating() const;
330 bool IsLastCell(int cell) const;
332 int GetCellAbove(int cell) const;
334 int GetCellBelow(int cell) const;
336 int GetLastCellAbove(int cell) const;
338 int GetLastCellBelow(int cell) const;
340 int GetCellNumber(int row, int column) const;
342 void SetUsebox(int cell, BoxType);
344 BoxType GetUsebox(int cell) const;
346 // Long Tabular Options support functions
348 bool checkLTType(int row, ltType const &) const;
350 void SetLTHead(int row, bool flag, ltType const &, bool first);
352 bool GetRowOfLTHead(int row, ltType &) const;
354 bool GetRowOfLTFirstHead(int row, ltType &) const;
356 void SetLTFoot(int row, bool flag, ltType const &, bool last);
358 bool GetRowOfLTFoot(int row, ltType &) const;
360 bool GetRowOfLTLastFoot(int row, ltType &) const;
362 void SetLTNewPage(int row, bool what);
364 bool GetLTNewPage(int row) const;
366 bool haveLTHead() const;
368 bool haveLTFirstHead() const;
370 bool haveLTFoot() const;
372 bool haveLTLastFoot() const;
374 // end longtable support
376 InsetText * GetCellInset(int cell) const;
378 InsetText * GetCellInset(int row, int column) const;
379 /// Search for \param inset in the tabular, with the
380 /// additional hint that it could be at \param maybe_cell
381 int GetCellFromInset(Inset const * inset, int maybe_cell = -1) const;
383 int rows() const { return rows_; }
385 int columns() const { return columns_;}
387 InsetTabular * owner() const { return owner_; }
389 void Validate(LaTeXFeatures &) const;
391 std::vector<string> const getLabelList() const;
393 /// recalculate the widths/heights only!
396 mutable int cur_cell;
401 cellstruct(BufferParams const &);
409 LyXAlignment alignment;
411 VAlignment valignment;
425 string align_special;
427 LyXLength p_width; // this is only set for multicolumn!!!
432 typedef std::vector<cellstruct> cell_vector;
434 typedef std::vector<cell_vector> cell_vvector;
448 /// This are for longtabulars only
451 /// a row of endfirsthead
455 /// row of endlastfoot
457 /// row for a pagebreak
461 typedef std::vector<rowstruct> row_vector;
464 struct columnstruct {
468 LyXAlignment alignment;
470 VAlignment valignment;
480 string align_special;
483 typedef std::vector<columnstruct> column_vector;
486 void read(Buffer const * buf, std::istream & is,
487 LyXLex & lex, string const & l, int const version);
496 std::vector<int> rowofcell;
498 std::vector<int> columnofcell;
502 column_vector column_info;
504 mutable cell_vvector cell_info;
506 int width_of_tabular;
512 bool is_long_tabular;
515 /// endfirsthead data
523 InsetTabular * owner_;
526 void Init(BufferParams const &,
527 int columns_arg, int rows_arg, LyXTabular const * lt = 0);
529 void Reinit(bool reset_widths = true);
531 void set_row_column_number_info(bool oldformat = false);
532 /// Returns true if a complete update is necessary, otherwise false
533 bool SetWidthOfMulticolCell(int cell, int new_width);
535 void recalculateMulticolumnsOfColumn(int column);
536 /// Returns true if change
537 bool calculate_width_of_column(int column);
539 bool calculate_width_of_column_NMC(int column); // no multi cells
541 void calculate_width_of_tabular();
543 cellstruct * cellinfo_of_cell(int cell) const;
545 void delete_column(int column);
547 int cells_in_multicolumn(int cell) const;
549 BoxType UseParbox(int cell) const;
551 void setHeaderFooterRows(int header, int fheader, int footer, int lfooter);
553 // helper function for Latex returns number of newlines
555 int TeXTopHLine(std::ostream &, int row) const;
557 int TeXBottomHLine(std::ostream &, int row) const;
559 int TeXCellPreamble(std::ostream &, int cell) const;
561 int TeXCellPostamble(std::ostream &, int cell) const;
563 int TeXLongtableHeaderFooter(std::ostream &, Buffer const * buf,
564 LatexRunParams const &) const;
566 bool isValidRow(int const row) const;
568 int TeXRow(std::ostream &, int const row, Buffer const * buf,
569 LatexRunParams const &) const;
571 // helper function for ASCII returns number of newlines
573 int asciiTopHLine(std::ostream &, int row,
574 std::vector<unsigned int> const &) const;
576 int asciiBottomHLine(std::ostream &, int row,
577 std::vector<unsigned int> const &) const;
579 int asciiPrintCell(Buffer const *, std::ostream &,
580 int cell, int row, int column,
581 std::vector<unsigned int> const &,
582 bool onlydata) const;
583 /// auxiliary function for docbook
584 int docbookRow(Buffer const * buf, std::ostream & os, int row) const;