1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxRendererNative class declaration
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
13 Renderers are used in wxWindows for two similar but different things:
14 (a) wxUniversal uses them to draw everything, i.e. all the control
15 (b) all the native ports use them to draw generic controls only
17 wxUniversal needs more functionality than what is included in the base class
18 as it needs to draw stuff like scrollbars which are never going to be
19 generic. So we put the bare minimum needed by the native ports here and the
20 full wxRenderer class is declared in wx/univ/renderer.h and is only used by
21 wxUniveral (although note that native ports can load wxRenderer objects from
22 theme DLLs and use them as wxRendererNative ones, of course).
25 #ifndef _WX_RENDERER_H_
26 #define _WX_RENDERER_H_
28 class WXDLLEXPORT wxDC
;
29 class WXDLLEXPORT wxWindow
;
31 #include "wx/gdicmn.h" // for wxPoint
33 // some platforms have their own renderers, others use the generic one
34 #if defined(__WXMSW__) || defined(__WXMAC__) || defined(__WXGTK__)
35 #define wxHAS_NATIVE_RENDERER
37 #undef wxHAS_NATIVE_RENDERER
40 // ----------------------------------------------------------------------------
42 // ----------------------------------------------------------------------------
44 // control state flags used in wxRenderer and wxColourScheme
47 wxCONTROL_DISABLED
= 0x00000001, // control is disabled
48 wxCONTROL_FOCUSED
= 0x00000002, // currently has keyboard focus
49 wxCONTROL_PRESSED
= 0x00000004, // (button) is pressed
50 wxCONTROL_ISDEFAULT
= 0x00000008, // only applies to the buttons
51 wxCONTROL_ISSUBMENU
= wxCONTROL_ISDEFAULT
, // only for menu items
52 wxCONTROL_EXPANDED
= wxCONTROL_ISDEFAULT
, // only for the tree items
53 wxCONTROL_CURRENT
= 0x00000010, // mouse is currently over the control
54 wxCONTROL_SELECTED
= 0x00000020, // selected item in e.g. listbox
55 wxCONTROL_CHECKED
= 0x00000040, // (check/radio button) is checked
56 wxCONTROL_CHECKABLE
= 0x00000080, // (menu) item can be checked
58 wxCONTROL_FLAGS_MASK
= 0x000000ff,
60 // this is a pseudo flag not used directly by wxRenderer but rather by some
61 // controls internally
62 wxCONTROL_DIRTY
= 0x80000000
65 // ----------------------------------------------------------------------------
67 // ----------------------------------------------------------------------------
69 // wxSplitterWindow parameters
70 struct WXDLLEXPORT wxSplitterRenderParams
72 // the only way to initialize this struct is by using this ctor
73 wxSplitterRenderParams(wxCoord widthSash_
, wxCoord border_
, bool isSens_
)
74 : widthSash(widthSash_
), border(border_
), isHotSensitive(isSens_
)
78 // the width of the splitter sash
79 const wxCoord widthSash
;
81 // the width of the border of the splitter window
84 // true if the splitter changes its appearance when the mouse is over it
85 const bool isHotSensitive
;
88 // ----------------------------------------------------------------------------
89 // wxRendererNative: abstracts drawing methods needed by the native controls
90 // ----------------------------------------------------------------------------
92 class WXDLLEXPORT wxRendererNative
95 virtual ~wxRendererNative() { } // stop GCC warning
100 // draw the header control button (used by wxListCtrl)
101 virtual void DrawHeaderButton(wxWindow
*win
,
106 // draw the expanded/collapsed icon for a tree control item
107 virtual void DrawTreeItemButton(wxWindow
*win
,
112 // draw the border for sash window: this border must be such that the sash
113 // drawn by DrawSash() blends into it well
114 virtual void DrawSplitterBorder(wxWindow
*win
,
119 // draw a (vertical) sash
120 virtual void DrawSplitterSash(wxWindow
*win
,
124 wxOrientation orient
,
128 // geometry functions
129 // ------------------
131 // get the splitter parameters: the x field of the returned point is the
132 // sash width and the y field is the border width
133 virtual wxSplitterRenderParams
GetSplitterParams(const wxWindow
*win
) = 0;
136 // pseudo constructors
137 // -------------------
139 // return the currently used renderer
140 static wxRendererNative
& Get();
142 // return the generic implementation of the renderer
143 static wxRendererNative
& GetGeneric();
145 // return the default (native) implementation for this platform
146 static wxRendererNative
& GetDefault();
149 // changing the global renderer
150 // ----------------------------
152 #if wxUSE_DYNLIB_CLASS
153 // load the renderer from the specified DLL, the returned pointer must be
154 // deleted by caller if not NULL when it is not used any more
155 static wxRendererNative
*Load(const wxString
& name
);
156 #endif // wxUSE_DYNLIB_CLASS
158 // set the renderer to use, passing NULL reverts to using the default
161 // return the previous renderer used with Set() or NULL if none
162 static wxRendererNative
*Set(wxRendererNative
*renderer
);
165 // ----------------------------------------------------------------------------
166 // wxDelegateRendererNative: allows reuse of renderers code
167 // ----------------------------------------------------------------------------
169 class WXDLLEXPORT wxDelegateRendererNative
: public wxRendererNative
172 wxDelegateRendererNative()
173 : m_rendererNative(GetGeneric()) { }
175 wxDelegateRendererNative(wxRendererNative
& rendererNative
)
176 : m_rendererNative(rendererNative
) { }
179 virtual void DrawHeaderButton(wxWindow
*win
,
183 { m_rendererNative
.DrawHeaderButton(win
, dc
, rect
, flags
); }
185 virtual void DrawTreeItemButton(wxWindow
*win
,
189 { m_rendererNative
.DrawTreeItemButton(win
, dc
, rect
, flags
); }
191 virtual void DrawSplitterBorder(wxWindow
*win
,
195 { m_rendererNative
.DrawSplitterBorder(win
, dc
, rect
, flags
); }
197 virtual void DrawSplitterSash(wxWindow
*win
,
201 wxOrientation orient
,
203 { m_rendererNative
.DrawSplitterSash(win
, dc
, size
,
204 position
, orient
, flags
); }
207 virtual wxSplitterRenderParams
GetSplitterParams(const wxWindow
*win
)
208 { return m_rendererNative
.GetSplitterParams(win
); }
211 wxRendererNative
& m_rendererNative
;
213 DECLARE_NO_COPY_CLASS(wxDelegateRendererNative
)
216 // ----------------------------------------------------------------------------
217 // inline functions implementation
218 // ----------------------------------------------------------------------------
220 #ifndef wxHAS_NATIVE_RENDERER
222 // default native renderer is the generic one then
224 wxRendererNative
& wxRendererNative::GetDefault()
229 #endif // !wxHAS_NATIVE_RENDERER
231 #endif // _WX_RENDERER_H_