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() : drawing_enabled_(true) {}
59 static const float thin_line;
61 /// possible line styles
63 line_solid, //< solid line
64 line_onoffdash //< dashes with spaces
67 /// possible character styles of preedit string.
68 /// This is used for CJK input method support.
70 preedit_default, //< when unselecting, no cursor and dashed underline.
71 preedit_selecting, //< when selecting.
72 preedit_cursor //< with cursor.
77 /// draw a line from point to point
78 virtual void line(int x1, int y1, int x2, int y2, Color,
79 line_style = line_solid, float line_width = thin_line) = 0;
82 * lines - draw a set of lines
83 * @param xp array of points' x co-ords
84 * @param yp array of points' y co-ords
85 * @param np size of the points array
87 virtual void lines(int const * xp, int const * yp, int np, Color,
88 line_style = line_solid, float line_width = thin_line) = 0;
91 virtual void rectangle(int x, int y, int w, int h, Color,
92 line_style = line_solid, float line_width = thin_line) = 0;
94 /// draw a filled rectangle
95 virtual void fillRectangle(int x, int y, int w, int h, Color) = 0;
98 virtual void arc(int x, int y, unsigned int w, unsigned int h,
99 int a1, int a2, Color) = 0;
102 virtual void point(int x, int y, Color) = 0;
104 /// draw a filled rectangle with the shape of a 3D button
105 virtual void button(int x, int y, int w, int h, bool mouseHover) = 0;
107 /// draw an image from the image cache
108 virtual void image(int x, int y, int w, int h,
109 graphics::Image const & image) = 0;
111 /** draw a string at position x, y (y is the baseline). The
112 * text direction is given by \c rtl.
113 * \return the width of the drawn text.
115 virtual int text(int x, int y, docstring const & str, FontInfo const & f, bool rtl = false) = 0;
117 /** draw a string at position x, y (y is the baseline). The
118 * text direction is enforced by the \c Font.
119 * \return the width of the drawn text.
121 virtual int text(int x, int y, docstring const & str, Font const & f) = 0;
123 /** draw a string at position x, y (y is the baseline), but
124 * make sure that the part between \c from and \c to is in
125 * \c other color. The text direction is enforced by the \c Font.
126 * \return the width of the drawn text.
128 virtual int text(int x, int y, docstring const & str, Font const & f,
129 Color other, size_type from, size_type to) = 0;
131 void setDrawingEnabled(bool drawing_enabled)
132 { drawing_enabled_ = drawing_enabled; }
134 /// Indicate wether real screen drawing shall be done or not.
135 bool isDrawingEnabled() const { return drawing_enabled_; }
137 /// draw a char at position x, y (y is the baseline)
139 * \return the width of the drawn text.
141 virtual int text(int x, int y, char_type c, FontInfo const & f) = 0;
143 /// draw the underbar, strikeout, uuline and uwave font attributes
144 virtual void textDecoration(FontInfo const & f, int x, int y, int width) = 0;
147 * Draw a string and enclose it inside a rectangle. If
148 * back color is specified, the background is cleared with
149 * the given color. If frame is specified, a thin frame is drawn
150 * around the text with the given color.
152 virtual void rectText(int x, int baseline, docstring const & str,
153 FontInfo const & font, Color back, Color frame) = 0;
155 /// draw a string and enclose it inside a button frame
156 virtual void buttonText(int x, int baseline, docstring const & s,
157 FontInfo const & font, bool mouseHover) = 0;
159 /// draw a character of a preedit string for cjk support.
160 virtual int preeditText(int x, int y,
161 char_type c, FontInfo const & f, preedit_style style) = 0;
163 /// start monochrome painting mode, i.e. map every color into [min,max]
164 virtual void enterMonochromeMode(Color const & min,
165 Color const & max) = 0;
166 /// leave monochrome painting mode
167 virtual void leaveMonochromeMode() = 0;
168 /// draws a wavy line that can be used for underlining.
169 virtual void wavyHorizontalLine(int x, int y, int width, ColorCode col) = 0;
172 bool drawing_enabled_;
175 } // namespace frontend