]> git.saurik.com Git - wxWidgets.git/blame - include/wx/univ/stdrend.h
adopting correct implementation virtualization for Do/GradientFillConcentric
[wxWidgets.git] / include / wx / univ / stdrend.h
CommitLineData
147b8a4a
VZ
1///////////////////////////////////////////////////////////////////////////////
2// Name: wx/univ/stdrend.h
3// Purpose: wxStdRenderer class declaration
4// Author: Vadim Zeitlin
5// Created: 2006-09-18
6// RCS-ID: $Id$
7// Copyright: (c) 2006 Vadim Zeitlin <vadim@wxwindows.org>
8// Licence: wxWindows licence
9///////////////////////////////////////////////////////////////////////////////
10
11#ifndef _WX_UNIV_STDREND_H_
12#define _WX_UNIV_STDREND_H_
13
14#include "wx/univ/renderer.h"
762ad185 15#include "wx/pen.h"
147b8a4a
VZ
16
17class WXDLLEXPORT wxColourScheme;
18
19// ----------------------------------------------------------------------------
20// wxStdRenderer: implements as much of wxRenderer API as possible generically
21// ----------------------------------------------------------------------------
22
23class wxStdRenderer : public wxRenderer
24{
25public:
26 // the renderer will use the given scheme, whose lifetime must be at least
27 // as long as of this object itself, to choose the colours for drawing
28 wxStdRenderer(const wxColourScheme *scheme);
29
30 virtual void DrawBackground(wxDC& dc,
31 const wxColour& col,
32 const wxRect& rect,
33 int flags = 0,
34 wxWindow *window = NULL);
35 virtual void DrawButtonSurface(wxDC& dc,
36 const wxColour& col,
37 const wxRect& rect,
38 int flags);
39
40
41 virtual void DrawFocusRect(wxDC& dc, const wxRect& rect);
42 virtual void DrawLabel(wxDC& dc,
43 const wxString& label,
44 const wxRect& rect,
45 int flags = 0,
46 int alignment = wxALIGN_LEFT | wxALIGN_TOP,
47 int indexAccel = -1,
48 wxRect *rectBounds = NULL);
49 virtual void DrawButtonLabel(wxDC& dc,
50 const wxString& label,
51 const wxBitmap& image,
52 const wxRect& rect,
53 int flags = 0,
54 int alignment = wxALIGN_LEFT | wxALIGN_TOP,
55 int indexAccel = -1,
56 wxRect *rectBounds = NULL);
57
58
59 virtual void DrawBorder(wxDC& dc,
60 wxBorder border,
61 const wxRect& rect,
62 int flags = 0,
63 wxRect *rectIn = NULL);
64 virtual void DrawTextBorder(wxDC& dc,
65 wxBorder border,
66 const wxRect& rect,
67 int flags = 0,
68 wxRect *rectIn = NULL);
69
70 virtual void DrawHorizontalLine(wxDC& dc,
71 wxCoord y, wxCoord x1, wxCoord x2);
72 virtual void DrawVerticalLine(wxDC& dc,
73 wxCoord x, wxCoord y1, wxCoord y2);
74 virtual void DrawFrame(wxDC& dc,
75 const wxString& label,
76 const wxRect& rect,
77 int flags = 0,
78 int alignment = wxALIGN_LEFT,
79 int indexAccel = -1);
80
81
82 virtual void DrawItem(wxDC& dc,
83 const wxString& label,
84 const wxRect& rect,
85 int flags = 0);
6229b92f
VZ
86 virtual void DrawCheckItem(wxDC& dc,
87 const wxString& label,
88 const wxBitmap& bitmap,
89 const wxRect& rect,
90 int flags = 0);
147b8a4a
VZ
91
92 virtual void DrawCheckButton(wxDC& dc,
93 const wxString& label,
94 const wxBitmap& bitmap,
95 const wxRect& rect,
96 int flags = 0,
97 wxAlignment align = wxALIGN_LEFT,
98 int indexAccel = -1);
99 virtual void DrawRadioButton(wxDC& dc,
100 const wxString& label,
101 const wxBitmap& bitmap,
102 const wxRect& rect,
103 int flags = 0,
104 wxAlignment align = wxALIGN_LEFT,
105 int indexAccel = -1);
106
0428ac8c
VZ
107 virtual void DrawScrollbarArrow(wxDC& dc,
108 wxDirection dir,
109 const wxRect& rect,
110 int flags = 0);
111 virtual void DrawScrollCorner(wxDC& dc,
112 const wxRect& rect);
113
147b8a4a
VZ
114#if wxUSE_TEXTCTRL
115 virtual void DrawTextLine(wxDC& dc,
116 const wxString& text,
117 const wxRect& rect,
118 int selStart = -1,
119 int selEnd = -1,
120 int flags = 0);
121
122 virtual void DrawLineWrapMark(wxDC& dc, const wxRect& rect);
6229b92f
VZ
123
124 virtual wxRect GetTextTotalArea(const wxTextCtrl *text,
125 const wxRect& rect) const;
126 virtual wxRect GetTextClientArea(const wxTextCtrl *text,
127 const wxRect& rect,
128 wxCoord *extraSpaceBeyond) const;
147b8a4a
VZ
129#endif // wxUSE_TEXTCTRL
130
131 virtual wxRect GetBorderDimensions(wxBorder border) const;
132
133 virtual bool AreScrollbarsInsideBorder() const;
134
1cd9779f
VZ
135 virtual void AdjustSize(wxSize *size, const wxWindow *window);
136
137 virtual wxCoord GetListboxItemHeight(wxCoord fontHeight);
138
147b8a4a
VZ
139#if wxUSE_SCROLLBAR
140 virtual wxRect GetScrollbarRect(const wxScrollBar *scrollbar,
141 wxScrollBar::Element elem,
142 int thumbPos = -1) const;
143
144 virtual wxCoord GetScrollbarSize(const wxScrollBar *scrollbar);
145
146 virtual wxHitTest HitTestScrollbar(const wxScrollBar *scrollbar,
147 const wxPoint& pt) const;
148
149 virtual wxCoord ScrollbarToPixel(const wxScrollBar *scrollbar,
150 int thumbPos = -1);
151 virtual int PixelToScrollbar(const wxScrollBar *scrollbar, wxCoord coord);
152#endif // wxUSE_SCROLLBAR
153
1cd9779f
VZ
154#if wxUSE_STATUSBAR
155 virtual void DrawStatusField(wxDC& dc,
156 const wxRect& rect,
157 const wxString& label,
158 int flags = 0, int style = 0);
159
160 virtual wxSize GetStatusBarBorders(wxCoord *borderBetweenFields) const;
161#endif // wxUSE_STATUSBAR
162
163 virtual wxCoord GetCheckItemMargin() const { return 0; }
164
249803fb
VZ
165
166 virtual void DrawFrameTitleBar(wxDC& dc,
167 const wxRect& rect,
168 const wxString& title,
169 const wxIcon& icon,
170 int flags,
171 int specialButton = 0,
172 int specialButtonFlag = 0);
173 virtual void DrawFrameBorder(wxDC& dc,
174 const wxRect& rect,
175 int flags);
176 virtual void DrawFrameBackground(wxDC& dc,
177 const wxRect& rect,
178 int flags);
179 virtual void DrawFrameTitle(wxDC& dc,
180 const wxRect& rect,
181 const wxString& title,
182 int flags);
183 virtual void DrawFrameIcon(wxDC& dc,
184 const wxRect& rect,
185 const wxIcon& icon,
186 int flags);
187 virtual void DrawFrameButton(wxDC& dc,
188 wxCoord x, wxCoord y,
189 int button,
190 int flags = 0);
191
192 virtual wxRect GetFrameClientArea(const wxRect& rect, int flags) const;
193
194 virtual wxSize GetFrameTotalSize(const wxSize& clientSize, int flags) const;
195
196 virtual wxSize GetFrameMinSize(int flags) const;
197
198 virtual wxSize GetFrameIconSize() const;
199
200 virtual int HitTestFrame(const wxRect& rect,
201 const wxPoint& pt,
202 int flags = 0) const;
147b8a4a
VZ
203protected:
204 // various constants
0428ac8c
VZ
205 enum ArrowDirection
206 {
207 Arrow_Left,
208 Arrow_Right,
209 Arrow_Up,
210 Arrow_Down,
211 Arrow_Max
212 };
213
214 enum ArrowStyle
215 {
216 Arrow_Normal,
217 Arrow_Disabled,
218 Arrow_Pressed,
219 Arrow_Inverted,
220 Arrow_InvertedDisabled,
221 Arrow_StateMax
222 };
223
249803fb
VZ
224 enum FrameButtonType
225 {
226 FrameButton_Close,
227 FrameButton_Minimize,
228 FrameButton_Maximize,
229 FrameButton_Restore,
230 FrameButton_Help,
231 FrameButton_Max
232 };
233
147b8a4a
VZ
234 enum IndicatorType
235 {
236 IndicatorType_Check,
237 IndicatorType_Radio,
6229b92f
VZ
238 IndicatorType_MaxCtrl,
239 IndicatorType_Menu = IndicatorType_MaxCtrl,
147b8a4a
VZ
240 IndicatorType_Max
241 };
242
243 enum IndicatorState
244 {
245 IndicatorState_Normal,
246 IndicatorState_Pressed, // this one is for check/radioboxes
247 IndicatorState_Disabled,
248 IndicatorState_MaxCtrl,
249
250 // the rest of the states are valid for menu items only
251 IndicatorState_Selected = IndicatorState_Pressed,
252 IndicatorState_SelectedDisabled = IndicatorState_MaxCtrl,
253 IndicatorState_MaxMenu
254 };
255
256 enum IndicatorStatus
257 {
258 IndicatorStatus_Checked,
259 IndicatorStatus_Unchecked,
260 IndicatorStatus_Undetermined,
261 IndicatorStatus_Max
262 };
263
264 // translate the appropriate bits in flags to the above enum elements
265 static void GetIndicatorsFromFlags(int flags,
266 IndicatorState& state,
267 IndicatorStatus& status);
268
0428ac8c
VZ
269 // translate wxDirection to ArrowDirection
270 static ArrowDirection GetArrowDirection(wxDirection dir);
271
272
147b8a4a
VZ
273 // fill the rectangle with a brush of given colour (must be valid)
274 void DrawSolidRect(wxDC& dc, const wxColour& col, const wxRect& rect);
275
276
277 // all the functions in this section adjust the rect parameter to
278 // correspond to the interiour of the drawn area
279
280 // draw complete rectangle
281 void DrawRect(wxDC& dc, wxRect *rect, const wxPen& pen);
282
283 // draw the rectange using the first pen for the left and top sides
284 // and the second one for the bottom and right ones
285 void DrawShadedRect(wxDC& dc, wxRect *rect,
286 const wxPen& pen1, const wxPen& pen2);
287
288 // border drawing routines, may be overridden in the derived class
289 virtual void DrawRaisedBorder(wxDC& dc, wxRect *rect);
290 virtual void DrawSunkenBorder(wxDC& dc, wxRect *rect);
291 virtual void DrawAntiSunkenBorder(wxDC& dc, wxRect *rect);
7419ba02
VZ
292 virtual void DrawBoxBorder(wxDC& dc, wxRect *rect);
293 virtual void DrawStaticBorder(wxDC& dc, wxRect *rect);
294 virtual void DrawExtraBorder(wxDC& dc, wxRect *rect);
147b8a4a
VZ
295
296
297 // draw the frame with non-empty label inside the given rectText
298 virtual void DrawFrameWithLabel(wxDC& dc,
299 const wxString& label,
300 const wxRect& rectFrame,
301 const wxRect& rectText,
302 int flags,
303 int alignment,
304 int indexAccel);
305
306 // draw the (static box) frame without the part corresponding to rectLabel
307 void DrawFrameWithoutLabel(wxDC& dc,
308 const wxRect& rectFrame,
309 const wxRect& rectLabel);
310
311
6229b92f
VZ
312 // draw the bitmap for a check item (which is by default the same as check
313 // box one but may be different)
314 virtual void DrawCheckItemBitmap(wxDC& dc,
315 const wxBitmap& bitmap,
316 const wxRect& rect,
317 int flags);
318
147b8a4a
VZ
319 // common routine for drawing check and radio buttons
320 void DrawCheckOrRadioButton(wxDC& dc,
321 const wxString& label,
322 const wxBitmap& bitmap,
323 const wxRect& rect,
324 int flags,
325 wxAlignment align,
326 int indexAccel);
327
328 // return the check/radio bitmap for the given flags
329 virtual wxBitmap GetRadioBitmap(int flags) = 0;
330 virtual wxBitmap GetCheckBitmap(int flags) = 0;
331
249803fb
VZ
332 // return the frame icon bitmap
333 virtual wxBitmap GetFrameButtonBitmap(FrameButtonType type) = 0;
334
b13862ee
VZ
335 // get the width of either normal or resizeable frame border depending on
336 // whether flags contains wxTOPLEVEL_RESIZEABLE bit
337 //
338 // notice that these methods only make sense with standard border drawing
339 // code which uses the borders of the same width on all sides, this is why
340 // they are only present here and not in wxRenderer itself
341 virtual int GetFrameBorderWidth(int flags) const;
342
6229b92f
VZ
343#if wxUSE_TEXTCTRL
344 // return the width of the border around the text area in the text control
345 virtual int GetTextBorderWidth(const wxTextCtrl *text) const;
346#endif // wxUSE_TEXTCTRL
147b8a4a
VZ
347
348 // return the starting and ending positions, in pixels, of the thumb of a
349 // scrollbar with the given logical position, thumb size and range and the
350 // given physical length
351 static void GetScrollBarThumbSize(wxCoord length,
352 int thumbPos,
353 int thumbSize,
354 int range,
355 wxCoord *thumbStart,
356 wxCoord *thumbEnd);
357
358 // GDI objects we often use
359 wxPen m_penBlack,
360 m_penDarkGrey,
361 m_penLightGrey,
362 m_penHighlight;
363
249803fb
VZ
364 wxFont m_titlebarFont;
365
147b8a4a
VZ
366 // the colours we use, they never change currently so we don't have to ever
367 // update m_penXXX objects above
368 const wxColourScheme * const m_scheme;
369
370 DECLARE_NO_COPY_CLASS(wxStdRenderer)
371};
372
373#endif // _WX_UNIV_STDREND_H_