1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/univ/stdrend.h
3 // Purpose: wxStdRenderer class declaration
4 // Author: Vadim Zeitlin
7 // Copyright: (c) 2006 Vadim Zeitlin <vadim@wxwindows.org>
8 // Licence: wxWindows licence
9 ///////////////////////////////////////////////////////////////////////////////
11 #ifndef _WX_UNIV_STDREND_H_
12 #define _WX_UNIV_STDREND_H_
14 #include "wx/univ/renderer.h"
17 class WXDLLEXPORT wxColourScheme
;
19 // ----------------------------------------------------------------------------
20 // wxStdRenderer: implements as much of wxRenderer API as possible generically
21 // ----------------------------------------------------------------------------
23 class wxStdRenderer
: public wxRenderer
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
);
30 virtual void DrawBackground(wxDC
& dc
,
34 wxWindow
*window
= NULL
);
35 virtual void DrawButtonSurface(wxDC
& dc
,
41 virtual void DrawFocusRect(wxDC
& dc
, const wxRect
& rect
);
42 virtual void DrawLabel(wxDC
& dc
,
43 const wxString
& label
,
46 int alignment
= wxALIGN_LEFT
| wxALIGN_TOP
,
48 wxRect
*rectBounds
= NULL
);
49 virtual void DrawButtonLabel(wxDC
& dc
,
50 const wxString
& label
,
51 const wxBitmap
& image
,
54 int alignment
= wxALIGN_LEFT
| wxALIGN_TOP
,
56 wxRect
*rectBounds
= NULL
);
59 virtual void DrawBorder(wxDC
& dc
,
63 wxRect
*rectIn
= NULL
);
64 virtual void DrawTextBorder(wxDC
& dc
,
68 wxRect
*rectIn
= NULL
);
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
,
78 int alignment
= wxALIGN_LEFT
,
82 virtual void DrawItem(wxDC
& dc
,
83 const wxString
& label
,
86 virtual void DrawCheckItem(wxDC
& dc
,
87 const wxString
& label
,
88 const wxBitmap
& bitmap
,
92 virtual void DrawCheckButton(wxDC
& dc
,
93 const wxString
& label
,
94 const wxBitmap
& bitmap
,
97 wxAlignment align
= wxALIGN_LEFT
,
99 virtual void DrawRadioButton(wxDC
& dc
,
100 const wxString
& label
,
101 const wxBitmap
& bitmap
,
104 wxAlignment align
= wxALIGN_LEFT
,
105 int indexAccel
= -1);
107 virtual void DrawScrollbarArrow(wxDC
& dc
,
111 virtual void DrawScrollCorner(wxDC
& dc
,
115 virtual void DrawTextLine(wxDC
& dc
,
116 const wxString
& text
,
122 virtual void DrawLineWrapMark(wxDC
& dc
, const wxRect
& rect
);
124 virtual wxRect
GetTextTotalArea(const wxTextCtrl
*text
,
125 const wxRect
& rect
) const;
126 virtual wxRect
GetTextClientArea(const wxTextCtrl
*text
,
128 wxCoord
*extraSpaceBeyond
) const;
129 #endif // wxUSE_TEXTCTRL
131 virtual wxRect
GetBorderDimensions(wxBorder border
) const;
133 virtual bool AreScrollbarsInsideBorder() const;
136 virtual wxRect
GetScrollbarRect(const wxScrollBar
*scrollbar
,
137 wxScrollBar::Element elem
,
138 int thumbPos
= -1) const;
140 virtual wxCoord
GetScrollbarSize(const wxScrollBar
*scrollbar
);
142 virtual wxHitTest
HitTestScrollbar(const wxScrollBar
*scrollbar
,
143 const wxPoint
& pt
) const;
145 virtual wxCoord
ScrollbarToPixel(const wxScrollBar
*scrollbar
,
147 virtual int PixelToScrollbar(const wxScrollBar
*scrollbar
, wxCoord coord
);
148 #endif // wxUSE_SCROLLBAR
167 Arrow_InvertedDisabled
,
175 IndicatorType_MaxCtrl
,
176 IndicatorType_Menu
= IndicatorType_MaxCtrl
,
182 IndicatorState_Normal
,
183 IndicatorState_Pressed
, // this one is for check/radioboxes
184 IndicatorState_Disabled
,
185 IndicatorState_MaxCtrl
,
187 // the rest of the states are valid for menu items only
188 IndicatorState_Selected
= IndicatorState_Pressed
,
189 IndicatorState_SelectedDisabled
= IndicatorState_MaxCtrl
,
190 IndicatorState_MaxMenu
195 IndicatorStatus_Checked
,
196 IndicatorStatus_Unchecked
,
197 IndicatorStatus_Undetermined
,
201 // translate the appropriate bits in flags to the above enum elements
202 static void GetIndicatorsFromFlags(int flags
,
203 IndicatorState
& state
,
204 IndicatorStatus
& status
);
206 // translate wxDirection to ArrowDirection
207 static ArrowDirection
GetArrowDirection(wxDirection dir
);
210 // fill the rectangle with a brush of given colour (must be valid)
211 void DrawSolidRect(wxDC
& dc
, const wxColour
& col
, const wxRect
& rect
);
214 // all the functions in this section adjust the rect parameter to
215 // correspond to the interiour of the drawn area
217 // draw complete rectangle
218 void DrawRect(wxDC
& dc
, wxRect
*rect
, const wxPen
& pen
);
220 // draw the rectange using the first pen for the left and top sides
221 // and the second one for the bottom and right ones
222 void DrawShadedRect(wxDC
& dc
, wxRect
*rect
,
223 const wxPen
& pen1
, const wxPen
& pen2
);
225 // border drawing routines, may be overridden in the derived class
226 virtual void DrawRaisedBorder(wxDC
& dc
, wxRect
*rect
);
227 virtual void DrawSunkenBorder(wxDC
& dc
, wxRect
*rect
);
228 virtual void DrawAntiSunkenBorder(wxDC
& dc
, wxRect
*rect
);
229 virtual void DrawFrameBorder(wxDC
& dc
, wxRect
*rect
);
232 // draw the frame with non-empty label inside the given rectText
233 virtual void DrawFrameWithLabel(wxDC
& dc
,
234 const wxString
& label
,
235 const wxRect
& rectFrame
,
236 const wxRect
& rectText
,
241 // draw the (static box) frame without the part corresponding to rectLabel
242 void DrawFrameWithoutLabel(wxDC
& dc
,
243 const wxRect
& rectFrame
,
244 const wxRect
& rectLabel
);
247 // draw the bitmap for a check item (which is by default the same as check
248 // box one but may be different)
249 virtual void DrawCheckItemBitmap(wxDC
& dc
,
250 const wxBitmap
& bitmap
,
254 // common routine for drawing check and radio buttons
255 void DrawCheckOrRadioButton(wxDC
& dc
,
256 const wxString
& label
,
257 const wxBitmap
& bitmap
,
263 // return the check/radio bitmap for the given flags
264 virtual wxBitmap
GetRadioBitmap(int flags
) = 0;
265 virtual wxBitmap
GetCheckBitmap(int flags
) = 0;
268 // return the width of the border around the text area in the text control
269 virtual int GetTextBorderWidth(const wxTextCtrl
*text
) const;
270 #endif // wxUSE_TEXTCTRL
272 // return the starting and ending positions, in pixels, of the thumb of a
273 // scrollbar with the given logical position, thumb size and range and the
274 // given physical length
275 static void GetScrollBarThumbSize(wxCoord length
,
282 // GDI objects we often use
288 // the colours we use, they never change currently so we don't have to ever
289 // update m_penXXX objects above
290 const wxColourScheme
* const m_scheme
;
292 DECLARE_NO_COPY_CLASS(wxStdRenderer
)
295 #endif // _WX_UNIV_STDREND_H_