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