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