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 OnCustomEditorEvent
 499 #define wxPG_FL_IN_ONCUSTOMEDITOREVENT      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 #ifndef SWIG
1183
1184     /**
1185         Generates contents for string dst based on the contents of
1186         wxArrayString src.
1187
1188         Format will be "(preDelim)str1(postDelim) (preDelim)str2(postDelim) and
1189         so on. Set flags to 1 inorder to convert backslashes to double-back-
1190         slashes and "(preDelims)"'s to "(preDelims)".
1191     */
1192     static void ArrayStringToString( wxString& dst, const wxArrayString& src,
1193                                      wxChar preDelim, wxChar postDelim,
1194                                      int flags );
1195
1196     // Mostly useful for page switching.
1197     void SwitchState( wxPropertyGridPageState* pNewState );
1198
1199     /**
1200         When creating custom property editors, connect required editor events to
1201         this function. For instance:
1202
1203         @code
1204             control->Connect(control->GetId(), wxEVT_COMMAND_TEXT_UPDATED,
1205                              wxEventHandler(wxPropertyGrid::OnCustomEditorEvent),
1206                              NULL, propgrid);
1207         @endcode
1208
1209         @remarks You should never need to call this function directly!
1210
1211         @see wxPGEditor::CreateControls(), wxEvtHandler::Connect()
1212     */
1213     void OnCustomEditorEvent( wxEvent &event );
1214
1215     long GetInternalFlags() const { return m_iFlags; }
1216     bool HasInternalFlag( long flag ) const
1217         { return (m_iFlags & flag) ? true : false; }
1218     void SetInternalFlag( long flag ) { m_iFlags |= flag; }
1219     void ClearInternalFlag( long flag ) { m_iFlags &= ~(flag); }
1220     void IncFrozen() { m_frozen++; }
1221     void DecFrozen() { m_frozen--; }
1222
1223     void OnComboItemPaint( const wxPGComboBox* pCb,
1224                            int item,
1225                            wxDC* pDc,
1226                            wxRect& rect,
1227                            int flags );
1228
1229     /** Standardized double-to-string conversion.
1230     */
1231     static void DoubleToString( wxString& target,
1232                                 double value,
1233                                 int precision,
1234                                 bool removeZeroes,
1235                                 wxString* precTemplate );
1236
1237     /**
1238         Call this from wxPGProperty::OnEvent() to cause property value to be
1239         changed after the function returns (with true as return value).
1240         ValueChangeInEvent() must be used if you wish the application to be
1241         able to use wxEVT_PG_CHANGING to potentially veto the given value.
1242     */
1243     void ValueChangeInEvent( wxVariant variant )
1244     {
1245         m_changeInEventValue = variant;
1246         m_iFlags |= wxPG_FL_VALUE_CHANGE_IN_EVENT;
1247     }
1248
1249     /** Returns true if given event is from first of an array of buttons
1250         (as can be in case when wxPGMultiButton is used).
1251     */
1252     bool IsMainButtonEvent( const wxEvent& event )
1253     {
1254         return (event.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED)
1255                     && (m_wndSecId == event.GetId());
1256     }
1257
1258     /** Pending value is expected to be passed in PerformValidation().
1259     */
1260     virtual bool DoPropertyChanged( wxPGProperty* p,
1261                                     unsigned int selFlags = 0 );
1262
1263     /** Called when validation for given property fails.
1264         @param invalidValue
1265             Value which failed in validation.
1266         @return
1267             Return true if user is allowed to change to another property even
1268             if current has invalid value.
1269         @remarks
1270         To add your own validation failure behavior, override
1271         wxPropertyGrid::DoOnValidationFailure().
1272     */
1273     bool OnValidationFailure( wxPGProperty* property, wxVariant& invalidValue )
1274     {
1275         bool res = DoOnValidationFailure(property, invalidValue);
1276         property->SetFlag(wxPG_PROP_INVALID_VALUE);
1277         return res;
1278     }
1279
1280     /** Called to indicate property and editor has valid value now.
1281     */
1282     void OnValidationFailureReset( wxPGProperty* property )
1283     {
1284         if ( property && property->HasFlag(wxPG_PROP_INVALID_VALUE) )
1285         {
1286             DoOnValidationFailureReset(property);
1287             property->ClearFlag(wxPG_PROP_INVALID_VALUE);
1288         }
1289         m_validationInfo.m_failureMessage.clear();
1290     }
1291
1292     /** Override in derived class to display error messages in custom manner
1293         (these message usually only result from validation failure).
1294     */
1295     virtual void DoShowPropertyError( wxPGProperty* property,
1296                                       const wxString& msg );
1297
1298     /** Override to customize property validation failure behavior.
1299         @param invalidValue
1300             Value which failed in validation.
1301         @return
1302             Return true if user is allowed to change to another property even
1303             if current has invalid value.
1304     */
1305     virtual bool DoOnValidationFailure( wxPGProperty* property,
1306                                         wxVariant& invalidValue );
1307
1308     /** Override to customize resetting of property validation failure status.
1309         @remarks
1310         Property is guaranteed to have flag wxPG_PROP_INVALID_VALUE set.
1311     */
1312     virtual void DoOnValidationFailureReset( wxPGProperty* property );
1313
1314     int GetSpacingY() const { return m_spacingy; }
1315
1316     /**
1317         Must be called in wxPGEditor::CreateControls() if primary editor window
1318         is wxTextCtrl, just before textctrl is created.
1319         @param text
1320             Initial text value of created wxTextCtrl.
1321     */
1322     void SetupTextCtrlValue( const wxString text ) { m_prevTcValue = text; }
1323
1324     /**
1325         Unfocuses or closes editor if one was open, but does not deselect
1326         property.
1327     */
1328     bool UnfocusEditor();
1329
1330     virtual bool ProcessEvent(wxEvent& event);
1331     virtual void SetWindowStyleFlag( long style );
1332
1333 protected:
1334
1335     /**
1336         wxPropertyGridPageState used by the grid is created here.
1337
1338         If grid is used in wxPropertyGridManager, there is no point overriding
1339         this - instead, set custom wxPropertyGridPage classes.
1340     */
1341     virtual wxPropertyGridPageState* CreateState() const;
1342
1343     enum PerformValidationFlags
1344     {
1345         SendEvtChanging         = 0x0001,
1346         IsStandaloneValidation  = 0x0002   // Not called in response to event
1347     };
1348
1349     /**
1350         Runs all validation functionality (includes sending wxEVT_PG_CHANGING).
1351         Returns true if all tests passed. Implement in derived class to
1352         add additional validation behavior.
1353     */
1354     virtual bool PerformValidation( wxPGProperty* p,
1355                                     wxVariant& pendingValue,
1356                                     int flags = SendEvtChanging );
1357
1358 public:
1359
1360     // Control font changer helper.
1361     void SetCurControlBoldFont();
1362
1363     wxPGCell& GetPropertyDefaultCell()
1364     {
1365         return m_propertyDefaultCell;
1366     }
1367
1368     wxPGCell& GetCategoryDefaultCell()
1369     {
1370         return m_categoryDefaultCell;
1371     }
1372
1373     //
1374     // Public methods for semi-public use
1375     // (not protected for optimization)
1376     //
1377     bool DoSelectProperty( wxPGProperty* p, unsigned int flags = 0 );
1378
1379     // Overridden functions.
1380     virtual bool Destroy();
1381     // Returns property at given y coordinate (relative to grid's top left).
1382     wxPGProperty* GetItemAtY( int y ) const { return DoGetItemAtY(y); }
1383
1384     virtual void Refresh( bool eraseBackground = true,
1385                           const wxRect *rect = (const wxRect *) NULL );
1386     virtual bool SetFont( const wxFont& font );
1387 #if wxPG_SUPPORT_TOOLTIPS
1388     void SetToolTip( const wxString& tipString );
1389 #endif
1390     virtual void Freeze();
1391     virtual void SetExtraStyle( long exStyle );
1392     virtual void Thaw();
1393
1394
1395 protected:
1396     virtual wxSize DoGetBestSize() const;
1397
1398 #ifndef wxPG_ICON_WIDTH
1399     wxBitmap            *m_expandbmp, *m_collbmp;
1400 #endif
1401
1402     wxCursor            *m_cursorSizeWE;
1403
1404     /** wxWindow pointers to editor control(s). */
1405     wxWindow            *m_wndEditor;
1406     wxWindow            *m_wndEditor2;
1407
1408     /** wxPGCanvas instance. */
1409     wxPanel             *m_canvas;
1410
1411 #if wxPG_DOUBLE_BUFFER
1412     wxBitmap            *m_doubleBuffer;
1413 #endif
1414
1415     /** Local time ms when control was created. */
1416     wxLongLong          m_timeCreated;
1417
1418     /** wxPGProperty::OnEvent can change value by setting this. */
1419     wxVariant           m_changeInEventValue;
1420
1421     /** Id of m_wndEditor2, or its first child, if any. */
1422     int                 m_wndSecId;
1423
1424     /** Extra Y spacing between the items. */
1425     int                 m_spacingy;
1426
1427     /** Control client area width; updated on resize. */
1428     int                 m_width;
1429
1430     /** Control client area height; updated on resize. */
1431     int                 m_height;
1432
1433     /** Current non-client width (needed when auto-centering). */
1434     int                 m_ncWidth;
1435
1436     /** Non-client width (auto-centering helper). */
1437     //int                 m_fWidth;
1438
1439     /** Previously recorded scroll start position. */
1440     int                 m_prevVY;
1441
1442     /**
1443         The gutter spacing in front and back of the image.
1444         This determines the amount of spacing in front of each item
1445      */
1446     int                 m_gutterWidth;
1447
1448     /** Includes separator line. */
1449     int                 m_lineHeight;
1450
1451     /** Gutter*2 + image width. */
1452     int                 m_marginWidth;
1453
1454     // y spacing for expand/collapse button.
1455     int                 m_buttonSpacingY;
1456
1457     /** Extra margin for expanded sub-group items. */
1458     int                 m_subgroup_extramargin;
1459
1460     /**
1461         The image width of the [+] icon.
1462
1463         This is also calculated in the gutter
1464      */
1465     int                 m_iconWidth;
1466
1467 #ifndef wxPG_ICON_WIDTH
1468
1469     /**
1470         The image height of the [+] icon.
1471
1472         This is calculated as minimal size and to align
1473      */
1474     int                 m_iconHeight;
1475 #endif
1476
1477     /** Current cursor id. */
1478     int                 m_curcursor;
1479
1480     /**
1481         This captionFont is made equal to the font of the wxScrolledWindow.
1482
1483         As extra the bold face is set on it when this is wanted by the user
1484         (see flags)
1485      */
1486     wxFont              m_captionFont;
1487
1488     int                 m_fontHeight;  // Height of the font.
1489
1490     /** m_splitterx when drag began. */
1491     int                 m_startingSplitterX;
1492
1493     /**
1494         Index to splitter currently being dragged (0=one after the first
1495         column).
1496      */
1497     int                 m_draggedSplitter;
1498
1499     /** Changed property, calculated in PerformValidation(). */
1500     wxPGProperty*       m_chgInfo_changedProperty;
1501
1502     /**
1503         Lowest property for which editing happened, but which does not have
1504         aggregate parent
1505      */
1506     wxPGProperty*       m_chgInfo_baseChangedProperty;
1507
1508     /** Changed property value, calculated in PerformValidation(). */
1509     wxVariant           m_chgInfo_pendingValue;
1510
1511     /** Passed to SetValue. */
1512     wxVariant           m_chgInfo_valueList;
1513
1514     /** Validation information. */
1515     wxPGValidationInfo  m_validationInfo;
1516
1517     /** Actions and keys that trigger them. */
1518     wxPGHashMapI2I      m_actionTriggers;
1519
1520     //
1521     // Temporary values
1522     //
1523
1524     /** Bits are used to indicate which colours are customized. */
1525     unsigned short      m_coloursCustomized;
1526
1527     /** x - m_splitterx. */
1528     signed char                 m_dragOffset;
1529
1530     /** 0 = not dragging, 1 = drag just started, 2 = drag in progress */
1531     unsigned char       m_dragStatus;
1532
1533     /** 0 = margin, 1 = label, 2 = value. */
1534     unsigned char       m_mouseSide;
1535
1536     /** True when editor control is focused. */
1537     unsigned char       m_editorFocused;
1538
1539     /** 1 if m_latsCaption is also the bottommost caption. */
1540     //unsigned char       m_lastCaptionBottomnest;
1541
1542     /** Set to 1 when graphics frozen. */
1543     unsigned char       m_frozen;
1544
1545     unsigned char       m_vspacing;
1546
1547     // Used to track when Alt/Ctrl+Key was consumed.
1548     unsigned char       m_keyComboConsumed;
1549
1550     /** 1 if in DoPropertyChanged() */
1551     unsigned char       m_inDoPropertyChanged;
1552
1553     /** 1 if in CommitChangesFromEditor() */
1554     unsigned char       m_inCommitChangesFromEditor;
1555
1556     /** 1 if in DoSelectProperty() */
1557     unsigned char       m_inDoSelectProperty;
1558
1559     wxPGVFBFlags        m_permanentValidationFailureBehavior;  // Set by app
1560
1561     /** Internal flags - see wxPG_FL_XXX constants. */
1562     wxUint32            m_iFlags;
1563
1564     /** When drawing next time, clear this many item slots at the end. */
1565     int                 m_clearThisMany;
1566
1567     /** Pointer to selected property. Note that this is duplicated in
1568         m_state for better transiency between pages so that the selected
1569         item can be retained.
1570     */
1571     wxPGProperty*       m_selected;
1572
1573     // pointer to property that has mouse hovering
1574     wxPGProperty*       m_propHover;
1575
1576     // EventObject for wxPropertyGridEvents
1577     wxWindow*           m_eventObject;
1578
1579     // What (global) window is currently focused (needed to resolve event
1580     // handling mess).
1581     wxWindow*           m_curFocused;
1582
1583     // wxPGTLWHandler
1584     wxEvtHandler*       m_tlwHandler;
1585
1586     // Top level parent
1587     wxWindow*           m_tlp;
1588
1589     // y coordinate of property that mouse hovering
1590     int                 m_propHoverY;
1591     // Which column's editor is selected (usually 1)?
1592     int                 m_selColumn;
1593
1594     // x relative to splitter (needed for resize).
1595     int                 m_ctrlXAdjust;
1596
1597     // lines between cells
1598     wxColour            m_colLine;
1599     // property labels and values are written in this colour
1600     wxColour            m_colPropFore;
1601     // or with this colour when disabled
1602     wxColour            m_colDisPropFore;
1603     // background for m_colPropFore
1604     wxColour            m_colPropBack;
1605     // text color for captions
1606     wxColour            m_colCapFore;
1607     // background color for captions
1608     wxColour            m_colCapBack;
1609     // foreground for selected property
1610     wxColour            m_colSelFore;
1611     // background for selected property (actually use background color when
1612     // control out-of-focus)
1613     wxColour            m_colSelBack;
1614     // background colour for margin
1615     wxColour            m_colMargin;
1616     // background colour for empty space below the grid
1617     wxColour            m_colEmptySpace;
1618
1619     // Default property colours
1620     wxPGCell            m_propertyDefaultCell;
1621
1622     // Default property category
1623     wxPGCell            m_categoryDefaultCell;
1624
1625     // Backup of selected property's cells
1626     wxVector<wxPGCell>  m_propCellsBackup;
1627
1628     // NB: These *cannot* be moved to globals.
1629
1630     // labels when properties use common values
1631     wxVector<wxPGCommonValue*>  m_commonValues;
1632
1633     // Which cv selection really sets value to unspecified?
1634     int                 m_cvUnspecified;
1635
1636     // Used to skip excess text editor events
1637     wxString            m_prevTcValue;
1638
1639 protected:
1640
1641     // Sets some members to defaults (called constructors).
1642     void Init1();
1643
1644     // Initializes some members (called by Create and complex constructor).
1645     void Init2();
1646
1647     void OnPaint(wxPaintEvent &event );
1648
1649     // main event receivers
1650     void OnMouseMove( wxMouseEvent &event );
1651     void OnMouseMoveBottom( wxMouseEvent &event );
1652     void OnMouseClick( wxMouseEvent &event );
1653     void OnMouseRightClick( wxMouseEvent &event );
1654     void OnMouseDoubleClick( wxMouseEvent &event );
1655     void OnMouseUp( wxMouseEvent &event );
1656     void OnKey( wxKeyEvent &event );
1657     void OnResize( wxSizeEvent &event );
1658
1659     // event handlers
1660     bool HandleMouseMove( int x, unsigned int y, wxMouseEvent &event );
1661     bool HandleMouseClick( int x, unsigned int y, wxMouseEvent &event );
1662     bool HandleMouseRightClick( int x, unsigned int y, wxMouseEvent &event );
1663     bool HandleMouseDoubleClick( int x, unsigned int y, wxMouseEvent &event );
1664     bool HandleMouseUp( int x, unsigned int y, wxMouseEvent &event );
1665     void HandleKeyEvent( wxKeyEvent &event, bool fromChild );
1666
1667     void OnMouseEntry( wxMouseEvent &event );
1668
1669     void OnIdle( wxIdleEvent &event );
1670     void OnFocusEvent( wxFocusEvent &event );
1671     void OnChildFocusEvent( wxChildFocusEvent& event );
1672
1673     bool OnMouseCommon( wxMouseEvent &event, int* px, int *py );
1674     bool OnMouseChildCommon( wxMouseEvent &event, int* px, int *py );
1675
1676     // sub-control event handlers
1677     void OnMouseClickChild( wxMouseEvent &event );
1678     void OnMouseRightClickChild( wxMouseEvent &event );
1679     void OnMouseMoveChild( wxMouseEvent &event );
1680     void OnMouseUpChild( wxMouseEvent &event );
1681     void OnChildKeyDown( wxKeyEvent &event );
1682
1683     void OnCaptureChange( wxMouseCaptureChangedEvent &event );
1684
1685     void OnScrollEvent( wxScrollWinEvent &event );
1686
1687     void OnSysColourChanged( wxSysColourChangedEvent &event );
1688
1689 protected:
1690
1691     /**
1692         Adjust the centering of the bitmap icons (collapse / expand) when the
1693         caption font changes.
1694
1695         They need to be centered in the middle of the font, so a bit of deltaY
1696         adjustment is needed. On entry, m_captionFont must be set to window
1697         font. It will be modified properly.
1698       */
1699     void CalculateFontAndBitmapStuff( int vspacing );
1700
1701     wxRect GetEditorWidgetRect( wxPGProperty* p, int column ) const;
1702
1703     void CorrectEditorWidgetSizeX();
1704
1705     /** Called in RecalculateVirtualSize() to reposition control
1706         on virtual height changes.
1707     */
1708     void CorrectEditorWidgetPosY();
1709
1710 #ifdef __WXDEBUG__
1711     void _log_items();
1712     void OnScreenNote( const wxChar* format, ... );
1713 #endif
1714
1715     /** Deselect current selection, if any. Returns true if success
1716         (ie. validator did not intercept). */
1717     bool DoClearSelection();
1718
1719     int DoDrawItems( wxDC& dc,
1720                      const wxPGProperty* first_item,
1721                      const wxPGProperty* last_item,
1722                      const wxRect* clip_rect,
1723                      bool isBuffered ) const;
1724
1725     void DoSetPropertyValueUnspecified( wxPGProperty* p );
1726
1727     /** Draws an expand/collapse (ie. +/-) button.
1728     */
1729     virtual void DrawExpanderButton( wxDC& dc, const wxRect& rect,
1730                                      wxPGProperty* property ) const;
1731
1732     /** Draws items from topitemy to bottomitemy */
1733     void DrawItems( wxDC& dc, unsigned int topitemy, unsigned int bottomitemy,
1734                     const wxRect* clip_rect = (const wxRect*) NULL );
1735
1736     void DrawItems( const wxPGProperty* p1, const wxPGProperty* p2 );
1737
1738     void DrawItem( wxPGProperty* p )
1739     {
1740         DrawItems(p,p);
1741     }
1742
1743     virtual void DrawItemAndChildren( wxPGProperty* p );
1744
1745     /**
1746         Draws item, children, and consequtive parents as long as category is
1747         not met.
1748      */
1749     void DrawItemAndValueRelated( wxPGProperty* p );
1750
1751     // Translate wxKeyEvent to wxPG_ACTION_XXX
1752     int KeyEventToActions(wxKeyEvent &event, int* pSecond) const;
1753
1754     int KeyEventToAction(wxKeyEvent &event) const
1755     {
1756         return KeyEventToActions(event, NULL);
1757     }
1758
1759     void ImprovedClientToScreen( int* px, int* py );
1760
1761     // Returns True if editor control has focus
1762     bool IsEditorFocused() const;
1763
1764     // Called by focus event handlers. newFocused is the window that becomes
1765     // focused.
1766     void HandleFocusChange( wxWindow* newFocused );
1767
1768     /** Reloads all non-customized colours from system settings. */
1769     void RegainColours();
1770
1771     bool DoEditorValidate();
1772
1773     wxPGProperty* DoGetItemAtY( int y ) const;
1774
1775     void DoSetSplitterPosition_( int newxpos,
1776                                  bool refresh = true,
1777                                  int splitterIndex = 0,
1778                                  bool allPages = false );
1779
1780     void FreeEditors();
1781
1782     virtual bool DoExpand( wxPGProperty* p, bool sendEvent = false );
1783
1784     virtual bool DoCollapse( wxPGProperty* p, bool sendEvent = false );
1785
1786     // Returns nearest paint visible property (such that will be painted unless
1787     // window is scrolled or resized). If given property is paint visible, then
1788     // it itself will be returned.
1789     wxPGProperty* GetNearestPaintVisible( wxPGProperty* p ) const;
1790
1791     static void RegisterDefaultEditors();
1792
1793     // Sets up basic event handling for child control
1794     void SetupChildEventHandling( wxWindow* wnd );
1795
1796     void CustomSetCursor( int type, bool override = false );
1797
1798     /**
1799         Repositions scrollbar and underlying panel according to changed virtual
1800         size.
1801     */
1802     void RecalculateVirtualSize( int forceXPos = -1 );
1803
1804     void PrepareAfterItemsAdded();
1805
1806     bool SendEvent( int eventType,
1807                     wxPGProperty* p,
1808                     wxVariant* pValue = NULL,
1809                     unsigned int selFlags = 0 );
1810
1811     void SetFocusOnCanvas();
1812
1813     bool DoHideProperty( wxPGProperty* p, bool hide, int flags );
1814
1815 private:
1816
1817     bool ButtonTriggerKeyTest( int action, wxKeyEvent& event );
1818
1819     DECLARE_EVENT_TABLE()
1820 #endif // #ifndef SWIG
1821 };
1822
1823 // -----------------------------------------------------------------------
1824 //
1825 // Bunch of inlines that need to resolved after all classes have been defined.
1826 //
1827
1828 #ifndef SWIG
1829 inline bool wxPropertyGridPageState::IsDisplayed() const
1830 {
1831     return ( this == m_pPropGrid->GetState() );
1832 }
1833
1834 inline unsigned int wxPropertyGridPageState::GetActualVirtualHeight() const
1835 {
1836     return DoGetRoot()->GetChildrenHeight(GetGrid()->GetRowHeight());
1837 }
1838 #endif
1839
1840 inline int wxPGProperty::GetDisplayedCommonValueCount() const
1841 {
1842     if ( HasFlag(wxPG_PROP_USES_COMMON_VALUE) )
1843     {
1844         wxPropertyGrid* pg = GetGrid();
1845         if ( pg )
1846             return (int) pg->GetCommonValueCount();
1847     }
1848     return 0;
1849 }
1850
1851 inline void wxPGProperty::SetEditor( const wxString& editorName )
1852 {
1853     m_customEditor = wxPropertyGridInterface::GetEditorByName(editorName);
1854 }
1855
1856 inline void wxPGProperty::SetName( const wxString& newName )
1857 {
1858     GetGrid()->SetPropertyName(this, newName);
1859 }
1860
1861 inline bool wxPGProperty::Hide( bool hide, int flags )
1862 {
1863     return GetGrid()->HideProperty(this, hide, flags);
1864 }
1865
1866 inline bool wxPGProperty::SetMaxLength( int maxLen )
1867 {
1868     return GetGrid()->SetPropertyMaxLength(this,maxLen);
1869 }
1870
1871 // -----------------------------------------------------------------------
1872
1873 #define wxPG_BASE_EVT_PRE_ID     1775
1874
1875 #ifndef SWIG
1876
1877 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_SELECTED;
1878 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_CHANGING;
1879 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_CHANGED;
1880 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_HIGHLIGHTED;
1881 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_RIGHT_CLICK;
1882 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_PAGE_CHANGED;
1883 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_ITEM_COLLAPSED;
1884 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_ITEM_EXPANDED;
1885 extern WXDLLIMPEXP_PROPGRID const wxEventType wxEVT_PG_DOUBLE_CLICK;
1886
1887 #else
1888     enum {
1889         wxEVT_PG_SELECTED = wxPG_BASE_EVT_PRE_ID,
1890         wxEVT_PG_CHANGING,
1891         wxEVT_PG_CHANGED,
1892         wxEVT_PG_HIGHLIGHTED,
1893         wxEVT_PG_RIGHT_CLICK,
1894         wxEVT_PG_PAGE_CHANGED,
1895         wxEVT_PG_ITEM_COLLAPSED,
1896         wxEVT_PG_ITEM_EXPANDED,
1897         wxEVT_PG_DOUBLE_CLICK
1898     };
1899 #endif
1900
1901
1902 #define wxPG_BASE_EVT_TYPE       wxEVT_PG_SELECTED
1903 #define wxPG_MAX_EVT_TYPE        (wxPG_BASE_EVT_TYPE+30)
1904
1905
1906 #ifndef SWIG
1907 typedef void (wxEvtHandler::*wxPropertyGridEventFunction)(wxPropertyGridEvent&);
1908
1909 #define EVT_PG_SELECTED(id, fn)              DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1910 #define EVT_PG_CHANGING(id, fn)              DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1911 #define EVT_PG_CHANGED(id, fn)               DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1912 #define EVT_PG_HIGHLIGHTED(id, fn)           DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_HIGHLIGHTED, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1913 #define EVT_PG_RIGHT_CLICK(id, fn)           DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1914 #define EVT_PG_DOUBLE_CLICK(id, fn)          DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_DOUBLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1915 #define EVT_PG_PAGE_CHANGED(id, fn)          DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_PAGE_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1916 #define EVT_PG_ITEM_COLLAPSED(id, fn)        DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1917 #define EVT_PG_ITEM_EXPANDED(id, fn)         DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1918
1919 #define wxPropertyGridEventHandler(A) \
1920     ((wxObjectEventFunction)(wxEventFunction)(wxPropertyGridEventFunction)&A)
1921
1922 #endif
1923
1924
1925 /** @class wxPropertyGridEvent
1926
1927     A propertygrid event holds information about events associated with
1928     wxPropertyGrid objects.
1929
1930     @library{wxpropgrid}
1931     @category{propgrid}
1932 */
1933 class WXDLLIMPEXP_PROPGRID wxPropertyGridEvent : public wxCommandEvent
1934 {
1935 public:
1936
1937     /** Constructor. */
1938     wxPropertyGridEvent(wxEventType commandType=0, int id=0);
1939 #ifndef SWIG
1940     /** Copy constructor. */
1941     wxPropertyGridEvent(const wxPropertyGridEvent& event);
1942 #endif
1943     /** Destructor. */
1944     ~wxPropertyGridEvent();
1945
1946     /** Copyer. */
1947     virtual wxEvent* Clone() const;
1948
1949     wxPGProperty* GetMainParent() const
1950     {
1951         wxASSERT(m_property);
1952         return m_property->GetMainParent();
1953     }
1954
1955     /** Returns id of associated property. */
1956     wxPGProperty* GetProperty() const
1957     {
1958         return m_property;
1959     }
1960
1961     wxPGValidationInfo& GetValidationInfo()
1962     {
1963         wxASSERT(m_validationInfo);
1964         return *m_validationInfo;
1965     }
1966
1967     /** Returns true if you can veto the action that the event is signaling.
1968     */
1969     bool CanVeto() const { return m_canVeto; }
1970
1971     /**
1972         Call this from your event handler to veto action that the event is
1973         signaling.
1974
1975         You can only veto a shutdown if wxPropertyGridEvent::CanVeto returns
1976         true.
1977         @remarks
1978         Currently only wxEVT_PG_CHANGING supports vetoing.
1979     */
1980     void Veto( bool veto = true ) { m_wasVetoed = veto; }
1981
1982     /** Returns value that is about to be set for wxEVT_PG_CHANGING.
1983     */
1984     const wxVariant& GetValue() const
1985     {
1986         wxASSERT_MSG( m_validationInfo,
1987                       "Only call GetValue from a handler "
1988                       "of event type that supports it" );
1989         return m_validationInfo->GetValue();
1990     }
1991
1992     /**
1993         Set override validation failure behavior.
1994
1995         Only effective if Veto was also called, and only allowed if event type
1996         is wxEVT_PG_CHANGING.
1997     */
1998     void SetValidationFailureBehavior( wxPGVFBFlags flags )
1999     {
2000         wxASSERT( GetEventType() == wxEVT_PG_CHANGING );
2001         m_validationInfo->SetFailureBehavior( flags );
2002     }
2003
2004     /** Sets custom failure message for this time only. Only applies if
2005         wxPG_VFB_SHOW_MESSAGE is set in validation failure flags.
2006     */
2007     void SetValidationFailureMessage( const wxString& message )
2008     {
2009         wxASSERT( GetEventType() == wxEVT_PG_CHANGING );
2010         m_validationInfo->SetFailureMessage( message );
2011     }
2012
2013 #ifndef SWIG
2014     wxPGVFBFlags GetValidationFailureBehavior() const
2015     {
2016         wxASSERT( GetEventType() == wxEVT_PG_CHANGING );
2017         return m_validationInfo->GetFailureBehavior();
2018     }
2019
2020     void SetCanVeto( bool canVeto ) { m_canVeto = canVeto; }
2021     bool WasVetoed() const { return m_wasVetoed; }
2022
2023     /** Changes the associated property. */
2024     void SetProperty( wxPGProperty* p ) { m_property = p; }
2025
2026     void SetPropertyGrid( wxPropertyGrid* pg ) { m_pg = pg; }
2027
2028     void SetupValidationInfo()
2029     {
2030         wxASSERT(m_pg);
2031         wxASSERT( GetEventType() == wxEVT_PG_CHANGING );
2032         m_validationInfo = &m_pg->GetValidationInfo();
2033     }
2034
2035 private:
2036     void Init();
2037     DECLARE_DYNAMIC_CLASS(wxPropertyGridEvent)
2038
2039     wxPGProperty*       m_property;
2040     wxPropertyGrid*     m_pg;
2041     wxPGValidationInfo* m_validationInfo;
2042
2043     bool                m_canVeto;
2044     bool                m_wasVetoed;
2045
2046 #endif
2047 };
2048
2049
2050 // -----------------------------------------------------------------------
2051
2052 /** @class wxPropertyGridPopulator
2053     @ingroup classes
2054     Allows populating wxPropertyGrid from arbitrary text source.
2055 */
2056 class WXDLLIMPEXP_PROPGRID wxPropertyGridPopulator
2057 {
2058 public:
2059     /** Default constructor.
2060     */
2061     wxPropertyGridPopulator();
2062
2063     /** Destructor. */
2064     virtual ~wxPropertyGridPopulator();
2065
2066     void SetState( wxPropertyGridPageState* state );
2067
2068     void SetGrid( wxPropertyGrid* pg );
2069
2070     /** Appends a new property under bottommost parent.
2071         @param propClass
2072         Property class as string.
2073     */
2074     wxPGProperty* Add( const wxString& propClass,
2075                        const wxString& propLabel,
2076                        const wxString& propName,
2077                        const wxString* propValue,
2078                        wxPGChoices* pChoices = NULL );
2079
2080     /**
2081         Pushes property to the back of parent array (ie it becomes bottommost
2082         parent), and starts scanning/adding children for it.
2083
2084         When finished, parent array is returned to the original state.
2085     */
2086     void AddChildren( wxPGProperty* property );
2087
2088     /** Adds attribute to the bottommost property.
2089         @param type
2090         Allowed values: "string", (same as string), "int", "bool". Empty string
2091           mean autodetect.
2092     */
2093     bool AddAttribute( const wxString& name,
2094                        const wxString& type,
2095                        const wxString& value );
2096
2097     /** Called once in AddChildren.
2098     */
2099     virtual void DoScanForChildren() = 0;
2100
2101     /**
2102         Returns id of parent property for which children can currently be
2103         added.
2104      */
2105     wxPGProperty* GetCurParent() const
2106     {
2107         return (wxPGProperty*) m_propHierarchy[m_propHierarchy.size()-1];
2108     }
2109
2110     wxPropertyGridPageState* GetState() { return m_state; }
2111     const wxPropertyGridPageState* GetState() const { return m_state; }
2112
2113     /** Like wxString::ToLong, except allows N% in addition of N.
2114     */
2115     static bool ToLongPCT( const wxString& s, long* pval, long max );
2116
2117     /** Parses strings of format "choice1"[=value1] ... "choiceN"[=valueN] into
2118         wxPGChoices. Registers parsed result using idString (if not empty).
2119         Also, if choices with given id already registered, then don't parse but
2120         return those choices instead.
2121     */
2122     wxPGChoices ParseChoices( const wxString& choicesString,
2123                               const wxString& idString );
2124
2125     /** Implement in derived class to do custom process when an error occurs.
2126         Default implementation uses wxLogError.
2127     */
2128     virtual void ProcessError( const wxString& msg );
2129
2130 protected:
2131
2132     /** Used property grid. */
2133     wxPropertyGrid*         m_pg;
2134
2135     /** Used property grid state. */
2136     wxPropertyGridPageState*    m_state;
2137
2138     /** Tree-hierarchy of added properties (that can have children). */
2139     wxArrayPGProperty       m_propHierarchy;
2140
2141     /** Hashmap for string-id to wxPGChoicesData mapping. */
2142     wxPGHashMapS2P          m_dictIdChoices;
2143 };
2144
2145 // -----------------------------------------------------------------------
2146
2147 //
2148 // Undefine macros that are not needed outside propertygrid sources
2149 //
2150 #ifndef __wxPG_SOURCE_FILE__
2151     #undef wxPG_FL_DESC_REFRESH_REQUIRED
2152     #undef wxPG_FL_SCROLLBAR_DETECTED
2153     #undef wxPG_FL_CREATEDSTATE
2154     #undef wxPG_FL_NOSTATUSBARHELP
2155     #undef wxPG_FL_SCROLLED
2156     #undef wxPG_FL_FOCUS_INSIDE_CHILD
2157     #undef wxPG_FL_FOCUS_INSIDE
2158     #undef wxPG_FL_MOUSE_INSIDE_CHILD
2159     #undef wxPG_FL_CUR_USES_CUSTOM_IMAGE
2160     #undef wxPG_FL_PRIMARY_FILLS_ENTIRE
2161     #undef wxPG_FL_VALUE_MODIFIED
2162     #undef wxPG_FL_MOUSE_INSIDE
2163     #undef wxPG_FL_FOCUSED
2164     #undef wxPG_FL_MOUSE_CAPTURED
2165     #undef wxPG_FL_INITIALIZED
2166     #undef wxPG_FL_ACTIVATION_BY_CLICK
2167     #undef wxPG_FL_DONT_CENTER_SPLITTER
2168     #undef wxPG_SUPPORT_TOOLTIPS
2169     #undef wxPG_DOUBLE_BUFFER
2170     #undef wxPG_ICON_WIDTH
2171     #undef wxPG_USE_RENDERER_NATIVE
2172 // Following are needed by the manager headers
2173 //    #undef const wxString&
2174 #endif
2175
2176 // -----------------------------------------------------------------------
2177
2178 #endif
2179
2180 #endif // _WX_PROPGRID_PROPGRID_H_
2181