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_onoffdash //< dashes with spaces
67 /// possible fill styles
74 /// possible character styles of preedit string.
75 /// This is used for CJK input method support.
77 preedit_default, //< when unselecting, no cursor and dashed underline.
78 preedit_selecting, //< when selecting.
79 preedit_cursor //< with cursor.
84 /// draw a line from point to point
85 virtual void line(int x1, int y1, int x2, int y2, Color,
86 line_style = line_solid, int line_width = thin_line) = 0;
89 * lines - draw a set of lines
90 * @param xp array of points' x co-ords
91 * @param yp array of points' y co-ords
92 * @param np size of the points array
94 virtual void lines(int const * xp, int const * yp, int np, Color,
95 fill_style = fill_none, line_style = line_solid,
96 int line_width = thin_line) = 0;
99 virtual void rectangle(int x, int y, int w, int h, Color,
100 line_style = line_solid, int line_width = thin_line) = 0;
102 /// draw a filled rectangle
103 virtual void fillRectangle(int x, int y, int w, int h, Color) = 0;
106 virtual void arc(int x, int y, unsigned int w, unsigned int h,
107 int a1, int a2, Color) = 0;
110 virtual void point(int x, int y, Color) = 0;
112 /// draw a filled rectangle with the shape of a 3D button
113 virtual void button(int x, int y, int w, int h, bool mouseHover) = 0;
115 /// draw an image from the image cache
116 virtual void image(int x, int y, int w, int h,
117 graphics::Image const & image) = 0;
119 /** draw a string at position x, y (y is the baseline). The
120 * text direction is given by \c rtl.
121 * \return the width of the drawn text.
123 virtual int text(int x, int y, docstring const & str, FontInfo const & f,
124 bool rtl = false, double wordspacing = 0.0) = 0;
126 /** draw a string at position x, y (y is the baseline). The
127 * text direction is enforced by the \c Font.
128 * \return the width of the drawn text.
130 virtual int text(int x, int y, docstring const & str, Font const & f,
131 double wordspacing = 0.0) = 0;
133 /** draw a string at position x, y (y is the baseline), but
134 * make sure that the part between \c from and \c to is in
135 * \c other color. The text direction is enforced by the \c Font.
136 * \return the width of the drawn text.
138 virtual int text(int x, int y, docstring const & str, Font const & f,
139 Color other, size_type from, size_type to,
140 double const wordspacing) = 0;
142 void setDrawingEnabled(bool drawing_enabled)
143 { drawing_enabled_ = drawing_enabled; }
145 /// Indicate wether real screen drawing shall be done or not.
146 bool isDrawingEnabled() const { return drawing_enabled_; }
148 double pixelRatio() const { return pixel_ratio_; }
150 /// draw a char at position x, y (y is the baseline)
152 * \return the width of the drawn text.
154 virtual int text(int x, int y, char_type c, FontInfo const & f) = 0;
156 /// draw the underbar, strikeout, uuline and uwave font attributes
157 virtual void textDecoration(FontInfo const & f, int x, int y, int width) = 0;
160 * Draw a string and enclose it inside a rectangle. If
161 * back color is specified, the background is cleared with
162 * the given color. If frame is specified, a thin frame is drawn
163 * around the text with the given color.
165 virtual void rectText(int x, int baseline, docstring const & str,
166 FontInfo const & font, Color back, Color frame) = 0;
168 /// draw a string and enclose it inside a button frame
169 virtual void buttonText(int x, int baseline, docstring const & s,
170 FontInfo const & font, bool mouseHover) = 0;
172 /// draw a character of a preedit string for cjk support.
173 virtual int preeditText(int x, int y,
174 char_type c, FontInfo const & f, preedit_style style) = 0;
176 /// start monochrome painting mode, i.e. map every color into [min,max]
177 virtual void enterMonochromeMode(Color const & min,
178 Color const & max) = 0;
179 /// leave monochrome painting mode
180 virtual void leaveMonochromeMode() = 0;
181 /// draws a wavy line that can be used for underlining.
182 virtual void wavyHorizontalLine(int x, int y, int width, ColorCode col) = 0;
185 bool drawing_enabled_;
186 /// Ratio between physical pixels and device-independent pixels
190 } // namespace frontend