]> git.lyx.org Git - lyx.git/blob - src/tabular.h
citation patch from Angus
[lyx.git] / src / tabular.h
1 // -*- C++ -*-
2 /* This file is part of
3  * ====================================================== 
4  * 
5  *           LyX, The Document Processor
6  *       
7  *           Copyright 2000 The LyX Team.
8  *
9  *           @author: Jürgen Vigna
10  *
11  * ====================================================== */
12 #ifndef TABULAR_H
13 #define TABULAR_H
14
15 #ifdef __GNUG__
16 #pragma interface
17 #endif
18
19 #include <iosfwd>
20 #include <vector>
21
22 #include "lyxlex.h"
23 #include "LString.h"
24 #include "insets/insettext.h"
25
26 class InsetTabular;
27 class LaTeXFeatures;
28 class Buffer;
29
30 /* The features the text class offers for tables */ 
31
32 ///
33 class LyXTabular  {
34 public:
35     ///
36     enum {
37         ///
38         APPEND_ROW = 0,
39         ///
40         APPEND_COLUMN,
41         ///
42         DELETE_ROW,
43         ///
44         DELETE_COLUMN,
45         ///
46         TOGGLE_LINE_TOP,
47         ///
48         TOGGLE_LINE_BOTTOM,
49         ///
50         TOGGLE_LINE_LEFT,
51         ///
52         TOGGLE_LINE_RIGHT,
53         ///
54         ALIGN_LEFT,
55         ///
56         ALIGN_RIGHT,
57         ///
58         ALIGN_CENTER,
59         ///
60         VALIGN_TOP,
61         ///
62         VALIGN_BOTTOM,
63         ///
64         VALIGN_CENTER,
65         ///
66         M_TOGGLE_LINE_TOP,
67         ///
68         M_TOGGLE_LINE_BOTTOM,
69         ///
70         M_TOGGLE_LINE_LEFT,
71         ///
72         M_TOGGLE_LINE_RIGHT,
73         ///
74         M_ALIGN_LEFT,
75         ///
76         M_ALIGN_RIGHT,
77         ///
78         M_ALIGN_CENTER,
79         ///
80         M_VALIGN_TOP,
81         ///
82         M_VALIGN_BOTTOM,
83         ///
84         M_VALIGN_CENTER,
85         ///
86         DELETE_TABULAR,
87         ///
88         MULTICOLUMN,
89         ///
90         SET_ALL_LINES,
91         ///
92         UNSET_ALL_LINES,
93         ///
94         SET_LONGTABULAR,
95         ///
96         UNSET_LONGTABULAR,
97         ///
98         SET_PWIDTH,
99         ///
100         SET_MPWIDTH,
101         ///
102         SET_ROTATE_TABULAR,
103         ///
104         UNSET_ROTATE_TABULAR,
105         ///
106         SET_ROTATE_CELL,
107         ///
108         UNSET_ROTATE_CELL,
109         ///
110         SET_USEBOX,
111         ///
112         SET_LTHEAD,
113         ///
114         SET_LTFIRSTHEAD,
115         ///
116         SET_LTFOOT,
117         ///
118         SET_LTLASTFOOT,
119         ///
120         SET_LTNEWPAGE,
121         ///
122         SET_SPECIAL_COLUMN,
123         ///
124         SET_SPECIAL_MULTI,
125         ///
126         LAST_ACTION
127     };
128     ///
129     enum {
130         ///
131         CELL_NORMAL = 0,
132         ///
133         CELL_BEGIN_OF_MULTICOLUMN,
134         ///
135         CELL_PART_OF_MULTICOLUMN
136     };
137
138     ///
139     enum VAlignment {
140         ///
141         LYX_VALIGN_TOP = 0,
142         ///
143         LYX_VALIGN_BOTTOM = 1,
144         ///
145         LYX_VALIGN_CENTER = 2
146     };
147
148     enum BoxType {
149         ///
150         BOX_NONE = 0,
151         ///
152         BOX_PARBOX = 1,
153         ///
154         BOX_MINIPAGE = 2
155     };
156
157     /* konstruktor */
158     ///
159     LyXTabular(InsetTabular *, int columns_arg, int rows_arg);
160     ///
161     LyXTabular(InsetTabular *, LyXTabular const &);
162     ///
163     explicit
164     LyXTabular(Buffer const *, InsetTabular *, LyXLex & lex);
165     ///
166     ~LyXTabular();
167     ///
168     LyXTabular & operator=(LyXTabular const &);
169     ///
170     LyXTabular * Clone(InsetTabular *);
171     
172     /// Returns true if there is a topline, returns false if not
173     bool TopLine(int cell, bool onlycolumn=false) const;
174     /// Returns true if there is a topline, returns false if not
175     bool BottomLine(int cell, bool onlycolumn=false) const;
176     /// Returns true if there is a topline, returns false if not
177     bool LeftLine(int cell, bool onlycolumn=false) const;
178     /// Returns true if there is a topline, returns false if not
179     bool RightLine(int cell, bool onlycolumn=false) const;
180     
181     ///
182     bool TopAlreadyDrawed(int cell) const;
183     ///
184     bool LeftAlreadyDrawed(int cell) const;
185     ///
186     bool IsLastRow(int cell) const;
187     
188     ///
189     int GetAdditionalHeight(int cell) const;
190     ///
191     int GetAdditionalWidth(int cell) const;
192     
193     /* returns the maximum over all rows */
194     ///
195     int GetWidthOfColumn(int cell) const;
196     ///
197     int GetWidthOfTabular() const;
198     ///
199     int GetAscentOfRow(int row) const;
200     ///
201     int GetDescentOfRow(int row) const;
202     ///
203     int GetHeightOfTabular() const;
204     /// Returns true if a complete update is necessary, otherwise false
205     bool SetAscentOfRow(int row, int height);
206     /// Returns true if a complete update is necessary, otherwise false
207     bool SetDescentOfRow(int row, int height);
208     /// Returns true if a complete update is necessary, otherwise false
209     bool SetWidthOfCell(int cell, int new_width);
210     /// Returns true if a complete update is necessary, otherwise false
211     bool SetAllLines(int cell, bool line);
212     /// Returns true if a complete update is necessary, otherwise false
213     bool SetTopLine(int cell, bool line, bool onlycolumn=false);
214     /// Returns true if a complete update is necessary, otherwise false
215     bool SetBottomLine(int cell, bool line, bool onlycolumn=false);
216     /// Returns true if a complete update is necessary, otherwise false
217     bool SetLeftLine(int cell, bool line, bool onlycolumn=false);
218     /// Returns true if a complete update is necessary, otherwise false
219     bool SetRightLine(int cell, bool line, bool onlycolumn=false);
220     /// Returns true if a complete update is necessary, otherwise false
221     bool SetAlignment(int cell, char align, bool onlycolumn = false);
222     /// Returns true if a complete update is necessary, otherwise false
223     bool SetVAlignment(int cell, char align, bool onlycolumn = false);
224     ///
225     bool SetColumnPWidth(int cell, string const & width);
226     ///
227     bool SetMColumnPWidth(int cell, string const & width);
228     ///
229     bool SetAlignSpecial(int cell, string const & special, int what);
230     ///
231     char GetAlignment(int cell, bool onlycolumn = false) const;
232     ///
233     char GetVAlignment(int cell, bool onlycolumn = false) const;
234     ///
235     string GetPWidth(int cell) const;
236     ///
237     string GetColumnPWidth(int cell) const;
238     ///
239     string GetMColumnPWidth(int cell) const;
240     ///
241     string GetAlignSpecial(int cell, int what) const;
242     ///
243     int GetWidthOfCell(int cell) const;
244     ///
245     int GetBeginningOfTextInCell(int cell) const;
246     ///
247     void AppendRow(int cell);
248     ///
249     void DeleteRow(int cell);
250     ///
251     void AppendColumn(int cell);
252     ///
253     void DeleteColumn(int cell);
254     ///
255     bool IsFirstCellInRow(int cell) const;
256     ///
257     int GetFirstCellInRow(int row) const;
258     ///
259     bool IsLastCellInRow(int cell) const;
260     ///
261     int GetLastCellInRow(int row) const;
262     ///
263     int GetNumberOfCells() const;
264     ///
265     int NumberOfCellsInRow(int cell) const;
266     ///
267     void Write(Buffer const *, std::ostream &) const;
268     ///
269     void Read(Buffer const *, LyXLex &);
270     ///
271     void OldFormatRead(LyXLex &, string const &);
272     //
273     // helper function for Latex returns number of newlines
274     ///
275     int TeXTopHLine(std::ostream &, int row) const;
276     ///
277     int TeXBottomHLine(std::ostream &, int row) const;
278     ///
279     int TeXCellPreamble(std::ostream &, int cell) const;
280     ///
281     int TeXCellPostamble(std::ostream &, int cell) const;
282     ///
283     int Latex(Buffer const *, std::ostream &, bool, bool) const;
284     ///
285     int DocBookEndOfCell(std::ostream &, int cell, int & depth) const;
286 #if 0
287     ///
288     int RoffEndOfCell(std::ostream &, int cell);
289 #endif
290     ///
291     char const * GetDocBookAlign(int cell, bool isColumn = false) const;
292
293     ///
294     bool IsMultiColumn(int cell, bool real = false) const;
295     ///
296     void SetMultiColumn(int cell, int number);
297     ///
298     int UnsetMultiColumn(int cell); // returns number of new cells
299     ///
300     bool IsPartOfMultiColumn(int row, int column) const;
301     ///
302     int row_of_cell(int cell) const;
303     ///
304     int column_of_cell(int cell) const;
305     ///
306     int right_column_of_cell(int cell) const;
307     ///
308     void SetLongTabular(int what);
309     ///
310     bool IsLongTabular() const;
311     ///
312     void SetRotateTabular(bool);
313     ///
314     bool GetRotateTabular() const;
315     ///
316     void SetRotateCell(int cell, bool);
317     ///
318     bool GetRotateCell(int cell) const;
319     ///
320     bool NeedRotating() const;
321     ///
322     bool IsLastCell(int cell) const;
323     ///
324     int GetCellAbove(int cell) const;
325     ///
326     int GetCellBelow(int cell) const;
327     ///
328     int GetLastCellAbove(int cell) const;
329     ///
330     int GetLastCellBelow(int cell) const;
331     ///
332     int GetCellNumber(int row, int column) const;
333     ///
334     void SetUsebox(int cell, BoxType);
335     ///
336     int GetUsebox(int cell) const;
337     //
338     // Long Tabular Options
339     ///
340     void SetLTHead(int cell, bool first);
341     ///
342     bool GetRowOfLTHead(int cell, int & row) const;
343     ///
344     bool GetRowOfLTFirstHead(int cell, int & row) const;
345     ///
346     void SetLTFoot(int cell, bool last);
347     ///
348     bool GetRowOfLTFoot(int cell, int & row) const;
349     ///
350     bool GetRowOfLTLastFoot(int cell, int & row) const;
351     ///
352     void SetLTNewPage(int cell, bool what);
353     ///
354     bool GetLTNewPage(int cell) const;
355     ///
356     InsetText * GetCellInset(int cell) const;
357     ///
358     int rows() const { return rows_; }
359     ///
360     int columns() const { return columns_;}
361     ///
362     InsetTabular * owner() const { return owner_; }
363     ///
364     void Validate(LaTeXFeatures &) const;
365
366 private: //////////////////////////////////////////////////////////////////
367     ///
368     struct cellstruct {
369         ///
370         cellstruct();
371         ///
372         int cellno;
373         ///
374         int width_of_cell;
375         ///
376         int multicolumn;
377         ///
378         int alignment;
379         ///
380         int valignment;
381         ///
382         bool top_line;
383         ///
384         bool bottom_line;
385         ///
386         bool left_line;
387         ///
388         bool right_line;
389         ///
390         int usebox;
391         ///
392         bool rotate;
393         ///
394         string align_special;
395         ///
396         string p_width; // this is only set for multicolumn!!!
397         ///
398         InsetText inset;
399     };
400     ///
401     typedef std::vector<cellstruct> cell_vector;
402     ///
403     typedef std::vector<cell_vector> cell_vvector;
404
405     ///
406     struct rowstruct {
407         ///
408         rowstruct();
409         ///
410         bool top_line;
411         ///
412         bool bottom_line;
413         ///
414         int ascent_of_row;
415         ///
416         int descent_of_row;
417         /// This are for longtabulars only
418         bool newpage;
419     };
420     ///
421     typedef std::vector<rowstruct> row_vector;
422
423     ///
424     struct columnstruct {
425         ///
426         columnstruct();
427         ///
428         int alignment;
429         ///
430         int valignment;
431         ///
432         bool left_line;
433         ///
434         bool right_line;
435         ///
436         int  width_of_column;
437         ///
438         string p_width;
439         ///
440         string align_special;
441     };
442     ///
443     typedef std::vector<columnstruct> column_vector;
444
445     ///
446     int rows_;
447     ///
448     int columns_;
449     ///
450     int numberofcells;
451     ///
452     int * rowofcell;
453     ///
454     int * columnofcell;
455     ///
456     row_vector row_info;
457     ///
458     column_vector column_info;
459     ///
460     mutable cell_vvector cell_info;
461     ///
462     int width_of_tabular;
463     ///
464     bool rotate;
465     //
466     // for long tabulars
467     ///
468     bool is_long_tabular;
469     /// row of endhead
470     int endhead;
471     /// row of endfirsthead
472     int endfirsthead;
473     /// row of endfoot
474     int endfoot;
475     /// row of endlastfoot
476     int endlastfoot;
477     ///
478     InsetTabular * owner_;
479    
480     ///
481     void Init(int columns_arg, int rows_arg);
482     ///
483     void Reinit();
484     ///
485     void set_row_column_number_info();
486     /// Returns true if a complete update is necessary, otherwise false
487     bool SetWidthOfMulticolCell(int cell, int new_width);
488     void recalculateMulticolCells(int cell, int new_width);
489     /// Returns true if change
490     bool calculate_width_of_column(int column);
491     ///
492     bool calculate_width_of_column_NMC(int column); // no multi cells
493     ///
494     void calculate_width_of_tabular();
495     ///
496     cellstruct * cellinfo_of_cell(int cell) const;
497     ///
498     void delete_column(int column);
499     ///
500     int cells_in_multicolumn(int cell) const;
501     ///
502     bool UseParbox(int cell) const;
503 };
504
505 #endif