]> git.saurik.com Git - wxWidgets.git/blob - include/wx/propgrid/propgriddefs.h
No changes, just removed hard tabs and trailing white space.
[wxWidgets.git] / include / wx / propgrid / propgriddefs.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/propgrid/propgriddefs.h
3 // Purpose: wxPropertyGrid miscellaneous definitions
4 // Author: Jaakko Salli
5 // Modified by:
6 // Created: 2008-08-31
7 // RCS-ID: $Id$
8 // Copyright: (c) Jaakko Salli
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_PROPGRID_PROPGRIDDEFS_H_
13 #define _WX_PROPGRID_PROPGRIDDEFS_H_
14
15 #if wxUSE_PROPGRID
16
17 #include "wx/dynarray.h"
18 #include "wx/vector.h"
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
87 #define wxPG_USE_RENDERER_NATIVE 1
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)
123 #define wxPG_TEXTCTRLXADJUST 0
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 DEFAULT_IMAGE_OFFSET_INCREMENT \
205 (wxCC_CUSTOM_IMAGE_MARGIN1 + wxCC_CUSTOM_IMAGE_MARGIN2)
206
207 #define wxPG_DRAG_MARGIN 30
208
209 #if wxPG_NO_CHILD_EVT_MOTION
210 #define wxPG_SPLITTERX_DETECTMARGIN1 3 // this much on left
211 #define wxPG_SPLITTERX_DETECTMARGIN2 2 // this much on right
212 #else
213 #define wxPG_SPLITTERX_DETECTMARGIN1 3 // this much on left
214 #define wxPG_SPLITTERX_DETECTMARGIN2 2 // this much on right
215 #endif
216
217 // Use this macro to generate standard custom image height from
218 #define wxPG_STD_CUST_IMAGE_HEIGHT(LINEHEIGHT) (LINEHEIGHT-3)
219
220
221 #if defined(__WXWINCE__)
222 #define wxPG_SMALL_SCREEN 1
223 #undef wxPG_DOUBLE_BUFFER
224 #define wxPG_DOUBLE_BUFFER 0
225 #else
226 #define wxPG_SMALL_SCREEN 0
227 #endif
228
229 #endif // #ifndef SWIG
230
231 // Undefine wxPG_ICON_WIDTH to use supplied xpm bitmaps instead
232 // (for tree buttons)
233 //#undef wxPG_ICON_WIDTH
234
235 #if WXWIN_COMPATIBILITY_2_6 || WXWIN_COMPATIBILITY_2_8
236 #define wxPG_COMPATIBILITY_1_4 1
237 #else
238 #define wxPG_COMPATIBILITY_1_4 0
239 #endif
240
241 // Need to force disable tooltips?
242 #if !wxUSE_TOOLTIPS
243 #undef wxPG_SUPPORT_TOOLTIPS
244 #define wxPG_SUPPORT_TOOLTIPS 0
245 #endif
246
247 // Set 1 to include advanced properties (wxFontProperty, wxColourProperty, etc.)
248 #ifndef wxPG_INCLUDE_ADVPROPS
249 #define wxPG_INCLUDE_ADVPROPS 1
250 #endif
251
252 // Set 1 to include checkbox editor class
253 #define wxPG_INCLUDE_CHECKBOX 1
254
255 // -----------------------------------------------------------------------
256
257
258 class wxPGEditor;
259 class wxPGProperty;
260 class wxPropertyCategory;
261 class wxPGChoices;
262 class wxPropertyGridPageState;
263 class wxPGCell;
264 class wxPGCellRenderer;
265 class wxPGChoiceEntry;
266 class wxPGPropArgCls;
267 class wxPropertyGridInterface;
268 class wxPropertyGrid;
269 class wxPropertyGridEvent;
270 class wxPropertyGridManager;
271 class wxPGOwnerDrawnComboBox;
272 class wxPGEditorDialogAdapter;
273 class wxPGValidationInfo;
274
275
276 // -----------------------------------------------------------------------
277
278 /** @section propgrid_misc wxPropertyGrid Miscellanous
279
280 This section describes some miscellanous values, types and macros.
281 @{
282 */
283
284 #ifndef SWIG
285 // Used to tell wxPGProperty to use label as name as well
286 #define wxPG_LABEL (*wxPGProperty::sm_wxPG_LABEL)
287 // This is the value placed in wxPGProperty::sm_wxPG_LABEL
288 #define wxPG_LABEL_STRING wxS("@!")
289 #define wxPG_NULL_BITMAP wxNullBitmap
290 #define wxPG_COLOUR_BLACK (*wxBLACK)
291 #else
292 #define wxPG_NULL_BITMAP wxBitmap_NULL
293 #define wxPG_COLOUR_BLACK wxColour_BLACK
294 #endif // #ifndef SWIG
295
296 /** Convert Red, Green and Blue to a single 32-bit value.
297 */
298 #define wxPG_COLOUR(R,G,B) ((wxUint32)(R+(G<<8)+(B<<16)))
299
300
301 /** If property is supposed to have custom-painted image, then returning
302 this in OnMeasureImage() will usually be enough.
303 */
304 #define wxPG_DEFAULT_IMAGE_SIZE wxSize(-1, -1)
305
306
307 /** This callback function is used for sorting properties.
308
309 Call wxPropertyGrid::SetSortFunction() to set it.
310
311 Sort function should return a value greater than 0 if position of p1 is
312 after p2. So, for instance, when comparing property names, you can use
313 following implementation:
314
315 @code
316 int MyPropertySortFunction(wxPropertyGrid* propGrid,
317 wxPGProperty* p1,
318 wxPGProperty* p2)
319 {
320 return p1->GetBaseName().compare( p2->GetBaseName() );
321 }
322 @endcode
323 */
324 typedef int (*wxPGSortCallback)(wxPropertyGrid* propGrid,
325 wxPGProperty* p1,
326 wxPGProperty* p2);
327
328
329
330 typedef wxString wxPGCachedString;
331
332 /** @}
333 */
334
335 // -----------------------------------------------------------------------
336
337 // Used to indicate wxPGChoices::Add etc that the value is actually not given
338 // by the caller.
339 #define wxPG_INVALID_VALUE INT_MAX
340
341 // -----------------------------------------------------------------------
342
343 #ifndef SWIG
344
345 WX_DEFINE_TYPEARRAY_WITH_DECL_PTR(wxPGProperty*, wxArrayPGProperty,
346 wxBaseArrayPtrVoid,
347 class WXDLLIMPEXP_PROPGRID);
348
349 // Always use wxString based hashmap with unicode, stl, swig and GCC 4.0+
350 WX_DECLARE_STRING_HASH_MAP_WITH_DECL(void*,
351 wxPGHashMapS2P,
352 class WXDLLIMPEXP_PROPGRID);
353
354 WX_DECLARE_STRING_HASH_MAP_WITH_DECL(wxString,
355 wxPGHashMapS2S,
356 class WXDLLIMPEXP_PROPGRID);
357
358 WX_DECLARE_VOIDPTR_HASH_MAP_WITH_DECL(void*,
359 wxPGHashMapP2P,
360 class WXDLLIMPEXP_PROPGRID);
361
362 WX_DECLARE_HASH_MAP_WITH_DECL(wxInt32,
363 wxInt32,
364 wxIntegerHash,
365 wxIntegerEqual,
366 wxPGHashMapI2I,
367 class WXDLLIMPEXP_PROPGRID);
368
369 #endif // #ifndef SWIG
370
371 // -----------------------------------------------------------------------
372
373 enum wxPG_GETPROPERTYVALUES_FLAGS
374 {
375
376 /** Flags for wxPropertyGridInterface::GetPropertyValues */
377 wxPG_KEEP_STRUCTURE = 0x00000010,
378
379 /** Flags for wxPropertyGrid::SetPropertyAttribute() etc */
380 wxPG_RECURSE = 0x00000020,
381
382 /** Include attributes for GetPropertyValues. */
383 wxPG_INC_ATTRIBUTES = 0x00000040,
384
385 /** Used when first starting recursion. */
386 wxPG_RECURSE_STARTS = 0x00000080,
387
388 /** Force value change. */
389 wxPG_FORCE = 0x00000100,
390
391 /** Only sort categories and their immediate children.
392 Sorting done by wxPG_AUTO_SORT option uses this.
393 */
394 wxPG_SORT_TOP_LEVEL_ONLY = 0x00000200
395
396 };
397
398 /** Flags for wxPropertyGrid::SetPropertyAttribute() etc */
399 #define wxPG_DONT_RECURSE 0x00000000
400
401 // -----------------------------------------------------------------------
402
403 // Misc argument flags.
404 enum wxPG_MISC_ARG_FLAGS
405 {
406 // Get/Store full value instead of displayed value.
407 wxPG_FULL_VALUE = 0x00000001,
408
409 wxPG_REPORT_ERROR = 0x00000002,
410
411 wxPG_PROPERTY_SPECIFIC = 0x00000004,
412
413 // Get/Store editable value instead of displayed one (should only be
414 // different in the case of common values)
415 wxPG_EDITABLE_VALUE = 0x00000008,
416
417 // Used when dealing with fragments of composite string value
418 wxPG_COMPOSITE_FRAGMENT = 0x00000010,
419
420 // Means property for which final string value is for can not really be
421 // edited.
422 wxPG_UNEDITABLE_COMPOSITE_FRAGMENT = 0x00000020,
423
424 // ValueToString() called from GetValueAsString()
425 // (guarantees that input wxVariant value is current own value)
426 wxPG_VALUE_IS_CURRENT = 0x00000040,
427
428 // Value is being set programmatically (ie. not by user)
429 wxPG_PROGRAMMATIC_VALUE = 0x00000080
430 };
431
432 // -----------------------------------------------------------------------
433
434 // wxPGProperty::SetValue() flags
435 enum wxPG_SETVALUE_FLAGS
436 {
437 wxPG_SETVAL_REFRESH_EDITOR = 0x0001,
438 wxPG_SETVAL_AGGREGATED = 0x0002,
439 wxPG_SETVAL_FROM_PARENT = 0x0004,
440 wxPG_SETVAL_BY_USER = 0x0008 // Set if value changed by user
441 };
442
443 // -----------------------------------------------------------------------
444
445 //
446 // Valid constants for wxPG_UINT_BASE attribute
447 // (long because of wxVariant constructor)
448 #define wxPG_BASE_OCT (long)8
449 #define wxPG_BASE_DEC (long)10
450 #define wxPG_BASE_HEX (long)16
451 #define wxPG_BASE_HEXL (long)32
452
453 //
454 // Valid constants for wxPG_UINT_PREFIX attribute
455 #define wxPG_PREFIX_NONE (long)0
456 #define wxPG_PREFIX_0x (long)1
457 #define wxPG_PREFIX_DOLLAR_SIGN (long)2
458
459 // -----------------------------------------------------------------------
460 // Editor class.
461
462 #ifndef SWIG
463
464 // Editor accessor (for backwards compatiblity use only).
465 #define wxPG_EDITOR(T) wxPGEditor_##T
466
467 // Declare editor class, with optional part.
468 #define WX_PG_DECLARE_EDITOR_WITH_DECL(EDITOR,DECL) \
469 extern DECL wxPGEditor* wxPGEditor_##EDITOR; \
470 extern DECL wxPGEditor* wxPGConstruct##EDITOR##EditorClass();
471
472 // Declare editor class.
473 #define WX_PG_DECLARE_EDITOR(EDITOR) \
474 extern wxPGEditor* wxPGEditor_##EDITOR; \
475 extern wxPGEditor* wxPGConstruct##EDITOR##EditorClass();
476
477 // Declare builtin editor classes.
478 WX_PG_DECLARE_EDITOR_WITH_DECL(TextCtrl,WXDLLIMPEXP_PROPGRID)
479 WX_PG_DECLARE_EDITOR_WITH_DECL(Choice,WXDLLIMPEXP_PROPGRID)
480 WX_PG_DECLARE_EDITOR_WITH_DECL(ComboBox,WXDLLIMPEXP_PROPGRID)
481 WX_PG_DECLARE_EDITOR_WITH_DECL(TextCtrlAndButton,WXDLLIMPEXP_PROPGRID)
482 #if wxPG_INCLUDE_CHECKBOX
483 WX_PG_DECLARE_EDITOR_WITH_DECL(CheckBox,WXDLLIMPEXP_PROPGRID)
484 #endif
485 WX_PG_DECLARE_EDITOR_WITH_DECL(ChoiceAndButton,WXDLLIMPEXP_PROPGRID)
486
487 #endif // !SWIG
488
489 // -----------------------------------------------------------------------
490
491 #ifndef SWIG
492
493 //
494 // Macro WXVARIANT allows creation of wxVariant from any type supported by
495 // wxWidgets internally, and of all types created using
496 // WX_PG_DECLARE_VARIANT_DATA.
497 template<class T>
498 wxVariant WXVARIANT( const T& WXUNUSED(value) )
499 {
500 wxFAIL_MSG("Code should always call specializations of this template");
501 return wxVariant();
502 }
503
504 template<> inline wxVariant WXVARIANT( const int& value )
505 { return wxVariant((long)value); }
506 template<> inline wxVariant WXVARIANT( const long& value )
507 { return wxVariant(value); }
508 template<> inline wxVariant WXVARIANT( const bool& value )
509 { return wxVariant(value); }
510 template<> inline wxVariant WXVARIANT( const double& value )
511 { return wxVariant(value); }
512 template<> inline wxVariant WXVARIANT( const wxArrayString& value )
513 { return wxVariant(value); }
514 template<> inline wxVariant WXVARIANT( const wxString& value )
515 { return wxVariant(value); }
516 #if wxUSE_LONGLONG
517 template<> inline wxVariant WXVARIANT( const wxLongLong& value )
518 { return wxVariant(value); }
519 template<> inline wxVariant WXVARIANT( const wxULongLong& value )
520 { return wxVariant(value); }
521 #endif
522 #if wxUSE_DATETIME
523 template<> inline wxVariant WXVARIANT( const wxDateTime& value )
524 { return wxVariant(value); }
525 #endif
526
527
528 //
529 // These are modified versions of DECLARE/WX_PG_IMPLEMENT_VARIANT_DATA
530 // macros found in variant.h. Difference are as follows:
531 // * These support non-wxObject data
532 // * These implement classname##RefFromVariant function which returns
533 // reference to data within.
534 // * const char* classname##_VariantType which equals classname.
535 // * WXVARIANT
536 //
537 #define WX_PG_DECLARE_VARIANT_DATA(classname) \
538 WX_PG_DECLARE_VARIANT_DATA_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE)
539
540 #define WX_PG_DECLARE_VARIANT_DATA_EXPORTED(classname,expdecl) \
541 expdecl classname& operator << ( classname &object, const wxVariant &variant ); \
542 expdecl wxVariant& operator << ( wxVariant &variant, const classname &object ); \
543 expdecl const classname& classname##RefFromVariant( const wxVariant& variant ); \
544 expdecl classname& classname##RefFromVariant( wxVariant& variant ); \
545 template<> inline wxVariant WXVARIANT( const classname& value ) \
546 { \
547 wxVariant variant; \
548 variant << value; \
549 return variant; \
550 } \
551 extern expdecl const char* classname##_VariantType;
552
553
554 #define WX_PG_IMPLEMENT_VARIANT_DATA(classname) \
555 WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE)
556
557 // Add getter (ie. classname << variant) separately to allow
558 // custom implementations.
559 #define WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_NO_EQ_NO_GETTER(classname,expdecl) \
560 const char* classname##_VariantType = #classname; \
561 class classname##VariantData: public wxVariantData \
562 { \
563 public:\
564 classname##VariantData() {} \
565 classname##VariantData( const classname &value ) { m_value = value; } \
566 \
567 classname &GetValue() { return m_value; } \
568 \
569 const classname &GetValue() const { return m_value; } \
570 \
571 virtual bool Eq(wxVariantData& data) const; \
572 \
573 virtual wxString GetType() const; \
574 \
575 virtual wxVariantData* Clone() const { return new classname##VariantData(m_value); } \
576 \
577 protected:\
578 classname m_value; \
579 };\
580 \
581 wxString classname##VariantData::GetType() const\
582 {\
583 return wxS(#classname);\
584 }\
585 \
586 expdecl wxVariant& operator << ( wxVariant &variant, const classname &value )\
587 {\
588 classname##VariantData *data = new classname##VariantData( value );\
589 variant.SetData( data );\
590 return variant;\
591 } \
592 expdecl classname& classname##RefFromVariant( wxVariant& variant ) \
593 { \
594 wxASSERT_MSG( variant.GetType() == wxS(#classname), \
595 wxString::Format("Variant type should have been '%s'" \
596 "instead of '%s'", \
597 wxS(#classname), \
598 variant.GetType().c_str())); \
599 classname##VariantData *data = \
600 (classname##VariantData*) variant.GetData(); \
601 return data->GetValue();\
602 } \
603 expdecl const classname& classname##RefFromVariant( const wxVariant& variant ) \
604 { \
605 wxASSERT_MSG( variant.GetType() == wxS(#classname), \
606 wxString::Format("Variant type should have been '%s'" \
607 "instead of '%s'", \
608 wxS(#classname), \
609 variant.GetType().c_str())); \
610 classname##VariantData *data = \
611 (classname##VariantData*) variant.GetData(); \
612 return data->GetValue();\
613 }
614
615 #define WX_PG_IMPLEMENT_VARIANT_DATA_GETTER(classname, expdecl) \
616 expdecl classname& operator << ( classname &value, const wxVariant &variant )\
617 {\
618 wxASSERT( variant.GetType() == #classname );\
619 \
620 classname##VariantData *data = (classname##VariantData*) variant.GetData();\
621 value = data->GetValue();\
622 return value;\
623 }
624
625 #define WX_PG_IMPLEMENT_VARIANT_DATA_EQ(classname, expdecl) \
626 bool classname##VariantData::Eq(wxVariantData& data) const \
627 {\
628 wxASSERT( GetType() == data.GetType() );\
629 \
630 classname##VariantData & otherData = (classname##VariantData &) data;\
631 \
632 return otherData.m_value == m_value;\
633 }
634
635 // implements a wxVariantData-derived class using for the Eq() method the
636 // operator== which must have been provided by "classname"
637 #define WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED(classname,expdecl) \
638 WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_NO_EQ_NO_GETTER(classname,wxEMPTY_PARAMETER_VALUE expdecl) \
639 WX_PG_IMPLEMENT_VARIANT_DATA_GETTER(classname,wxEMPTY_PARAMETER_VALUE expdecl) \
640 WX_PG_IMPLEMENT_VARIANT_DATA_EQ(classname,wxEMPTY_PARAMETER_VALUE expdecl)
641
642 #define WX_PG_IMPLEMENT_VARIANT_DATA(classname) \
643 WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE)
644
645 // with Eq() implementation that always returns false
646 #define WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_DUMMY_EQ(classname,expdecl) \
647 WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_NO_EQ_NO_GETTER(classname,wxEMPTY_PARAMETER_VALUE expdecl) \
648 WX_PG_IMPLEMENT_VARIANT_DATA_GETTER(classname,wxEMPTY_PARAMETER_VALUE expdecl) \
649 \
650 bool classname##VariantData::Eq(wxVariantData& WXUNUSED(data)) const \
651 {\
652 return false; \
653 }
654
655 #define WX_PG_IMPLEMENT_VARIANT_DATA_DUMMY_EQ(classname) \
656 WX_PG_IMPLEMENT_VARIANT_DATA_EXPORTED_DUMMY_EQ(classname, wxEMPTY_PARAMETER_VALUE)
657
658 WX_PG_DECLARE_VARIANT_DATA_EXPORTED(wxPoint, WXDLLIMPEXP_PROPGRID)
659 WX_PG_DECLARE_VARIANT_DATA_EXPORTED(wxSize, WXDLLIMPEXP_PROPGRID)
660 WX_PG_DECLARE_VARIANT_DATA_EXPORTED(wxArrayInt, WXDLLIMPEXP_PROPGRID)
661 DECLARE_VARIANT_OBJECT_EXPORTED(wxFont, WXDLLIMPEXP_PROPGRID)
662 template<> inline wxVariant WXVARIANT( const wxFont& value )
663 {
664 wxVariant variant;
665 variant << value;
666 return variant;
667 }
668
669 template<> inline wxVariant WXVARIANT( const wxColour& value )
670 {
671 wxVariant variant;
672 variant << value;
673 return variant;
674 }
675
676 // Define constants for common wxVariant type strings
677
678 #define wxPG_VARIANT_TYPE_STRING wxPGGlobalVars->m_strstring
679 #define wxPG_VARIANT_TYPE_LONG wxPGGlobalVars->m_strlong
680 #define wxPG_VARIANT_TYPE_BOOL wxPGGlobalVars->m_strbool
681 #define wxPG_VARIANT_TYPE_LIST wxPGGlobalVars->m_strlist
682 #define wxPG_VARIANT_TYPE_DOUBLE wxS("double")
683 #define wxPG_VARIANT_TYPE_ARRSTRING wxS("arrstring")
684 #define wxPG_VARIANT_TYPE_DATETIME wxS("datetime")
685 #define wxPG_VARIANT_TYPE_LONGLONG wxS("longlong")
686 #define wxPG_VARIANT_TYPE_ULONGLONG wxS("ulonglong")
687
688 #endif // !SWIG
689
690 // -----------------------------------------------------------------------
691
692 #ifndef SWIG
693
694 //
695 // Tokenizer macros.
696 // NOTE: I have made two versions - worse ones (performance and consistency
697 // wise) use wxStringTokenizer and better ones (may have unfound bugs)
698 // use custom code.
699 //
700
701 #include "wx/tokenzr.h"
702
703 // TOKENIZER1 can be done with wxStringTokenizer
704 #define WX_PG_TOKENIZER1_BEGIN(WXSTRING,DELIMITER) \
705 wxStringTokenizer tkz(WXSTRING,DELIMITER,wxTOKEN_RET_EMPTY); \
706 while ( tkz.HasMoreTokens() ) \
707 { \
708 wxString token = tkz.GetNextToken(); \
709 token.Trim(true); \
710 token.Trim(false);
711
712 #define WX_PG_TOKENIZER1_END() \
713 }
714
715
716 //
717 // 2nd version: tokens are surrounded by DELIMITERs (for example, C-style
718 // strings). TOKENIZER2 must use custom code (a class) for full compliance with
719 // " surrounded strings with \" inside.
720 //
721 // class implementation is in propgrid.cpp
722 //
723
724 class WXDLLIMPEXP_PROPGRID wxPGStringTokenizer
725 {
726 public:
727 wxPGStringTokenizer( const wxString& str, wxChar delimeter );
728 ~wxPGStringTokenizer();
729
730 bool HasMoreTokens(); // not const so we can do some stuff in it
731 wxString GetNextToken();
732
733 protected:
734 const wxString* m_str;
735 wxString::const_iterator m_curPos;
736 wxString m_readyToken;
737 wxUniChar m_delimeter;
738 };
739
740 #define WX_PG_TOKENIZER2_BEGIN(WXSTRING,DELIMITER) \
741 wxPGStringTokenizer tkz(WXSTRING,DELIMITER); \
742 while ( tkz.HasMoreTokens() ) \
743 { \
744 wxString token = tkz.GetNextToken();
745
746 #define WX_PG_TOKENIZER2_END() \
747 }
748
749 #endif
750
751 // -----------------------------------------------------------------------
752
753 #endif // wxUSE_PROPGRID
754
755 #endif // _WX_PROPGRID_PROPGRIDDEFS_H_