interface/wx/propgrid/propgrid.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        propgrid.h
   3 // Purpose:     interface of wxPropertyGrid
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10 /**
  11     @section propgrid_window_styles wxPropertyGrid Window Styles
  12
  13     SetWindowStyleFlag method can be used to modify some of these at run-time.
  14     @{
  15 */
  16 enum wxPG_WINDOW_STYLES
  17 {
  18
  19 /**
  20     This will cause Sort() automatically after an item is added.
  21     When inserting a lot of items in this mode, it may make sense to
  22     use Freeze() before operations and Thaw() afterwards to increase
  23     performance.
  24 */
  25 wxPG_AUTO_SORT                      = 0x00000010,
  26
  27 /**
  28     Categories are not initially shown (even if added).
  29     IMPORTANT NOTE: If you do not plan to use categories, then this
  30     style will waste resources.
  31     This flag can also be changed using wxPropertyGrid::EnableCategories method.
  32 */
  33 wxPG_HIDE_CATEGORIES                = 0x00000020,
  34
  35 /**
  36     This style combines non-categoric mode and automatic sorting.
  37 */
  38 wxPG_ALPHABETIC_MODE                = (wxPG_HIDE_CATEGORIES|wxPG_AUTO_SORT),
  39
  40 /**
  41     Modified values are shown in bold font. Changing this requires Refresh()
  42     to show changes.
  43 */
  44 wxPG_BOLD_MODIFIED                  = 0x00000040,
  45
  46 /**
  47     When wxPropertyGrid is resized, splitter moves to the center. This
  48     behavior stops once the user manually moves the splitter.
  49 */
  50 wxPG_SPLITTER_AUTO_CENTER           = 0x00000080,
  51
  52 /**
  53     Display tool tips for cell text that cannot be shown completely. If
  54     wxUSE_TOOLTIPS is 0, then this doesn't have any effect.
  55 */
  56 wxPG_TOOLTIPS                       = 0x00000100,
  57
  58 /**
  59     Disables margin and hides all expand/collapse buttons that would appear
  60     outside the margin (for sub-properties). Toggling this style automatically
  61     expands all collapsed items.
  62 */
  63 wxPG_HIDE_MARGIN                    = 0x00000200,
  64
  65 /**
  66     This style prevents user from moving the splitter.
  67 */
  68 wxPG_STATIC_SPLITTER                = 0x00000400,
  69
  70 /**
  71     Combination of other styles that make it impossible for user to modify
  72     the layout.
  73 */
  74 wxPG_STATIC_LAYOUT                  = (wxPG_HIDE_MARGIN|wxPG_STATIC_SPLITTER),
  75
  76 /**
  77     Disables wxTextCtrl based editors for properties which
  78     can be edited in another way. Equals calling
  79     wxPropertyGrid::LimitPropertyEditing() for all added properties.
  80 */
  81 wxPG_LIMITED_EDITING                = 0x00000800,
  82
  83 /**
  84     wxPropertyGridManager only: Show tool bar for mode and page selection.
  85 */
  86 wxPG_TOOLBAR                        = 0x00001000,
  87
  88 /**
  89     wxPropertyGridManager only: Show adjustable text box showing description
  90     or help text, if available, for currently selected property.
  91 */
  92 wxPG_DESCRIPTION                    = 0x00002000
  93
  94 };
  95
  96 enum wxPG_EX_WINDOW_STYLES
  97 {
  98
  99 /**
 100     NOTE: wxPG_EX_xxx are extra window styles and must be set using SetExtraStyle()
 101     member function.
 102
 103     Speeds up switching to wxPG_HIDE_CATEGORIES mode. Initially, if
 104     wxPG_HIDE_CATEGORIES is not defined, the non-categorized data storage is not
 105     activated, and switching the mode first time becomes somewhat slower.
 106     wxPG_EX_INIT_NOCAT activates the non-categorized data storage right away.
 107
 108     NOTE: If you do plan not switching to non-categoric mode, or if
 109     you don't plan to use categories at all, then using this style will result
 110     in waste of resources.
 111 */
 112 wxPG_EX_INIT_NOCAT                  = 0x00001000,
 113
 114 /**
 115     Extended window style that sets wxPropertyGridManager tool bar to not
 116     use flat style.
 117 */
 118 wxPG_EX_NO_FLAT_TOOLBAR             = 0x00002000,
 119
 120 /**
 121     Shows alphabetic/categoric mode buttons from tool bar.
 122 */
 123 wxPG_EX_MODE_BUTTONS                = 0x00008000,
 124
 125 /**
 126     Show property help strings as tool tips instead as text on the status bar.
 127     You can set the help strings using SetPropertyHelpString member function.
 128 */
 129 wxPG_EX_HELP_AS_TOOLTIPS            = 0x00010000,
 130
 131 /**
 132     Allows relying on native double-buffering.
 133 */
 134 wxPG_EX_NATIVE_DOUBLE_BUFFERING         = 0x00080000,
 135
 136 /**
 137     Set this style to let user have ability to set values of properties to
 138     unspecified state. Same as setting wxPG_PROP_AUTO_UNSPECIFIED for
 139     all properties.
 140 */
 141 wxPG_EX_AUTO_UNSPECIFIED_VALUES         = 0x00200000,
 142
 143 /**
 144     If this style is used, built-in attributes (such as wxPG_FLOAT_PRECISION and
 145     wxPG_STRING_PASSWORD) are not stored into property's attribute storage (thus
 146     they are not readable).
 147
 148     Note that this option is global, and applies to all wxPG property containers.
 149 */
 150 wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES    = 0x00400000,
 151
 152 /**
 153     Hides page selection buttons from tool bar.
 154 */
 155 wxPG_EX_HIDE_PAGE_BUTTONS               = 0x01000000
 156
 157 };
 158
 159 /** Combines various styles.
 160 */
 161 #define wxPG_DEFAULT_STYLE              (0)
 162
 163 /** Combines various styles.
 164 */
 165 #define wxPGMAN_DEFAULT_STYLE       (0)
 166
 167 /** @}
 168 */
 169
 170 // -----------------------------------------------------------------------
 171
 172 /**
 173     @section propgrid_vfbflags wxPropertyGrid Validation Failure Behavior Flags
 174     @{
 175 */
 176
 177 enum wxPG_VALIDATION_FAILURE_BEHAVIOR_FLAGS
 178 {
 179
 180 /**
 181     Prevents user from leaving property unless value is valid. If this
 182     behavior flag is not used, then value change is instead cancelled.
 183 */
 184 wxPG_VFB_STAY_IN_PROPERTY           = 0x01,
 185
 186 /**
 187     Calls wxBell() on validation failure.
 188 */
 189 wxPG_VFB_BEEP                       = 0x02,
 190
 191 /**
 192     Cell with invalid value will be marked (with red colour).
 193 */
 194 wxPG_VFB_MARK_CELL                  = 0x04,
 195
 196 /**
 197     Display customizable text message explaining the situation.
 198 */
 199 wxPG_VFB_SHOW_MESSAGE               = 0x08,
 200
 201 /**
 202     Defaults.
 203 */
 204 wxPG_VFB_DEFAULT                    = wxPG_VFB_STAY_IN_PROPERTY|wxPG_VFB_BEEP,
 205 };
 206
 207 /** @}
 208 */
 209
 210 typedef wxByte wxPGVFBFlags;
 211
 212 /**
 213     wxPGValidationInfo
 214
 215     Used to convey validation information to and from functions that
 216     actually perform validation. Mostly used in custom property classes.
 217 */
 218 class wxPGValidationInfo
 219 {
 220 public:
 221     /**
 222         @return Returns failure behavior which is a combination of
 223             @ref propgrid_vfbflags.
 224     */
 225     wxPGVFBFlags GetFailureBehavior();
 226
 227     /**
 228         Returns current failure message.
 229     */
 230     const wxString& GetFailureMessage() const;
 231
 232     /**
 233         Returns reference to pending value.
 234     */
 235     const wxVariant& GetValue() const;
 236
 237     /** Set validation failure behavior
 238
 239         @param failureBehavior
 240             Mixture of @ref propgrid_vfbflags.
 241     */
 242     void SetFailureBehavior(wxPGVFBFlags failureBehavior);
 243
 244     /**
 245         Set current failure message.
 246     */
 247     void SetFailureMessage(const wxString& message);
 248 };
 249
 250 // -----------------------------------------------------------------------
 251
 252 /**
 253     @section propgrid_keyboard_actions wxPropertyGrid Action Identifiers
 254
 255     These are used with wxPropertyGrid::AddActionTrigger() and
 256     wxPropertyGrid::ClearActionTriggers().
 257     @{
 258 */
 259
 260 enum wxPG_KEYBOARD_ACTIONS
 261 {
 262     wxPG_ACTION_INVALID = 0,
 263     wxPG_ACTION_NEXT_PROPERTY,
 264     wxPG_ACTION_PREV_PROPERTY,
 265     wxPG_ACTION_EXPAND_PROPERTY,
 266     wxPG_ACTION_COLLAPSE_PROPERTY,
 267     wxPG_ACTION_CANCEL_EDIT,
 268     wxPG_ACTION_MAX
 269 };
 270
 271 /** @}
 272 */
 273
 274 /** This callback function is used for sorting properties.
 275
 276     Call wxPropertyGrid::SetSortFunction() to set it.
 277
 278     Sort function should return a value greater than 0 if position of p1 is
 279     after p2. So, for instance, when comparing property names, you can use
 280     following implementation:
 281
 282         @code
 283             int MyPropertySortFunction(wxPropertyGrid* propGrid,
 284                                        wxPGProperty* p1,
 285                                        wxPGProperty* p2)
 286             {
 287                 return p1->GetBaseName().compare( p2->GetBaseName() );
 288             }
 289         @endcode
 290 */
 291 typedef int (*wxPGSortCallback)(wxPropertyGrid* propGrid,
 292                                 wxPGProperty* p1,
 293                                 wxPGProperty* p2);
 294
 295 // -----------------------------------------------------------------------
 296
 297 /**
 298     @class wxPropertyGrid
 299
 300     wxPropertyGrid is a specialized grid for editing properties - in other
 301     words name = value pairs. List of ready-to-use property classes include
 302     strings, numbers, flag sets, fonts, colours and many others. It is possible,
 303     for example, to categorize properties, set up a complete tree-hierarchy,
 304     add more than two columns, and set arbitrary per-property attributes.
 305
 306     Please note that most member functions are inherited and as such not
 307     documented on this page. This means you will probably also want to read
 308     wxPropertyGridInterface class reference.
 309
 310     See also @ref overview_propgrid.
 311
 312     @section propgrid_window_styles_ Window Styles
 313
 314     See @ref propgrid_window_styles.
 315
 316     @section propgrid_event_handling Event Handling
 317
 318     To process input from a property grid control, use these event handler macros
 319     to direct input to member functions that take a wxPropertyGridEvent argument.
 320
 321     @beginEventEmissionTable{wxPropertyGridEvent}
 322     @event{EVT_PG_SELECTED (id, func)}
 323         Respond to wxEVT_PG_SELECTED event, generated when property value
 324         has been changed by user.
 325     @event{EVT_PG_CHANGING(id, func)}
 326         Respond to wxEVT_PG_CHANGING event, generated when property value
 327         is about to be changed by user. Use wxPropertyGridEvent::GetValue()
 328         to take a peek at the pending value, and wxPropertyGridEvent::Veto()
 329         to prevent change from taking place, if necessary.
 330     @event{EVT_PG_HIGHLIGHTED(id, func)}
 331         Respond to wxEVT_PG_HIGHLIGHTED event, which occurs when mouse
 332         moves over a property. Event's property is NULL if hovered area does
 333         not belong to any property.
 334     @event{EVT_PG_RIGHT_CLICK(id, func)}
 335         Respond to wxEVT_PG_RIGHT_CLICK event, which occurs when property is
 336         clicked on with right mouse button.
 337     @event{EVT_PG_DOUBLE_CLICK(id, func)}
 338         Respond to wxEVT_PG_DOUBLE_CLICK event, which occurs when property is
 339         double-clicked on with left mouse button.
 340     @event{EVT_PG_ITEM_COLLAPSED(id, func)}
 341         Respond to wxEVT_PG_ITEM_COLLAPSED event, generated when user collapses
 342         a property or category.
 343     @event{EVT_PG_ITEM_EXPANDED(id, func)}
 344         Respond to wxEVT_PG_ITEM_EXPANDED event, generated when user expands
 345         a property or category.
 346     @endEventTable
 347
 348     @remarks
 349     Use Freeze() and Thaw() respectively to disable and enable drawing.
 350     This will also delay sorting etc. miscellaneous calculations to the last
 351     possible moment.
 352
 353     @library{wxpropgrid}
 354     @category{propgrid}
 355     @appearance{propertygrid.png}
 356 */
 357 class wxPropertyGrid : public wxScrolledWindow, public wxPropertyGridInterface
 358 {
 359 public:
 360     /**
 361         Two step constructor.
 362         Call Create() when this constructor is called to build up the wxPropertyGrid
 363     */
 364     wxPropertyGrid();
 365
 366     /**
 367         Constructor.
 368         The styles to be used are styles valid for the wxWindow and wxScrolledWindow.
 369
 370         @see @ref propgrid_window_styles.
 371     */
 372     wxPropertyGrid( wxWindow *parent, wxWindowID id = wxID_ANY,
 373                     const wxPoint& pos = wxDefaultPosition,
 374                     const wxSize& size = wxDefaultSize,
 375                     long style = wxPG_DEFAULT_STYLE,
 376                     const wxChar* name = wxPropertyGridNameStr );
 377
 378     /** Destructor */
 379     virtual ~wxPropertyGrid();
 380
 381     /**
 382         Adds given key combination to trigger given action.
 383
 384         @param action
 385             Which action to trigger. See @ref propgrid_keyboard_actions.
 386         @param keycode
 387             Which keycode triggers the action.
 388         @param modifiers
 389             Which key event modifiers, in addition to keycode, are needed to
 390             trigger the action.
 391     */
 392     void AddActionTrigger( int action, int keycode, int modifiers = 0 );
 393
 394     /**
 395         This static function enables or disables automatic use of
 396         wxGetTranslation() for following strings: wxEnumProperty list labels,
 397         wxFlagsProperty child property labels.
 398
 399         Default is false.
 400     */
 401     static void AutoGetTranslation( bool enable );
 402
 403     /**
 404         Changes value of a property, as if from an editor. Use this instead of
 405         SetPropertyValue() if you need the value to run through validation
 406         process, and also send the property change event.
 407
 408         @return Returns true if value was successfully changed.
 409     */
 410     bool ChangePropertyValue( wxPGPropArg id, wxVariant newValue );
 411
 412     /**
 413         Centers the splitter. If argument is true, automatic splitter centering
 414         is enabled (only applicable if style wxPG_SPLITTER_AUTO_CENTER was
 415         defined).
 416     */
 417     void CenterSplitter( bool enable_auto_centering = false );
 418
 419     /**
 420         Deletes all properties.
 421     */
 422     virtual void Clear();
 423
 424     /**
 425         Clears action triggers for given action.
 426
 427         @param action
 428             Which action to trigger. @ref propgrid_keyboard_actions.
 429     */
 430     void ClearActionTriggers( int action );
 431
 432     /**
 433         Forces updating the value of property from the editor control.
 434         Note that wxEVT_PG_CHANGING and wxEVT_PG_CHANGED are dispatched using
 435         ProcessEvent, meaning your event handlers will be called immediately.
 436
 437         @return Returns @true if anything was changed.
 438     */
 439     virtual bool CommitChangesFromEditor( wxUint32 flags = 0 );
 440
 441     /**
 442         Two step creation. Whenever the control is created without any
 443         parameters, use Create to actually create it. Don't access the control's
 444         public methods before this is called
 445
 446         @see @ref propgrid_window_styles.
 447     */
 448     bool Create( wxWindow *parent, wxWindowID id = wxID_ANY,
 449                 const wxPoint& pos = wxDefaultPosition,
 450                 const wxSize& size = wxDefaultSize,
 451                 long style = wxPG_DEFAULT_STYLE,
 452                 const wxChar* name = wxPropertyGridNameStr );
 453
 454     /**
 455         Call when editor widget's contents is modified. For example, this is
 456         called when changes text in wxTextCtrl (used in wxStringProperty and
 457         wxIntProperty).
 458
 459         @remarks This function should only be called by custom properties.
 460
 461         @see wxPGProperty::OnEvent()
 462     */
 463     void EditorsValueWasModified();
 464
 465     /**
 466         Reverse of EditorsValueWasModified().
 467
 468         @remarks This function should only be called by custom properties.
 469     */
 470     void EditorsValueWasNotModified();
 471
 472     /**
 473         Enables or disables (shows/hides) categories according to parameter
 474         enable.
 475
 476         @remarks This functions deselects selected property, if any. Validation
 477                 failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie.
 478                 selection is cleared even if editor had invalid value.
 479     */
 480     bool EnableCategories( bool enable );
 481
 482     /**
 483         Scrolls and/or expands items to ensure that the given item is visible.
 484
 485         @return Returns @true if something was actually done.
 486     */
 487     bool EnsureVisible( wxPGPropArg id );
 488
 489     /**
 490         Reduces column sizes to minimum possible, while still retaining
 491         fully visible grid contents (labels, images).
 492
 493         @return Minimum size for the grid to still display everything.
 494
 495         @remarks Does not work well with wxPG_SPLITTER_AUTO_CENTER window style.
 496
 497                 This function only works properly if grid size prior to call was
 498                 already fairly large.
 499
 500                 Note that you can also get calculated column widths by calling
 501                 GetState->GetColumnWidth() immediately after this function
 502                 returns.
 503     */
 504     wxSize FitColumns();
 505
 506     /**
 507         Returns wxWindow that the properties are painted on, and which should be
 508         used as the parent for editor controls.
 509     */
 510     wxPanel* GetPanel() const;
 511
 512     /**
 513         Returns current category caption background colour.
 514     */
 515     wxColour GetCaptionBackgroundColour() const;
 516
 517     /**
 518         Returns current category caption font.
 519     */
 520     wxFont& GetCaptionFont();
 521
 522     /**
 523         Returns current category caption text colour.
 524     */
 525     wxColour GetCaptionForegroundColour() const;
 526
 527     /**
 528         Returns current cell background colour.
 529     */
 530     wxColour GetCellBackgroundColour() const;
 531
 532     /**
 533         Returns current cell text colour when disabled.
 534     */
 535     wxColour GetCellDisabledTextColour() const;
 536
 537     /**
 538         Returns current cell text colour.
 539     */
 540     wxColour GetCellTextColour() const;
 541
 542     /**
 543         Returns number of columns currently on grid.
 544     */
 545     unsigned int GetColumnCount() const;
 546
 547     /**
 548         Returns colour of empty space below properties.
 549     */
 550     wxColour GetEmptySpaceColour() const;
 551
 552     /**
 553         Returns height of highest characters of used font.
 554     */
 555     int GetFontHeight() const;
 556
 557     /**
 558         Returns pointer to itself. Dummy function that enables same kind
 559         of code to use wxPropertyGrid and wxPropertyGridManager.
 560     */
 561     wxPropertyGrid* GetGrid();
 562
 563     /**
 564         Returns rectangle of custom paint image.
 565
 566         @param property
 567             Return image rectangle for this property.
 568
 569         @param item
 570             Which choice of property to use (each choice may have
 571             different image).
 572     */
 573     wxRect GetImageRect( wxPGProperty* property, int item ) const;
 574
 575     /**
 576         Returns size of the custom paint image in front of property.
 577
 578         @param property
 579             Return image rectangle for this property.
 580             If this argument is NULL, then preferred size is returned.
 581
 582         @param item
 583             Which choice of property to use (each choice may have
 584             different image).
 585     */
 586     wxSize GetImageSize( wxPGProperty* property = NULL, int item = -1 ) const;
 587
 588     /**
 589         Returns last item which could be iterated using given flags.
 590
 591         @param flags
 592             See @ref propgrid_iterator_flags.
 593     */
 594     wxPGProperty* GetLastItem( int flags = wxPG_ITERATE_DEFAULT );
 595
 596     /**
 597         Returns colour of lines between cells.
 598     */
 599     wxColour GetLineColour() const;
 600
 601     /**
 602         Returns background colour of margin.
 603     */
 604     wxColour GetMarginColour() const;
 605
 606     /**
 607         Returns most up-to-date value of selected property. This will return
 608         value different from GetSelectedProperty()->GetValue() only when text
 609         editor is activate and string edited by user represents valid,
 610         uncommitted property value.
 611     */
 612     wxVariant GetUncommittedPropertyValue();
 613
 614     /**
 615         Returns "root property". It does not have name, etc. and it is not
 616         visible. It is only useful for accessing its children.
 617     */
 618     wxPGProperty* GetRoot() const;
 619
 620     /**
 621         Returns height of a single grid row (in pixels).
 622     */
 623     int GetRowHeight() const;
 624
 625     /**
 626         Returns currently selected property.
 627     */
 628     wxPGProperty* GetSelectedProperty() const;
 629
 630     /**
 631         Returns currently selected property.
 632     */
 633     wxPGProperty* GetSelection() const;
 634
 635     /**
 636         Returns current selection background colour.
 637     */
 638     wxColour GetSelectionBackgroundColour() const;
 639
 640     /**
 641         Returns current selection text colour.
 642     */
 643     wxColour GetSelectionForegroundColour() const;
 644
 645     /**
 646         Returns the property sort function (default is @NULL).
 647
 648         @see SetSortFunction
 649     */
 650     wxPGSortCallback GetSortFunction() const;
 651
 652     /**
 653         Returns current splitter x position.
 654     */
 655     int GetSplitterPosition() const;
 656
 657     /**
 658         Returns wxTextCtrl active in currently selected property, if any. Takes
 659         wxOwnerDrawnComboBox into account.
 660     */
 661     wxTextCtrl* GetEditorTextCtrl() const;
 662
 663     /**
 664         Returns current vertical spacing.
 665     */
 666     int GetVerticalSpacing() const;
 667
 668     /**
 669         Returns true if editor's value was marked modified.
 670     */
 671     bool IsEditorsValueModified() const;
 672
 673     /**
 674         Returns information about arbitrary position in the grid.
 675
 676         @param pt
 677             Coordinates in the virtual grid space. You may need to use
 678             wxScrolledWindow::CalcScrolledPosition() for translating
 679             wxPropertyGrid client coordinates into something this member
 680             function can use.
 681     */
 682     wxPropertyGridHitTestResult HitTest( const wxPoint& pt ) const;
 683
 684     /**
 685         Returns true if any property has been modified by the user.
 686     */
 687     bool IsAnyModified() const;
 688
 689     /**
 690         Returns @true if a property editor control has focus.
 691     */
 692     bool IsEditorFocused() const;
 693
 694     /**
 695         Returns true if updating is frozen (ie. Freeze() called but not
 696         yet Thaw() ).
 697     */
 698     bool IsFrozen() const;
 699
 700     /**
 701         It is recommended that you call this function any time your code causes
 702         wxPropertyGrid's top-level parent to change. wxPropertyGrid's OnIdle()
 703         handler should be able to detect most changes, but it is not perfect.
 704
 705         @param newTLP
 706             New top-level parent that is about to be set. Old top-level parent
 707             window should still exist as the current one.
 708
 709         @remarks This function is automatically called from wxPropertyGrid::
 710                  Reparent() and wxPropertyGridManager::Reparent(). You only
 711                  need to use it if you reparent wxPropertyGrid indirectly.
 712     */
 713     void OnTLPChanging( wxWindow* newTLP );
 714
 715     /**
 716         Refreshes any active editor control.
 717     */
 718     void RefreshEditor();
 719
 720     /**
 721         Redraws given property.
 722     */
 723     virtual void RefreshProperty( wxPGProperty* p );
 724
 725     /**
 726         Registers a new editor class.
 727
 728         @return Returns pointer  to the editor class instance that should be used.
 729     */
 730     static wxPGEditor* RegisterEditorClass( wxPGEditor* editor,
 731                                             const wxString& name,
 732                                             bool noDefCheck = false );
 733
 734     /**
 735         Resets all colours to the original system values.
 736     */
 737     void ResetColours();
 738
 739     /**
 740         Selects a property. Editor widget is automatically created, but
 741         not focused unless focus is true. This will generate wxEVT_PG_SELECT
 742         event.
 743
 744         @param id
 745             Property to select (name or pointer).
 746
 747         @param focus
 748             If @true, move keyboard focus to the created editor right away.
 749
 750         @return returns @true if selection finished successfully. Usually only
 751         fails if current value in editor is not valid.
 752
 753         @see wxPropertyGrid::ClearSelection()
 754     */
 755     bool SelectProperty( wxPGPropArg id, bool focus = false );
 756
 757     /**
 758         Changes keyboard shortcut to push the editor button.
 759
 760         @remarks You can set default with keycode 0. Good value for the platform
 761                 is guessed, but don't expect it to be very accurate.
 762     */
 763     void SetButtonShortcut( int keycode, bool ctrlDown = false, bool altDown = false );
 764
 765     /**
 766         Sets category caption background colour.
 767     */
 768     void SetCaptionBackgroundColour(const wxColour& col);
 769
 770     /**
 771         Sets category caption text colour.
 772     */
 773     void SetCaptionTextColour(const wxColour& col);
 774
 775     /**
 776         Sets default cell background colour - applies to property cells.
 777         Note that appearance of editor widgets may not be affected.
 778     */
 779     void SetCellBackgroundColour(const wxColour& col);
 780
 781     /**
 782         Sets cell text colour for disabled properties.
 783     */
 784     void SetCellDisabledTextColour(const wxColour& col);
 785
 786     /**
 787         Sets default cell text colour - applies to property name and value text.
 788         Note that appearance of editor widgets may not be affected.
 789     */
 790     void SetCellTextColour(const wxColour& col);
 791
 792     /**
 793         Set number of columns (2 or more).
 794     */
 795     void SetColumnCount( int colCount );
 796
 797     /**
 798         Sets the 'current' category - Append will add non-category properties
 799         under it.
 800     */
 801     void SetCurrentCategory( wxPGPropArg id );
 802
 803     /**
 804         Sets colour of empty space below properties.
 805     */
 806     void SetEmptySpaceColour(const wxColour& col);
 807
 808     /**
 809         Sets colour of lines between cells.
 810     */
 811     void SetLineColour(const wxColour& col);
 812
 813     /**
 814         Sets background colour of margin.
 815     */
 816     void SetMarginColour(const wxColour& col);
 817
 818     /**
 819         Sets selection background colour - applies to selected property name
 820         background.
 821     */
 822     void SetSelectionBackgroundColour(const wxColour& col);
 823
 824     /**
 825         Sets selection foreground colour - applies to selected property name text.
 826     */
 827     void SetSelectionTextColour(const wxColour& col);
 828
 829
 830     /**
 831         Sets the property sorting function.
 832
 833         @param sortFunction
 834             The sorting function to be used. It should return a value greater
 835             than 0 if position of p1 is after p2. So, for instance, when
 836             comparing property names, you can use following implementation:
 837
 838             @code
 839                 int MyPropertySortFunction(wxPropertyGrid* propGrid,
 840                                            wxPGProperty* p1,
 841                                            wxPGProperty* p2)
 842                 {
 843                     return p1->GetBaseName().compare( p2->GetBaseName() );
 844                 }
 845             @endcode
 846
 847         @remarks
 848             Default property sort function sorts properties by their labels
 849             (case-insensitively).
 850
 851         @see GetSortFunction, wxPropertyGridInterface::Sort,
 852              wxPropertyGridInterface::SortChildren
 853     */
 854     void SetSortFunction( wxPGSortCallback sortFunction );
 855
 856     /**
 857         Sets x coordinate of the splitter.
 858
 859         @remarks Splitter position cannot exceed grid size, and therefore setting
 860                 it during form creation may fail as initial grid size is often
 861                 smaller than desired splitter position, especially when sizers
 862                 are being used.
 863     */
 864     void SetSplitterPosition( int newxpos, int col = 0 );
 865
 866     /**
 867         Moves splitter as left as possible, while still allowing all
 868         labels to be shown in full.
 869
 870         @param privateChildrenToo
 871             If @false, will still allow private children to be cropped.
 872     */
 873     void SetSplitterLeft( bool privateChildrenToo = false );
 874
 875     /**
 876         Sets vertical spacing. Can be 1, 2, or 3 - a value relative to font
 877         height. Value of 2 should be default on most platforms.
 878     */
 879     void SetVerticalSpacing( int vspacing );
 880
 881     /**
 882         Shows an brief error message that is related to a property.
 883     */
 884     void ShowPropertyError( wxPGPropArg id, const wxString& msg );
 885 };
 886
 887
 888 /**
 889     @class wxPropertyGridEvent
 890
 891     A property grid event holds information about events associated with
 892     wxPropertyGrid objects.
 893
 894     @library{wxpropgrid}
 895     @category{propgrid}
 896 */
 897 class wxPropertyGridEvent : public wxCommandEvent
 898 {
 899 public:
 900
 901     /** Constructor. */
 902     wxPropertyGridEvent(wxEventType commandType=0, int id=0);
 903
 904     /** Copy constructor. */
 905     wxPropertyGridEvent(const wxPropertyGridEvent& event);
 906
 907     /** Destructor. */
 908     ~wxPropertyGridEvent();
 909
 910     /**
 911         Returns true if you can veto the action that the event is signaling.
 912     */
 913     bool CanVeto() const;
 914
 915     /**
 916         Returns highest level non-category, non-root parent of property for
 917         which event occurred. Useful when you have nested properties with
 918         children.
 919
 920         @remarks If immediate parent is root or category, this will return the
 921                 property itself.
 922     */
 923     wxPGProperty* GetMainParent() const;
 924
 925     /**
 926         Returns property associated with this event.
 927     */
 928     wxPGProperty* GetProperty() const;
 929
 930     /**
 931         Returns current validation failure flags.
 932     */
 933     wxPGVFBFlags GetValidationFailureBehavior() const;
 934
 935     /**
 936         Returns value that is about to be set for wxEVT_PG_CHANGING.
 937     */
 938     const wxVariant& GetValue() const;
 939
 940     /**
 941         Set if event can be vetoed.
 942     */
 943     void SetCanVeto( bool canVeto );
 944
 945     /** Changes the property associated with this event. */
 946     void SetProperty( wxPGProperty* p );
 947
 948     /**
 949         Set override validation failure behavior. Only effective if Veto() was
 950         also called, and only allowed if event type is wxEVT_PG_CHANGING.
 951     */
 952     void SetValidationFailureBehavior( wxPGVFBFlags flags );
 953
 954     /**
 955         Sets custom failure message for this time only. Only applies if
 956         wxPG_VFB_SHOW_MESSAGE is set in validation failure flags.
 957     */
 958     void SetValidationFailureMessage( const wxString& message );
 959
 960     /**
 961         Call this from your event handler to veto action that the event is
 962         signaling. You can only veto a shutdown if wxPropertyGridEvent::CanVeto()
 963         returns true.
 964
 965         @remarks Currently only wxEVT_PG_CHANGING supports vetoing.
 966     */
 967     void Veto( bool veto = true );
 968
 969     /**
 970         Returns @true if event was vetoed.
 971     */
 972     bool WasVetoed() const;
 973 };