]>
Commit | Line | Data |
---|---|---|
1c4293cb VZ |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: wx/propgrid/propgriddefs.h | |
3 | // Purpose: wxPropertyGrid miscellaneous definitions | |
4 | // Author: Jaakko Salli | |
5 | // Modified by: | |
6 | // Created: 2008-08-31 | |
ea5af9c5 | 7 | // RCS-ID: $Id$ |
1c4293cb VZ |
8 | // Copyright: (c) Jaakko Salli |
9 | // Licence: wxWindows license | |
10 | ///////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_PROPGRID_PROPGRIDDEFS_H_ | |
13 | #define _WX_PROPGRID_PROPGRIDDEFS_H_ | |
14 | ||
f4bc1aa2 JS |
15 | #if wxUSE_PROPGRID |
16 | ||
1c4293cb | 17 | #include "wx/dynarray.h" |
f7a094e1 | 18 | #include "wx/vector.h" |
1c4293cb VZ |
19 | #include "wx/hashmap.h" |
20 | #include "wx/variant.h" | |
21 | #include "wx/longlong.h" | |
22 | #include "wx/clntdata.h" | |
23 | ||
24 | // ----------------------------------------------------------------------- | |
25 | ||
26 | // | |
27 | // Here are some platform dependent defines | |
28 | // NOTE: More in propertygrid.cpp | |
29 | // | |
30 | ||
31 | #ifndef SWIG | |
32 | ||
33 | #if defined(__WXMSW__) | |
34 | ||
35 | // space between vertical line and value text | |
36 | #define wxPG_XBEFORETEXT 4 | |
37 | // space between vertical line and value editor control | |
38 | #define wxPG_XBEFOREWIDGET 1 | |
39 | ||
40 | // x position adjustment for wxTextCtrl (and like) | |
41 | #define wxPG_TEXTCTRLXADJUST 3 | |
42 | ||
43 | // comment to use bitmap buttons | |
44 | #define wxPG_ICON_WIDTH 9 | |
45 | // 1 if wxRendererNative should be employed | |
46 | #define wxPG_USE_RENDERER_NATIVE 0 | |
47 | ||
48 | // 1 to use double-buffer that guarantees flicker-free painting | |
49 | #define wxPG_DOUBLE_BUFFER 1 | |
50 | ||
51 | // Enable tooltips | |
52 | #define wxPG_SUPPORT_TOOLTIPS 1 | |
53 | ||
54 | // width of optional bitmap/image in front of property | |
55 | #define wxPG_CUSTOM_IMAGE_WIDTH 20 | |
56 | ||
57 | // 1 to create controls out of sight, hide them, and then move them into | |
58 | // correct position | |
59 | #define wxPG_CREATE_CONTROLS_HIDDEN 0 | |
60 | ||
61 | // 1 if splitter drag detect margin and control cannot overlap | |
62 | #define wxPG_NO_CHILD_EVT_MOTION 0 | |
63 | ||
64 | // If 1, then setting empty tooltip actually hides it | |
65 | #define wxPG_ALLOW_EMPTY_TOOLTIPS 1 | |
66 | ||
67 | #define wxPG_NAT_BUTTON_BORDER_ANY 1 | |
68 | #define wxPG_NAT_BUTTON_BORDER_X 1 | |
69 | #define wxPG_NAT_BUTTON_BORDER_Y 1 | |
70 | ||
71 | // If 1 then controls are refreshed after selected was drawn. | |
72 | #define wxPG_REFRESH_CONTROLS_AFTER_REPAINT 0 | |
73 | ||
74 | #elif defined(__WXGTK__) | |
75 | ||
76 | // space between vertical line and value text | |
77 | #define wxPG_XBEFORETEXT 5 | |
78 | // space between vertical line and value editor control | |
79 | #define wxPG_XBEFOREWIDGET 1 | |
80 | ||
81 | // x position adjustment for wxTextCtrl (and like) | |
82 | #define wxPG_TEXTCTRLXADJUST 3 | |
83 | ||
84 | // comment to use bitmap buttons | |
85 | #define wxPG_ICON_WIDTH 9 | |
86 | // 1 if wxRendererNative should be employed | |
9861dc94 | 87 | #define wxPG_USE_RENDERER_NATIVE 1 |
1c4293cb VZ |
88 | |
89 | // 1 to use double-buffer that guarantees flicker-free painting | |
90 | #define wxPG_DOUBLE_BUFFER 1 | |
91 | ||
92 | // Enable tooltips | |
93 | #define wxPG_SUPPORT_TOOLTIPS 1 | |
94 | ||
95 | // width of optional bitmap/image in front of property | |
96 | #define wxPG_CUSTOM_IMAGE_WIDTH 20 | |
97 | ||
98 | // 1 to create controls out of sight, hide them, and then move them into | |
99 | // correct position | |
100 | #define wxPG_CREATE_CONTROLS_HIDDEN 0 | |
101 | ||
102 | // 1 if splitter drag detect margin and control cannot overlap | |
103 | #define wxPG_NO_CHILD_EVT_MOTION 1 | |
104 | ||
105 | // If 1, then setting empty tooltip actually hides it | |
106 | #define wxPG_ALLOW_EMPTY_TOOLTIPS 0 | |
107 | ||
108 | #define wxPG_NAT_BUTTON_BORDER_ANY 1 | |
109 | #define wxPG_NAT_BUTTON_BORDER_X 1 | |
110 | #define wxPG_NAT_BUTTON_BORDER_Y 1 | |
111 | ||
112 | // If 1 then controls are refreshed after selected was drawn. | |
113 | #define wxPG_REFRESH_CONTROLS_AFTER_REPAINT 1 | |
114 | ||
115 | #elif defined(__WXMAC__) | |
116 | ||
117 | // space between vertical line and value text | |
118 | #define wxPG_XBEFORETEXT 4 | |
119 | // space between vertical line and value editor widget | |
120 | #define wxPG_XBEFOREWIDGET 1 | |
121 | ||
122 | // x position adjustment for wxTextCtrl (and like) | |
012b4a07 | 123 | #define wxPG_TEXTCTRLXADJUST 0 |
1c4293cb VZ |
124 | |
125 | // comment to use bitmap buttons | |
126 | #define wxPG_ICON_WIDTH 11 | |
127 | // 1 if wxRendererNative should be employed | |
128 | #define wxPG_USE_RENDERER_NATIVE 1 | |
129 | ||
130 | // 1 to use double-buffer that guarantees flicker-free painting | |
131 | #define wxPG_DOUBLE_BUFFER 0 | |
132 | ||
133 | // Enable tooltips | |
134 | #define wxPG_SUPPORT_TOOLTIPS 1 | |
135 | ||
136 | // width of optional bitmap/image in front of property | |
137 | #define wxPG_CUSTOM_IMAGE_WIDTH 20 | |
138 | ||
139 | // 1 to create controls out of sight, hide them, and then move them into | |
140 | // correct position | |
141 | #define wxPG_CREATE_CONTROLS_HIDDEN 0 | |
142 | ||
143 | // 1 if splitter drag detect margin and control cannot overlap | |
144 | #define wxPG_NO_CHILD_EVT_MOTION 0 | |
145 | ||
146 | // If 1, then setting empty tooltip actually hides it | |
147 | #define wxPG_ALLOW_EMPTY_TOOLTIPS 1 | |
148 | ||
149 | #define wxPG_NAT_BUTTON_BORDER_ANY 0 | |
150 | #define wxPG_NAT_BUTTON_BORDER_X 0 | |
151 | #define wxPG_NAT_BUTTON_BORDER_Y 0 | |
152 | ||
153 | // If 1 then controls are refreshed after selected was drawn. | |
154 | #define wxPG_REFRESH_CONTROLS_AFTER_REPAINT 0 | |
155 | ||
156 | #else // defaults | |
157 | ||
158 | // space between vertical line and value text | |
159 | #define wxPG_XBEFORETEXT 5 | |
160 | // space between vertical line and value editor widget | |
161 | #define wxPG_XBEFOREWIDGET 1 | |
162 | ||
163 | // x position adjustment for wxTextCtrl (and like) | |
164 | #define wxPG_TEXTCTRLXADJUST 3 | |
165 | ||
166 | // comment to use bitmap buttons | |
167 | #define wxPG_ICON_WIDTH 9 | |
168 | // 1 if wxRendererNative should be employed | |
169 | #define wxPG_USE_RENDERER_NATIVE 0 | |
170 | ||
171 | // 1 to use double-buffer that guarantees flicker-free painting | |
172 | #define wxPG_DOUBLE_BUFFER 0 | |
173 | ||
174 | // Enable tooltips | |
175 | #define wxPG_SUPPORT_TOOLTIPS 0 | |
176 | ||
177 | // width of optional bitmap/image in front of property | |
178 | #define wxPG_CUSTOM_IMAGE_WIDTH 20 | |
179 | ||
180 | // 1 to create controls out of sight, hide them, and then move them into | |
181 | // correct position | |
182 | #define wxPG_CREATE_CONTROLS_HIDDEN 0 | |
183 | ||
184 | // 1 if splitter drag detect margin and control cannot overlap | |
185 | #define wxPG_NO_CHILD_EVT_MOTION 1 | |
186 | ||
187 | // If 1, then setting empty tooltip actually hides it | |
188 | #define wxPG_ALLOW_EMPTY_TOOLTIPS 0 | |
189 | ||
190 | #define wxPG_NAT_BUTTON_BORDER_ANY 0 | |
191 | #define wxPG_NAT_BUTTON_BORDER_X 0 | |
192 | #define wxPG_NAT_BUTTON_BORDER_Y 0 | |
193 | ||
194 | // If 1 then controls are refreshed after selected was drawn. | |
195 | #define wxPG_REFRESH_CONTROLS_AFTER_REPAINT 1 | |
196 | #endif // platform | |
197 | ||
198 | ||
199 | #define wxPG_CONTROL_MARGIN 0 // space between splitter and control | |
200 | ||
201 | #define wxCC_CUSTOM_IMAGE_MARGIN1 4 // before image | |
202 | #define wxCC_CUSTOM_IMAGE_MARGIN2 5 // after image | |
203 | ||
204 | #define wxPG_DRAG_MARGIN 30 | |
205 | ||
206 | #if wxPG_NO_CHILD_EVT_MOTION | |
207 | #define wxPG_SPLITTERX_DETECTMARGIN1 3 // this much on left | |
208 | #define wxPG_SPLITTERX_DETECTMARGIN2 2 // this much on right | |
209 | #else | |
210 | #define wxPG_SPLITTERX_DETECTMARGIN1 3 // this much on left | |
211 | #define wxPG_SPLITTERX_DETECTMARGIN2 2 // this much on right | |
212 | #endif | |
213 | ||
214 | // Use this macro to generate standard custom image height from | |
215 | #define wxPG_STD_CUST_IMAGE_HEIGHT(LINEHEIGHT) (LINEHEIGHT-3) | |
216 | ||
217 | ||
218 | #if defined(__WXWINCE__) | |
219 | #define wxPG_SMALL_SCREEN 1 | |
220 | #undef wxPG_DOUBLE_BUFFER | |
221 | #define wxPG_DOUBLE_BUFFER 0 | |
222 | #else | |
223 | #define wxPG_SMALL_SCREEN 0 | |
224 | #endif | |
225 | ||
226 | #endif // #ifndef SWIG | |
227 | ||
228 | // Undefine wxPG_ICON_WIDTH to use supplied xpm bitmaps instead | |
229 | // (for tree buttons) | |
230 | //#undef wxPG_ICON_WIDTH | |
231 | ||
1425eca5 JS |
232 | #if WXWIN_COMPATIBILITY_2_6 || WXWIN_COMPATIBILITY_2_8 |
233 | #define wxPG_COMPATIBILITY_1_4 1 | |
234 | #else | |
235 | #define wxPG_COMPATIBILITY_1_4 0 | |
236 | #endif | |
237 | ||
1c4293cb VZ |
238 | // Need to force disable tooltips? |
239 | #if !wxUSE_TOOLTIPS | |
240 | #undef wxPG_SUPPORT_TOOLTIPS | |
241 | #define wxPG_SUPPORT_TOOLTIPS 0 | |
242 | #endif | |
243 | ||
244 | // Set 1 to include advanced properties (wxFontProperty, wxColourProperty, etc.) | |
245 | #ifndef wxPG_INCLUDE_ADVPROPS | |
246 | #define wxPG_INCLUDE_ADVPROPS 1 | |
247 | #endif | |
248 | ||
249 | // Set 1 to include checkbox editor class | |
250 | #define wxPG_INCLUDE_CHECKBOX 1 | |
251 | ||
252 | // ----------------------------------------------------------------------- | |
253 | ||
254 | ||
1c4293cb VZ |
255 | class wxPGEditor; |
256 | class wxPGProperty; | |
257 | class wxPropertyCategory; | |
258 | class wxPGChoices; | |
259 | class wxPropertyGridPageState; | |
260 | class wxPGCell; | |
261 | class wxPGCellRenderer; | |
262 | class wxPGChoiceEntry; | |
263 | class wxPGPropArgCls; | |
264 | class wxPropertyGridInterface; | |
265 | class wxPropertyGrid; | |
266 | class wxPropertyGridEvent; | |
267 | class wxPropertyGridManager; | |
268 | class wxPGOwnerDrawnComboBox; | |
1c4293cb | 269 | class wxPGEditorDialogAdapter; |
2a8312bc | 270 | class wxPGValidationInfo; |
1c4293cb VZ |
271 | |
272 | ||
273 | // ----------------------------------------------------------------------- | |
274 | ||
275 | /** @section propgrid_misc wxPropertyGrid Miscellanous | |
276 | ||
277 | This section describes some miscellanous values, types and macros. | |
278 | @{ | |
279 | */ | |
280 | ||
281 | #ifndef SWIG | |
282 | // Used to tell wxPGProperty to use label as name as well | |
283 | #define wxPG_LABEL (*wxPGProperty::sm_wxPG_LABEL) | |
284 | // This is the value placed in wxPGProperty::sm_wxPG_LABEL | |
285 | #define wxPG_LABEL_STRING wxS("@!") | |
286 | #define wxPG_NULL_BITMAP wxNullBitmap | |
287 | #define wxPG_COLOUR_BLACK (*wxBLACK) | |
288 | #else | |
289 | #define wxPG_NULL_BITMAP wxBitmap_NULL | |
290 | #define wxPG_COLOUR_BLACK wxColour_BLACK | |
291 | #endif // #ifndef SWIG | |
292 | ||
293 | /** Convert Red, Green and Blue to a single 32-bit value. | |
294 | */ | |
295 | #define wxPG_COLOUR(R,G,B) ((wxUint32)(R+(G<<8)+(B<<16))) | |
296 | ||
297 | ||
298 | /** If property is supposed to have custom-painted image, then returning | |
299 | this in OnMeasureImage() will usually be enough. | |
300 | */ | |
301 | #define wxPG_DEFAULT_IMAGE_SIZE wxSize(-1, -1) | |
302 | ||
303 | ||
304 | typedef wxString wxPGCachedString; | |
305 | ||
306 | /** @} | |
307 | */ | |
308 | ||
309 | // ----------------------------------------------------------------------- | |
310 | ||
311 | // Used to indicate wxPGChoices::Add etc that the value is actually not given | |
312 | // by the caller. | |
313 | #define wxPG_INVALID_VALUE INT_MAX | |
314 | ||
315 | // ----------------------------------------------------------------------- | |
316 | ||
317 | #ifndef SWIG | |
318 | ||
319 | #if wxUSE_STL | |
4a84bb72 | 320 | typedef std::vector<wxPGProperty*> wxArrayPGProperty; |
1c4293cb VZ |
321 | #else |
322 | WX_DEFINE_TYPEARRAY_WITH_DECL_PTR(wxPGProperty*, wxArrayPGProperty, | |
323 | wxBaseArrayPtrVoid, | |
324 | class WXDLLIMPEXP_PROPGRID); | |
325 | #endif | |
326 | ||
327 | // Always use wxString based hashmap with unicode, stl, swig and GCC 4.0+ | |
328 | WX_DECLARE_STRING_HASH_MAP_WITH_DECL(void*, | |
329 | wxPGHashMapS2P, | |
330 | class WXDLLIMPEXP_PROPGRID); | |
331 | ||
1425eca5 JS |
332 | WX_DECLARE_STRING_HASH_MAP_WITH_DECL(wxString, |
333 | wxPGHashMapS2S, | |
334 | class WXDLLIMPEXP_PROPGRID); | |
335 | ||
1c4293cb VZ |
336 | WX_DECLARE_VOIDPTR_HASH_MAP_WITH_DECL(void*, |
337 | wxPGHashMapP2P, | |
338 | class WXDLLIMPEXP_PROPGRID); | |
339 | ||
340 | WX_DECLARE_HASH_MAP_WITH_DECL(wxInt32, | |
341 | wxInt32, | |
342 | wxIntegerHash, | |
343 | wxIntegerEqual, | |
344 | wxPGHashMapI2I, | |
345 | class WXDLLIMPEXP_PROPGRID); | |
346 | ||
347 | #endif // #ifndef SWIG | |
348 | ||
349 | // ----------------------------------------------------------------------- | |
350 | ||
351 | enum wxPG_GETPROPERTYVALUES_FLAGS | |
352 | { | |
353 | ||
354 | /** Flags for wxPropertyGridInterface::GetPropertyValues */ | |
355 | wxPG_KEEP_STRUCTURE = 0x00000010, | |
356 | ||
357 | /** Flags for wxPropertyGrid::SetPropertyAttribute() etc */ | |
358 | wxPG_RECURSE = 0x00000020, | |
359 | ||
360 | /** Include attributes for GetPropertyValues. */ | |
361 | wxPG_INC_ATTRIBUTES = 0x00000040, | |
362 | ||
363 | /** Used when first starting recursion. */ | |
364 | wxPG_RECURSE_STARTS = 0x00000080, | |
365 | ||
366 | /** Force value change. */ | |
367 | wxPG_FORCE = 0x00000100 | |
368 | ||
369 | }; | |
370 | ||
371 | /** Flags for wxPropertyGrid::SetPropertyAttribute() etc */ | |
372 | #define wxPG_DONT_RECURSE 0x00000000 | |
373 | ||
374 | // ----------------------------------------------------------------------- | |
375 | ||
376 | // Misc argument flags. | |
377 | enum wxPG_MISC_ARG_FLAGS | |
378 | { | |
379 | // Get/Store full value instead of displayed value. | |
380 | wxPG_FULL_VALUE = 0x00000001, | |
381 | ||
382 | wxPG_REPORT_ERROR = 0x00000002, | |
383 | ||
384 | wxPG_PROPERTY_SPECIFIC = 0x00000004, | |
385 | ||
386 | // Get/Store editable value instead of displayed one (should only be | |
387 | // different in the case of common values) | |
388 | wxPG_EDITABLE_VALUE = 0x00000008, | |
389 | ||
390 | // Used when dealing with fragments of composite string value | |
391 | wxPG_COMPOSITE_FRAGMENT = 0x00000010, | |
392 | ||
393 | // Means property for which final string value is for can not really be | |
394 | // edited. | |
1425eca5 JS |
395 | wxPG_UNEDITABLE_COMPOSITE_FRAGMENT = 0x00000020, |
396 | ||
397 | // ValueToString() called from GetValueAsString() | |
398 | // (guarantees that input wxVariant value is current own value) | |
f275b5db JS |
399 | wxPG_VALUE_IS_CURRENT = 0x00000040, |
400 | ||
401 | // Value is being set programmatically (ie. not by user) | |
402 | wxPG_PROGRAMMATIC_VALUE = 0x00000080 | |
1c4293cb VZ |
403 | }; |
404 | ||
405 | // ----------------------------------------------------------------------- | |
406 | ||
407 | // wxPGProperty::SetValue() flags | |
408 | enum wxPG_SETVALUE_FLAGS | |
409 | { | |
410 | wxPG_SETVAL_REFRESH_EDITOR = 0x0001, | |
411 | wxPG_SETVAL_AGGREGATED = 0x0002, | |
8f18b252 JS |
412 | wxPG_SETVAL_FROM_PARENT = 0x0004, |
413 | wxPG_SETVAL_BY_USER = 0x0008 // Set if value changed by user | |
1c4293cb VZ |
414 | }; |
415 | ||
416 | // ----------------------------------------------------------------------- | |
417 | ||
418 | // | |
419 | // Valid constants for wxPG_UINT_BASE attribute | |
420 | // (long because of wxVariant constructor) | |
421 | #define wxPG_BASE_OCT (long)8 | |
422 | #define wxPG_BASE_DEC (long)10 | |
423 | #define wxPG_BASE_HEX (long)16 | |
424 | #define wxPG_BASE_HEXL (long)32 | |
425 | ||
426 | // | |
427 | // Valid constants for wxPG_UINT_PREFIX attribute | |
428 | #define wxPG_PREFIX_NONE (long)0 | |
429 | #define wxPG_PREFIX_0x (long)1 | |
430 | #define wxPG_PREFIX_DOLLAR_SIGN (long)2 | |
431 | ||
432 | // ----------------------------------------------------------------------- | |
433 | // Editor class. | |
434 | ||
435 | #ifndef SWIG | |
436 | ||
c26873c8 | 437 | // Editor accessor (for backwards compatiblity use only). |
1c4293cb VZ |
438 | #define wxPG_EDITOR(T) wxPGEditor_##T |
439 | ||
440 | // Declare editor class, with optional part. | |
441 | #define WX_PG_DECLARE_EDITOR_WITH_DECL(EDITOR,DECL) \ | |
442 | extern DECL wxPGEditor* wxPGEditor_##EDITOR; \ | |
443 | extern DECL wxPGEditor* wxPGConstruct##EDITOR##EditorClass(); | |
444 | ||
445 | // Declare editor class. | |
446 | #define WX_PG_DECLARE_EDITOR(EDITOR) \ | |
447 | extern wxPGEditor* wxPGEditor_##EDITOR; \ | |
448 | extern wxPGEditor* wxPGConstruct##EDITOR##EditorClass(); | |
449 | ||
450 | // Declare builtin editor classes. | |
451 | WX_PG_DECLARE_EDITOR_WITH_DECL(TextCtrl,WXDLLIMPEXP_PROPGRID) | |
452 | WX_PG_DECLARE_EDITOR_WITH_DECL(Choice,WXDLLIMPEXP_PROPGRID) | |
453 | WX_PG_DECLARE_EDITOR_WITH_DECL(ComboBox,WXDLLIMPEXP_PROPGRID) | |
454 | WX_PG_DECLARE_EDITOR_WITH_DECL(TextCtrlAndButton,WXDLLIMPEXP_PROPGRID) | |
455 | #if wxPG_INCLUDE_CHECKBOX | |
456 | WX_PG_DECLARE_EDITOR_WITH_DECL(CheckBox,WXDLLIMPEXP_PROPGRID) | |
457 | #endif | |
458 | WX_PG_DECLARE_EDITOR_WITH_DECL(ChoiceAndButton,WXDLLIMPEXP_PROPGRID) | |
459 | ||
460 | #endif // !SWIG | |
461 | ||
462 | // ----------------------------------------------------------------------- | |
463 | ||
464 | #ifndef SWIG | |
465 | ||
1c4293cb VZ |
466 | // |
467 | // Macro WXVARIANT allows creation of wxVariant from any type supported by | |
468 | // wxWidgets internally, and of all types created using | |
469 | // WX_PG_DECLARE_VARIANT_DATA. | |
470 | template<class T> | |
0372d42e | 471 | wxVariant WXVARIANT( const T& WXUNUSED(value) ) |
1c4293cb | 472 | { |
0372d42e JS |
473 | wxFAIL_MSG("Code should always call specializations of this template"); |
474 | return wxVariant(); | |
1c4293cb VZ |
475 | } |
476 | ||
477 | template<> inline wxVariant WXVARIANT( const int& value ) | |
478 | { return wxVariant((long)value); } | |
479 | template<> inline wxVariant WXVARIANT( const long& value ) | |
480 | { return wxVariant(value); } | |
481 | template<> inline wxVariant WXVARIANT( const bool& value ) | |
482 | { return wxVariant(value); } | |
483 | template<> inline wxVariant WXVARIANT( const double& value ) | |
484 | { return wxVariant(value); } | |
485 | template<> inline wxVariant WXVARIANT( const wxArrayString& value ) | |
486 | { return wxVariant(value); } | |
487 | template<> inline wxVariant WXVARIANT( const wxString& value ) | |
488 | { return wxVariant(value); } | |
489 | #if wxUSE_DATETIME | |
490 | template<> inline wxVariant WXVARIANT( const wxDateTime& value ) | |
491 | { return wxVariant(value); } | |
492 | #endif | |
493 | ||
0372d42e JS |
494 | |
495 | // | |
496 | // These are modified versions of DECLARE/WX_PG_IMPLEMENT_VARIANT_DATA | |
497 | // macros found in variant.h. Difference are as follows: | |
498 | // * These support non-wxObject data | |
499 | // * These implement classname##RefFromVariant function which returns | |
500 | // reference to data within. | |
501 | // * const char* classname##_VariantType which equals classname. | |
502 | // * WXVARIANT | |
503 | // | |
504 | #define WX_PG_DECLARE_VARIANT_DATA(classname) \ | |
505 | WX_PG_DECLARE_VARIANT_DATA_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE) | |
506 | ||
507 | #define WX_PG_DECLARE_VARIANT_DATA_EXPORTED(classname,expdecl) \ | |
508 | expdecl classname& operator << ( classname &object, const wxVariant &variant ); \ | |
509 | expdecl wxVariant& operator << ( wxVariant &variant, const classname &object ); \ | |
510 | expdecl const classname& classname##RefFromVariant( const wxVariant& variant ); \ | |
511 | expdecl classname& classname##RefFromVariant( wxVariant& variant ); \ | |
512 | template<> inline wxVariant WXVARIANT( const classname& value ) \ | |
1c4293cb | 513 | { \ |
0372d42e JS |
514 | wxVariant variant; \ |
515 | variant << value; \ | |
516 | return variant; \ | |
1c4293cb | 517 | } \ |
0372d42e JS |
518 | extern expdecl const char* classname##_VariantType; |
519 | ||
520 | ||
521 | #define WX_PG_IMPLEMENT_VARIANT_DATA(classname) \ | |
522 | WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE) | |
523 | ||
a6162a3e JS |
524 | // Add getter (ie. classname << variant) separately to allow |
525 | // custom implementations. | |
526 | #define WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_NO_EQ_NO_GETTER(classname,expdecl) \ | |
0372d42e JS |
527 | const char* classname##_VariantType = #classname; \ |
528 | class classname##VariantData: public wxVariantData \ | |
1c4293cb | 529 | { \ |
0372d42e JS |
530 | public:\ |
531 | classname##VariantData() {} \ | |
532 | classname##VariantData( const classname &value ) { m_value = value; } \ | |
533 | \ | |
534 | classname &GetValue() { return m_value; } \ | |
a48fcef3 JS |
535 | \ |
536 | const classname &GetValue() const { return m_value; } \ | |
0372d42e JS |
537 | \ |
538 | virtual bool Eq(wxVariantData& data) const; \ | |
539 | \ | |
540 | virtual wxString GetType() const; \ | |
541 | \ | |
542 | virtual wxVariantData* Clone() const { return new classname##VariantData(m_value); } \ | |
0372d42e JS |
543 | \ |
544 | protected:\ | |
545 | classname m_value; \ | |
546 | };\ | |
547 | \ | |
548 | wxString classname##VariantData::GetType() const\ | |
549 | {\ | |
550 | return wxS(#classname);\ | |
551 | }\ | |
552 | \ | |
0372d42e JS |
553 | expdecl wxVariant& operator << ( wxVariant &variant, const classname &value )\ |
554 | {\ | |
555 | classname##VariantData *data = new classname##VariantData( value );\ | |
556 | variant.SetData( data );\ | |
557 | return variant;\ | |
1c4293cb | 558 | } \ |
0372d42e | 559 | expdecl classname& classname##RefFromVariant( wxVariant& variant ) \ |
1c4293cb | 560 | { \ |
0372d42e JS |
561 | wxASSERT( variant.GetType() == #classname );\ |
562 | classname##VariantData *data = (classname##VariantData*) variant.GetData();\ | |
a48fcef3 | 563 | return data->GetValue();\ |
1c4293cb | 564 | } \ |
0372d42e | 565 | expdecl const classname& classname##RefFromVariant( const wxVariant& variant ) \ |
1c4293cb | 566 | { \ |
0372d42e JS |
567 | wxASSERT( variant.GetType() == #classname );\ |
568 | classname##VariantData *data = (classname##VariantData*) variant.GetData();\ | |
a48fcef3 | 569 | return data->GetValue();\ |
0372d42e JS |
570 | } |
571 | ||
a6162a3e JS |
572 | #define WX_PG_IMPLEMENT_VARIANT_DATA_GETTER(classname, expdecl) \ |
573 | expdecl classname& operator << ( classname &value, const wxVariant &variant )\ | |
574 | {\ | |
575 | wxASSERT( variant.GetType() == #classname );\ | |
576 | \ | |
577 | classname##VariantData *data = (classname##VariantData*) variant.GetData();\ | |
578 | value = data->GetValue();\ | |
579 | return value;\ | |
580 | } | |
581 | ||
582 | #define WX_PG_IMPLEMENT_VARIANT_DATA_EQ(classname, expdecl) \ | |
0372d42e JS |
583 | bool classname##VariantData::Eq(wxVariantData& data) const \ |
584 | {\ | |
585 | wxASSERT( GetType() == data.GetType() );\ | |
586 | \ | |
587 | classname##VariantData & otherData = (classname##VariantData &) data;\ | |
588 | \ | |
589 | return otherData.m_value == m_value;\ | |
590 | } | |
591 | ||
a6162a3e JS |
592 | // implements a wxVariantData-derived class using for the Eq() method the |
593 | // operator== which must have been provided by "classname" | |
594 | #define WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED(classname,expdecl) \ | |
595 | WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_NO_EQ_NO_GETTER(classname,wxEMPTY_PARAMETER_VALUE expdecl) \ | |
596 | WX_PG_IMPLEMENT_VARIANT_DATA_GETTER(classname,wxEMPTY_PARAMETER_VALUE expdecl) \ | |
597 | WX_PG_IMPLEMENT_VARIANT_DATA_EQ(classname,wxEMPTY_PARAMETER_VALUE expdecl) | |
598 | ||
0372d42e JS |
599 | #define WX_PG_IMPLEMENT_VARIANT_DATA(classname) \ |
600 | WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE) | |
601 | ||
602 | // with Eq() implementation that always returns false | |
603 | #define WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_DUMMY_EQ(classname,expdecl) \ | |
a6162a3e JS |
604 | WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_NO_EQ_NO_GETTER(classname,wxEMPTY_PARAMETER_VALUE expdecl) \ |
605 | WX_PG_IMPLEMENT_VARIANT_DATA_GETTER(classname,wxEMPTY_PARAMETER_VALUE expdecl) \ | |
0372d42e JS |
606 | \ |
607 | bool classname##VariantData::Eq(wxVariantData& WXUNUSED(data)) const \ | |
608 | {\ | |
609 | return false; \ | |
610 | } | |
611 | ||
612 | #define WX_PG_IMPLEMENT_VARIANT_DATA_DUMMY_EQ(classname) \ | |
613 | WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_DUMMY_EQ(classname, wxEMPTY_PARAMETER_VALUE) | |
614 | ||
615 | WX_PG_DECLARE_VARIANT_DATA_EXPORTED(wxPoint, WXDLLIMPEXP_PROPGRID) | |
616 | WX_PG_DECLARE_VARIANT_DATA_EXPORTED(wxSize, WXDLLIMPEXP_PROPGRID) | |
617 | WX_PG_DECLARE_VARIANT_DATA_EXPORTED(wxArrayInt, WXDLLIMPEXP_PROPGRID) | |
618 | WX_PG_DECLARE_VARIANT_DATA_EXPORTED(wxLongLong, WXDLLIMPEXP_PROPGRID) | |
619 | WX_PG_DECLARE_VARIANT_DATA_EXPORTED(wxULongLong, WXDLLIMPEXP_PROPGRID) | |
620 | DECLARE_VARIANT_OBJECT_EXPORTED(wxFont, WXDLLIMPEXP_PROPGRID) | |
621 | template<> inline wxVariant WXVARIANT( const wxFont& value ) | |
622 | { | |
623 | wxVariant variant; | |
624 | variant << value; | |
625 | return variant; | |
1c4293cb VZ |
626 | } |
627 | ||
1c4293cb VZ |
628 | template<> inline wxVariant WXVARIANT( const wxColour& value ) |
629 | { | |
630 | wxVariant variant; | |
631 | variant << value; | |
632 | return variant; | |
633 | } | |
634 | ||
a6162a3e JS |
635 | #if wxUSE_LONGLONG_NATIVE |
636 | ||
637 | template<> inline wxVariant WXVARIANT( const wxLongLong_t& value ) | |
638 | { | |
639 | wxVariant variant; | |
640 | variant << wxLongLong(value); | |
641 | return variant; | |
642 | } | |
643 | ||
644 | template<> inline wxVariant WXVARIANT( const wxULongLong_t& value ) | |
645 | { | |
646 | wxVariant variant; | |
647 | variant << wxULongLong(value); | |
648 | return variant; | |
649 | } | |
650 | ||
651 | WXDLLIMPEXP_PROPGRID wxLongLong_t& operator << ( wxLongLong_t &value, const wxVariant &variant ); | |
652 | WXDLLIMPEXP_PROPGRID wxULongLong_t& operator << ( wxULongLong_t &value, const wxVariant &variant ); | |
653 | ||
654 | #endif // wxUSE_LONGLONG_NATIVE | |
655 | ||
0372d42e JS |
656 | // Define constants for common wxVariant type strings |
657 | ||
658 | #define wxPG_VARIANT_TYPE_STRING wxPGGlobalVars->m_strstring | |
659 | #define wxPG_VARIANT_TYPE_LONG wxPGGlobalVars->m_strlong | |
660 | #define wxPG_VARIANT_TYPE_BOOL wxPGGlobalVars->m_strbool | |
661 | #define wxPG_VARIANT_TYPE_LIST wxPGGlobalVars->m_strlist | |
662 | #define wxPG_VARIANT_TYPE_DOUBLE wxS("double") | |
663 | #define wxPG_VARIANT_TYPE_ARRSTRING wxS("arrstring") | |
664 | #define wxPG_VARIANT_TYPE_DATETIME wxS("datetime") | |
1c4293cb VZ |
665 | |
666 | // Safely converts a wxVariant to (long) int. Supports converting from string | |
667 | // and boolean as well. | |
668 | WXDLLIMPEXP_PROPGRID | |
669 | long wxPGVariantToInt( const wxVariant& variant, long defVal = 1 ); | |
670 | ||
671 | // Safely converts a wxVariant to wxLongLong_t. Returns true on success. | |
672 | WXDLLIMPEXP_PROPGRID | |
673 | bool wxPGVariantToLongLong( const wxVariant& variant, wxLongLong_t* pResult ); | |
674 | ||
675 | // Safely converts a wxVariant to wxULongLong_t. Returns true on success. | |
676 | WXDLLIMPEXP_PROPGRID | |
677 | bool wxPGVariantToULongLong( const wxVariant& variant, wxULongLong_t* pResult ); | |
678 | ||
679 | // Safely converts a wxVariant to double. Supports converting from string and | |
680 | // wxLongLong as well. | |
681 | WXDLLIMPEXP_PROPGRID | |
682 | bool wxPGVariantToDouble( const wxVariant& variant, double* pResult ); | |
683 | ||
684 | #endif // !SWIG | |
685 | ||
686 | // ----------------------------------------------------------------------- | |
687 | ||
688 | #ifndef SWIG | |
689 | ||
1c4293cb VZ |
690 | // |
691 | // Tokenizer macros. | |
692 | // NOTE: I have made two versions - worse ones (performance and consistency | |
693 | // wise) use wxStringTokenizer and better ones (may have unfound bugs) | |
694 | // use custom code. | |
695 | // | |
696 | ||
697 | #include "wx/tokenzr.h" | |
698 | ||
699 | // TOKENIZER1 can be done with wxStringTokenizer | |
700 | #define WX_PG_TOKENIZER1_BEGIN(WXSTRING,DELIMITER) \ | |
701 | wxStringTokenizer tkz(WXSTRING,DELIMITER,wxTOKEN_RET_EMPTY); \ | |
702 | while ( tkz.HasMoreTokens() ) \ | |
703 | { \ | |
704 | wxString token = tkz.GetNextToken(); \ | |
705 | token.Trim(true); \ | |
706 | token.Trim(false); | |
707 | ||
708 | #define WX_PG_TOKENIZER1_END() \ | |
709 | } | |
710 | ||
711 | ||
712 | // | |
713 | // 2nd version: tokens are surrounded by DELIMITERs (for example, C-style | |
714 | // strings). TOKENIZER2 must use custom code (a class) for full compliance with | |
715 | // " surrounded strings with \" inside. | |
716 | // | |
717 | // class implementation is in propgrid.cpp | |
718 | // | |
719 | ||
720 | class WXDLLIMPEXP_PROPGRID wxPGStringTokenizer | |
721 | { | |
722 | public: | |
723 | wxPGStringTokenizer( const wxString& str, wxChar delimeter ); | |
724 | ~wxPGStringTokenizer(); | |
725 | ||
726 | bool HasMoreTokens(); // not const so we can do some stuff in it | |
727 | wxString GetNextToken(); | |
728 | ||
729 | protected: | |
730 | const wxString* m_str; | |
731 | wxString::const_iterator m_curPos; | |
732 | wxString m_readyToken; | |
733 | wxUniChar m_delimeter; | |
734 | }; | |
735 | ||
736 | #define WX_PG_TOKENIZER2_BEGIN(WXSTRING,DELIMITER) \ | |
737 | wxPGStringTokenizer tkz(WXSTRING,DELIMITER); \ | |
738 | while ( tkz.HasMoreTokens() ) \ | |
739 | { \ | |
740 | wxString token = tkz.GetNextToken(); | |
741 | ||
742 | #define WX_PG_TOKENIZER2_END() \ | |
743 | } | |
744 | ||
745 | #endif | |
746 | ||
747 | // ----------------------------------------------------------------------- | |
748 | ||
f4bc1aa2 JS |
749 | #endif // wxUSE_PROPGRID |
750 | ||
1c4293cb | 751 | #endif // _WX_PROPGRID_PROPGRIDDEFS_H_ |