include/wx/propgrid/propgridiface.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/propgeid/propgridiface.h
   3 // Purpose:     wxPropertyGridInterface class
   4 // Author:      Jaakko Salli
   5 // Modified by:
   6 // Created:     2008-08-24
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Jaakko Salli
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef __WX_PROPGRID_PROPGRIDIFACE_H__
  13 #define __WX_PROPGRID_PROPGRIDIFACE_H__
  14
  15 #if wxUSE_PROPGRID
  16
  17 #include "wx/propgrid/property.h"
  18 #include "wx/propgrid/propgridpagestate.h"
  19
  20 // -----------------------------------------------------------------------
  21
  22 #ifndef SWIG
  23
  24 /** @section wxPGPropArgCls
  25
  26     Most property grid functions have this type as their argument, as it can
  27     convey a property by either a pointer or name.
  28 */
  29 class WXDLLIMPEXP_PROPGRID wxPGPropArgCls
  30 {
  31 public:
  32     wxPGPropArgCls() { }
  33     wxPGPropArgCls( const wxPGProperty* property )
  34     {
  35         m_ptr.property = (wxPGProperty*) property;
  36         m_flags = IsProperty;
  37     }
  38     wxPGPropArgCls( const wxString& str )
  39     {
  40         m_ptr.stringName = &str;
  41         m_flags = IsWxString;
  42     }
  43     wxPGPropArgCls( const wxPGPropArgCls& id )
  44     {
  45         m_ptr = id.m_ptr;
  46         m_flags = id.m_flags;
  47     }
  48     // This is only needed for wxPython bindings
  49     wxPGPropArgCls( wxString* str, bool WXUNUSED(deallocPtr) )
  50     {
  51         m_ptr.stringName = str;
  52         m_flags = IsWxString | OwnsWxString;
  53     }
  54     ~wxPGPropArgCls()
  55     {
  56         if ( m_flags & OwnsWxString )
  57             delete m_ptr.stringName;
  58     }
  59     wxPGProperty* GetPtr() const
  60     {
  61         wxCHECK( m_flags == IsProperty, NULL );
  62         return m_ptr.property;
  63     }
  64     wxPGPropArgCls( const char* str )
  65     {
  66         m_ptr.charName = str;
  67         m_flags = IsCharPtr;
  68     }
  69 #if wxUSE_WCHAR_T
  70     wxPGPropArgCls( const wchar_t* str )
  71     {
  72         m_ptr.wcharName = str;
  73         m_flags = IsWCharPtr;
  74     }
  75 #endif
  76     /** This constructor is required for NULL. */
  77     wxPGPropArgCls( int )
  78     {
  79         m_ptr.property = NULL;
  80         m_flags = IsProperty;
  81     }
  82     wxPGProperty* GetPtr( wxPropertyGridInterface* iface ) const;
  83     wxPGProperty* GetPtr( const wxPropertyGridInterface* iface ) const
  84     {
  85         return GetPtr((wxPropertyGridInterface*)iface);
  86     }
  87     wxPGProperty* GetPtr0() const { return m_ptr.property; }
  88     bool HasName() const { return (m_flags != IsProperty); }
  89     const wxString& GetName() const { return *m_ptr.stringName; }
  90 private:
  91
  92     enum
  93     {
  94         IsProperty      = 0x00,
  95         IsWxString      = 0x01,
  96         IsCharPtr       = 0x02,
  97         IsWCharPtr      = 0x04,
  98         OwnsWxString    = 0x10
  99     };
 100
 101     union
 102     {
 103         wxPGProperty* property;
 104         const char* charName;
 105 #if wxUSE_WCHAR_T
 106         const wchar_t* wcharName;
 107 #endif
 108         const wxString* stringName;
 109     } m_ptr;
 110     unsigned char m_flags;
 111 };
 112
 113 #endif
 114
 115 typedef const wxPGPropArgCls& wxPGPropArg;
 116
 117 // -----------------------------------------------------------------------
 118
 119 WXDLLIMPEXP_PROPGRID
 120 void wxPGTypeOperationFailed( const wxPGProperty* p,
 121                               const wxString& typestr,
 122                               const wxString& op );
 123 WXDLLIMPEXP_PROPGRID
 124 void wxPGGetFailed( const wxPGProperty* p, const wxString& typestr );
 125
 126 // -----------------------------------------------------------------------
 127
 128 // Helper macro that does necessary preparations when calling
 129 // some wxPGProperty's member function.
 130 #define wxPG_PROP_ARG_CALL_PROLOG_0(PROPERTY) \
 131     PROPERTY *p = (PROPERTY*)id.GetPtr(this); \
 132     if ( !p ) return;
 133
 134 #define wxPG_PROP_ARG_CALL_PROLOG_RETVAL_0(PROPERTY, RETVAL) \
 135     PROPERTY *p = (PROPERTY*)id.GetPtr(this); \
 136     if ( !p ) return RETVAL;
 137
 138 #define wxPG_PROP_ARG_CALL_PROLOG() \
 139     wxPG_PROP_ARG_CALL_PROLOG_0(wxPGProperty)
 140
 141 #define wxPG_PROP_ARG_CALL_PROLOG_RETVAL(RVAL) \
 142     wxPG_PROP_ARG_CALL_PROLOG_RETVAL_0(wxPGProperty, RVAL)
 143
 144 #define wxPG_PROP_ID_CONST_CALL_PROLOG() \
 145     wxPG_PROP_ARG_CALL_PROLOG_0(const wxPGProperty)
 146
 147 #define wxPG_PROP_ID_CONST_CALL_PROLOG_RETVAL(RVAL) \
 148     wxPG_PROP_ARG_CALL_PROLOG_RETVAL_0(const wxPGProperty, RVAL)
 149
 150 // -----------------------------------------------------------------------
 151
 152
 153 /** @class wxPropertyGridInterface
 154
 155     Most of the shared property manipulation interface shared by wxPropertyGrid,
 156     wxPropertyGridPage, and wxPropertyGridManager is defined in this class.
 157
 158     @remarks
 159     - In separate wxPropertyGrid component this class was known as
 160     wxPropertyContainerMethods.
 161
 162     @library{wxpropgrid}
 163     @category{propgrid}
 164 */
 165 class WXDLLIMPEXP_PROPGRID wxPropertyGridInterface
 166 {
 167 public:
 168
 169     /** Destructor */
 170     virtual ~wxPropertyGridInterface() { }
 171
 172     /**
 173         Appends property to the list.
 174
 175         wxPropertyGrid assumes ownership of the object.
 176         Becomes child of most recently added category.
 177         @remarks
 178         - wxPropertyGrid takes the ownership of the property pointer.
 179         - If appending a category with name identical to a category already in
 180           the wxPropertyGrid, then newly created category is deleted, and most
 181           recently added category (under which properties are appended) is set
 182           to the one with same name. This allows easier adding of items to same
 183           categories in multiple passes.
 184         - Does not automatically redraw the control, so you may need to call
 185           Refresh when calling this function after control has been shown for
 186           the first time.
 187     */
 188     wxPGProperty* Append( wxPGProperty* property );
 189
 190     wxPGProperty* AppendIn( wxPGPropArg id, wxPGProperty* newproperty );
 191
 192     /**
 193         In order to add new items into a property with fixed children (for
 194         instance, wxFlagsProperty), you need to call this method. After
 195         populating has been finished, you need to call EndAddChildren.
 196     */
 197     void BeginAddChildren( wxPGPropArg id );
 198
 199     /** Deletes all properties.
 200     */
 201     virtual void Clear() = 0;
 202
 203     /**
 204         Clears current selection, if any.
 205
 206         @param validation
 207             If set to @false, deselecting the property will always work,
 208             even if its editor had invalid value in it.
 209
 210         @return Returns @true if successful or if there was no selection. May
 211                 fail if validation was enabled and active editor had invalid
 212                 value.
 213     */
 214     bool ClearSelection( bool validation = false);
 215
 216     /** Resets modified status of all properties.
 217     */
 218     void ClearModifiedStatus();
 219
 220     /** Collapses given category or property with children.
 221         Returns true if actually collapses.
 222     */
 223     bool Collapse( wxPGPropArg id );
 224
 225     /** Collapses all items that can be collapsed.
 226
 227         @return
 228         Return false if failed (may fail if editor value cannot be validated).
 229     */
 230     bool CollapseAll() { return ExpandAll(false); }
 231
 232     /**
 233         Changes value of a property, as if from an editor.
 234         Use this instead of SetPropertyValue() if you need the value to run
 235         through validation process, and also send the property change event.
 236
 237         @return
 238         Returns true if value was successfully changed.
 239     */
 240     bool ChangePropertyValue( wxPGPropArg id, wxVariant newValue );
 241
 242     /**
 243         Deletes a property by id. If category is deleted, all children are
 244         automatically deleted as well.
 245      */
 246     void DeleteProperty( wxPGPropArg id );
 247
 248     /**
 249         Removes and returns a property.
 250
 251         @param id
 252             Pointer or name of a property.
 253
 254         @remarks Removed property cannot have any children.
 255     */
 256     wxPGProperty* RemoveProperty( wxPGPropArg id );
 257
 258     /** Disables property. */
 259     bool DisableProperty( wxPGPropArg id ) { return EnableProperty(id,false); }
 260
 261     /**
 262         Returns true if all property grid data changes have been committed.
 263
 264         Usually only returns false if value in active editor has been
 265         invalidated by a wxValidator.
 266     */
 267     bool EditorValidate();
 268
 269     /**
 270         Enables or disables property, depending on whether enable is true or
 271         false.
 272      */
 273     bool EnableProperty( wxPGPropArg id, bool enable = true );
 274
 275     /** Called after population of property with fixed children has finished.
 276     */
 277     void EndAddChildren( wxPGPropArg id );
 278
 279     /** Expands given category or property with children.
 280         Returns true if actually expands.
 281     */
 282     bool Expand( wxPGPropArg id );
 283
 284     /** Expands all items that can be expanded.
 285     */
 286     bool ExpandAll( bool expand = true );
 287
 288     /** Returns id of first child of given property.
 289         @remarks
 290         Does not return sub-properties!
 291     */
 292     wxPGProperty* GetFirstChild( wxPGPropArg id )
 293     {
 294         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(wxNullProperty)
 295
 296         if ( !p->GetChildCount() || p->HasFlag(wxPG_PROP_AGGREGATE) )
 297             return wxNullProperty;
 298
 299         return p->Item(0);
 300     }
 301
 302     //@{
 303     /** Returns iterator class instance.
 304         @param flags
 305         See @ref propgrid_iterator_flags. Value wxPG_ITERATE_DEFAULT causes
 306         iteration over everything except private child properties.
 307         @param firstProp
 308             Property to start iteration from. If NULL, then first child of root
 309             is used.
 310         @param startPos
 311             Either wxTOP or wxBOTTOM. wxTOP will indicate that iterations start
 312             from the first property from the top, and wxBOTTOM means that the
 313             iteration will instead begin from bottommost valid item.
 314     */
 315     wxPropertyGridIterator GetIterator( int flags = wxPG_ITERATE_DEFAULT,
 316                                         wxPGProperty* firstProp = NULL )
 317     {
 318         return wxPropertyGridIterator( m_pState, flags, firstProp );
 319     }
 320
 321     wxPropertyGridConstIterator
 322     GetIterator( int flags = wxPG_ITERATE_DEFAULT,
 323                  wxPGProperty* firstProp = NULL ) const
 324     {
 325         return wxPropertyGridConstIterator( m_pState, flags, firstProp );
 326     }
 327
 328     wxPropertyGridIterator GetIterator( int flags, int startPos )
 329     {
 330         return wxPropertyGridIterator( m_pState, flags, startPos );
 331     }
 332
 333     wxPropertyGridConstIterator GetIterator( int flags, int startPos ) const
 334     {
 335         return wxPropertyGridConstIterator( m_pState, flags, startPos );
 336     }
 337     //@}
 338
 339     /** Returns id of first item, whether it is a category or property.
 340         @param flags
 341         @link iteratorflags List of iterator flags@endlink
 342     */
 343     wxPGProperty* GetFirst( int flags = wxPG_ITERATE_ALL )
 344     {
 345         wxPropertyGridIterator it( m_pState, flags, wxNullProperty, 1 );
 346         return *it;
 347     }
 348
 349     const wxPGProperty* GetFirst( int flags = wxPG_ITERATE_ALL ) const
 350     {
 351         return ((wxPropertyGridInterface*)this)->GetFirst(flags);
 352     }
 353
 354     /**
 355         Returns pointer to a property with given name (case-sensitive).
 356         If there is no property with such name, @NULL pointer is returned.
 357
 358         @remarks Properties which have non-category, non-root parent
 359                  can not be accessed globally by their name. Instead, use
 360                  "<property>.<subproperty>" instead of "<subproperty>".
 361     */
 362     wxPGProperty* GetProperty( const wxString& name ) const
 363     {
 364         return GetPropertyByName(name);
 365     }
 366
 367     /** Returns map-like storage of property's attributes.
 368         @remarks
 369         Note that if extra style wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set,
 370         then builtin-attributes are not included in the storage.
 371     */
 372     const wxPGAttributeStorage& GetPropertyAttributes( wxPGPropArg id ) const
 373     {
 374         // If 'id' refers to invalid property, then we will return dummy
 375         // attributes (ie. root property's attributes, which contents should
 376         // should always be empty and of no consequence).
 377         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(m_pState->DoGetRoot()->GetAttributes());
 378         return p->GetAttributes();
 379     }
 380
 381     /** Adds to 'targetArr' pointers to properties that have given
 382         flags 'flags' set. However, if 'inverse' is set to true, then
 383         only properties without given flags are stored.
 384         @param flags
 385         Property flags to use.
 386         @param iterFlags
 387         Iterator flags to use. Default is everything expect private children.
 388     */
 389     void GetPropertiesWithFlag( wxArrayPGProperty* targetArr,
 390                                 wxPGProperty::FlagType flags,
 391                                 bool inverse = false,
 392                                 int iterFlags = wxPG_ITERATE_PROPERTIES |
 393                                                 wxPG_ITERATE_HIDDEN |
 394                                                 wxPG_ITERATE_CATEGORIES) const;
 395
 396     /** Returns value of given attribute. If none found, returns NULL-variant.
 397     */
 398     wxVariant GetPropertyAttribute( wxPGPropArg id,
 399                                     const wxString& attrName ) const
 400     {
 401         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(wxNullVariant)
 402         return p->GetAttribute(attrName);
 403     }
 404
 405     /** Returns pointer of property's nearest parent category. If no category
 406         found, returns NULL.
 407     */
 408     wxPropertyCategory* GetPropertyCategory( wxPGPropArg id ) const
 409     {
 410         wxPG_PROP_ID_CONST_CALL_PROLOG_RETVAL(NULL)
 411         return m_pState->GetPropertyCategory(p);
 412     }
 413
 414 #ifndef SWIG
 415     /** Returns client data (void*) of a property. */
 416     void* GetPropertyClientData( wxPGPropArg id ) const
 417     {
 418         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(NULL)
 419         return p->GetClientData();
 420     }
 421 #endif
 422
 423     /**
 424         Returns first property which label matches given string.
 425
 426         NULL if none found. Note that this operation is extremely slow when
 427         compared to GetPropertyByName().
 428     */
 429     wxPGProperty* GetPropertyByLabel( const wxString& label ) const;
 430
 431     /** Returns property with given name. NULL if none found.
 432     */
 433     wxPGProperty* GetPropertyByName( const wxString& name ) const;
 434
 435     /** Returns child property 'subname' of property 'name'. Same as
 436         calling GetPropertyByName("name.subname"), albeit slightly faster.
 437     */
 438     wxPGProperty* GetPropertyByName( const wxString& name,
 439                                      const wxString& subname ) const;
 440
 441     /** Returns property's editor. */
 442     const wxPGEditor* GetPropertyEditor( wxPGPropArg id ) const
 443     {
 444         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(NULL)
 445         return p->GetEditorClass();
 446     }
 447
 448     /** Returns help string associated with a property. */
 449     wxString GetPropertyHelpString( wxPGPropArg id ) const
 450     {
 451         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(m_emptyString)
 452         return p->GetHelpString();
 453     }
 454
 455     /** Returns property's custom value image (NULL of none). */
 456     wxBitmap* GetPropertyImage( wxPGPropArg id ) const
 457     {
 458         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(NULL)
 459         return p->GetValueImage();
 460     }
 461
 462     /** Returns label of a property. */
 463     const wxString& GetPropertyLabel( wxPGPropArg id )
 464     {
 465         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(m_emptyString)
 466         return p->GetLabel();
 467     }
 468
 469     /** Returns name of a property, by which it is globally accessible. */
 470     wxString GetPropertyName( wxPGProperty* property )
 471     {
 472         return property->GetName();
 473     }
 474
 475     /** Returns parent item of a property. */
 476     wxPGProperty* GetPropertyParent( wxPGPropArg id )
 477     {
 478         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(wxNullProperty)
 479         return p->GetParent();
 480     }
 481
 482 #if wxUSE_VALIDATORS
 483     /** Returns validator of a property as a reference, which you
 484         can pass to any number of SetPropertyValidator.
 485     */
 486     wxValidator* GetPropertyValidator( wxPGPropArg id )
 487     {
 488         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(NULL)
 489         return p->GetValidator();
 490     }
 491 #endif
 492
 493     /** Returns value as wxVariant. To get wxObject pointer from it,
 494         you will have to use WX_PG_VARIANT_TO_WXOBJECT(VARIANT,CLASSNAME) macro.
 495
 496         If property value is unspecified, Null variant is returned.
 497     */
 498     wxVariant GetPropertyValue( wxPGPropArg id )
 499     {
 500         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(wxVariant())
 501         return p->GetValue();
 502     }
 503
 504     wxString GetPropertyValueAsString( wxPGPropArg id ) const;
 505     long GetPropertyValueAsLong( wxPGPropArg id ) const;
 506     unsigned long GetPropertyValueAsULong( wxPGPropArg id ) const
 507     {
 508         return (unsigned long) GetPropertyValueAsLong(id);
 509     }
 510 #ifndef SWIG
 511     int GetPropertyValueAsInt( wxPGPropArg id ) const
 512         { return (int)GetPropertyValueAsLong(id); }
 513 #endif
 514     bool GetPropertyValueAsBool( wxPGPropArg id ) const;
 515     double GetPropertyValueAsDouble( wxPGPropArg id ) const;
 516
 517 #define wxPG_PROP_ID_GETPROPVAL_CALL_PROLOG_RETVAL(TYPENAME, DEFVAL) \
 518     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(DEFVAL) \
 519     wxString typeName(wxS(TYPENAME)); \
 520     wxVariant value = p->GetValue(); \
 521     if ( value.GetType() != typeName ) \
 522     { \
 523         wxPGGetFailed(p, typeName); \
 524         return DEFVAL; \
 525     }
 526
 527 #define wxPG_PROP_ID_GETPROPVAL_CALL_PROLOG_RETVAL_WFALLBACK(TYPENAME, DEFVAL) \
 528     wxPG_PROP_ARG_CALL_PROLOG_RETVAL(DEFVAL) \
 529     wxVariant value = p->GetValue(); \
 530     if ( value.GetType() != wxS(TYPENAME) ) \
 531         return DEFVAL; \
 532
 533     wxArrayString GetPropertyValueAsArrayString( wxPGPropArg id ) const
 534     {
 535         wxPG_PROP_ID_GETPROPVAL_CALL_PROLOG_RETVAL("arrstring",
 536                                                    wxArrayString())
 537         return value.GetArrayString();
 538     }
 539
 540 #ifdef wxLongLong_t
 541     wxLongLong_t GetPropertyValueAsLongLong( wxPGPropArg id ) const
 542     {
 543         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(0)
 544         return p->GetValue().GetLongLong().GetValue();
 545     }
 546
 547     wxULongLong_t GetPropertyValueAsULongLong( wxPGPropArg id ) const
 548     {
 549         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(0)
 550         return p->GetValue().GetULongLong().GetValue();
 551     }
 552 #endif
 553
 554     wxArrayInt GetPropertyValueAsArrayInt( wxPGPropArg id ) const
 555     {
 556         wxPG_PROP_ID_GETPROPVAL_CALL_PROLOG_RETVAL("wxArrayInt",
 557                                                    wxArrayInt())
 558         wxArrayInt arr;
 559         arr << value;
 560         return arr;
 561     }
 562
 563 #if wxUSE_DATETIME
 564     wxDateTime GetPropertyValueAsDateTime( wxPGPropArg id ) const
 565     {
 566         wxPG_PROP_ID_GETPROPVAL_CALL_PROLOG_RETVAL("datetime",
 567                                                    wxDateTime())
 568         return value.GetDateTime();
 569     }
 570 #endif
 571
 572 #ifndef SWIG
 573     /** Returns a wxVariant list containing wxVariant versions of all
 574         property values. Order is not guaranteed.
 575         @param flags
 576         Use wxPG_KEEP_STRUCTURE to retain category structure; each sub
 577         category will be its own wxVariantList of wxVariant.
 578         Use wxPG_INC_ATTRIBUTES to include property attributes as well.
 579         Each attribute will be stored as list variant named
 580         "@@<propname>@@attr."
 581         @remarks
 582     */
 583     wxVariant GetPropertyValues( const wxString& listname = wxEmptyString,
 584         wxPGProperty* baseparent = NULL, long flags = 0 ) const
 585     {
 586         return m_pState->DoGetPropertyValues(listname, baseparent, flags);
 587     }
 588 #endif
 589
 590     /** Returns currently selected property. */
 591     wxPGProperty* GetSelection() const
 592     {
 593         return m_pState->GetSelection();
 594     }
 595
 596 #ifndef SWIG
 597     wxPropertyGridPageState* GetState() const { return m_pState; }
 598 #endif
 599
 600     /** Similar to GetIterator(), but instead returns wxPGVIterator instance,
 601         which can be useful for forward-iterating through arbitrary property
 602         containers.
 603
 604         @param flags
 605         See @ref propgrid_iterator_flags.
 606     */
 607     virtual wxPGVIterator GetVIterator( int flags ) const;
 608
 609     /** Hides or reveals a property.
 610         @param hide
 611             If true, hides property, otherwise reveals it.
 612         @param flags
 613             By default changes are applied recursively. Set this paramter
 614             wxPG_DONT_RECURSE to prevent this.
 615     */
 616     bool HideProperty( wxPGPropArg id,
 617                        bool hide = true,
 618                        int flags = wxPG_RECURSE );
 619
 620 #if wxPG_INCLUDE_ADVPROPS
 621     /** Initializes *all* property types. Causes references to most object
 622         files in the library, so calling this may cause significant increase
 623         in executable size when linking with static library.
 624     */
 625     static void InitAllTypeHandlers();
 626 #else
 627     static void InitAllTypeHandlers() { }
 628 #endif
 629
 630     //@{
 631     /** Inserts property to the property container.
 632
 633         @param priorThis
 634         New property is inserted just prior to this. Available only
 635         in the first variant. There are two versions of this function
 636         to allow this parameter to be either an id or name to
 637         a property.
 638
 639         @param newproperty
 640         Pointer to the inserted property. wxPropertyGrid will take
 641         ownership of this object.
 642
 643         @param parent
 644         New property is inserted under this category. Available only
 645         in the second variant. There are two versions of this function
 646         to allow this parameter to be either an id or name to
 647         a property.
 648
 649         @param index
 650         Index under category. Available only in the second variant.
 651         If index is < 0, property is appended in category.
 652
 653         @return
 654         Returns id for the property,
 655
 656         @remarks
 657
 658         - wxPropertyGrid takes the ownership of the property pointer.
 659
 660         - While Append may be faster way to add items, make note that when
 661           both types of data storage (categoric and
 662           non-categoric) are active, Insert becomes even more slow. This is
 663           especially true if current mode is non-categoric.
 664
 665         Example of use:
 666
 667         @code
 668
 669             // append category
 670             wxPGProperty* my_cat_id = propertygrid->Append(
 671                 new wxPropertyCategory("My Category") );
 672
 673             ...
 674
 675             // insert into category - using second variant
 676             wxPGProperty* my_item_id_1 = propertygrid->Insert(
 677                 my_cat_id, 0, new wxStringProperty("My String 1") );
 678
 679             // insert before to first item - using first variant
 680             wxPGProperty* my_item_id_2 = propertygrid->Insert(
 681                 my_item_id, new wxStringProperty("My String 2") );
 682
 683         @endcode
 684
 685     */
 686     wxPGProperty* Insert( wxPGPropArg priorThis, wxPGProperty* newproperty );
 687     wxPGProperty* Insert( wxPGPropArg parent,
 688                           int index,
 689                           wxPGProperty* newproperty );
 690     //@}
 691
 692     /** Returns true if property is a category. */
 693     bool IsPropertyCategory( wxPGPropArg id ) const
 694     {
 695         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
 696         return p->IsCategory();
 697     }
 698
 699     /** Returns true if property is enabled. */
 700     bool IsPropertyEnabled( wxPGPropArg id ) const
 701     {
 702         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
 703         return (!(p->GetFlags() & wxPG_PROP_DISABLED))?true:false;
 704     }
 705
 706     /**
 707         Returns true if given property is expanded.
 708
 709         Naturally, always returns false for properties that cannot be expanded.
 710     */
 711     bool IsPropertyExpanded( wxPGPropArg id ) const;
 712
 713     /**
 714         Returns true if property has been modified after value set or modify
 715         flag clear by software.
 716     */
 717     bool IsPropertyModified( wxPGPropArg id ) const
 718     {
 719         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
 720         return ( (p->GetFlags() & wxPG_PROP_MODIFIED) ? true : false );
 721     }
 722
 723     /**
 724         Returns true if property is shown (ie hideproperty with true not
 725         called for it).
 726      */
 727     bool IsPropertyShown( wxPGPropArg id ) const
 728     {
 729         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
 730         return (!(p->GetFlags() & wxPG_PROP_HIDDEN))?true:false;
 731     }
 732
 733     /** Returns true if property value is set to unspecified.
 734     */
 735     bool IsPropertyValueUnspecified( wxPGPropArg id ) const
 736     {
 737         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
 738         return p->IsValueUnspecified();
 739     }
 740
 741     /**
 742         Disables (limit = true) or enables (limit = false) wxTextCtrl editor of
 743         a property, if it is not the sole mean to edit the value.
 744     */
 745     void LimitPropertyEditing( wxPGPropArg id, bool limit = true );
 746
 747     /** If state is shown in it's grid, refresh it now.
 748     */
 749     virtual void RefreshGrid( wxPropertyGridPageState* state = NULL );
 750
 751 #if wxPG_INCLUDE_ADVPROPS
 752     /**
 753         Initializes additional property editors (SpinCtrl etc.). Causes
 754         references to most object files in the library, so calling this may
 755         cause significant increase in executable size when linking with static
 756         library.
 757     */
 758     static void RegisterAdditionalEditors();
 759 #else
 760     static void RegisterAdditionalEditors() { }
 761 #endif
 762
 763     /** Replaces property with id with newly created property. For example,
 764         this code replaces existing property named "Flags" with one that
 765         will have different set of items:
 766         @code
 767             pg->ReplaceProperty("Flags",
 768                 wxFlagsProperty("Flags", wxPG_LABEL, newItems))
 769         @endcode
 770         For more info, see wxPropertyGrid::Insert.
 771     */
 772     wxPGProperty* ReplaceProperty( wxPGPropArg id, wxPGProperty* property );
 773
 774     /** @anchor propgridinterface_editablestate_flags
 775
 776         Flags for wxPropertyGridInterface::SaveEditableState() and
 777         wxPropertyGridInterface::RestoreEditableState().
 778     */
 779     enum EditableStateFlags
 780     {
 781         /** Include selected property. */
 782         SelectionState   = 0x01,
 783         /** Include expanded/collapsed property information. */
 784         ExpandedState    = 0x02,
 785         /** Include scrolled position. */
 786         ScrollPosState   = 0x04,
 787         /** Include selected page information.
 788             Only applies to wxPropertyGridManager. */
 789         PageState        = 0x08,
 790         /** Include splitter position. Stored for each page. */
 791         SplitterPosState = 0x10,
 792         /** Include description box size.
 793             Only applies to wxPropertyGridManager. */
 794         DescBoxState     = 0x20,
 795
 796         /**
 797             Include all supported user editable state information.
 798             This is usually the default value. */
 799         AllStates        = SelectionState |
 800                            ExpandedState |
 801                            ScrollPosState |
 802                            PageState |
 803                            SplitterPosState |
 804                            DescBoxState
 805     };
 806
 807     /**
 808         Restores user-editable state.
 809
 810         See also wxPropertyGridInterface::SaveEditableState().
 811
 812         @param src
 813             String generated by SaveEditableState.
 814
 815         @param restoreStates
 816             Which parts to restore from source string. See @ref
 817             propgridinterface_editablestate_flags "list of editable state
 818             flags".
 819
 820         @return
 821             False if there was problem reading the string.
 822
 823         @remarks
 824         If some parts of state (such as scrolled or splitter position) fail to
 825         restore correctly, please make sure that you call this function after
 826         wxPropertyGrid size has been set (this may sometimes be tricky when
 827         sizers are used).
 828     */
 829     bool RestoreEditableState( const wxString& src,
 830                                int restoreStates = AllStates );
 831
 832     /**
 833         Used to acquire user-editable state (selected property, expanded
 834         properties, scrolled position, splitter positions).
 835
 836         @param includedStates
 837         Which parts of state to include. See @ref
 838         propgridinterface_editablestate_flags "list of editable state flags".
 839     */
 840     wxString SaveEditableState( int includedStates = AllStates ) const;
 841
 842     /**
 843         Lets user to set the strings listed in the choice dropdown of a
 844         wxBoolProperty. Defaults are "True" and "False", so changing them to,
 845         say, "Yes" and "No" may be useful in some less technical applications.
 846     */
 847     static void SetBoolChoices( const wxString& trueChoice,
 848                                 const wxString& falseChoice );
 849
 850     /** Sets an attribute for this property.
 851         @param name
 852             Text identifier of attribute. See @ref propgrid_property_attributes.
 853         @param value
 854             Value of attribute.
 855         @param argFlags
 856             Optional. Use wxPG_RECURSE to set the attribute to child properties
 857             recursively.
 858     */
 859     void SetPropertyAttribute( wxPGPropArg id,
 860                                const wxString& attrName,
 861                                wxVariant value,
 862                                long argFlags = 0 )
 863     {
 864         DoSetPropertyAttribute(id,attrName,value,argFlags);
 865     }
 866
 867     /** Sets property attribute for all applicapple properties.
 868         Be sure to use this method only after all properties have been
 869         added to the grid.
 870     */
 871     void SetPropertyAttributeAll( const wxString& attrName, wxVariant value );
 872
 873     /**
 874         Sets background colour of a property.
 875
 876         @param id
 877             Property name or pointer.
 878
 879         @param colour
 880             New background colour.
 881
 882         @param recursively
 883             If True, child properties are affected recursively. Property
 884             categories are skipped if this flag is used.
 885     */
 886     void SetPropertyBackgroundColour( wxPGPropArg id,
 887                                       const wxColour& colour,
 888                                       bool recursively = true );
 889
 890     /** Resets text and background colours of given property.
 891     */
 892     void SetPropertyColoursToDefault( wxPGPropArg id );
 893
 894     /**
 895         Sets text colour of a property.
 896
 897         @param id
 898             Property name or pointer.
 899
 900         @param colour
 901             New background colour.
 902
 903         @param recursively
 904             If True, child properties are affected recursively. Property
 905             categories are skipped if this flag is used.
 906     */
 907     void SetPropertyTextColour( wxPGPropArg id,
 908                                 const wxColour& col,
 909                                 bool recursively = true );
 910
 911     /**
 912         Returns background colour of first cell of a property.
 913     */
 914     wxColour GetPropertyBackgroundColour( wxPGPropArg id ) const
 915     {
 916         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(wxColour())
 917         return p->GetCell(0).GetBgCol();
 918     }
 919
 920     /**
 921         Returns text colour of first cell of a property.
 922     */
 923     wxColour GetPropertyTextColour( wxPGPropArg id ) const
 924     {
 925         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(wxColour())
 926         return p->GetCell(0).GetFgCol();
 927     }
 928
 929     /** Sets text, bitmap, and colours for given column's cell.
 930
 931         @remarks
 932         - You can set label cell by setting column to 0.
 933         - You can use wxPG_LABEL as text to use default text for column.
 934     */
 935     void SetPropertyCell( wxPGPropArg id,
 936                           int column,
 937                           const wxString& text = wxEmptyString,
 938                           const wxBitmap& bitmap = wxNullBitmap,
 939                           const wxColour& fgCol = wxNullColour,
 940                           const wxColour& bgCol = wxNullColour );
 941
 942 #ifndef SWIG
 943     /** Sets client data (void*) of a property.
 944         @remarks
 945         This untyped client data has to be deleted manually.
 946     */
 947     void SetPropertyClientData( wxPGPropArg id, void* clientData )
 948     {
 949         wxPG_PROP_ARG_CALL_PROLOG()
 950         p->SetClientData(clientData);
 951     }
 952
 953     /** Sets editor for a property.
 954
 955         @param editor
 956         For builtin editors, use wxPGEditor_X, where X is builtin editor's
 957         name (TextCtrl, Choice, etc. see wxPGEditor documentation for full
 958         list).
 959
 960         For custom editors, use pointer you received from
 961         wxPropertyGrid::RegisterEditorClass().
 962     */
 963     void SetPropertyEditor( wxPGPropArg id, const wxPGEditor* editor )
 964     {
 965         wxPG_PROP_ARG_CALL_PROLOG()
 966         wxCHECK_RET( editor, wxT("unknown/NULL editor") );
 967         p->SetEditor(editor);
 968         RefreshProperty(p);
 969     }
 970 #endif
 971
 972     /** Sets editor control of a property. As editor argument, use
 973         editor name string, such as "TextCtrl" or "Choice".
 974     */
 975     void SetPropertyEditor( wxPGPropArg id, const wxString& editorName )
 976     {
 977         SetPropertyEditor(id,GetEditorByName(editorName));
 978     }
 979
 980     /** Sets label of a property.
 981     */
 982     void SetPropertyLabel( wxPGPropArg id, const wxString& newproplabel );
 983
 984     /**
 985         Sets name of a property.
 986
 987         @param id
 988             Name or pointer of property which name to change.
 989
 990         @param newName
 991             New name for property.
 992     */
 993     void SetPropertyName( wxPGPropArg id, const wxString& newName )
 994     {
 995         wxPG_PROP_ARG_CALL_PROLOG()
 996         m_pState->DoSetPropertyName( p, newName );
 997     }
 998
 999     /**
1000         Sets property (and, recursively, its children) to have read-only value.
1001         In other words, user cannot change the value in the editor, but they
1002         can still copy it.
1003         @remarks
1004         This is mainly for use with textctrl editor. Not all other editors fully
1005         support it.
1006         @param flags
1007         By default changes are applied recursively. Set this paramter
1008         wxPG_DONT_RECURSE to prevent this.
1009     */
1010     void SetPropertyReadOnly( wxPGPropArg id,
1011                               bool set = true,
1012                               int flags = wxPG_RECURSE )
1013     {
1014         wxPG_PROP_ARG_CALL_PROLOG()
1015         if ( flags & wxPG_RECURSE )
1016             p->SetFlagRecursively(wxPG_PROP_READONLY, set);
1017         else
1018             p->ChangeFlag(wxPG_PROP_READONLY, set);
1019     }
1020
1021     /** Sets property's value to unspecified.
1022         If it has children (it may be category), then the same thing is done to
1023         them.
1024     */
1025     void SetPropertyValueUnspecified( wxPGPropArg id )
1026     {
1027         wxPG_PROP_ARG_CALL_PROLOG()
1028         wxVariant nullVariant;
1029         SetPropVal(p, nullVariant);
1030     }
1031
1032 #ifndef SWIG
1033     /** Sets various property values from a list of wxVariants. If property with
1034         name is missing from the grid, new property is created under given
1035         default category (or root if omitted).
1036     */
1037     void SetPropertyValues( const wxVariantList& list,
1038                             wxPGPropArg defaultCategory = wxNullProperty )
1039     {
1040         wxPGProperty *p;
1041         if ( defaultCategory.HasName() ) p = defaultCategory.GetPtr(this);
1042         else p = defaultCategory.GetPtr0();
1043         m_pState->DoSetPropertyValues(list, p);
1044     }
1045
1046     void SetPropertyValues( const wxVariant& list,
1047                             wxPGPropArg defaultCategory = wxNullProperty )
1048     {
1049         SetPropertyValues(list.GetList(),defaultCategory);
1050     }
1051 #endif
1052
1053     /** Associates the help string with property.
1054         @remarks
1055         By default, text is shown either in the manager's "description"
1056         text box or in the status bar. If extra window style
1057         wxPG_EX_HELP_AS_TOOLTIPS is used, then the text will appear as a
1058         tooltip.
1059     */
1060     void SetPropertyHelpString( wxPGPropArg id, const wxString& helpString )
1061     {
1062         wxPG_PROP_ARG_CALL_PROLOG()
1063         p->SetHelpString(helpString);
1064     }
1065
1066     /** Set wxBitmap in front of the value.
1067         @remarks
1068         - Bitmap will be scaled to a size returned by
1069         wxPropertyGrid::GetImageSize();
1070     */
1071     void SetPropertyImage( wxPGPropArg id, wxBitmap& bmp )
1072     {
1073         wxPG_PROP_ARG_CALL_PROLOG()
1074         p->SetValueImage(bmp);
1075         RefreshProperty(p);
1076     }
1077
1078     /** Sets max length of property's text.
1079     */
1080     bool SetPropertyMaxLength( wxPGPropArg id, int maxLen );
1081
1082 #if wxUSE_VALIDATORS
1083     /** Sets validator of a property.
1084     */
1085     void SetPropertyValidator( wxPGPropArg id, const wxValidator& validator )
1086     {
1087         wxPG_PROP_ARG_CALL_PROLOG()
1088         p->SetValidator(validator);
1089     }
1090 #endif
1091
1092 #ifndef SWIG
1093     /** Sets value (long integer) of a property.
1094     */
1095     void SetPropertyValue( wxPGPropArg id, long value )
1096     {
1097         wxVariant v(value);
1098         SetPropVal( id, v );
1099     }
1100
1101     /** Sets value (integer) of a property.
1102     */
1103     void SetPropertyValue( wxPGPropArg id, int value )
1104     {
1105         wxVariant v((long)value);
1106         SetPropVal( id, v );
1107     }
1108     /** Sets value (floating point) of a property.
1109     */
1110     void SetPropertyValue( wxPGPropArg id, double value )
1111     {
1112         wxVariant v(value);
1113         SetPropVal( id, v );
1114     }
1115     /** Sets value (bool) of a property.
1116     */
1117     void SetPropertyValue( wxPGPropArg id, bool value )
1118     {
1119         wxVariant v(value);
1120         SetPropVal( id, v );
1121     }
1122 #if wxUSE_WCHAR_T
1123     void SetPropertyValue( wxPGPropArg id, const wchar_t* value )
1124     {
1125         SetPropertyValueString( id, wxString(value) );
1126     }
1127 #endif
1128     void SetPropertyValue( wxPGPropArg id, const char* value )
1129     {
1130         SetPropertyValueString( id, wxString(value) );
1131     }
1132     void SetPropertyValue( wxPGPropArg id, const wxString& value )
1133     {
1134         SetPropertyValueString( id, value );
1135     }
1136
1137     /** Sets value (wxArrayString) of a property.
1138     */
1139     void SetPropertyValue( wxPGPropArg id, const wxArrayString& value )
1140     {
1141         wxVariant v(value);
1142         SetPropVal( id, v );
1143     }
1144
1145 #if wxUSE_DATETIME
1146     void SetPropertyValue( wxPGPropArg id, const wxDateTime& value )
1147     {
1148         wxVariant v(value);
1149         SetPropVal( id, v );
1150     }
1151 #endif
1152
1153     /** Sets value (wxObject*) of a property.
1154     */
1155     void SetPropertyValue( wxPGPropArg id, wxObject* value )
1156     {
1157         wxVariant v(value);
1158         SetPropVal( id, v );
1159     }
1160
1161     void SetPropertyValue( wxPGPropArg id, wxObject& value )
1162     {
1163         wxVariant v(&value);
1164         SetPropVal( id, v );
1165     }
1166
1167 #ifdef wxLongLong_t
1168     /** Sets value (wxLongLong&) of a property.
1169     */
1170     void SetPropertyValue( wxPGPropArg id, wxLongLong_t value )
1171     {
1172         wxVariant v = WXVARIANT(wxLongLong(value));
1173         SetPropVal( id, v );
1174     }
1175     /** Sets value (wxULongLong&) of a property.
1176     */
1177     void SetPropertyValue( wxPGPropArg id, wxULongLong_t value )
1178     {
1179         wxVariant v = WXVARIANT(wxULongLong(value));
1180         SetPropVal( id, v );
1181     }
1182 #endif
1183
1184     /** Sets value (wxArrayInt&) of a property.
1185     */
1186     void SetPropertyValue( wxPGPropArg id, const wxArrayInt& value )
1187     {
1188         wxVariant v = WXVARIANT(value);
1189         SetPropVal( id, v );
1190     }
1191 #endif  // !SWIG
1192
1193     /** Sets value (wxString) of a property.
1194
1195         @remarks
1196         This method uses wxPGProperty::SetValueFromString, which all properties
1197         should implement. This means that there should not be a type error,
1198         and instead the string is converted to property's actual value type.
1199     */
1200     void SetPropertyValueString( wxPGPropArg id, const wxString& value );
1201
1202     /** Sets value (wxVariant&) of a property.
1203
1204         @remarks
1205         Use wxPropertyGrid::ChangePropertyValue() instead if you need to run
1206         through validation process and send property change event.
1207     */
1208     void SetPropertyValue( wxPGPropArg id, wxVariant value )
1209     {
1210         SetPropVal( id, value );
1211     }
1212
1213 #ifndef SWIG
1214     /** Sets value (wxVariant&) of a property. Same as SetPropertyValue, but
1215         accepts reference. */
1216     void SetPropVal( wxPGPropArg id, wxVariant& value );
1217 #endif
1218
1219     /** Adjusts how wxPropertyGrid behaves when invalid value is entered
1220         in a property.
1221         @param vfbFlags
1222         See @link vfbflags list of valid flags values@endlink
1223     */
1224     void SetValidationFailureBehavior( int vfbFlags );
1225
1226     /**
1227         Sorts all properties recursively.
1228
1229         @param flags
1230             This can contain any of the following options:
1231               wxPG_SORT_TOP_LEVEL_ONLY: Only sort categories and their
1232                 immediate children. Sorting done by wxPG_AUTO_SORT option
1233                 uses this.
1234
1235         @see SortChildren, wxPropertyGrid::SetSortFunction
1236     */
1237     void Sort( int flags = 0 );
1238
1239     /**
1240         Sorts children of a property.
1241
1242         @param id
1243             Name or pointer to a property.
1244
1245         @param flags
1246             This can contain any of the following options:
1247               wxPG_RECURSE: Sorts recursively.
1248
1249         @see Sort, wxPropertyGrid::SetSortFunction
1250     */
1251     void SortChildren( wxPGPropArg id, int flags = 0 )
1252     {
1253         wxPG_PROP_ARG_CALL_PROLOG()
1254         m_pState->DoSortChildren(p, flags);
1255     }
1256
1257     // GetPropertyByName With nice assertion error message.
1258     wxPGProperty* GetPropertyByNameA( const wxString& name ) const;
1259
1260     static wxPGEditor* GetEditorByName( const wxString& editorName );
1261
1262     virtual void RefreshProperty( wxPGProperty* p ) = 0;
1263
1264 protected:
1265
1266     /**
1267         In derived class, implement to set editable state component with
1268         given name to given value.
1269     */
1270     virtual bool SetEditableStateItem( const wxString& name, wxVariant value )
1271     {
1272         wxUnusedVar(name);
1273         wxUnusedVar(value);
1274         return false;
1275     }
1276
1277     /**
1278         In derived class, implement to return editable state component with
1279         given name.
1280     */
1281     virtual wxVariant GetEditableStateItem( const wxString& name ) const
1282     {
1283         wxUnusedVar(name);
1284         return wxNullVariant;
1285     }
1286
1287     // Returns page state data for given (sub) page (-1 means current page).
1288     virtual wxPropertyGridPageState* GetPageState( int pageIndex ) const
1289     {
1290         if ( pageIndex <= 0 )
1291             return m_pState;
1292         return NULL;
1293     }
1294
1295     virtual bool DoSelectPage( int WXUNUSED(index) ) { return true; }
1296
1297     // Default call's m_pState's BaseGetPropertyByName
1298     virtual wxPGProperty* DoGetPropertyByName( const wxString& name ) const;
1299
1300 #ifndef SWIG
1301
1302     // Deriving classes must set this (it must be only or current page).
1303     wxPropertyGridPageState*         m_pState;
1304
1305     // Intermediate version needed due to wxVariant copying inefficiency
1306     void DoSetPropertyAttribute( wxPGPropArg id,
1307                                  const wxString& name,
1308                                  wxVariant& value, long argFlags );
1309
1310     // Empty string object to return from member functions returning const
1311     // wxString&.
1312     wxString                    m_emptyString;
1313
1314 private:
1315     // Cannot be GetGrid() due to ambiguity issues.
1316     wxPropertyGrid* GetPropertyGrid()
1317     {
1318         return m_pState->GetGrid();
1319     }
1320
1321     // Cannot be GetGrid() due to ambiguity issues.
1322     const wxPropertyGrid* GetPropertyGrid() const
1323     {
1324         return (const wxPropertyGrid*) m_pState->GetGrid();
1325     }
1326 #endif // #ifndef SWIG
1327
1328     friend class wxPropertyGrid;
1329     friend class wxPropertyGridManager;
1330 };
1331
1332 #endif // wxUSE_PROPGRID
1333
1334 #endif // __WX_PROPGRID_PROPGRIDIFACE_H__