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/strfwd.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() : drawing_enabled_(true) {}
60 static const float thin_line;
62 /// possible line styles
64 line_solid, //< solid line
65 line_onoffdash //< dashes with spaces
68 /// possible character styles of preedit string.
69 /// This is used for CJK input method support.
71 preedit_default, //< when unselecting, no cursor and dashed underline.
72 preedit_selecting, //< when selecting.
73 preedit_cursor //< with cursor.
78 /// draw a line from point to point
79 virtual void line(int x1, int y1, int x2, int y2, Color,
80 line_style = line_solid, float line_width = thin_line) = 0;
83 * lines - draw a set of lines
84 * @param xp array of points' x co-ords
85 * @param yp array of points' y co-ords
86 * @param np size of the points array
88 virtual void lines(int const * xp, int const * yp, int np, Color,
89 line_style = line_solid, float line_width = thin_line) = 0;
92 virtual void rectangle(int x, int y, int w, int h, Color,
93 line_style = line_solid, float line_width = thin_line) = 0;
95 /// draw a filled rectangle
96 virtual void fillRectangle(int x, int y, int w, int h, Color) = 0;
99 virtual void arc(int x, int y, unsigned int w, unsigned int h,
100 int a1, int a2, Color) = 0;
103 virtual void point(int x, int y, Color) = 0;
105 /// draw a filled rectangle with the shape of a 3D button
106 virtual void button(int x, int y, int w, int h, bool mouseHover) = 0;
108 /// draw an image from the image cache
109 virtual void image(int x, int y, int w, int h,
110 graphics::Image const & image) = 0;
112 /// draw a string at position x, y (y is the baseline)
114 * \return the width of the drawn text.
116 virtual int text(int x, int y, docstring const & str, FontInfo const & f) = 0;
118 void setDrawingEnabled(bool drawing_enabled)
119 { drawing_enabled_ = drawing_enabled; }
121 /// Indicate wether real screen drawing shall be done or not.
122 bool isDrawingEnabled() const { return drawing_enabled_; }
124 /// draw a char at position x, y (y is the baseline)
126 * \return the width of the drawn text.
128 virtual int text(int x, int y, char_type c, FontInfo const & f) = 0;
131 * Draw a string and enclose it inside a rectangle. If
132 * back color is specified, the background is cleared with
133 * the given color. If frame is specified, a thin frame is drawn
134 * around the text with the given color.
136 virtual void rectText(int x, int baseline, docstring const & str,
137 FontInfo const & font, Color back, Color frame) = 0;
139 /// draw a string and enclose it inside a button frame
140 virtual void buttonText(int x, int baseline, docstring const & s,
141 FontInfo const & font, bool mouseHover) = 0;
143 /// draw a character of a preedit string for cjk support.
144 virtual int preeditText(int x, int y,
145 char_type c, FontInfo const & f, preedit_style style) = 0;
147 /// start monochrome painting mode, i.e. map every color into [min,max]
148 virtual void enterMonochromeMode(Color const & min,
149 Color const & max) = 0;
150 /// leave monochrome painting mode
151 virtual void leaveMonochromeMode() = 0;
152 /// draws a wavy line that can be used for underlining.
153 virtual void wavyHorizontalLine(int x, int y, int width, ColorCode col) = 0;
156 bool drawing_enabled_;
159 } // namespace frontend