include/wx/propgrid/propgrid.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/propgrid/propgrid.h
   3 // Purpose:     wxPropertyGrid
   4 // Author:      Jaakko Salli
   5 // Modified by:
   6 // Created:     2004-09-25
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Jaakko Salli
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_PROPGRID_PROPGRID_H_
  13 #define _WX_PROPGRID_PROPGRID_H_
  14
  15 #if wxUSE_PROPGRID
  16
  17 #include "wx/dcclient.h"
  18 #include "wx/scrolwin.h"
  19 #include "wx/tooltip.h"
  20 #include "wx/datetime.h"
  21
  22 #include "wx/propgrid/property.h"
  23 #include "wx/propgrid/propgridiface.h"
  24
  25
  26 #ifndef SWIG
  27 extern WXDLLIMPEXP_DATA_PROPGRID(const char) wxPropertyGridNameStr[];
  28 #endif
  29
  30 class wxPGComboBox;
  31
  32 // -----------------------------------------------------------------------
  33 // Global variables
  34 // -----------------------------------------------------------------------
  35
  36 #ifndef SWIG
  37
  38 // This is required for sharing common global variables.
  39 class WXDLLIMPEXP_PROPGRID wxPGGlobalVarsClass
  40 {
  41 public:
  42
  43     wxPGGlobalVarsClass();
  44     ~wxPGGlobalVarsClass();
  45
  46     // Used by advprops, but here to make things easier.
  47     wxString            m_pDefaultImageWildcard;
  48
  49     // Map of editor class instances (keys are name string).
  50     wxPGHashMapS2P      m_mapEditorClasses;
  51
  52 #if wxUSE_VALIDATORS
  53     wxVector<wxValidator*>  m_arrValidators; // These wxValidators need to be freed
  54 #endif
  55
  56     wxPGHashMapS2P      m_dictPropertyClassInfo; // PropertyName -> ClassInfo
  57
  58     wxPGChoices*        m_fontFamilyChoices;
  59
  60     // Replace with your own to affect all properties using default renderer.
  61     wxPGCellRenderer*   m_defaultRenderer;
  62
  63     wxPGChoices         m_boolChoices;
  64
  65     wxVariant           m_vEmptyString;
  66     wxVariant           m_vZero;
  67     wxVariant           m_vMinusOne;
  68     wxVariant           m_vTrue;
  69     wxVariant           m_vFalse;
  70
  71     // Cached constant strings
  72     wxPGCachedString    m_strstring;
  73     wxPGCachedString    m_strlong;
  74     wxPGCachedString    m_strbool;
  75     wxPGCachedString    m_strlist;
  76
  77     wxPGCachedString    m_strMin;
  78     wxPGCachedString    m_strMax;
  79     wxPGCachedString    m_strUnits;
  80     wxPGCachedString    m_strInlineHelp;
  81
  82     // If true then some things are automatically translated
  83     bool                m_autoGetTranslation;
  84
  85     // > 0 if errors cannot or should not be shown in statusbar etc.
  86     int                 m_offline;
  87
  88     int                 m_extraStyle;  // global extra style
  89
  90 #ifdef __WXDEBUG__
  91     int                 m_warnings;
  92 #endif
  93
  94     int HasExtraStyle( int style ) const { return (m_extraStyle & style); }
  95 };
  96
  97 extern WXDLLIMPEXP_PROPGRID wxPGGlobalVarsClass* wxPGGlobalVars;
  98
  99 #define wxPGVariant_EmptyString     (wxPGGlobalVars->m_vEmptyString)
 100 #define wxPGVariant_Zero            (wxPGGlobalVars->m_vZero)
 101 #define wxPGVariant_MinusOne        (wxPGGlobalVars->m_vMinusOne)
 102 #define wxPGVariant_True            (wxPGGlobalVars->m_vTrue)
 103 #define wxPGVariant_False           (wxPGGlobalVars->m_vFalse)
 104
 105 #define wxPGVariant_Bool(A)     (A?wxPGVariant_True:wxPGVariant_False)
 106
 107 #endif // !SWIG
 108
 109 // -----------------------------------------------------------------------
 110
 111 /** @section propgrid_window_styles wxPropertyGrid Window Styles
 112
 113     SetWindowStyleFlag method can be used to modify some of these at run-time.
 114     @{
 115 */
 116 enum wxPG_WINDOW_STYLES
 117 {
 118
 119 /** This will cause Sort() automatically after an item is added.
 120     When inserting a lot of items in this mode, it may make sense to
 121     use Freeze() before operations and Thaw() afterwards to increase
 122     performance.
 123 */
 124 wxPG_AUTO_SORT                      = 0x00000010,
 125
 126 /** Categories are not initially shown (even if added).
 127     IMPORTANT NOTE: If you do not plan to use categories, then this
 128     style will waste resources.
 129     This flag can also be changed using wxPropertyGrid::EnableCategories method.
 130 */
 131 wxPG_HIDE_CATEGORIES                = 0x00000020,
 132
 133 /* This style combines non-categoric mode and automatic sorting.
 134 */
 135 wxPG_ALPHABETIC_MODE                = (wxPG_HIDE_CATEGORIES|wxPG_AUTO_SORT),
 136
 137 /** Modified values are shown in bold font. Changing this requires Refresh()
 138     to show changes.
 139 */
 140 wxPG_BOLD_MODIFIED                  = 0x00000040,
 141
 142 /** When wxPropertyGrid is resized, splitter moves to the center. This
 143     behavior stops once the user manually moves the splitter.
 144 */
 145 wxPG_SPLITTER_AUTO_CENTER           = 0x00000080,
 146
 147 /** Display tooltips for cell text that cannot be shown completely. If
 148     wxUSE_TOOLTIPS is 0, then this doesn't have any effect.
 149 */
 150 wxPG_TOOLTIPS                       = 0x00000100,
 151
 152 /** Disables margin and hides all expand/collapse buttons that would appear
 153     outside the margin (for sub-properties). Toggling this style automatically
 154     expands all collapsed items.
 155 */
 156 wxPG_HIDE_MARGIN                    = 0x00000200,
 157
 158 /** This style prevents user from moving the splitter.
 159 */
 160 wxPG_STATIC_SPLITTER                = 0x00000400,
 161
 162 /** Combination of other styles that make it impossible for user to modify
 163     the layout.
 164 */
 165 wxPG_STATIC_LAYOUT                  = (wxPG_HIDE_MARGIN|wxPG_STATIC_SPLITTER),
 166
 167 /** Disables wxTextCtrl based editors for properties which
 168     can be edited in another way.
 169
 170     Equals calling wxPropertyGrid::LimitPropertyEditing for all added
 171     properties.
 172 */
 173 wxPG_LIMITED_EDITING                = 0x00000800,
 174
 175 /** wxPropertyGridManager only: Show toolbar for mode and page selection. */
 176 wxPG_TOOLBAR                        = 0x00001000,
 177
 178 /** wxPropertyGridManager only: Show adjustable text box showing description
 179     or help text, if available, for currently selected property.
 180 */
 181 wxPG_DESCRIPTION                    = 0x00002000
 182
 183 };
 184
 185 enum wxPG_EX_WINDOW_STYLES
 186 {
 187
 188 /**
 189     NOTE: wxPG_EX_xxx are extra window styles and must be set using
 190     SetExtraStyle() member function.
 191
 192     Speeds up switching to wxPG_HIDE_CATEGORIES mode. Initially, if
 193     wxPG_HIDE_CATEGORIES is not defined, the non-categorized data storage is
 194     not activated, and switching the mode first time becomes somewhat slower.
 195     wxPG_EX_INIT_NOCAT activates the non-categorized data storage right away.
 196     IMPORTANT NOTE: If you do plan not switching to non-categoric mode, or if
 197     you don't plan to use categories at all, then using this style will result
 198     in waste of resources.
 199
 200 */
 201 wxPG_EX_INIT_NOCAT                  = 0x00001000,
 202
 203 /** Extended window style that sets wxPropertyGridManager toolbar to not
 204     use flat style.
 205 */
 206 wxPG_EX_NO_FLAT_TOOLBAR             = 0x00002000,
 207
 208 /** Shows alphabetic/categoric mode buttons from toolbar.
 209 */
 210 wxPG_EX_MODE_BUTTONS                = 0x00008000,
 211
 212 /** Show property help strings as tool tips instead as text on the status bar.
 213     You can set the help strings using SetPropertyHelpString member function.
 214 */
 215 wxPG_EX_HELP_AS_TOOLTIPS            = 0x00010000,
 216
 217 /** Prevent TAB from focusing to wxButtons. This behavior was default
 218     in version 1.2.0 and earlier.
 219     NOTE! Tabbing to button doesn't work yet. Problem seems to be that on wxMSW
 220       atleast the button doesn't properly propagate key events (yes, I'm using
 221       wxWANTS_CHARS).
 222 */
 223 //wxPG_EX_NO_TAB_TO_BUTTON            = 0x00020000,
 224
 225 /** Allows relying on native double-buffering.
 226 */
 227 wxPG_EX_NATIVE_DOUBLE_BUFFERING         = 0x00080000,
 228
 229 /** Set this style to let user have ability to set values of properties to
 230     unspecified state. Same as setting wxPG_PROP_AUTO_UNSPECIFIED for
 231     all properties.
 232 */
 233 wxPG_EX_AUTO_UNSPECIFIED_VALUES         = 0x00200000,
 234
 235 /**
 236     If this style is used, built-in attributes (such as wxPG_FLOAT_PRECISION
 237     and wxPG_STRING_PASSWORD) are not stored into property's attribute storage
 238     (thus they are not readable).
 239
 240     Note that this option is global, and applies to all wxPG property
 241     containers.
 242 */
 243 wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES    = 0x00400000,
 244
 245 /** Hides page selection buttons from toolbar.
 246 */
 247 wxPG_EX_HIDE_PAGE_BUTTONS               = 0x01000000
 248
 249 };
 250
 251 /** Combines various styles.
 252 */
 253 #define wxPG_DEFAULT_STYLE          (0)
 254
 255 /** Combines various styles.
 256 */
 257 #define wxPGMAN_DEFAULT_STYLE       (0)
 258
 259 /** @}
 260 */
 261
 262 // -----------------------------------------------------------------------
 263
 264 //
 265 // Ids for sub-controls
 266 // NB: It should not matter what these are.
 267 #define wxPG_SUBID1                     2
 268 #define wxPG_SUBID2                     3
 269 #define wxPG_SUBID_TEMP1                4
 270
 271 // -----------------------------------------------------------------------
 272
 273 /** @class wxPGCommonValue
 274
 275     wxPropertyGrid stores information about common values in these
 276     records.
 277
 278     NB: Common value feature is not complete, and thus not mentioned in
 279         documentation.
 280 */
 281 class WXDLLIMPEXP_PROPGRID wxPGCommonValue
 282 {
 283 public:
 284
 285     wxPGCommonValue( const wxString& label, wxPGCellRenderer* renderer )
 286     {
 287         m_label = label;
 288         m_renderer = renderer;
 289         renderer->IncRef();
 290     }
 291     virtual ~wxPGCommonValue()
 292     {
 293         m_renderer->DecRef();
 294     }
 295
 296     virtual wxString GetEditableText() const { return m_label; }
 297     const wxString& GetLabel() const { return m_label; }
 298     wxPGCellRenderer* GetRenderer() const { return m_renderer; }
 299
 300 protected:
 301     wxString            m_label;
 302     wxPGCellRenderer*   m_renderer;
 303 };
 304
 305 // -----------------------------------------------------------------------
 306
 307 /** @section propgrid_vfbflags wxPropertyGrid Validation Failure Behavior Flags
 308     @{
 309 */
 310
 311 enum wxPG_VALIDATION_FAILURE_BEHAVIOR_FLAGS
 312 {
 313
 314 /** Prevents user from leaving property unless value is valid. If this
 315     behavior flag is not used, then value change is instead cancelled.
 316 */
 317 wxPG_VFB_STAY_IN_PROPERTY           = 0x01,
 318
 319 /** Calls wxBell() on validation failure.
 320 */
 321 wxPG_VFB_BEEP                       = 0x02,
 322
 323 /** Cell with invalid value will be marked (with red colour).
 324 */
 325 wxPG_VFB_MARK_CELL                  = 0x04,
 326
 327 /** Display customizable text message explaining the situation.
 328 */
 329 wxPG_VFB_SHOW_MESSAGE               = 0x08,
 330
 331 /** Defaults. */
 332 wxPG_VFB_DEFAULT                    = wxPG_VFB_STAY_IN_PROPERTY|wxPG_VFB_BEEP,
 333
 334 /** Only used internally. */
 335 wxPG_VFB_UNDEFINED                  = 0x80
 336
 337 };
 338
 339 /** @}
 340 */
 341
 342 typedef wxByte wxPGVFBFlags;
 343
 344 /**
 345     wxPGValidationInfo
 346
 347     Used to convey validation information to and from functions that
 348     actually perform validation. Mostly used in custom property
 349     classes.
 350 */
 351 class WXDLLIMPEXP_PROPGRID wxPGValidationInfo
 352 {
 353     friend class wxPropertyGrid;
 354 public:
 355     /**
 356         @return Returns failure behavior which is a combination of
 357                @ref propgrid_vfbflags.
 358     */
 359     wxPGVFBFlags GetFailureBehavior() const
 360         { return m_failureBehavior; }
 361
 362     /**
 363         Returns current failure message.
 364     */
 365     const wxString& GetFailureMessage() const
 366         { return m_failureMessage; }
 367
 368     /**
 369         Returns reference to pending value.
 370     */
 371     const wxVariant& GetValue() const
 372     {
 373         wxASSERT(m_pValue);
 374         return *m_pValue;
 375     }
 376
 377     /** Set validation failure behavior
 378
 379         @param failureBehavior
 380             Mixture of @ref propgrid_vfbflags.
 381     */
 382     void SetFailureBehavior(wxPGVFBFlags failureBehavior)
 383         { m_failureBehavior = failureBehavior; }
 384
 385     /**
 386         Set current failure message.
 387     */
 388     void SetFailureMessage(const wxString& message)
 389         { m_failureMessage = message; }
 390
 391 private:
 392     /** Value to be validated.
 393     */
 394     wxVariant*      m_pValue;
 395
 396     /** Message displayed on validation failure.
 397     */
 398     wxString        m_failureMessage;
 399
 400     /** Validation failure behavior. Use wxPG_VFB_XXX flags.
 401     */
 402     wxPGVFBFlags    m_failureBehavior;
 403 };
 404
 405 // -----------------------------------------------------------------------
 406
 407 /** @section propgrid_pgactions wxPropertyGrid Action Identifiers
 408
 409     These are used with wxPropertyGrid::AddActionTrigger() and
 410     wxPropertyGrid::ClearActionTriggers().
 411     @{
 412 */
 413
 414 enum wxPG_KEYBOARD_ACTIONS
 415 {
 416     wxPG_ACTION_INVALID = 0,
 417     wxPG_ACTION_NEXT_PROPERTY,
 418     wxPG_ACTION_PREV_PROPERTY,
 419     wxPG_ACTION_EXPAND_PROPERTY,
 420     wxPG_ACTION_COLLAPSE_PROPERTY,
 421     wxPG_ACTION_CANCEL_EDIT,
 422     wxPG_ACTION_PRESS_BUTTON,  // Causes editor button (if any) to be pressed
 423     wxPG_ACTION_MAX
 424 };
 425
 426 /** @}
 427 */
 428
 429 // -----------------------------------------------------------------------
 430
 431
 432 // wxPropertyGrid::DoSelectProperty flags (selFlags)
 433
 434 // Focuses to created editor
 435 #define wxPG_SEL_FOCUS      0x01
 436 // Forces deletion and recreation of editor
 437 #define wxPG_SEL_FORCE      0x02
 438 // For example, doesn't cause EnsureVisible
 439 #define wxPG_SEL_NONVISIBLE 0x04
 440 // Do not validate editor's value before selecting
 441 #define wxPG_SEL_NOVALIDATE 0x08
 442 // Property being deselected is about to be deleted
 443 #define wxPG_SEL_DELETING   0x10
 444 // Property's values was set to unspecified by the user
 445 #define wxPG_SEL_SETUNSPEC  0x20
 446 // Property's event handler changed the value
 447 #define wxPG_SEL_DIALOGVAL  0x40
 448
 449
 450 // -----------------------------------------------------------------------
 451
 452 #ifndef SWIG
 453
 454 // Internal flags
 455 #define wxPG_FL_INITIALIZED                 0x0001
 456 // Set when creating editor controls if it was clicked on.
 457 #define wxPG_FL_ACTIVATION_BY_CLICK         0x0002
 458 #define wxPG_FL_DONT_CENTER_SPLITTER        0x0004
 459 #define wxPG_FL_FOCUSED                     0x0008
 460 #define wxPG_FL_MOUSE_CAPTURED              0x0010
 461 #define wxPG_FL_MOUSE_INSIDE                0x0020
 462 #define wxPG_FL_VALUE_MODIFIED              0x0040
 463 // don't clear background of m_wndEditor
 464 #define wxPG_FL_PRIMARY_FILLS_ENTIRE        0x0080
 465 // currently active editor uses custom image
 466 #define wxPG_FL_CUR_USES_CUSTOM_IMAGE       0x0100
 467 // cell colours override selection colours for selected cell
 468 #define wxPG_FL_CELL_OVERRIDES_SEL          0x0200
 469 #define wxPG_FL_SCROLLED                    0x0400
 470 // set when all added/inserted properties get hideable flag
 471 #define wxPG_FL_ADDING_HIDEABLES            0x0800
 472 // Disables showing help strings on statusbar.
 473 #define wxPG_FL_NOSTATUSBARHELP             0x1000
 474 // Marks that we created the state, so we have to destroy it too.
 475 #define wxPG_FL_CREATEDSTATE                0x2000
 476 // Set if scrollbar's existence was detected in last onresize.
 477 #define wxPG_FL_SCROLLBAR_DETECTED          0x4000
 478 // Set if wxPGMan requires redrawing of description text box.
 479 #define wxPG_FL_DESC_REFRESH_REQUIRED       0x8000
 480 // Set if contained in wxPropertyGridManager
 481 #define wxPG_FL_IN_MANAGER                  0x00020000
 482 // Set after wxPropertyGrid is shown in its initial good size
 483 #define wxPG_FL_GOOD_SIZE_SET               0x00040000
 484 // Set when in SelectProperty.
 485 #define wxPG_FL_IN_SELECT_PROPERTY          0x00100000
 486 // Set when help string is shown in status bar
 487 #define wxPG_FL_STRING_IN_STATUSBAR         0x00200000
 488 // Splitter position has been custom-set by the user
 489 #define wxPG_FL_SPLITTER_PRE_SET            0x00400000
 490 // Validation failed. Clear on modify event.
 491 #define wxPG_FL_VALIDATION_FAILED           0x00800000
 492 // Auto sort is enabled (for categorized mode)
 493 #define wxPG_FL_CATMODE_AUTO_SORT           0x01000000
 494 // Set after page has been inserted to manager
 495 #define wxPG_MAN_FL_PAGE_INSERTED           0x02000000
 496 // Active editor control is abnormally large
 497 #define wxPG_FL_ABNORMAL_EDITOR             0x04000000
 498 // Recursion guard for HandleCustomEditorEvent
 499 #define wxPG_FL_IN_HANDLECUSTOMEDITOREVENT  0x08000000
 500 #define wxPG_FL_VALUE_CHANGE_IN_EVENT       0x10000000
 501 // Editor control width should not change on resize
 502 #define wxPG_FL_FIXED_WIDTH_EDITOR          0x20000000
 503 // Width of panel can be different than width of grid
 504 #define wxPG_FL_HAS_VIRTUAL_WIDTH           0x40000000
 505 // Prevents RecalculateVirtualSize re-entrancy
 506 #define wxPG_FL_RECALCULATING_VIRTUAL_SIZE  0x80000000
 507
 508 #endif // #ifndef SWIG
 509
 510 #if !defined(__wxPG_SOURCE_FILE__) && !defined(SWIG)
 511     // Reduce compile time, but still include in user app
 512     #include "wx/propgrid/props.h"
 513 #endif
 514
 515 // -----------------------------------------------------------------------
 516
 517 /** @class wxPropertyGrid
 518
 519     wxPropertyGrid is a specialized grid for editing properties
 520     such as strings, numbers, flagsets, fonts, and colours. wxPropertySheet
 521     used to do the very same thing, but it hasn't been updated for a while
 522     and it is currently deprecated.
 523
 524     Please note that most member functions are inherited and as such not
 525     documented on this page. This means you will probably also want to read
 526     wxPropertyGridInterface class reference.
 527
 528     See also @ref overview_propgrid.
 529
 530     @section propgrid_window_styles_ Window Styles
 531
 532     See @ref propgrid_window_styles.
 533
 534     @section propgrid_event_handling Event Handling
 535
 536     To process input from a propertygrid control, use these event handler
 537     macros to direct input to member functions that take a wxPropertyGridEvent
 538     argument.
 539
 540     @beginEventTable{wxPropertyGridEvent}
 541     @event{EVT_PG_SELECTED (id, func)}
 542         Respond to wxEVT_PG_SELECTED event, generated when property value
 543         has been changed by user.
 544     @event{EVT_PG_CHANGING(id, func)}
 545         Respond to wxEVT_PG_CHANGING event, generated when property value
 546         is about to be changed by user. Use wxPropertyGridEvent::GetValue()
 547         to take a peek at the pending value, and wxPropertyGridEvent::Veto()
 548         to prevent change from taking place, if necessary.
 549     @event{EVT_PG_HIGHLIGHTED(id, func)}
 550         Respond to wxEVT_PG_HIGHLIGHTED event, which occurs when mouse
 551         moves over a property. Event's property is NULL if hovered area does
 552         not belong to any property.
 553     @event{EVT_PG_RIGHT_CLICK(id, func)}
 554         Respond to wxEVT_PG_RIGHT_CLICK event, which occurs when property is
 555         clicked on with right mouse button.
 556     @event{EVT_PG_DOUBLE_CLICK(id, func)}
 557         Respond to wxEVT_PG_DOUBLE_CLICK event, which occurs when property is
 558         double-clicked onwith left mouse button.
 559     @event{EVT_PG_ITEM_COLLAPSED(id, func)}
 560         Respond to wxEVT_PG_ITEM_COLLAPSED event, generated when user collapses
 561         a property or category..
 562     @event{EVT_PG_ITEM_EXPANDED(id, func)}
 563         Respond to wxEVT_PG_ITEM_EXPANDED event, generated when user expands
 564         a property or category..
 565     @endEventTable
 566
 567     @remarks
 568
 569     - Use Freeze() and Thaw() respectively to disable and enable drawing. This
 570       will also delay sorting etc. miscellaneous calculations to the last
 571       possible moment.
 572
 573     @library{wxpropgrid}
 574     @category{propgrid}
 575 */
 576 class WXDLLIMPEXP_PROPGRID
 577     wxPropertyGrid : public wxScrolledWindow, public wxPropertyGridInterface
 578 {
 579     friend class wxPropertyGridPageState;
 580     friend class wxPropertyGridInterface;
 581     friend class wxPropertyGridManager;
 582     friend class wxPGCanvas;
 583
 584 #ifndef SWIG
 585     DECLARE_DYNAMIC_CLASS(wxPropertyGrid)
 586 #endif
 587 public:
 588
 589 #ifdef SWIG
 590     %pythonAppend wxPropertyGrid {
 591         self._setOORInfo(self)
 592         self.DoDefaultTypeMappings()
 593         self.edited_objects = {}
 594         self.DoDefaultValueTypeMappings()
 595         if not hasattr(self.__class__,'_vt2setter'):
 596             self.__class__._vt2setter = {}
 597     }
 598     %pythonAppend wxPropertyGrid() ""
 599
 600     wxPropertyGrid( wxWindow *parent, wxWindowID id = wxID_ANY,
 601                     const wxPoint& pos = wxDefaultPosition,
 602                     const wxSize& size = wxDefaultSize,
 603                     long style = wxPG_DEFAULT_STYLE,
 604                     const wxChar* name = wxPyPropertyGridNameStr );
 605     %RenameCtor(PrePropertyGrid,  wxPropertyGrid());
 606 #else
 607
 608     /**
 609         Two step constructor.
 610
 611         Call Create when this constructor is called to build up the
 612         wxPropertyGrid
 613     */
 614     wxPropertyGrid();
 615
 616     /** The default constructor. The styles to be used are styles valid for
 617         the wxWindow and wxScrolledWindow.
 618
 619         @see @link wndflags Additional Window Styles @endlink
 620     */
 621     wxPropertyGrid( wxWindow *parent, wxWindowID id = wxID_ANY,
 622                     const wxPoint& pos = wxDefaultPosition,
 623                     const wxSize& size = wxDefaultSize,
 624                     long style = wxPG_DEFAULT_STYLE,
 625                     const wxString& name = wxPropertyGridNameStr );
 626
 627     /** Destructor */
 628     virtual ~wxPropertyGrid();
 629 #endif
 630
 631     /** Adds given key combination to trigger given action.
 632
 633         @param action
 634             Which action to trigger. See @link pgactions List of list of
 635             wxPropertyGrid actions@endlink.
 636     */
 637     void AddActionTrigger( int action, int keycode, int modifiers = 0 );
 638
 639     /**
 640         This static function enables or disables automatic use of
 641         wxGetTranslation for following strings: wxEnumProperty list labels,
 642         wxFlagsProperty sub-property labels.
 643
 644         Default is false.
 645     */
 646     static void AutoGetTranslation( bool enable );
 647
 648     /**
 649         Changes value of a property, as if from an editor.
 650
 651         Use this instead of SetPropertyValue() if you need the value to run
 652         through validation process, and also send the property change event.
 653
 654         @return
 655         Returns true if value was successfully changed.
 656     */
 657     bool ChangePropertyValue( wxPGPropArg id, wxVariant newValue );
 658
 659     /**
 660         Centers the splitter.
 661
 662         If argument is true, automatic splitter centering is enabled (only
 663         applicapple if style wxPG_SPLITTER_AUTO_CENTER was defined).
 664     */
 665     void CenterSplitter( bool enable_auto_centering = false );
 666
 667     /** Deletes all properties.
 668     */
 669     virtual void Clear();
 670
 671     /** Clears action triggers for given action.
 672         @param action
 673             Which action to trigger. See @link pgactions List of list of
 674             wxPropertyGrid actions@endlink.
 675     */
 676     void ClearActionTriggers( int action );
 677
 678     /** Forces updating the value of property from the editor control.
 679
 680         Note that wxEVT_PG_CHANGING and wxEVT_PG_CHANGED are dispatched using
 681         ProcessEvent, meaning your event handlers will be called immediately.
 682
 683         @return
 684         Returns true if anything was changed.
 685     */
 686     virtual bool CommitChangesFromEditor( wxUint32 flags = 0 );
 687
 688     /**
 689         Two step creation.
 690
 691         Whenever the control is created without any parameters, use Create to
 692         actually create it. Don't access the control's public methods before
 693         this is called @see @link wndflags Additional Window Styles@endlink
 694     */
 695     bool Create( wxWindow *parent, wxWindowID id = wxID_ANY,
 696                  const wxPoint& pos = wxDefaultPosition,
 697                  const wxSize& size = wxDefaultSize,
 698                  long style = wxPG_DEFAULT_STYLE,
 699                  const wxString& name = wxPropertyGridNameStr );
 700
 701     /**
 702         Call when editor widget's contents is modified.
 703
 704         For example, this is called when changes text in wxTextCtrl (used in
 705         wxStringProperty and wxIntProperty).
 706
 707         @remarks
 708         This function should only be called by custom properties.
 709
 710         @see wxPGProperty::OnEvent()
 711     */
 712     void EditorsValueWasModified() { m_iFlags |= wxPG_FL_VALUE_MODIFIED; }
 713
 714     /** Reverse of EditorsValueWasModified().
 715
 716         @remarks
 717         This function should only be called by custom properties.
 718     */
 719     void EditorsValueWasNotModified()
 720     {
 721         m_iFlags &= ~(wxPG_FL_VALUE_MODIFIED);
 722     }
 723
 724     /**
 725         Enables or disables (shows/hides) categories according to parameter
 726         enable.
 727      */
 728     bool EnableCategories( bool enable );
 729
 730     /** Scrolls and/or expands items to ensure that the given item is visible.
 731         Returns true if something was actually done.
 732     */
 733     bool EnsureVisible( wxPGPropArg id );
 734
 735     /**
 736         Reduces column sizes to minimum possible that contents are still
 737         visibly (naturally some margin space will be applied as well).
 738
 739         @return
 740         Minimum size for the grid to still display everything.
 741
 742         @remarks
 743         Does not work well with wxPG_SPLITTER_AUTO_CENTER window style.
 744
 745         This function only works properly if grid size prior to call was already
 746         fairly large.
 747
 748         Note that you can also get calculated column widths by calling
 749         GetState->GetColumnWidth() immediately after this function returns.
 750     */
 751     wxSize FitColumns()
 752     {
 753         wxSize sz = m_pState->DoFitColumns();
 754         return sz;
 755     }
 756
 757     /**
 758         Returns wxWindow that the properties are painted on, and which should
 759         be used as the parent for editor controls.
 760     */
 761     wxPanel* GetPanel() const
 762     {
 763         return m_canvas;
 764     }
 765
 766     /** Returns current category caption background colour. */
 767     wxColour GetCaptionBackgroundColour() const { return m_colCapBack; }
 768
 769     wxFont& GetCaptionFont() { return m_captionFont; }
 770
 771     const wxFont& GetCaptionFont() const { return m_captionFont; }
 772
 773     /** Returns current category caption text colour. */
 774     wxColour GetCaptionForegroundColour() const { return m_colCapFore; }
 775
 776     /** Returns current cell background colour. */
 777     wxColour GetCellBackgroundColour() const { return m_colPropBack; }
 778
 779     /** Returns current cell text colour when disabled. */
 780     wxColour GetCellDisabledTextColour() const { return m_colDisPropFore; }
 781
 782     /** Returns current cell text colour. */
 783     wxColour GetCellTextColour() const { return m_colPropFore; }
 784
 785     /**
 786         Returns number of columns currently on grid.
 787     */
 788     unsigned int GetColumnCount() const
 789     {
 790         return (unsigned int) m_pState->m_colWidths.size();
 791     }
 792
 793     /** Returns colour of empty space below properties. */
 794     wxColour GetEmptySpaceColour() const { return m_colEmptySpace; }
 795
 796     /** Returns height of highest characters of used font. */
 797     int GetFontHeight() const { return m_fontHeight; }
 798
 799     /** Returns pointer to itself. Dummy function that enables same kind
 800         of code to use wxPropertyGrid and wxPropertyGridManager.
 801     */
 802     wxPropertyGrid* GetGrid() { return this; }
 803
 804     /** Returns rectangle of custom paint image.
 805     */
 806     wxRect GetImageRect( wxPGProperty* p, int item ) const;
 807
 808     /** Returns size of the custom paint image in front of property.
 809         If no argument is given, returns preferred size.
 810     */
 811     wxSize GetImageSize( wxPGProperty* p = NULL, int item = -1 ) const;
 812
 813     //@{
 814     /** Returns last item which could be iterated using given flags.
 815         @param flags
 816         See @ref propgrid_iterator_flags.
 817     */
 818     wxPGProperty* GetLastItem( int flags = wxPG_ITERATE_DEFAULT )
 819     {
 820         return m_pState->GetLastItem(flags);
 821     }
 822
 823     const wxPGProperty* GetLastItem( int flags = wxPG_ITERATE_DEFAULT ) const
 824     {
 825         return m_pState->GetLastItem(flags);
 826     }
 827     //@}
 828
 829     /** Returns colour of lines between cells. */
 830     wxColour GetLineColour() const { return m_colLine; }
 831
 832     /** Returns background colour of margin. */
 833     wxColour GetMarginColour() const { return m_colMargin; }
 834
 835     /**
 836         Returns most up-to-date value of selected property. This will return
 837         value different from GetSelectedProperty()->GetValue() only when text
 838         editor is activate and string edited by user represents valid,
 839         uncommitted property value.
 840     */
 841     wxVariant GetUncommittedPropertyValue();
 842
 843     /** Returns "root property". It does not have name, etc. and it is not
 844         visible. It is only useful for accessing its children.
 845     */
 846     wxPGProperty* GetRoot() const { return m_pState->m_properties; }
 847
 848     /** Returns height of a single grid row (in pixels). */
 849     int GetRowHeight() const { return m_lineHeight; }
 850
 851     /** Returns currently selected property. */
 852     wxPGProperty* GetSelectedProperty() const { return GetSelection(); }
 853
 854     /** Returns currently selected property. */
 855     wxPGProperty* GetSelection() const
 856     {
 857         return m_selected;
 858     }
 859
 860     /** Returns current selection background colour. */
 861     wxColour GetSelectionBackgroundColour() const { return m_colSelBack; }
 862
 863     /** Returns current selection text colour. */
 864     wxColour GetSelectionForegroundColour() const { return m_colSelFore; }
 865
 866     /** Returns current splitter x position. */
 867     int GetSplitterPosition() const
 868         { return m_pState->DoGetSplitterPosition(0); }
 869
 870     /** Returns wxTextCtrl active in currently selected property, if any. Takes
 871         into account wxOwnerDrawnComboBox.
 872     */
 873     wxTextCtrl* GetEditorTextCtrl() const;
 874
 875     wxPGValidationInfo& GetValidationInfo()
 876     {
 877         return m_validationInfo;
 878     }
 879
 880     /** Returns current vertical spacing. */
 881     int GetVerticalSpacing() const { return (int)m_vspacing; }
 882
 883     /** Returns true if editor's value was marked modified.
 884     */
 885     bool IsEditorsValueModified() const
 886         { return  ( m_iFlags & wxPG_FL_VALUE_MODIFIED ) ? true : false; }
 887
 888     /** Returns information about arbitrary position in the grid.
 889
 890         For wxPropertyGridHitTestResult definition, see
 891         wxPropertyGridPageState::HitTest().
 892     */
 893     wxPropertyGridHitTestResult HitTest( const wxPoint& pt ) const;
 894
 895     /** Returns true if any property has been modified by the user. */
 896     bool IsAnyModified() const { return (m_pState->m_anyModified>0); }
 897
 898     /**
 899         Returns true if updating is frozen (ie Freeze() called but not yet
 900         Thaw() ).
 901      */
 902     bool IsFrozen() const { return (m_frozen>0)?true:false; }
 903
 904     /** Redraws given property.
 905     */
 906     virtual void RefreshProperty( wxPGProperty* p );
 907
 908 #ifndef SWIG
 909     /** Registers a new editor class.
 910         @return
 911         Pointer to the editor class instance that should be used.
 912     */
 913     static wxPGEditor* RegisterEditorClass( wxPGEditor* editor,
 914                                             bool noDefCheck = false );
 915 #endif
 916
 917     /** Resets all colours to the original system values.
 918     */
 919     void ResetColours();
 920
 921     /**
 922         Selects a property.
 923         Editor widget is automatically created, but not focused unless focus is
 924         true. This will generate wxEVT_PG_SELECT event.
 925         @param id
 926             Property to select.
 927         @return
 928             True if selection finished successfully. Usually only fails if
 929             current value in editor is not valid.
 930         @see wxPropertyGrid::Unselect
 931     */
 932     bool SelectProperty( wxPGPropArg id, bool focus = false )
 933     {
 934         wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
 935         return DoSelectProperty(p,focus?wxPG_SEL_FOCUS:0);
 936     }
 937
 938     /** Sets category caption background colour. */
 939     void SetCaptionBackgroundColour(const wxColour& col);
 940
 941     /** Sets category caption text colour. */
 942     void SetCaptionTextColour(const wxColour& col);
 943
 944     /** Sets default cell background colour - applies to property cells.
 945         Note that appearance of editor widgets may not be affected.
 946     */
 947     void SetCellBackgroundColour(const wxColour& col);
 948
 949     /** Sets cell text colour for disabled properties.
 950     */
 951     void SetCellDisabledTextColour(const wxColour& col);
 952
 953     /** Sets default cell text colour - applies to property name and value text.
 954         Note that appearance of editor widgets may not be affected.
 955     */
 956     void SetCellTextColour(const wxColour& col);
 957
 958     /** Set number of columns (2 or more).
 959     */
 960     void SetColumnCount( int colCount )
 961     {
 962         m_pState->SetColumnCount(colCount);
 963         Refresh();
 964     }
 965
 966     /**
 967         Sets the 'current' category - Append will add non-category properties
 968         under it.
 969     */
 970     void SetCurrentCategory( wxPGPropArg id )
 971     {
 972         wxPG_PROP_ARG_CALL_PROLOG()
 973         wxPropertyCategory* pc = wxDynamicCast(p, wxPropertyCategory);
 974         wxASSERT(pc);
 975         m_pState->m_currentCategory = pc;
 976     }
 977
 978     /** Sets colour of empty space below properties. */
 979     void SetEmptySpaceColour(const wxColour& col);
 980
 981     /** Sets colour of lines between cells. */
 982     void SetLineColour(const wxColour& col);
 983
 984     /** Sets background colour of margin. */
 985     void SetMarginColour(const wxColour& col);
 986
 987     /**
 988         Sets selection background colour - applies to selected property name
 989         background.
 990     */
 991     void SetSelectionBackgroundColour(const wxColour& col);
 992
 993     /**
 994         Sets selection foreground colour - applies to selected property name
 995         text.
 996      */
 997     void SetSelectionTextColour(const wxColour& col);
 998
 999     /** Sets x coordinate of the splitter.
1000         @remarks
1001         Splitter position cannot exceed grid size, and therefore setting it
1002         during form creation may fail as initial grid size is often smaller
1003         than desired splitter position, especially when sizers are being used.
1004     */
1005     void SetSplitterPosition( int newxpos, int col = 0 )
1006     {
1007         DoSetSplitterPosition_(newxpos, true, col);
1008         m_iFlags |= wxPG_FL_SPLITTER_PRE_SET;
1009     }
1010
1011     /** Set virtual width for this particular page. Width -1 indicates that the
1012         virtual width should be disabled. */
1013     void SetVirtualWidth( int width );
1014
1015     /**
1016         Moves splitter as left as possible, while still allowing all
1017         labels to be shown in full.
1018
1019         @param privateChildrenToo
1020             If @false, will still allow private children to be cropped.
1021     */
1022     void SetSplitterLeft( bool privateChildrenToo = false )
1023     {
1024         m_pState->SetSplitterLeft(privateChildrenToo);
1025     }
1026
1027     /** Sets vertical spacing. Can be 1, 2, or 3 - a value relative to font
1028         height. Value of 2 should be default on most platforms.
1029     */
1030     void SetVerticalSpacing( int vspacing )
1031     {
1032         m_vspacing = (unsigned char)vspacing;
1033         CalculateFontAndBitmapStuff( vspacing );
1034         if ( !m_pState->m_itemsAdded ) Refresh();
1035     }
1036
1037     /** Shows an brief error message that is related to a property. */
1038     void ShowPropertyError( wxPGPropArg id, const wxString& msg )
1039     {
1040         wxPG_PROP_ARG_CALL_PROLOG()
1041         DoShowPropertyError(p, msg);
1042     }
1043
1044     /** Sorts all items at all levels (except sub-properties). */
1045     void Sort();
1046
1047     /** Sorts children of a category.
1048     */
1049     void SortChildren( wxPGPropArg id );
1050
1051     /////////////////////////////////////////////////////////////////
1052     //
1053     // Following methods do not need to be (currently) documented
1054     //
1055     /////////////////////////////////////////////////////////////////
1056
1057     bool HasVirtualWidth() const
1058         { return (m_iFlags & wxPG_FL_HAS_VIRTUAL_WIDTH) ? true : false; }
1059
1060     const wxPGCommonValue* GetCommonValue( unsigned int i ) const
1061     {
1062         return (wxPGCommonValue*) m_commonValues[i];
1063     }
1064
1065     /** Returns number of common values.
1066     */
1067     unsigned int GetCommonValueCount() const
1068     {
1069         return (unsigned int) m_commonValues.size();
1070     }
1071
1072     /** Returns label of given common value.
1073     */
1074     wxString GetCommonValueLabel( unsigned int i ) const
1075     {
1076         wxASSERT( GetCommonValue(i) );
1077         return GetCommonValue(i)->GetLabel();
1078     }
1079
1080     /**
1081         Returns index of common value that will truly change value to
1082         unspecified.
1083     */
1084     int GetUnspecifiedCommonValue() const { return m_cvUnspecified; }
1085
1086     /** Set index of common value that will truly change value to unspecified.
1087         Using -1 will set none to have such effect.
1088         Default is 0.
1089     */
1090     void SetUnspecifiedCommonValue( int index ) { m_cvUnspecified = index; }
1091
1092     /**
1093         Shortcut for creating dialog-caller button. Used, for example, by
1094         wxFontProperty.
1095         @remarks
1096         This should only be called by properties.
1097     */
1098     wxWindow* GenerateEditorButton( const wxPoint& pos, const wxSize& sz );
1099
1100     /** Fixes position of wxTextCtrl-like control (wxSpinCtrl usually
1101         fits as one). Call after control has been created (but before
1102         shown).
1103     */
1104     void FixPosForTextCtrl( wxWindow* ctrl,
1105                             const wxPoint& offset = wxPoint(0, 0) );
1106
1107     /** Shortcut for creating text editor widget.
1108         @param pos
1109             Same as pos given for CreateEditor.
1110         @param sz
1111             Same as sz given for CreateEditor.
1112         @param value
1113             Initial text for wxTextCtrl.
1114         @param secondary
1115             If right-side control, such as button, also created, then create it
1116             first and pass it as this parameter.
1117         @param extraStyle
1118             Extra style flags to pass for wxTextCtrl.
1119         @remarks
1120         Note that this should generally be called only by new classes derived
1121         from wxPGProperty.
1122     */
1123     wxWindow* GenerateEditorTextCtrl( const wxPoint& pos,
1124                                       const wxSize& sz,
1125                                       const wxString& value,
1126                                       wxWindow* secondary,
1127                                       int extraStyle = 0,
1128                                       int maxLen = 0 );
1129
1130     /* Generates both textctrl and button.
1131     */
1132     wxWindow* GenerateEditorTextCtrlAndButton( const wxPoint& pos,
1133         const wxSize& sz, wxWindow** psecondary, int limited_editing,
1134         wxPGProperty* property );
1135
1136     /** Generates position for a widget editor dialog box.
1137         @param p
1138         Property for which dialog is positioned.
1139         @param sz
1140         Known or over-approximated size of the dialog.
1141         @return
1142         Position for dialog.
1143     */
1144     wxPoint GetGoodEditorDialogPosition( wxPGProperty* p,
1145                                          const wxSize& sz );
1146
1147     // Converts escape sequences in src_str to newlines,
1148     // tabs, etc. and copies result to dst_str.
1149     static wxString& ExpandEscapeSequences( wxString& dst_str,
1150                                             wxString& src_str );
1151
1152     // Converts newlines, tabs, etc. in src_str to escape
1153     // sequences, and copies result to dst_str.
1154     static wxString& CreateEscapeSequences( wxString& dst_str,
1155                                             wxString& src_str );
1156
1157     /**
1158         Returns rectangle that fully contains properties between and including
1159         p1 and p2.
1160     */
1161     wxRect GetPropertyRect( const wxPGProperty* p1,
1162                             const wxPGProperty* p2 ) const;
1163
1164     /** Returns pointer to current active primary editor control (NULL if none).
1165     */
1166     wxWindow* GetEditorControl() const;
1167
1168     wxWindow* GetPrimaryEditor() const
1169     {
1170         return GetEditorControl();
1171     }
1172
1173     /**
1174         Returns pointer to current active secondary editor control (NULL if
1175         none).
1176     */
1177     wxWindow* GetEditorControlSecondary() const
1178     {
1179         return m_wndEditor2;
1180     }
1181
1182     /**
1183         Refreshes any active editor control.
1184     */
1185     void RefreshEditor();
1186
1187     // Events from editor controls are forward to this function
1188     void HandleCustomEditorEvent( wxEvent &event );
1189
1190 #ifndef SWIG
1191
1192     /**
1193         Generates contents for string dst based on the contents of
1194         wxArrayString src.
1195
1196         Format will be "(preDelim)str1(postDelim) (preDelim)str2(postDelim) and
1197         so on. Set flags to 1 inorder to convert backslashes to double-back-
1198         slashes and "(preDelims)"'s to "(preDelims)".
1199     */
1200     static void ArrayStringToString( wxString& dst, const wxArrayString& src,
1201                                      wxChar preDelim, wxChar postDelim,
1202                                      int flags );
1203
1204     // Mostly useful for page switching.
1205     void SwitchState( wxPropertyGridPageState* pNewState );
1206
1207     long GetInternalFlags() const { return m_iFlags; }
1208     bool HasInternalFlag( long flag ) const
1209         { return (m_iFlags & flag) ? true : false; }
1210     void SetInternalFlag( long flag ) { m_iFlags |= flag; }
1211     void ClearInternalFlag( long flag ) { m_iFlags &= ~(flag); }
1212     void IncFrozen() { m_frozen++; }
1213     void DecFrozen() { m_frozen--; }
1214
1215     void OnComboItemPaint( const wxPGComboBox* pCb,
1216                            int item,
1217                            wxDC* pDc,
1218                            wxRect& rect,
1219                            int flags );
1220
1221     /** Standardized double-to-string conversion.
1222     */
1223     static void DoubleToString( wxString& target,
1224                                 double value,
1225                                 int precision,
1226                                 bool removeZeroes,
1227                                 wxString* precTemplate );
1228
1229     /**
1230         Call this from wxPGProperty::OnEvent() to cause property value to be
1231         changed after the function returns (with true as return value).
1232         ValueChangeInEvent() must be used if you wish the application to be
1233         able to use wxEVT_PG_CHANGING to potentially veto the given value.
1234     */
1235     void ValueChangeInEvent( wxVariant variant )
1236     {
1237         m_changeInEventValue = variant;
1238         m_iFlags |= wxPG_FL_VALUE_CHANGE_IN_EVENT;
1239     }
1240
1241     /** Returns true if given event is from first of an array of buttons
1242         (as can be in case when wxPGMultiButton is used).
1243     */
1244     bool IsMainButtonEvent( const wxEvent& event )
1245     {
1246         return (event.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED)
1247                     && (m_wndSecId == event.GetId());
1248     }
1249
1250     /** Pending value is expected to be passed in PerformValidation().
1251     */
1252     virtual bool DoPropertyChanged( wxPGProperty* p,
1253                                     unsigned int selFlags = 0 );
1254
1255     /** Called when validation for given property fails.
1256         @param invalidValue
1257             Value which failed in validation.
1258         @return
1259             Return true if user is allowed to change to another property even
1260             if current has invalid value.
1261         @remarks
1262         To add your own validation failure behavior, override
1263         wxPropertyGrid::DoOnValidationFailure().
1264     */
1265     bool OnValidationFailure( wxPGProperty* property, wxVariant& invalidValue )
1266     {
1267         bool res = DoOnValidationFailure(property, invalidValue);
1268         property->SetFlag(wxPG_PROP_INVALID_VALUE);
1269         return res;
1270     }
1271
1272     /** Called to indicate property and editor has valid value now.
1273     */
1274     void OnValidationFailureReset( wxPGProperty* property )
1275     {
1276         if ( property && property->HasFlag(wxPG_PROP_INVALID_VALUE) )
1277         {
1278             DoOnValidationFailureReset(property);
1279             property->ClearFlag(wxPG_PROP_INVALID_VALUE);
1280         }
1281         m_validationInfo.m_failureMessage.clear();
1282     }
1283
1284     /** Override in derived class to display error messages in custom manner
1285         (these message usually only result from validation failure).
1286     */
1287     virtual void DoShowPropertyError( wxPGProperty* property,
1288                                       const wxString& msg );
1289
1290     /** Override to customize property validation failure behavior.
1291         @param invalidValue
1292             Value which failed in validation.
1293         @return
1294             Return true if user is allowed to change to another property even
1295             if current has invalid value.
1296     */
1297     virtual bool DoOnValidationFailure( wxPGProperty* property,
1298                                         wxVariant& invalidValue );
1299
1300     /** Override to customize resetting of property validation failure status.
1301         @remarks
1302         Property is guaranteed to have flag wxPG_PROP_INVALID_VALUE set.
1303     */
1304     virtual void DoOnValidationFailureReset( wxPGProperty* property );
1305
1306     int GetSpacingY() const { return m_spacingy; }
1307
1308     /**
1309         Must be called in wxPGEditor::CreateControls() if primary editor window
1310         is wxTextCtrl, just before textctrl is created.
1311         @param text
1312             Initial text value of created wxTextCtrl.
1313     */
1314     void SetupTextCtrlValue( const wxString text ) { m_prevTcValue = text; }
1315
1316     /**
1317         Unfocuses or closes editor if one was open, but does not deselect
1318         property.
1319     */
1320     bool UnfocusEditor();
1321
1322     virtual void SetWindowStyleFlag( long style );
1323
1324 protected:
1325
1326     /**
1327         wxPropertyGridPageState used by the grid is created here.
1328
1329         If grid is used in wxPropertyGridManager, there is no point overriding
1330         this - instead, set custom wxPropertyGridPage classes.
1331     */
1332     virtual wxPropertyGridPageState* CreateState() const;
1333
1334     enum PerformValidationFlags
1335     {
1336         SendEvtChanging         = 0x0001,
1337         IsStandaloneValidation  = 0x0002   // Not called in response to event
1338     };
1339
1340     /**
1341         Runs all validation functionality (includes sending wxEVT_PG_CHANGING).
1342         Returns true if all tests passed. Implement in derived class to
1343         add additional validation behavior.
1344     */
1345     virtual bool PerformValidation( wxPGProperty* p,
1346                                     wxVariant& pendingValue,
1347                                     int flags = SendEvtChanging );
1348
1349 public:
1350
1351     // Control font changer helper.
1352     void SetCurControlBoldFont();
1353
1354     wxPGCell& GetPropertyDefaultCell()
1355     {
1356         return m_propertyDefaultCell;
1357     }
1358
1359     wxPGCell& GetCategoryDefaultCell()
1360     {
1361         return m_categoryDefaultCell;
1362     }
1363
1364     //
1365     // Public methods for semi-public use
1366     // (not protected for optimization)
1367     //
1368     bool DoSelectProperty( wxPGProperty* p, unsigned int flags = 0 );
1369
1370     // Overridden functions.
1371     virtual bool Destroy();
1372     // Returns property at given y coordinate (relative to grid's top left).
1373     wxPGProperty* GetItemAtY( int y ) const { return DoGetItemAtY(y); }
1374
1375     virtual void Refresh( bool eraseBackground = true,
1376                           const wxRect *rect = (const wxRect *) NULL );
1377     virtual bool SetFont( const wxFont& font );
1378 #if wxPG_SUPPORT_TOOLTIPS
1379     void SetToolTip( const wxString& tipString );
1380 #endif
1381     virtual void Freeze();
1382     virtual void SetExtraStyle( long exStyle );
1383     virtual void Thaw();
1384
1385
1386 protected:
1387     virtual wxSize DoGetBestSize() const;
1388
1389 #ifndef wxPG_ICON_WIDTH
1390     wxBitmap            *m_expandbmp, *m_collbmp;
1391 #endif
1392
1393     wxCursor            *m_cursorSizeWE;
1394
1395     /** wxWindow pointers to editor control(s). */
1396     wxWindow            *m_wndEditor;
1397     wxWindow            *m_wndEditor2;
1398
1399     /** wxPGCanvas instance. */
1400     wxPanel             *m_canvas;
1401
1402 #if wxPG_DOUBLE_BUFFER
1403     wxBitmap            *m_doubleBuffer;
1404 #endif
1405
1406     /** Local time ms when control was created. */
1407     wxLongLong          m_timeCreated;
1408
1409     /** wxPGProperty::OnEvent can change value by setting this. */
1410     wxVariant           m_changeInEventValue;
1411
1412     /** Id of m_wndEditor2, or its first child, if any. */
1413     int                 m_wndSecId;
1414
1415     /** Extra Y spacing between the items. */
1416     int                 m_spacingy;
1417
1418     /** Control client area width; updated on resize. */
1419     int                 m_width;
1420
1421     /** Control client area height; updated on resize. */
1422     int                 m_height;
1423
1424     /** Current non-client width (needed when auto-centering). */
1425     int                 m_ncWidth;
1426
1427     /** Non-client width (auto-centering helper). */
1428     //int                 m_fWidth;
1429
1430     /** Previously recorded scroll start position. */
1431     int                 m_prevVY;
1432
1433     /**
1434         The gutter spacing in front and back of the image.
1435         This determines the amount of spacing in front of each item
1436      */
1437     int                 m_gutterWidth;
1438
1439     /** Includes separator line. */
1440     int                 m_lineHeight;
1441
1442     /** Gutter*2 + image width. */
1443     int                 m_marginWidth;
1444
1445     // y spacing for expand/collapse button.
1446     int                 m_buttonSpacingY;
1447
1448     /** Extra margin for expanded sub-group items. */
1449     int                 m_subgroup_extramargin;
1450
1451     /**
1452         The image width of the [+] icon.
1453
1454         This is also calculated in the gutter
1455      */
1456     int                 m_iconWidth;
1457
1458 #ifndef wxPG_ICON_WIDTH
1459
1460     /**
1461         The image height of the [+] icon.
1462
1463         This is calculated as minimal size and to align
1464      */
1465     int                 m_iconHeight;
1466 #endif
1467
1468     /** Current cursor id. */
1469     int                 m_curcursor;
1470
1471     /**
1472         This captionFont is made equal to the font of the wxScrolledWindow.
1473
1474         As extra the bold face is set on it when this is wanted by the user
1475         (see flags)
1476      */
1477     wxFont              m_captionFont;
1478
1479     int                 m_fontHeight;  // Height of the font.
1480
1481     /** m_splitterx when drag began. */
1482     int                 m_startingSplitterX;
1483
1484     /**
1485         Index to splitter currently being dragged (0=one after the first
1486         column).
1487      */
1488     int                 m_draggedSplitter;
1489
1490     /** Changed property, calculated in PerformValidation(). */
1491     wxPGProperty*       m_chgInfo_changedProperty;
1492
1493     /**
1494         Lowest property for which editing happened, but which does not have
1495         aggregate parent
1496      */
1497     wxPGProperty*       m_chgInfo_baseChangedProperty;
1498
1499     /** Changed property value, calculated in PerformValidation(). */
1500     wxVariant           m_chgInfo_pendingValue;
1501
1502     /** Passed to SetValue. */
1503     wxVariant           m_chgInfo_valueList;
1504
1505     /** Validation information. */
1506     wxPGValidationInfo  m_validationInfo;
1507
1508     /** Actions and keys that trigger them. */
1509     wxPGHashMapI2I      m_actionTriggers;
1510
1511     //
1512     // Temporary values
1513     //
1514
1515     /** Bits are used to indicate which colours are customized. */
1516     unsigned short      m_coloursCustomized;
1517
1518     /** x - m_splitterx. */
1519     signed char                 m_dragOffset;
1520
1521     /** 0 = not dragging, 1 = drag just started, 2 = drag in progress */
1522     unsigned char       m_dragStatus;
1523
1524     /** 0 = margin, 1 = label, 2 = value. */
1525     unsigned char       m_mouseSide;
1526
1527     /** True when editor control is focused. */
1528     unsigned char       m_editorFocused;
1529
1530     /** 1 if m_latsCaption is also the bottommost caption. */
1531     //unsigned char       m_lastCaptionBottomnest;
1532
1533     /** Set to 1 when graphics frozen. */
1534     unsigned char       m_frozen;
1535
1536     unsigned char       m_vspacing;
1537
1538     // Used to track when Alt/Ctrl+Key was consumed.
1539     unsigned char       m_keyComboConsumed;
1540
1541     /** 1 if in DoPropertyChanged() */
1542     unsigned char       m_inDoPropertyChanged;
1543
1544     /** 1 if in CommitChangesFromEditor() */
1545     unsigned char       m_inCommitChangesFromEditor;
1546
1547     /** 1 if in DoSelectProperty() */
1548     unsigned char       m_inDoSelectProperty;
1549
1550     wxPGVFBFlags        m_permanentValidationFailureBehavior;  // Set by app
1551
1552     /** Internal flags - see wxPG_FL_XXX constants. */
1553     wxUint32            m_iFlags;
1554
1555     /** When drawing next time, clear this many item slots at the end. */
1556     int                 m_clearThisMany;
1557
1558     /** Pointer to selected property. Note that this is duplicated in
1559         m_state for better transiency between pages so that the selected
1560         item can be retained.
1561     */
1562     wxPGProperty*       m_selected;
1563
1564     // pointer to property that has mouse hovering
1565     wxPGProperty*       m_propHover;
1566
1567     // EventObject for wxPropertyGridEvents
1568     wxWindow*           m_eventObject;
1569
1570     // What (global) window is currently focused (needed to resolve event
1571     // handling mess).
1572     wxWindow*           m_curFocused;
1573
1574     // wxPGTLWHandler
1575     wxEvtHandler*       m_tlwHandler;
1576
1577     // Top level parent
1578     wxWindow*           m_tlp;
1579
1580     // y coordinate of property that mouse hovering
1581     int                 m_propHoverY;
1582     // Which column's editor is selected (usually 1)?
1583     int                 m_selColumn;
1584
1585     // x relative to splitter (needed for resize).
1586     int                 m_ctrlXAdjust;
1587
1588     // lines between cells
1589     wxColour            m_colLine;
1590     // property labels and values are written in this colour
1591     wxColour            m_colPropFore;
1592     // or with this colour when disabled
1593     wxColour            m_colDisPropFore;
1594     // background for m_colPropFore
1595     wxColour            m_colPropBack;
1596     // text color for captions
1597     wxColour            m_colCapFore;
1598     // background color for captions
1599     wxColour            m_colCapBack;
1600     // foreground for selected property
1601     wxColour            m_colSelFore;
1602     // background for selected property (actually use background color when
1603     // control out-of-focus)
1604     wxColour            m_colSelBack;
1605     // background colour for margin
1606     wxColour            m_colMargin;
1607     // background colour for empty space below the grid
1608     wxColour            m_colEmptySpace;
1609
1610     // Default property colours
1611     wxPGCell            m_propertyDefaultCell;
1612
1613     // Default property category
1614     wxPGCell            m_categoryDefaultCell;
1615
1616     // Backup of selected property's cells
1617     wxVector<wxPGCell>  m_propCellsBackup;
1618
1619     // NB: These *cannot* be moved to globals.
1620
1621     // labels when properties use common values
1622     wxVector<wxPGCommonValue*>  m_commonValues;
1623
1624     // Which cv selection really sets value to unspecified?
1625     int                 m_cvUnspecified;
1626
1627     // Used to skip excess text editor events
1628     wxString            m_prevTcValue;
1629
1630 protected:
1631
1632     // Sets some members to defaults (called constructors).
1633     void Init1();
1634
1635     // Initializes some members (called by Create and complex constructor).
1636     void Init2();
1637
1638     void OnPaint(wxPaintEvent &event );
1639
1640     // main event receivers
1641     void OnMouseMove( wxMouseEvent &event );
1642     void OnMouseMoveBottom( wxMouseEvent &event );
1643     void OnMouseClick( wxMouseEvent &event );
1644     void OnMouseRightClick( wxMouseEvent &event );
1645     void OnMouseDoubleClick( wxMouseEvent &event );
1646     void OnMouseUp( wxMouseEvent &event );
1647     void OnKey( wxKeyEvent &event );
1648     void OnResize( wxSizeEvent &event );
1649
1650     // event handlers
1651     bool HandleMouseMove( int x, unsigned int y, wxMouseEvent &event );
1652     bool HandleMouseClick( int x, unsigned int y, wxMouseEvent &event );
1653     bool HandleMouseRightClick( int x, unsigned int y, wxMouseEvent &event );
1654     bool HandleMouseDoubleClick( int x, unsigned int y, wxMouseEvent &event );
1655     bool HandleMouseUp( int x, unsigned int y, wxMouseEvent &event );
1656     void HandleKeyEvent( wxKeyEvent &event, bool fromChild );
1657
1658     void OnMouseEntry( wxMouseEvent &event );
1659
1660     void OnIdle( wxIdleEvent &event );
1661     void OnFocusEvent( wxFocusEvent &event );
1662     void OnChildFocusEvent( wxChildFocusEvent& event );
1663
1664     bool OnMouseCommon( wxMouseEvent &event, int* px, int *py );
1665     bool OnMouseChildCommon( wxMouseEvent &event, int* px, int *py );
1666
1667     // sub-control event handlers
1668     void OnMouseClickChild( wxMouseEvent &event );
1669     void OnMouseRightClickChild( wxMouseEvent &event );
1670     void OnMouseMoveChild( wxMouseEvent &event );
1671     void OnMouseUpChild( wxMouseEvent &event );
1672     void OnChildKeyDown( wxKeyEvent &event );
1673
1674     void OnCaptureChange( wxMouseCaptureChangedEvent &event );
1675
1676     void OnScrollEvent( wxScrollWinEvent &event );
1677
1678     void OnSysColourChanged( wxSysColourChangedEvent &event );
1679
1680 protected:
1681
1682     /**
1683         Adjust the centering of the bitmap icons (collapse / expand) when the
1684         caption font changes.
1685
1686         They need to be centered in the middle of the font, so a bit of deltaY
1687         adjustment is needed. On entry, m_captionFont must be set to window
1688         font. It will be modified properly.
1689       */
1690     void CalculateFontAndBitmapStuff( int vspacing );
1691
1692     wxRect GetEditorWidgetRect( wxPGProperty* p, int column ) const;
1693
1694     void CorrectEditorWidgetSizeX();
1695
1696     /** Called in RecalculateVirtualSize() to reposition control
1697         on virtual height changes.
1698     */
1699     void CorrectEditorWidgetPosY();
1700
1701 #ifdef __WXDEBUG__
1702     void _log_items();
1703     void OnScreenNote( const wxChar* format, ... );
1704 #endif
1705
1706     /** Deselect current selection, if any. Returns true if success
1707         (ie. validator did not intercept). */
1708     bool DoClearSelection();
1709
1710     int DoDrawItems( wxDC& dc,
1711                      const wxPGProperty* first_item,
1712                      const wxPGProperty* last_item,
1713                      const wxRect* clip_rect,
1714                      bool isBuffered ) const;
1715
1716     void DoSetPropertyValueUnspecified( wxPGProperty* p );
1717
1718     /** Draws an expand/collapse (ie. +/-) button.
1719     */
1720     virtual void DrawExpanderButton( wxDC& dc, const wxRect& rect,
1721                                      wxPGProperty* property ) const;
1722
1723     /** Draws items from topitemy to bottomitemy */
1724     void DrawItems( wxDC& dc, unsigned int topitemy, unsigned int bottomitemy,
1725                     const wxRect* clip_rect = (const wxRect*) NULL );
1726
1727     void DrawItems( const wxPGProperty* p1, const wxPGProperty* p2 );
1728
1729     void DrawItem( wxPGProperty* p )
1730     {
1731         DrawItems(p,p);
1732     }
1733
1734     virtual void DrawItemAndChildren( wxPGProperty* p );
1735
1736     /**
1737         Draws item, children, and consequtive parents as long as category is
1738         not met.
1739      */
1740     void DrawItemAndValueRelated( wxPGProperty* p );
1741
1742     // Translate wxKeyEvent to wxPG_ACTION_XXX
1743     int KeyEventToActions(wxKeyEvent &event, int* pSecond) const;
1744
1745     int KeyEventToAction(wxKeyEvent &event) const
1746     {
1747         return KeyEventToActions(event, NULL);
1748     }
1749
1750     void ImprovedClientToScreen( int* px, int* py );
1751
1752     // Returns True if editor control has focus
1753     bool IsEditorFocused() const;
1754
1755     // Called by focus event handlers. newFocused is the window that becomes
1756     // focused.
1757     void HandleFocusChange( wxWindow* newFocused );
1758
1759     /** Reloads all non-customized colours from system settings. */
1760     void RegainColours();
1761
1762     bool DoEditorValidate();
1763
1764     wxPGProperty* DoGetItemAtY( int y ) const;
1765
1766     void DoSetSplitterPosition_( int newxpos,
1767                                  bool refresh = true,
1768                                  int splitterIndex = 0,
1769                                  bool allPages = false );
1770
1771     void FreeEditors();
1772
1773     virtual bool DoExpand( wxPGProperty* p, bool sendEvent = false );
1774
1775     virtual bool DoCollapse( wxPGProperty* p, bool sendEvent = false );
1776
1777     // Returns nearest paint visible property (such that will be painted unless
1778     // window is scrolled or resized). If given property is paint visible, then
1779     // it itself will be returned.
1780     wxPGProperty* GetNearestPaintVisible( wxPGProperty* p ) const;
1781
1782     static void RegisterDefaultEditors();
1783
1784     // Sets up basic event handling for child control
1785     void SetupChildEventHandling( wxWindow* wnd );
1786
1787     void CustomSetCursor( int type, bool override = false );
1788
1789     /**
1790         Repositions scrollbar and underlying panel according to changed virtual
1791         size.
1792     */
1793     void RecalculateVirtualSize( int forceXPos = -1 );
1794
1795     void PrepareAfterItemsAdded();
1796
1797     bool SendEvent( int eventType,
1798                     wxPGProperty* p,
1799                     wxVariant* pValue = NULL,
1800                     unsigned int selFlags = 0 );
1801
1802     void SetFocusOnCanvas();
1803
1804     bool DoHideProperty( wxPGProperty* p, bool hide, int flags );
1805
1806 private:
1807
1808     bool ButtonTriggerKeyTest( int action, wxKeyEvent& event );
1809
1810     DECLARE_EVENT_TABLE()
1811 #endif // #ifndef SWIG
1812 };
1813
1814 // -----------------------------------------------------------------------
1815 //
1816 // Bunch of inlines that need to resolved after all classes have been defined.
1817 //
1818
1819 #ifndef SWIG
1820 inline bool wxPropertyGridPageState::IsDisplayed() const
1821 {
1822     return ( this == m_pPropGrid->GetState() );
1823 }
1824
1825 inline unsigned int wxPropertyGridPageState::GetActualVirtualHeight() const
1826 {
1827     return DoGetRoot()->GetChildrenHeight(GetGrid()->GetRowHeight());
1828 }
1829 #endif
1830
1831 inline int wxPGProperty::GetDisplayedCommonValueCount() const
1832 {
1833     if ( HasFlag(wxPG_PROP_USES_COMMON_VALUE) )
1834     {
1835         wxPropertyGrid* pg = GetGrid();
1836         if ( pg )
1837             return (int) pg->GetCommonValueCount();
1838     }
1839     return 0;
1840 }
1841
1842 inline void wxPGProperty::SetEditor( const wxString& editorName )
1843 {
1844     m_customEditor = wxPropertyGridInterface::GetEditorByName(editorName);
1845 }
1846
1847 inline void wxPGProperty::SetName( const wxString& newName )
1848 {
1849     GetGrid()->SetPropertyName(this, newName);
1850 }
1851
1852 inline bool wxPGProperty::Hide( bool hide, int flags )
1853 {
1854     return GetGrid()->HideProperty(this, hide, flags);
1855 }
1856
1857 inline bool wxPGProperty::SetMaxLength( int maxLen )
1858 {
1859     return GetGrid()->SetPropertyMaxLength(this,maxLen);
1860 }
1861
1862 // -----------------------------------------------------------------------
1863
1864 #define wxPG_BASE_EVT_PRE_ID     1775
1865
1866 #ifndef SWIG
1867
1868 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_SELECTED;
1869 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_CHANGING;
1870 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_CHANGED;
1871 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_HIGHLIGHTED;
1872 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_RIGHT_CLICK;
1873 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_PAGE_CHANGED;
1874 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_ITEM_COLLAPSED;
1875 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_ITEM_EXPANDED;
1876 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_DOUBLE_CLICK;
1877
1878 #else
1879     enum {
1880         wxEVT_PG_SELECTED = wxPG_BASE_EVT_PRE_ID,
1881         wxEVT_PG_CHANGING,
1882         wxEVT_PG_CHANGED,
1883         wxEVT_PG_HIGHLIGHTED,
1884         wxEVT_PG_RIGHT_CLICK,
1885         wxEVT_PG_PAGE_CHANGED,
1886         wxEVT_PG_ITEM_COLLAPSED,
1887         wxEVT_PG_ITEM_EXPANDED,
1888         wxEVT_PG_DOUBLE_CLICK
1889     };
1890 #endif
1891
1892
1893 #define wxPG_BASE_EVT_TYPE       wxEVT_PG_SELECTED
1894 #define wxPG_MAX_EVT_TYPE        (wxPG_BASE_EVT_TYPE+30)
1895
1896
1897 #ifndef SWIG
1898 typedef void (wxEvtHandler::*wxPropertyGridEventFunction)(wxPropertyGridEvent&);
1899
1900 #define EVT_PG_SELECTED(id, fn)              DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1901 #define EVT_PG_CHANGING(id, fn)              DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1902 #define EVT_PG_CHANGED(id, fn)               DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1903 #define EVT_PG_HIGHLIGHTED(id, fn)           DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_HIGHLIGHTED, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1904 #define EVT_PG_RIGHT_CLICK(id, fn)           DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1905 #define EVT_PG_DOUBLE_CLICK(id, fn)          DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_DOUBLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1906 #define EVT_PG_PAGE_CHANGED(id, fn)          DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_PAGE_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1907 #define EVT_PG_ITEM_COLLAPSED(id, fn)        DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1908 #define EVT_PG_ITEM_EXPANDED(id, fn)         DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1909
1910 #define wxPropertyGridEventHandler(A) \
1911     ((wxObjectEventFunction)(wxEventFunction)(wxPropertyGridEventFunction)&A)
1912
1913 #endif
1914
1915
1916 /** @class wxPropertyGridEvent
1917
1918     A propertygrid event holds information about events associated with
1919     wxPropertyGrid objects.
1920
1921     @library{wxpropgrid}
1922     @category{propgrid}
1923 */
1924 class WXDLLIMPEXP_PROPGRID wxPropertyGridEvent : public wxCommandEvent
1925 {
1926 public:
1927
1928     /** Constructor. */
1929     wxPropertyGridEvent(wxEventType commandType=0, int id=0);
1930 #ifndef SWIG
1931     /** Copy constructor. */
1932     wxPropertyGridEvent(const wxPropertyGridEvent& event);
1933 #endif
1934     /** Destructor. */
1935     ~wxPropertyGridEvent();
1936
1937     /** Copyer. */
1938     virtual wxEvent* Clone() const;
1939
1940     wxPGProperty* GetMainParent() const
1941     {
1942         wxASSERT(m_property);
1943         return m_property->GetMainParent();
1944     }
1945
1946     /** Returns id of associated property. */
1947     wxPGProperty* GetProperty() const
1948     {
1949         return m_property;
1950     }
1951
1952     wxPGValidationInfo& GetValidationInfo()
1953     {
1954         wxASSERT(m_validationInfo);
1955         return *m_validationInfo;
1956     }
1957
1958     /** Returns true if you can veto the action that the event is signaling.
1959     */
1960     bool CanVeto() const { return m_canVeto; }
1961
1962     /**
1963         Call this from your event handler to veto action that the event is
1964         signaling.
1965
1966         You can only veto a shutdown if wxPropertyGridEvent::CanVeto returns
1967         true.
1968         @remarks
1969         Currently only wxEVT_PG_CHANGING supports vetoing.
1970     */
1971     void Veto( bool veto = true ) { m_wasVetoed = veto; }
1972
1973     /** Returns value that is about to be set for wxEVT_PG_CHANGING.
1974     */
1975     const wxVariant& GetValue() const
1976     {
1977         wxASSERT_MSG( m_validationInfo,
1978                       "Only call GetValue from a handler "
1979                       "of event type that supports it" );
1980         return m_validationInfo->GetValue();
1981     }
1982
1983     /**
1984         Set override validation failure behavior.
1985
1986         Only effective if Veto was also called, and only allowed if event type
1987         is wxEVT_PG_CHANGING.
1988     */
1989     void SetValidationFailureBehavior( wxPGVFBFlags flags )
1990     {
1991         wxASSERT( GetEventType() == wxEVT_PG_CHANGING );
1992         m_validationInfo->SetFailureBehavior( flags );
1993     }
1994
1995     /** Sets custom failure message for this time only. Only applies if
1996         wxPG_VFB_SHOW_MESSAGE is set in validation failure flags.
1997     */
1998     void SetValidationFailureMessage( const wxString& message )
1999     {
2000         wxASSERT( GetEventType() == wxEVT_PG_CHANGING );
2001         m_validationInfo->SetFailureMessage( message );
2002     }
2003
2004 #ifndef SWIG
2005     wxPGVFBFlags GetValidationFailureBehavior() const
2006     {
2007         wxASSERT( GetEventType() == wxEVT_PG_CHANGING );
2008         return m_validationInfo->GetFailureBehavior();
2009     }
2010
2011     void SetCanVeto( bool canVeto ) { m_canVeto = canVeto; }
2012     bool WasVetoed() const { return m_wasVetoed; }
2013
2014     /** Changes the associated property. */
2015     void SetProperty( wxPGProperty* p ) { m_property = p; }
2016
2017     void SetPropertyGrid( wxPropertyGrid* pg ) { m_pg = pg; }
2018
2019     void SetupValidationInfo()
2020     {
2021         wxASSERT(m_pg);
2022         wxASSERT( GetEventType() == wxEVT_PG_CHANGING );
2023         m_validationInfo = &m_pg->GetValidationInfo();
2024     }
2025
2026 private:
2027     void Init();
2028     DECLARE_DYNAMIC_CLASS(wxPropertyGridEvent)
2029
2030     wxPGProperty*       m_property;
2031     wxPropertyGrid*     m_pg;
2032     wxPGValidationInfo* m_validationInfo;
2033
2034     bool                m_canVeto;
2035     bool                m_wasVetoed;
2036
2037 #endif
2038 };
2039
2040
2041 // -----------------------------------------------------------------------
2042
2043 /** @class wxPropertyGridPopulator
2044     @ingroup classes
2045     Allows populating wxPropertyGrid from arbitrary text source.
2046 */
2047 class WXDLLIMPEXP_PROPGRID wxPropertyGridPopulator
2048 {
2049 public:
2050     /** Default constructor.
2051     */
2052     wxPropertyGridPopulator();
2053
2054     /** Destructor. */
2055     virtual ~wxPropertyGridPopulator();
2056
2057     void SetState( wxPropertyGridPageState* state );
2058
2059     void SetGrid( wxPropertyGrid* pg );
2060
2061     /** Appends a new property under bottommost parent.
2062         @param propClass
2063         Property class as string.
2064     */
2065     wxPGProperty* Add( const wxString& propClass,
2066                        const wxString& propLabel,
2067                        const wxString& propName,
2068                        const wxString* propValue,
2069                        wxPGChoices* pChoices = NULL );
2070
2071     /**
2072         Pushes property to the back of parent array (ie it becomes bottommost
2073         parent), and starts scanning/adding children for it.
2074
2075         When finished, parent array is returned to the original state.
2076     */
2077     void AddChildren( wxPGProperty* property );
2078
2079     /** Adds attribute to the bottommost property.
2080         @param type
2081         Allowed values: "string", (same as string), "int", "bool". Empty string
2082           mean autodetect.
2083     */
2084     bool AddAttribute( const wxString& name,
2085                        const wxString& type,
2086                        const wxString& value );
2087
2088     /** Called once in AddChildren.
2089     */
2090     virtual void DoScanForChildren() = 0;
2091
2092     /**
2093         Returns id of parent property for which children can currently be
2094         added.
2095      */
2096     wxPGProperty* GetCurParent() const
2097     {
2098         return (wxPGProperty*) m_propHierarchy[m_propHierarchy.size()-1];
2099     }
2100
2101     wxPropertyGridPageState* GetState() { return m_state; }
2102     const wxPropertyGridPageState* GetState() const { return m_state; }
2103
2104     /** Like wxString::ToLong, except allows N% in addition of N.
2105     */
2106     static bool ToLongPCT( const wxString& s, long* pval, long max );
2107
2108     /** Parses strings of format "choice1"[=value1] ... "choiceN"[=valueN] into
2109         wxPGChoices. Registers parsed result using idString (if not empty).
2110         Also, if choices with given id already registered, then don't parse but
2111         return those choices instead.
2112     */
2113     wxPGChoices ParseChoices( const wxString& choicesString,
2114                               const wxString& idString );
2115
2116     /** Implement in derived class to do custom process when an error occurs.
2117         Default implementation uses wxLogError.
2118     */
2119     virtual void ProcessError( const wxString& msg );
2120
2121 protected:
2122
2123     /** Used property grid. */
2124     wxPropertyGrid*         m_pg;
2125
2126     /** Used property grid state. */
2127     wxPropertyGridPageState*    m_state;
2128
2129     /** Tree-hierarchy of added properties (that can have children). */
2130     wxArrayPGProperty       m_propHierarchy;
2131
2132     /** Hashmap for string-id to wxPGChoicesData mapping. */
2133     wxPGHashMapS2P          m_dictIdChoices;
2134 };
2135
2136 // -----------------------------------------------------------------------
2137
2138 //
2139 // Undefine macros that are not needed outside propertygrid sources
2140 //
2141 #ifndef __wxPG_SOURCE_FILE__
2142     #undef wxPG_FL_DESC_REFRESH_REQUIRED
2143     #undef wxPG_FL_SCROLLBAR_DETECTED
2144     #undef wxPG_FL_CREATEDSTATE
2145     #undef wxPG_FL_NOSTATUSBARHELP
2146     #undef wxPG_FL_SCROLLED
2147     #undef wxPG_FL_FOCUS_INSIDE_CHILD
2148     #undef wxPG_FL_FOCUS_INSIDE
2149     #undef wxPG_FL_MOUSE_INSIDE_CHILD
2150     #undef wxPG_FL_CUR_USES_CUSTOM_IMAGE
2151     #undef wxPG_FL_PRIMARY_FILLS_ENTIRE
2152     #undef wxPG_FL_VALUE_MODIFIED
2153     #undef wxPG_FL_MOUSE_INSIDE
2154     #undef wxPG_FL_FOCUSED
2155     #undef wxPG_FL_MOUSE_CAPTURED
2156     #undef wxPG_FL_INITIALIZED
2157     #undef wxPG_FL_ACTIVATION_BY_CLICK
2158     #undef wxPG_FL_DONT_CENTER_SPLITTER
2159     #undef wxPG_SUPPORT_TOOLTIPS
2160     #undef wxPG_DOUBLE_BUFFER
2161     #undef wxPG_ICON_WIDTH
2162     #undef wxPG_USE_RENDERER_NATIVE
2163 // Following are needed by the manager headers
2164 //    #undef const wxString&
2165 #endif
2166
2167 // -----------------------------------------------------------------------
2168
2169 #endif
2170
2171 #endif // _WX_PROPGRID_PROPGRID_H_
2172