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.
18 #include "support/docstring.h"
25 namespace graphics { class Image; }
30 * Painter - A painter class to encapsulate all graphics parameters and operations
32 * Every graphics operation in LyX should be made by this class. The
33 * painter is used for drawing on the WorkArea, and is passed around
34 * during draw operations.
36 * It hides low level windows system parameters so insets and other
37 * clients don't have to worry about them and we can control graphics and
38 * GUI toolkit dependent drawing functions inside this single class.
40 * The intention for a toolkit is that it uses these methods to paint
41 * onto a backing pixmap. Only when expose events arrive via the event
42 * queue (perhaps generated via Screen::expose), does the copy onto
43 * the actual WorkArea widget take place. Paints are wrapped in (possibly
44 * recursive) calls to start() and end() to facilitate the backing pixmap
47 * Note that the methods return *this for convenience.
51 Painter(): drawing_enabled_(true) {}
52 /// possible line widths
54 line_thin, //< thin line
55 line_thick //< thick line
58 /// possible line styles
60 line_solid, //< solid line
61 line_onoffdash //< dashes with spaces
67 //virtual void start() {}
70 ////virtual void end() {}
72 /// draw a line from point to point
77 line_style = line_solid,
78 line_width = line_thin) = 0;
81 * lines - draw a set of lines
82 * @param xp array of points' x co-ords
83 * @param yp array of points' y co-ords
84 * @param np size of the points array
91 line_style = line_solid,
92 line_width = line_thin) = 0;
95 virtual void rectangle(
99 line_style = line_solid,
100 line_width = line_thin) = 0;
102 /// draw a filled rectangle
103 virtual void fillRectangle(
111 unsigned int w, unsigned int h,
120 /// draw a filled rectangle with the shape of a 3D button
121 virtual void button(int x, int y,
124 /// draw an image from the image cache
125 virtual void image(int x, int y,
127 graphics::Image const & image) = 0;
129 /// draw a string at position x, y (y is the baseline)
131 * \return the width of the drawn text.
133 virtual int text(int x, int y,
134 docstring const & str, LyXFont const & f) = 0;
136 void setDrawingEnabled(bool drawing_enabled = true)
137 { drawing_enabled_ = drawing_enabled; }
140 * Draw a string at position x, y (y is the baseline)
141 * This is just for fast drawing
142 * \return the width of the drawn text.
144 virtual int text(int x, int y,
145 char_type const * str, size_t l, LyXFont const & f) = 0;
147 /// draw a char at position x, y (y is the baseline)
149 * \return the width of the drawn text.
151 virtual int text(int x, int y, char_type c, LyXFont const & f) = 0;
154 * Draw a string and enclose it inside a rectangle. If
155 * back color is specified, the background is cleared with
156 * the given color. If frame is specified, a thin frame is drawn
157 * around the text with the given color.
159 virtual void rectText(int x, int baseline,
160 docstring const & str,
161 LyXFont const & font,
165 /// draw a string and enclose it inside a button frame
166 virtual void buttonText(int x,
167 int baseline, docstring const & s, LyXFont const & font);
170 /// check the font, and if set, draw an underline
171 virtual void underline(LyXFont const & f,
172 int x, int y, int width);
174 /// draw a bevelled button border
175 virtual void buttonFrame(int x, int y, int w, int h);
177 /// Indicate wether real screen drawing shall be done or not.
178 bool const isDrawingEnabled() { return drawing_enabled_; }
182 bool drawing_enabled_;
185 } // namespace frontend