]> git.lyx.org Git - features.git/blob - src/RowPainter.h
95c64269e55a38edc4e3d33b1d3c1d4c370bacbd
[features.git] / src / RowPainter.h
1 // -*- C++ -*-
2 /**
3  * \file RowPainter.h
4  * This file is part of LyX, the document processor.
5  * Licence details can be found in the file COPYING.
6  *
7  * \author various
8  * \author John Levon
9  * \author André Pönitz
10  *
11  * Full author contact details are available in file CREDITS.
12  */
13
14 #ifndef ROWPAINTER_H
15 #define ROWPAINTER_H
16
17 #include "Bidi.h"
18 #include "Changes.h"
19
20 #include "support/types.h"
21
22 namespace lyx {
23
24 class BufferView;
25 class Font;
26 class FontInfo;
27 class Inset;
28 class Language;
29 class PainterInfo;
30 class Paragraph;
31 class ParagraphList;
32 class ParagraphMetrics;
33 class Row;
34 class Text;
35 class TextMetrics;
36
37 namespace frontend { class Painter; }
38
39 /**
40  * FIXME: Re-implement row painting using row elements.
41  *
42  * This is not difficult in principle, but the code is intricate and
43  * needs some careful analysis. The first thing that needs to be done
44  * is to break row elements with the same criteria. Currently breakRow
45  * does not consider on-the-fly spell-checking, but it is not clear to
46  * me that it is required. Moreover, this thing would only work if we
47  * are sure that the Row object is up-to-date when drawing happens.
48  * This depends on the update machinery.
49  *
50  * This would allow to get rid of the Bidi class.
51  */
52
53
54 /**
55  * A class used for painting an individual row of text.
56  * FIXME: get rid of that class.
57  */
58 class RowPainter {
59 public:
60         /// initialise and run painter
61         RowPainter(PainterInfo & pi, Text const & text,
62                 pit_type pit, Row const & row, int x, int y);
63
64         /// paint various parts
65         /// FIXME: transfer to TextMetrics
66         void paintAppendix() const;
67         void paintDepthBar() const;
68         void paintChangeBar() const;
69         void paintTooLargeMarks(bool const left, bool const right) const;
70         void paintFirst() const;
71         void paintLast();
72         void paintText();
73         void paintOnlyInsets();
74         void paintSelection() const;
75
76 private:
77         void paintSeparator(double orig_x, double width, FontInfo const & font);
78         void paintForeignMark(double orig_x, Language const * lang, int desc = 0) const;
79         void paintStringAndSel(docstring const & str, Font const & font,
80                          Change const & change,
81                          pos_type start_pos, pos_type end_pos);
82         void paintMisspelledMark(double orig_x,
83                                  docstring const & str, Font const & font,
84                                  pos_type pos, bool changed) const;
85         int paintAppendixStart(int y) const;
86         void paintFromPos(pos_type & vpos, bool changed);
87         void paintInset(Inset const * inset, pos_type const pos);
88         void paintInlineCompletion(Font const & font);
89
90         /// return left margin
91         int leftMargin() const;
92
93         /// return the label font for this row
94         FontInfo labelFont() const;
95
96         ///
97         void paintLabel() const;
98         ///
99         void paintTopLevelLabel() const;
100
101
102         /// contains painting related information.
103         PainterInfo & pi_;
104
105         /// Text for the row
106         Text const & text_;
107         TextMetrics const & text_metrics_;
108         ParagraphList const & pars_;
109
110         /// The row to paint
111         Row const & row_;
112
113         /// Row's paragraph
114         pit_type const pit_;
115         Paragraph const & par_;
116         ParagraphMetrics const & pm_;
117
118         /// bidi cache
119         Bidi bidi_;
120
121         /// row changed? (change tracking)
122         Change const change_;
123
124         // Looks ugly - is
125         double const xo_;
126         int const yo_;    // current baseline
127         double x_;
128         int width_;
129         int solid_line_thickness_;
130         int solid_line_offset_;
131         int dotted_line_thickness_;
132         int dotted_line_offset_;
133 };
134
135 } // namespace lyx
136
137 #endif // ROWPAINTER_H