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 &);
185 //LyXTabular(BufferParams const &,
186 // InsetTabular *, LyXTabular const &, bool same_id = false);
189 LyXTabular(Buffer const *, InsetTabular *, LyXLex & lex);
191 LyXTabular & operator=(LyXTabular const &);
193 LyXTabular * clone(BufferParams const &, InsetTabular *);
195 //LyXTabular * clone(BufferParams const &,
196 // InsetTabular *, bool same_id = false);
198 /// Returns true if there is a topline, returns false if not
199 bool TopLine(int cell, bool onlycolumn = false) const;
200 /// Returns true if there is a topline, returns false if not
201 bool BottomLine(int cell, bool onlycolumn = false) const;
202 /// Returns true if there is a topline, returns false if not
203 bool LeftLine(int cell, bool onlycolumn = false) const;
204 /// Returns true if there is a topline, returns false if not
205 bool RightLine(int cell, bool onlycolumn = false) const;
208 bool topAlreadyDrawn(int cell) const;
210 bool leftAlreadyDrawn(int cell) const;
212 bool IsLastRow(int cell) const;
215 int GetAdditionalHeight(int row) const;
217 int GetAdditionalWidth(int cell) const;
219 /* returns the maximum over all rows */
221 int GetWidthOfColumn(int cell) const;
223 int GetWidthOfTabular() const;
225 int GetAscentOfRow(int row) const;
227 int GetDescentOfRow(int row) const;
229 int GetHeightOfTabular() const;
230 /// Returns true if a complete update is necessary, otherwise false
231 bool SetAscentOfRow(int row, int height);
232 /// Returns true if a complete update is necessary, otherwise false
233 bool SetDescentOfRow(int row, int height);
234 /// Returns true if a complete update is necessary, otherwise false
235 bool SetWidthOfCell(int cell, int new_width);
236 /// Returns true if a complete update is necessary, otherwise false
237 bool SetAllLines(int cell, bool line);
238 /// Returns true if a complete update is necessary, otherwise false
239 bool SetTopLine(int cell, bool line, bool onlycolumn = false);
240 /// Returns true if a complete update is necessary, otherwise false
241 bool SetBottomLine(int cell, bool line, bool onlycolumn = false);
242 /// Returns true if a complete update is necessary, otherwise false
243 bool SetLeftLine(int cell, bool line, bool onlycolumn = false);
244 /// Returns true if a complete update is necessary, otherwise false
245 bool SetRightLine(int cell, bool line, bool onlycolumn = false);
246 /// Returns true if a complete update is necessary, otherwise false
247 bool SetAlignment(int cell, LyXAlignment align,
248 bool onlycolumn = false);
249 /// Returns true if a complete update is necessary, otherwise false
250 bool SetVAlignment(int cell, VAlignment align,
251 bool onlycolumn = false);
253 bool SetColumnPWidth(int cell, LyXLength const & width);
255 bool SetMColumnPWidth(int cell, LyXLength const & width);
257 bool SetAlignSpecial(int cell, string const & special, Feature what);
259 LyXAlignment GetAlignment(int cell, bool onlycolumn = false) const;
261 VAlignment GetVAlignment(int cell, bool onlycolumn = false) const;
263 LyXLength const GetPWidth(int cell) const;
265 LyXLength const GetColumnPWidth(int cell) const;
267 LyXLength const GetMColumnPWidth(int cell) const;
269 string const GetAlignSpecial(int cell, int what) const;
271 int GetWidthOfCell(int cell) const;
273 int GetBeginningOfTextInCell(int cell) const;
275 void AppendRow(BufferParams const &, int cell);
277 void DeleteRow(int row);
279 void AppendColumn(BufferParams const &, int cell);
281 void DeleteColumn(int column);
283 bool IsFirstCellInRow(int cell) const;
285 int GetFirstCellInRow(int row) const;
287 bool IsLastCellInRow(int cell) const;
289 int GetLastCellInRow(int row) const;
291 int GetNumberOfCells() const;
293 int NumberOfCellsInRow(int cell) const;
295 void Write(Buffer const *, std::ostream &) const;
297 void Read(Buffer const *, LyXLex &);
299 int latex(Buffer const *, std::ostream &,
300 LatexRunParams const &) const;
302 int docbook(Buffer const * buf, std::ostream & os, bool mixcont) const;
304 int ascii(Buffer const *, std::ostream &, int const depth,
305 bool onlydata, unsigned char delim) const;
307 bool IsMultiColumn(int cell, bool real = false) const;
309 void SetMultiColumn(Buffer *, int cell, int number);
311 int UnsetMultiColumn(int cell); // returns number of new cells
313 bool IsPartOfMultiColumn(int row, int column) const;
315 int row_of_cell(int cell) const;
317 int column_of_cell(int cell) const;
319 int right_column_of_cell(int cell) const;
321 void SetLongTabular(bool);
323 bool IsLongTabular() const;
325 void SetRotateTabular(bool);
327 bool GetRotateTabular() const;
329 void SetRotateCell(int cell, bool);
331 bool GetRotateCell(int cell) const;
333 bool NeedRotating() const;
335 bool IsLastCell(int cell) const;
337 int GetCellAbove(int cell) const;
339 int GetCellBelow(int cell) const;
341 int GetLastCellAbove(int cell) const;
343 int GetLastCellBelow(int cell) const;
345 int GetCellNumber(int row, int column) const;
347 void SetUsebox(int cell, BoxType);
349 BoxType GetUsebox(int cell) const;
351 // Long Tabular Options support functions
353 bool checkLTType(int row, ltType const &) const;
355 void SetLTHead(int row, bool flag, ltType const &, bool first);
357 bool GetRowOfLTHead(int row, ltType &) const;
359 bool GetRowOfLTFirstHead(int row, ltType &) const;
361 void SetLTFoot(int row, bool flag, ltType const &, bool last);
363 bool GetRowOfLTFoot(int row, ltType &) const;
365 bool GetRowOfLTLastFoot(int row, ltType &) const;
367 void SetLTNewPage(int row, bool what);
369 bool GetLTNewPage(int row) const;
371 bool haveLTHead() const;
373 bool haveLTFirstHead() const;
375 bool haveLTFoot() const;
377 bool haveLTLastFoot() const;
379 // end longtable support
381 InsetText * GetCellInset(int cell) const;
383 InsetText * GetCellInset(int row, int column) const;
384 /// Search for \param inset in the tabular, with the
385 /// additional hint that it could be at \param maybe_cell
386 int GetCellFromInset(Inset const * inset, int maybe_cell = -1) const;
388 int rows() const { return rows_; }
390 int columns() const { return columns_;}
392 InsetTabular * owner() const { return owner_; }
394 void Validate(LaTeXFeatures &) const;
396 std::vector<string> const getLabelList() const;
398 /// recalculate the widths/heights only!
401 mutable int cur_cell;
406 cellstruct(BufferParams const &);
414 LyXAlignment alignment;
416 VAlignment valignment;
430 string align_special;
432 LyXLength p_width; // this is only set for multicolumn!!!
437 typedef std::vector<cellstruct> cell_vector;
439 typedef std::vector<cell_vector> cell_vvector;
453 /// This are for longtabulars only
456 /// a row of endfirsthead
460 /// row of endlastfoot
462 /// row for a pagebreak
466 typedef std::vector<rowstruct> row_vector;
469 struct columnstruct {
473 LyXAlignment alignment;
475 VAlignment valignment;
485 string align_special;
488 typedef std::vector<columnstruct> column_vector;
491 void read(Buffer const * buf, std::istream & is,
492 LyXLex & lex, string const & l, int const version);
501 std::vector<int> rowofcell;
503 std::vector<int> columnofcell;
507 column_vector column_info;
509 mutable cell_vvector cell_info;
511 int width_of_tabular;
517 bool is_long_tabular;
520 /// endfirsthead data
528 InsetTabular * owner_;
531 void Init(BufferParams const &,
532 int columns_arg, int rows_arg, LyXTabular const * lt = 0);
534 void Reinit(bool reset_widths = true);
536 void set_row_column_number_info(bool oldformat = false);
537 /// Returns true if a complete update is necessary, otherwise false
538 bool SetWidthOfMulticolCell(int cell, int new_width);
540 void recalculateMulticolumnsOfColumn(int column);
541 /// Returns true if change
542 bool calculate_width_of_column(int column);
544 bool calculate_width_of_column_NMC(int column); // no multi cells
546 void calculate_width_of_tabular();
548 cellstruct * cellinfo_of_cell(int cell) const;
550 void delete_column(int column);
552 int cells_in_multicolumn(int cell) const;
554 BoxType UseParbox(int cell) const;
556 void setHeaderFooterRows(int header, int fheader, int footer, int lfooter);
558 // helper function for Latex returns number of newlines
560 int TeXTopHLine(std::ostream &, int row) const;
562 int TeXBottomHLine(std::ostream &, int row) const;
564 int TeXCellPreamble(std::ostream &, int cell) const;
566 int TeXCellPostamble(std::ostream &, int cell) const;
568 int TeXLongtableHeaderFooter(std::ostream &, Buffer const * buf,
569 LatexRunParams const &) const;
571 bool isValidRow(int const row) const;
573 int TeXRow(std::ostream &, int const row, Buffer const * buf,
574 LatexRunParams const &) const;
576 // helper function for ASCII returns number of newlines
578 int asciiTopHLine(std::ostream &, int row,
579 std::vector<unsigned int> const &) const;
581 int asciiBottomHLine(std::ostream &, int row,
582 std::vector<unsigned int> const &) const;
584 int asciiPrintCell(Buffer const *, std::ostream &,
585 int cell, int row, int column,
586 std::vector<unsigned int> const &,
587 bool onlydata) const;
588 /// auxiliary function for docbook
589 int docbookRow(Buffer const * buf, std::ostream & os, int row) const;