4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
10 * Full author contact details are available in file CREDITS.
16 #include "support/strfwd.h"
17 #include "support/types.h"
24 namespace graphics { class Image; }
29 * Painter - A painter class to encapsulate all graphics parameters and operations
31 * Every graphics operation in LyX should be made by this class. The
32 * painter is used for drawing on the WorkArea, and is passed around
33 * during draw operations.
35 * It hides low level windows system parameters so insets and other
36 * clients don't have to worry about them and we can control graphics and
37 * GUI toolkit dependent drawing functions inside this single class.
39 * The intention for a toolkit is that it uses these methods to paint
40 * onto a backing pixmap. Only when expose events arrive via the event
41 * queue (perhaps generated via Screen::expose), does the copy onto
42 * the actual WorkArea widget take place. Paints are wrapped in (possibly
43 * recursive) calls to start() and end() to facilitate the backing pixmap
46 * Note that the methods return *this for convenience.
48 * Caution: All char_type and docstring arguments of the text drawing
49 * methods of this class are no UCS4 chars or strings if the font is a
50 * symbol font. They simply denote the code points of the font instead.
51 * You have to keep this in mind when you implement the methods in a
52 * frontend. You must not pass these parameters to a unicode conversion
53 * function in particular.
57 Painter(double pixel_ratio) : drawing_enabled_(true), pixel_ratio_(pixel_ratio) {}
59 static const int thin_line;
61 /// possible line styles
63 line_solid, //< solid line
64 line_solid_aliased, //< solid line, no anti-aliasing (used as a
65 // workaround to painting issues)
66 line_onoffdash //< dashes with spaces
69 /// possible fill styles
76 /// possible character styles of preedit string.
77 /// This is used for CJK input method support.
79 preedit_default, //< when unselecting, no cursor and dashed underline.
80 preedit_selecting, //< when selecting.
81 preedit_cursor //< with cursor.
86 /// draw a line from point to point
87 virtual void line(int x1, int y1, int x2, int y2, Color,
88 line_style = line_solid, int line_width = thin_line) = 0;
91 * lines - draw a set of lines
92 * @param xp array of points' x co-ords
93 * @param yp array of points' y co-ords
94 * @param np size of the points array
96 virtual void lines(int const * xp, int const * yp, int np, Color,
97 fill_style = fill_none, line_style = line_solid,
98 int line_width = thin_line) = 0;
101 * path - draw a path with bezier curves
102 * @param xp array of points' x co-ords
103 * @param yp array of points' y co-ords
104 * @param c1x array of first control points' x co-ords
105 * @param c1y array of first control points' y co-ords
106 * @param c2x array of second control points' x co-ords
107 * @param c2y array of second control points' y co-ords
108 * @param np size of the points array
110 virtual void path(int const * xp, int const * yp,
111 int const * c1x, int const * c1y,
112 int const * c2x, int const * c2y,
114 fill_style = fill_none, line_style = line_solid,
115 int line_width = thin_line) = 0;
118 virtual void rectangle(int x, int y, int w, int h, Color,
119 line_style = line_solid, int line_width = thin_line) = 0;
121 /// draw a filled rectangle
122 virtual void fillRectangle(int x, int y, int w, int h, Color) = 0;
125 virtual void arc(int x, int y, unsigned int w, unsigned int h,
126 int a1, int a2, Color) = 0;
129 virtual void point(int x, int y, Color) = 0;
131 /// draw a filled rectangle with the shape of a 3D button
132 virtual void button(int x, int y, int w, int h, bool mouseHover) = 0;
134 /// draw an image from the image cache
135 virtual void image(int x, int y, int w, int h,
136 graphics::Image const & image) = 0;
138 /// draw a string at position x, y (y is the baseline).
139 virtual void text(int x, int y, docstring const & str, FontInfo const & f) = 0;
141 /// draw a char at position x, y (y is the baseline)
142 virtual void text(int x, int y, char_type c, FontInfo const & f) = 0;
144 /** draw a string at position x, y (y is the baseline). The
145 * text direction is enforced by the \c Font.
147 virtual void text(int x, int y, docstring const & str, Font const & f,
148 double wordspacing, double textwidth) = 0;
150 /** draw a string at position x, y (y is the baseline), but
151 * make sure that the part between \c from and \c to is in
152 * \c other color. The text direction is enforced by the \c Font.
154 virtual void text(int x, int y, docstring const & str, Font const & f,
155 Color other, size_type from, size_type to,
156 double wordspacing, double textwidth) = 0;
158 void setDrawingEnabled(bool drawing_enabled)
159 { drawing_enabled_ = drawing_enabled; }
161 /// Indicate wether real screen drawing shall be done or not.
162 bool isDrawingEnabled() const { return drawing_enabled_; }
164 double pixelRatio() const { return pixel_ratio_; }
166 /// draw the underbar, strikeout, uuline and uwave font attributes
167 virtual void textDecoration(FontInfo const & f, int x, int y, int width) = 0;
170 * Draw a string and enclose it inside a rectangle. If
171 * back color is specified, the background is cleared with
172 * the given color. If frame is specified, a thin frame is drawn
173 * around the text with the given color.
175 virtual void rectText(int x, int baseline, docstring const & str,
176 FontInfo const & font, Color back, Color frame) = 0;
178 /// draw a string and enclose it inside a button frame
179 virtual void buttonText(int x, int baseline, docstring const & s,
180 FontInfo const & font, bool mouseHover) = 0;
182 /// draw a character of a preedit string for cjk support.
183 virtual int preeditText(int x, int y,
184 char_type c, FontInfo const & f, preedit_style style) = 0;
186 /// start monochrome painting mode, i.e. map every color into [min,max]
187 virtual void enterMonochromeMode(Color const & min,
188 Color const & max) = 0;
189 /// leave monochrome painting mode
190 virtual void leaveMonochromeMode() = 0;
191 /// draws a wavy line that can be used for underlining.
192 virtual void wavyHorizontalLine(int x, int y, int width, ColorCode col) = 0;
195 bool drawing_enabled_;
196 /// Ratio between physical pixels and device-independent pixels
200 } // namespace frontend