Commit | Line | Data |
---|---|---|
9c7f49f5 VZ |
1 | /////////////////////////////////////////////////////////////////////////////// |
2 | // Name: wx/renderer.h | |
3 | // Purpose: wxRendererNative class declaration | |
4 | // Author: Vadim Zeitlin | |
5 | // Modified by: | |
6 | // Created: 20.07.2003 | |
7 | // RCS-ID: $Id$ | |
77ffb593 | 8 | // Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org> |
65571936 | 9 | // Licence: wxWindows licence |
9c7f49f5 VZ |
10 | /////////////////////////////////////////////////////////////////////////////// |
11 | ||
12 | /* | |
77ffb593 | 13 | Renderers are used in wxWidgets for two similar but different things: |
9c7f49f5 VZ |
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 | |
16 | ||
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). | |
23 | */ | |
24 | ||
25 | #ifndef _WX_RENDERER_H_ | |
26 | #define _WX_RENDERER_H_ | |
27 | ||
38c4cb6a | 28 | class WXDLLEXPORT wxDC; |
38c4cb6a VZ |
29 | class WXDLLEXPORT wxWindow; |
30 | ||
7df07b10 MB |
31 | #include "wx/gdicmn.h" // for wxPoint |
32 | ||
f0244295 | 33 | // some platforms have their own renderers, others use the generic one |
82ef81ed | 34 | #if defined(__WXMSW__) || defined(__WXMAC__) || defined(__WXGTK__) |
f0244295 VZ |
35 | #define wxHAS_NATIVE_RENDERER |
36 | #else | |
37 | #undef wxHAS_NATIVE_RENDERER | |
38 | #endif | |
39 | ||
9c7f49f5 VZ |
40 | // ---------------------------------------------------------------------------- |
41 | // constants | |
42 | // ---------------------------------------------------------------------------- | |
43 | ||
44 | // control state flags used in wxRenderer and wxColourScheme | |
45 | enum | |
46 | { | |
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 | |
415a0ff1 | 57 | wxCONTROL_UNDETERMINED = wxCONTROL_CHECKABLE, // (check) undetermined state |
9c7f49f5 VZ |
58 | |
59 | wxCONTROL_FLAGS_MASK = 0x000000ff, | |
60 | ||
61 | // this is a pseudo flag not used directly by wxRenderer but rather by some | |
62 | // controls internally | |
63 | wxCONTROL_DIRTY = 0x80000000 | |
64 | }; | |
65 | ||
af99040c VZ |
66 | // ---------------------------------------------------------------------------- |
67 | // helper structs | |
68 | // ---------------------------------------------------------------------------- | |
69 | ||
70 | // wxSplitterWindow parameters | |
71 | struct WXDLLEXPORT wxSplitterRenderParams | |
72 | { | |
73 | // the only way to initialize this struct is by using this ctor | |
74 | wxSplitterRenderParams(wxCoord widthSash_, wxCoord border_, bool isSens_) | |
75 | : widthSash(widthSash_), border(border_), isHotSensitive(isSens_) | |
76 | { | |
77 | } | |
78 | ||
79 | // the width of the splitter sash | |
80 | const wxCoord widthSash; | |
81 | ||
82 | // the width of the border of the splitter window | |
83 | const wxCoord border; | |
84 | ||
85 | // true if the splitter changes its appearance when the mouse is over it | |
86 | const bool isHotSensitive; | |
87 | }; | |
88 | ||
04857cb7 VZ |
89 | // wxRendererNative interface version |
90 | struct WXDLLEXPORT wxRendererVersion | |
91 | { | |
92 | wxRendererVersion(int version_, int age_) : version(version_), age(age_) { } | |
93 | ||
94 | // default copy ctor, assignment operator and dtor are ok | |
95 | ||
96 | // the current version and age of wxRendererNative interface: different | |
97 | // versions are incompatible (in both ways) while the ages inside the same | |
98 | // version are upwards compatible, i.e. the version of the renderer must | |
99 | // match the version of the main program exactly while the age may be | |
100 | // highergreater or equal to it | |
101 | // | |
102 | // NB: don't forget to increment age after adding any new virtual function! | |
103 | enum | |
104 | { | |
105 | Current_Version = 1, | |
106 | Current_Age = 5 | |
107 | }; | |
108 | ||
109 | ||
110 | // check if the given version is compatible with the current one | |
111 | static bool IsCompatible(const wxRendererVersion& ver) | |
112 | { | |
113 | return ver.version == Current_Version && ver.age >= Current_Age; | |
114 | } | |
115 | ||
116 | const int version; | |
117 | const int age; | |
118 | }; | |
119 | ||
9c7f49f5 VZ |
120 | // ---------------------------------------------------------------------------- |
121 | // wxRendererNative: abstracts drawing methods needed by the native controls | |
122 | // ---------------------------------------------------------------------------- | |
123 | ||
124 | class WXDLLEXPORT wxRendererNative | |
125 | { | |
126 | public: | |
127 | // drawing functions | |
128 | // ----------------- | |
129 | ||
130 | // draw the header control button (used by wxListCtrl) | |
131 | virtual void DrawHeaderButton(wxWindow *win, | |
132 | wxDC& dc, | |
133 | const wxRect& rect, | |
134 | int flags = 0) = 0; | |
135 | ||
136 | // draw the expanded/collapsed icon for a tree control item | |
137 | virtual void DrawTreeItemButton(wxWindow *win, | |
138 | wxDC& dc, | |
139 | const wxRect& rect, | |
140 | int flags = 0) = 0; | |
141 | ||
b3208e11 VZ |
142 | // draw the border for sash window: this border must be such that the sash |
143 | // drawn by DrawSash() blends into it well | |
144 | virtual void DrawSplitterBorder(wxWindow *win, | |
145 | wxDC& dc, | |
af99040c VZ |
146 | const wxRect& rect, |
147 | int flags = 0) = 0; | |
b3208e11 VZ |
148 | |
149 | // draw a (vertical) sash | |
150 | virtual void DrawSplitterSash(wxWindow *win, | |
151 | wxDC& dc, | |
152 | const wxSize& size, | |
62dc9cb4 | 153 | wxCoord position, |
af99040c VZ |
154 | wxOrientation orient, |
155 | int flags = 0) = 0; | |
b3208e11 | 156 | |
f33cef9f VZ |
157 | // draw a combobox dropdown button |
158 | // | |
159 | // flags may only use wxCONTROL_PRESSED | |
160 | virtual void DrawComboBoxDropButton(wxWindow *win, | |
161 | wxDC& dc, | |
162 | const wxRect& rect, | |
163 | int flags = 0) = 0; | |
164 | ||
b3208e11 VZ |
165 | |
166 | // geometry functions | |
167 | // ------------------ | |
168 | ||
169 | // get the splitter parameters: the x field of the returned point is the | |
170 | // sash width and the y field is the border width | |
af99040c | 171 | virtual wxSplitterRenderParams GetSplitterParams(const wxWindow *win) = 0; |
b3208e11 | 172 | |
9c7f49f5 VZ |
173 | |
174 | // pseudo constructors | |
175 | // ------------------- | |
176 | ||
177 | // return the currently used renderer | |
178 | static wxRendererNative& Get(); | |
179 | ||
180 | // return the generic implementation of the renderer | |
181 | static wxRendererNative& GetGeneric(); | |
f0244295 VZ |
182 | |
183 | // return the default (native) implementation for this platform | |
184 | static wxRendererNative& GetDefault(); | |
9f2be125 VZ |
185 | |
186 | ||
187 | // changing the global renderer | |
188 | // ---------------------------- | |
189 | ||
190 | #if wxUSE_DYNLIB_CLASS | |
191 | // load the renderer from the specified DLL, the returned pointer must be | |
192 | // deleted by caller if not NULL when it is not used any more | |
193 | static wxRendererNative *Load(const wxString& name); | |
194 | #endif // wxUSE_DYNLIB_CLASS | |
195 | ||
196 | // set the renderer to use, passing NULL reverts to using the default | |
197 | // renderer | |
198 | // | |
199 | // return the previous renderer used with Set() or NULL if none | |
200 | static wxRendererNative *Set(wxRendererNative *renderer); | |
04857cb7 VZ |
201 | |
202 | ||
203 | // miscellaneous stuff | |
204 | // ------------------- | |
205 | ||
206 | // this function is used for version checking: Load() refuses to load any | |
207 | // DLLs implementing an older or incompatible version; it should be | |
208 | // implemented simply by returning wxRendererVersion::Current_XXX values | |
209 | virtual wxRendererVersion GetVersion() const = 0; | |
210 | ||
211 | // virtual dtor for any base class | |
212 | virtual ~wxRendererNative(); | |
9c7f49f5 VZ |
213 | }; |
214 | ||
215 | // ---------------------------------------------------------------------------- | |
216 | // wxDelegateRendererNative: allows reuse of renderers code | |
217 | // ---------------------------------------------------------------------------- | |
218 | ||
219 | class WXDLLEXPORT wxDelegateRendererNative : public wxRendererNative | |
220 | { | |
221 | public: | |
222 | wxDelegateRendererNative() | |
223 | : m_rendererNative(GetGeneric()) { } | |
224 | ||
225 | wxDelegateRendererNative(wxRendererNative& rendererNative) | |
226 | : m_rendererNative(rendererNative) { } | |
227 | ||
228 | ||
229 | virtual void DrawHeaderButton(wxWindow *win, | |
230 | wxDC& dc, | |
231 | const wxRect& rect, | |
232 | int flags = 0) | |
233 | { m_rendererNative.DrawHeaderButton(win, dc, rect, flags); } | |
b3208e11 | 234 | |
9c7f49f5 VZ |
235 | virtual void DrawTreeItemButton(wxWindow *win, |
236 | wxDC& dc, | |
237 | const wxRect& rect, | |
238 | int flags = 0) | |
239 | { m_rendererNative.DrawTreeItemButton(win, dc, rect, flags); } | |
240 | ||
b3208e11 VZ |
241 | virtual void DrawSplitterBorder(wxWindow *win, |
242 | wxDC& dc, | |
af99040c VZ |
243 | const wxRect& rect, |
244 | int flags = 0) | |
2c0e6de1 | 245 | { m_rendererNative.DrawSplitterBorder(win, dc, rect, flags); } |
b3208e11 VZ |
246 | |
247 | virtual void DrawSplitterSash(wxWindow *win, | |
248 | wxDC& dc, | |
249 | const wxSize& size, | |
62dc9cb4 | 250 | wxCoord position, |
af99040c VZ |
251 | wxOrientation orient, |
252 | int flags = 0) | |
2c0e6de1 VZ |
253 | { m_rendererNative.DrawSplitterSash(win, dc, size, |
254 | position, orient, flags); } | |
b3208e11 | 255 | |
f33cef9f VZ |
256 | virtual void DrawComboBoxDropButton(wxWindow *win, |
257 | wxDC& dc, | |
258 | const wxRect& rect, | |
259 | int flags = 0) | |
260 | { m_rendererNative.DrawComboBoxDropButton(win, dc, rect, flags); } | |
261 | ||
b3208e11 | 262 | |
af99040c VZ |
263 | virtual wxSplitterRenderParams GetSplitterParams(const wxWindow *win) |
264 | { return m_rendererNative.GetSplitterParams(win); } | |
b3208e11 | 265 | |
04857cb7 VZ |
266 | virtual wxRendererVersion GetVersion() const |
267 | { return m_rendererNative.GetVersion(); } | |
268 | ||
9c7f49f5 VZ |
269 | protected: |
270 | wxRendererNative& m_rendererNative; | |
fc7a2a60 VZ |
271 | |
272 | DECLARE_NO_COPY_CLASS(wxDelegateRendererNative) | |
9c7f49f5 VZ |
273 | }; |
274 | ||
f0244295 VZ |
275 | // ---------------------------------------------------------------------------- |
276 | // inline functions implementation | |
277 | // ---------------------------------------------------------------------------- | |
278 | ||
279 | #ifndef wxHAS_NATIVE_RENDERER | |
280 | ||
281 | // default native renderer is the generic one then | |
282 | /* static */ inline | |
283 | wxRendererNative& wxRendererNative::GetDefault() | |
284 | { | |
285 | return GetGeneric(); | |
286 | } | |
287 | ||
288 | #endif // !wxHAS_NATIVE_RENDERER | |
289 | ||
9c7f49f5 VZ |
290 | #endif // _WX_RENDERER_H_ |
291 |