1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/propgrid/propgrid.h
3 // Purpose: wxPropertyGrid
4 // Author: Jaakko Salli
8 // Copyright: (c) Jaakko Salli
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_PROPGRID_PROPGRID_H_
13 #define _WX_PROPGRID_PROPGRID_H_
17 #include "wx/dcclient.h"
18 #include "wx/scrolwin.h"
19 #include "wx/tooltip.h"
20 #include "wx/datetime.h"
22 #include "wx/propgrid/property.h"
23 #include "wx/propgrid/propgridiface.h"
27 extern WXDLLIMPEXP_PROPGRID
const wxChar
*wxPropertyGridNameStr
;
31 // -----------------------------------------------------------------------
33 // -----------------------------------------------------------------------
37 // This is required for sharing common global variables.
38 class WXDLLIMPEXP_PROPGRID wxPGGlobalVarsClass
42 wxPGGlobalVarsClass();
43 ~wxPGGlobalVarsClass();
45 // Used by advprops, but here to make things easier.
46 wxString m_pDefaultImageWildcard
;
48 // Map of editor class instances (keys are name string).
49 wxPGHashMapS2P m_mapEditorClasses
;
52 wxArrayPtrVoid m_arrValidators
; // These wxValidators need to be freed
55 wxPGHashMapS2P m_dictPropertyClassInfo
; // PropertyName -> ClassInfo
57 wxPGChoices
* m_fontFamilyChoices
;
59 // Replace with your own to affect all properties using default renderer.
60 wxPGCellRenderer
* m_defaultRenderer
;
62 wxPGChoices m_boolChoices
;
64 wxVariant m_vEmptyString
;
66 wxVariant m_vMinusOne
;
70 // Cached constant strings
71 wxPGCachedString m_strstring
;
72 wxPGCachedString m_strlong
;
73 wxPGCachedString m_strbool
;
74 wxPGCachedString m_strlist
;
76 wxPGCachedString m_strMin
;
77 wxPGCachedString m_strMax
;
78 wxPGCachedString m_strUnits
;
79 wxPGCachedString m_strInlineHelp
;
81 // If true then some things are automatically translated
82 bool m_autoGetTranslation
;
84 // > 0 if errors cannot or should not be shown in statusbar etc.
87 int m_extraStyle
; // global extra style
93 int HasExtraStyle( int style
) const { return (m_extraStyle
& style
); }
96 extern WXDLLIMPEXP_PROPGRID wxPGGlobalVarsClass
* wxPGGlobalVars
;
98 #define wxPGVariant_EmptyString (wxPGGlobalVars->m_vEmptyString)
99 #define wxPGVariant_Zero (wxPGGlobalVars->m_vZero)
100 #define wxPGVariant_MinusOne (wxPGGlobalVars->m_vMinusOne)
101 #define wxPGVariant_True (wxPGGlobalVars->m_vTrue)
102 #define wxPGVariant_False (wxPGGlobalVars->m_vFalse)
104 #define wxPGVariant_Bool(A) (A?wxPGVariant_True:wxPGVariant_False)
108 // -----------------------------------------------------------------------
110 /** @section propgrid_window_styles wxPropertyGrid Window Styles
112 SetWindowStyleFlag method can be used to modify some of these at run-time.
115 enum wxPG_WINDOW_STYLES
118 /** This will cause Sort() automatically after an item is added.
119 When inserting a lot of items in this mode, it may make sense to
120 use Freeze() before operations and Thaw() afterwards to increase
123 wxPG_AUTO_SORT
= 0x00000010,
125 /** Categories are not initially shown (even if added).
126 IMPORTANT NOTE: If you do not plan to use categories, then this
127 style will waste resources.
128 This flag can also be changed using wxPropertyGrid::EnableCategories method.
130 wxPG_HIDE_CATEGORIES
= 0x00000020,
132 /* This style combines non-categoric mode and automatic sorting.
134 wxPG_ALPHABETIC_MODE
= (wxPG_HIDE_CATEGORIES
|wxPG_AUTO_SORT
),
136 /** Modified values are shown in bold font. Changing this requires Refresh()
139 wxPG_BOLD_MODIFIED
= 0x00000040,
141 /** When wxPropertyGrid is resized, splitter moves to the center. This
142 behavior stops once the user manually moves the splitter.
144 wxPG_SPLITTER_AUTO_CENTER
= 0x00000080,
146 /** Display tooltips for cell text that cannot be shown completely. If
147 wxUSE_TOOLTIPS is 0, then this doesn't have any effect.
149 wxPG_TOOLTIPS
= 0x00000100,
151 /** Disables margin and hides all expand/collapse buttons that would appear
152 outside the margin (for sub-properties). Toggling this style automatically
153 expands all collapsed items.
155 wxPG_HIDE_MARGIN
= 0x00000200,
157 /** This style prevents user from moving the splitter.
159 wxPG_STATIC_SPLITTER
= 0x00000400,
161 /** Combination of other styles that make it impossible for user to modify
164 wxPG_STATIC_LAYOUT
= (wxPG_HIDE_MARGIN
|wxPG_STATIC_SPLITTER
),
166 /** Disables wxTextCtrl based editors for properties which
167 can be edited in another way.
169 Equals calling wxPropertyGrid::LimitPropertyEditing for all added
172 wxPG_LIMITED_EDITING
= 0x00000800,
174 /** wxPropertyGridManager only: Show toolbar for mode and page selection. */
175 wxPG_TOOLBAR
= 0x00001000,
177 /** wxPropertyGridManager only: Show adjustable text box showing description
178 or help text, if available, for currently selected property.
180 wxPG_DESCRIPTION
= 0x00002000
184 enum wxPG_EX_WINDOW_STYLES
188 NOTE: wxPG_EX_xxx are extra window styles and must be set using
189 SetExtraStyle() member function.
191 Speeds up switching to wxPG_HIDE_CATEGORIES mode. Initially, if
192 wxPG_HIDE_CATEGORIES is not defined, the non-categorized data storage is
193 not activated, and switching the mode first time becomes somewhat slower.
194 wxPG_EX_INIT_NOCAT activates the non-categorized data storage right away.
195 IMPORTANT NOTE: If you do plan not switching to non-categoric mode, or if
196 you don't plan to use categories at all, then using this style will result
197 in waste of resources.
200 wxPG_EX_INIT_NOCAT
= 0x00001000,
202 /** Extended window style that sets wxPropertyGridManager toolbar to not
205 wxPG_EX_NO_FLAT_TOOLBAR
= 0x00002000,
207 /** Shows alphabetic/categoric mode buttons from toolbar.
209 wxPG_EX_MODE_BUTTONS
= 0x00008000,
211 /** Show property help strings as tool tips instead as text on the status bar.
212 You can set the help strings using SetPropertyHelpString member function.
214 wxPG_EX_HELP_AS_TOOLTIPS
= 0x00010000,
216 /** Prevent TAB from focusing to wxButtons. This behavior was default
217 in version 1.2.0 and earlier.
218 NOTE! Tabbing to button doesn't work yet. Problem seems to be that on wxMSW
219 atleast the button doesn't properly propagate key events (yes, I'm using
222 //wxPG_EX_NO_TAB_TO_BUTTON = 0x00020000,
224 /** Allows relying on native double-buffering.
226 wxPG_EX_NATIVE_DOUBLE_BUFFERING
= 0x00080000,
228 /** Set this style to let user have ability to set values of properties to
229 unspecified state. Same as setting wxPG_PROP_AUTO_UNSPECIFIED for
232 wxPG_EX_AUTO_UNSPECIFIED_VALUES
= 0x00200000,
235 If this style is used, built-in attributes (such as wxPG_FLOAT_PRECISION
236 and wxPG_STRING_PASSWORD) are not stored into property's attribute storage
237 (thus they are not readable).
239 Note that this option is global, and applies to all wxPG property
242 wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES
= 0x00400000,
245 With this style Validators on properties will work same as in
248 wxPG_EX_LEGACY_VALIDATORS
= 0x00800000,
250 /** Hides page selection buttons from toolbar.
252 wxPG_EX_HIDE_PAGE_BUTTONS
= 0x01000000
256 /** Combines various styles.
258 #define wxPG_DEFAULT_STYLE (0)
260 /** Combines various styles.
262 #define wxPGMAN_DEFAULT_STYLE (0)
267 // -----------------------------------------------------------------------
270 // Ids for sub-controls
271 // NB: It should not matter what these are.
272 #define wxPG_SUBID1 2
273 #define wxPG_SUBID2 3
274 #define wxPG_SUBID_TEMP1 4
276 // -----------------------------------------------------------------------
278 /** @class wxPGCommonValue
280 wxPropertyGrid stores information about common values in these
283 NB: Common value feature is not complete, and thus not mentioned in
286 class WXDLLIMPEXP_PROPGRID wxPGCommonValue
290 wxPGCommonValue( const wxString
& label
, wxPGCellRenderer
* renderer
)
293 m_renderer
= renderer
;
296 virtual ~wxPGCommonValue()
298 m_renderer
->DecRef();
301 virtual wxString
GetEditableText() const { return m_label
; }
302 const wxString
& GetLabel() const { return m_label
; }
303 wxPGCellRenderer
* GetRenderer() const { return m_renderer
; }
307 wxPGCellRenderer
* m_renderer
;
310 // -----------------------------------------------------------------------
312 /** @section propgrid_vfbflags wxPropertyGrid Validation Failure Behavior Flags
316 enum wxPG_VALIDATION_FAILURE_BEHAVIOR_FLAGS
319 /** Prevents user from leaving property unless value is valid. If this
320 behavior flag is not used, then value change is instead cancelled.
322 wxPG_VFB_STAY_IN_PROPERTY
= 0x01,
324 /** Calls wxBell() on validation failure.
326 wxPG_VFB_BEEP
= 0x02,
328 /** Cell with invalid value will be marked (with red colour).
330 wxPG_VFB_MARK_CELL
= 0x04,
332 /** Display customizable text message explaining the situation.
334 wxPG_VFB_SHOW_MESSAGE
= 0x08,
337 wxPG_VFB_DEFAULT
= wxPG_VFB_STAY_IN_PROPERTY
|wxPG_VFB_BEEP
,
339 /** Only used internally. */
340 wxPG_VFB_UNDEFINED
= 0x80
347 typedef wxByte wxPGVFBFlags
;
352 Used to convey validation information to and from functions that
353 actually perform validation. Mostly used in custom property
356 class wxPGValidationInfo
358 friend class wxPropertyGrid
;
361 @return Returns failure behavior which is a combination of
362 @ref propgrid_vfbflags.
364 wxPGVFBFlags
GetFailureBehavior();
367 Returns current failure message.
369 const wxString
& GetFailureMessage() const
370 { return m_failureMessage
; }
373 Returns reference to pending value.
375 const wxVariant
& GetValue() const
381 /** Set validation failure behavior
383 @param failureBehavior
384 Mixture of @ref propgrid_vfbflags.
386 void SetFailureBehavior(wxPGVFBFlags failureBehavior
)
387 { m_failureBehavior
= failureBehavior
; }
390 Set current failure message.
392 void SetFailureMessage(const wxString
& message
);
395 /** Value to be validated.
399 /** Message displayed on validation failure.
401 wxString m_failureMessage
;
403 /** Validation failure behavior. Use wxPG_VFB_XXX flags.
405 wxPGVFBFlags m_failureBehavior
;
408 // -----------------------------------------------------------------------
410 /** @section propgrid_pgactions wxPropertyGrid Action Identifiers
412 These are used with wxPropertyGrid::AddActionTrigger() and
413 wxPropertyGrid::ClearActionTriggers().
417 enum wxPG_KEYBOARD_ACTIONS
419 wxPG_ACTION_INVALID
= 0,
420 wxPG_ACTION_NEXT_PROPERTY
,
421 wxPG_ACTION_PREV_PROPERTY
,
422 wxPG_ACTION_EXPAND_PROPERTY
,
423 wxPG_ACTION_COLLAPSE_PROPERTY
,
424 wxPG_ACTION_CANCEL_EDIT
,
434 // -----------------------------------------------------------------------
437 // wxPropertyGrid::DoSelectProperty flags (selFlags)
439 // Focuses to created editor
440 #define wxPG_SEL_FOCUS 0x01
441 // Forces deletion and recreation of editor
442 #define wxPG_SEL_FORCE 0x02
443 // For example, doesn't cause EnsureVisible
444 #define wxPG_SEL_NONVISIBLE 0x04
445 // Do not validate editor's value before selecting
446 #define wxPG_SEL_NOVALIDATE 0x08
447 // Property being deselected is about to be deleted
448 #define wxPG_SEL_DELETING 0x10
449 // Property's values was set to unspecified by the user
450 #define wxPG_SEL_SETUNSPEC 0x20
451 // Property's event handler changed the value
452 #define wxPG_SEL_DIALOGVAL 0x40
455 // -----------------------------------------------------------------------
460 #define wxPG_FL_INITIALIZED 0x0001
461 // Set when creating editor controls if it was clicked on.
462 #define wxPG_FL_ACTIVATION_BY_CLICK 0x0002
463 #define wxPG_FL_DONT_CENTER_SPLITTER 0x0004
464 #define wxPG_FL_FOCUSED 0x0008
465 #define wxPG_FL_MOUSE_CAPTURED 0x0010
466 #define wxPG_FL_MOUSE_INSIDE 0x0020
467 #define wxPG_FL_VALUE_MODIFIED 0x0040
468 // don't clear background of m_wndEditor
469 #define wxPG_FL_PRIMARY_FILLS_ENTIRE 0x0080
470 // currently active editor uses custom image
471 #define wxPG_FL_CUR_USES_CUSTOM_IMAGE 0x0100
472 // cell colours override selection colours for selected cell
473 #define wxPG_FL_CELL_OVERRIDES_SEL 0x0200
474 #define wxPG_FL_SCROLLED 0x0400
475 // set when all added/inserted properties get hideable flag
476 #define wxPG_FL_ADDING_HIDEABLES 0x0800
477 // Disables showing help strings on statusbar.
478 #define wxPG_FL_NOSTATUSBARHELP 0x1000
479 // Marks that we created the state, so we have to destroy it too.
480 #define wxPG_FL_CREATEDSTATE 0x2000
481 // Set if scrollbar's existence was detected in last onresize.
482 #define wxPG_FL_SCROLLBAR_DETECTED 0x4000
483 // Set if wxPGMan requires redrawing of description text box.
484 #define wxPG_FL_DESC_REFRESH_REQUIRED 0x8000
485 // Set if contained in wxPropertyGridManager
486 #define wxPG_FL_IN_MANAGER 0x00020000
487 // Set after wxPropertyGrid is shown in its initial good size
488 #define wxPG_FL_GOOD_SIZE_SET 0x00040000
489 // Next navigation key event will get ignored
490 #define wxPG_FL_IGNORE_NEXT_NAVKEY 0x00080000
491 // Set when in SelectProperty.
492 #define wxPG_FL_IN_SELECT_PROPERTY 0x00100000
493 // Set when help string is shown in status bar
494 #define wxPG_FL_STRING_IN_STATUSBAR 0x00200000
495 // Splitter position has been custom-set by the user
496 #define wxPG_FL_SPLITTER_PRE_SET 0x00400000
497 // Validation failed. Clear on modify event.
498 #define wxPG_FL_VALIDATION_FAILED 0x00800000
499 // Set if selected is fully painted (ie. both image and text)
500 //#define wxPG_FL_SELECTED_IS_FULL_PAINT 0x01000000
501 // Set after page has been inserted to manager
502 #define wxPG_MAN_FL_PAGE_INSERTED 0x02000000
503 // Active editor control is abnormally large
504 #define wxPG_FL_ABNORMAL_EDITOR 0x04000000
505 // Recursion guard for OnCustomEditorEvent
506 #define wxPG_FL_IN_ONCUSTOMEDITOREVENT 0x08000000
507 #define wxPG_FL_VALUE_CHANGE_IN_EVENT 0x10000000
508 // Editor control width should not change on resize
509 #define wxPG_FL_FIXED_WIDTH_EDITOR 0x20000000
510 // Width of panel can be different than width of grid
511 #define wxPG_FL_HAS_VIRTUAL_WIDTH 0x40000000
512 // Prevents RecalculateVirtualSize re-entrancy
513 #define wxPG_FL_RECALCULATING_VIRTUAL_SIZE 0x80000000
515 #endif // #ifndef SWIG
517 #if !defined(__wxPG_SOURCE_FILE__) && !defined(SWIG)
518 // Reduce compile time, but still include in user app
519 #include "wx/propgrid/props.h"
522 // -----------------------------------------------------------------------
524 /** @class wxPropertyGrid
526 wxPropertyGrid is a specialized grid for editing properties
527 such as strings, numbers, flagsets, fonts, and colours. wxPropertySheet
528 used to do the very same thing, but it hasn't been updated for a while
529 and it is currently deprecated.
531 Please note that most member functions are inherited and as such not
532 documented on this page. This means you will probably also want to read
533 wxPropertyGridInterface class reference.
535 See also @ref overview_propgrid.
537 @section propgrid_window_styles_ Window Styles
539 See @ref propgrid_window_styles.
541 @section propgrid_event_handling Event Handling
543 To process input from a propertygrid control, use these event handler
544 macros to direct input to member functions that take a wxPropertyGridEvent
547 @beginEventTable{wxPropertyGridEvent}
548 @event{EVT_PG_SELECTED (id, func)}
549 Respond to wxEVT_PG_SELECTED event, generated when property value
550 has been changed by user.
551 @event{EVT_PG_CHANGING(id, func)}
552 Respond to wxEVT_PG_CHANGING event, generated when property value
553 is about to be changed by user. Use wxPropertyGridEvent::GetValue()
554 to take a peek at the pending value, and wxPropertyGridEvent::Veto()
555 to prevent change from taking place, if necessary.
556 @event{EVT_PG_HIGHLIGHTED(id, func)}
557 Respond to wxEVT_PG_HIGHLIGHTED event, which occurs when mouse
558 moves over a property. Event's property is NULL if hovered area does
559 not belong to any property.
560 @event{EVT_PG_RIGHT_CLICK(id, func)}
561 Respond to wxEVT_PG_RIGHT_CLICK event, which occurs when property is
562 clicked on with right mouse button.
563 @event{EVT_PG_DOUBLE_CLICK(id, func)}
564 Respond to wxEVT_PG_DOUBLE_CLICK event, which occurs when property is
565 double-clicked onwith left mouse button.
566 @event{EVT_PG_ITEM_COLLAPSED(id, func)}
567 Respond to wxEVT_PG_ITEM_COLLAPSED event, generated when user collapses
568 a property or category..
569 @event{EVT_PG_ITEM_EXPANDED(id, func)}
570 Respond to wxEVT_PG_ITEM_EXPANDED event, generated when user expands
571 a property or category..
576 - Use Freeze() and Thaw() respectively to disable and enable drawing. This
577 will also delay sorting etc. miscellaneous calculations to the last
583 class WXDLLIMPEXP_PROPGRID
584 wxPropertyGrid
: public wxScrolledWindow
, public wxPropertyGridInterface
586 friend class wxPropertyGridPageState
;
587 friend class wxPropertyGridInterface
;
588 friend class wxPropertyGridManager
;
589 friend class wxPGCanvas
;
592 DECLARE_DYNAMIC_CLASS(wxPropertyGrid
)
597 %pythonAppend wxPropertyGrid
{
598 self
._setOORInfo(self
)
599 self
.DoDefaultTypeMappings()
600 self
.edited_objects
= {}
601 self
.DoDefaultValueTypeMappings()
602 if not hasattr(self
.__class__
,'_vt2setter'):
603 self
.__class__
._vt2setter
= {}
605 %pythonAppend
wxPropertyGrid() ""
607 wxPropertyGrid( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
608 const wxPoint
& pos
= wxDefaultPosition
,
609 const wxSize
& size
= wxDefaultSize
,
610 long style
= wxPG_DEFAULT_STYLE
,
611 const wxChar
* name
= wxPyPropertyGridNameStr
);
612 %RenameCtor
(PrePropertyGrid
, wxPropertyGrid());
616 Two step constructor.
618 Call Create when this constructor is called to build up the
623 /** The default constructor. The styles to be used are styles valid for
624 the wxWindow and wxScrolledWindow.
625 @see @link wndflags Additional Window Styles@endlink
627 wxPropertyGrid( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
628 const wxPoint
& pos
= wxDefaultPosition
,
629 const wxSize
& size
= wxDefaultSize
,
630 long style
= wxPG_DEFAULT_STYLE
,
631 const wxChar
* name
= wxPropertyGridNameStr
);
634 virtual ~wxPropertyGrid();
637 /** Adds given key combination to trigger given action.
639 Which action to trigger. See @link pgactions List of list of
640 wxPropertyGrid actions@endlink.
642 void AddActionTrigger( int action
, int keycode
, int modifiers
= 0 );
645 This static function enables or disables automatic use of
646 wxGetTranslation for following strings: wxEnumProperty list labels,
647 wxFlagsProperty sub-property labels.
651 static void AutoGetTranslation( bool enable
);
654 Changes value of a property, as if from an editor.
656 Use this instead of SetPropertyValue() if you need the value to run
657 through validation process, and also send the property change event.
660 Returns true if value was successfully changed.
662 bool ChangePropertyValue( wxPGPropArg id
, wxVariant newValue
);
665 Centers the splitter.
667 If argument is true, automatic splitter centering is enabled (only
668 applicapple if style wxPG_SPLITTER_AUTO_CENTER was defined).
670 void CenterSplitter( bool enable_auto_centering
= false );
672 /** Deletes all properties.
674 virtual void Clear();
676 /** Clears action triggers for given action.
678 Which action to trigger. See @link pgactions List of list of
679 wxPropertyGrid actions@endlink.
681 void ClearActionTriggers( int action
);
683 /** Forces updating the value of property from the editor control.
685 Note that wxEVT_PG_CHANGING and wxEVT_PG_CHANGED are dispatched using
686 ProcessEvent, meaning your event handlers will be called immediately.
689 Returns true if anything was changed.
691 virtual bool CommitChangesFromEditor( wxUint32 flags
= 0 );
696 Whenever the control is created without any parameters, use Create to
697 actually create it. Don't access the control's public methods before
698 this is called @see @link wndflags Additional Window Styles@endlink
700 bool Create( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
701 const wxPoint
& pos
= wxDefaultPosition
,
702 const wxSize
& size
= wxDefaultSize
,
703 long style
= wxPG_DEFAULT_STYLE
,
704 const wxChar
* name
= wxPropertyGridNameStr
);
707 Call when editor widget's contents is modified.
709 For example, this is called when changes text in wxTextCtrl (used in
710 wxStringProperty and wxIntProperty).
713 This function should only be called by custom properties.
715 @see wxPGProperty::OnEvent()
717 void EditorsValueWasModified() { m_iFlags
|= wxPG_FL_VALUE_MODIFIED
; }
719 /** Reverse of EditorsValueWasModified().
722 This function should only be called by custom properties.
724 void EditorsValueWasNotModified()
726 m_iFlags
&= ~(wxPG_FL_VALUE_MODIFIED
);
730 Enables or disables (shows/hides) categories according to parameter
733 bool EnableCategories( bool enable
);
735 /** Scrolls and/or expands items to ensure that the given item is visible.
736 Returns true if something was actually done.
738 bool EnsureVisible( wxPGPropArg id
);
741 Reduces column sizes to minimum possible that contents are still
742 visibly (naturally some margin space will be applied as well).
745 Minimum size for the grid to still display everything.
748 Does not work well with wxPG_SPLITTER_AUTO_CENTER window style.
750 This function only works properly if grid size prior to call was already
753 Note that you can also get calculated column widths by calling
754 GetState->GetColumnWidth() immediately after this function returns.
758 wxSize sz
= m_pState
->DoFitColumns();
763 Returns wxWindow that the properties are painted on, and which should
764 be used as the parent for editor controls.
766 wxPanel
* GetPanel() const
771 /** Returns current category caption background colour. */
772 wxColour
GetCaptionBackgroundColour() const { return m_colCapBack
; }
774 wxFont
& GetCaptionFont() { return m_captionFont
; }
776 const wxFont
& GetCaptionFont() const { return m_captionFont
; }
778 /** Returns current category caption text colour. */
779 wxColour
GetCaptionForegroundColour() const { return m_colCapFore
; }
781 /** Returns current cell background colour. */
782 wxColour
GetCellBackgroundColour() const { return m_colPropBack
; }
784 /** Returns current cell text colour when disabled. */
785 wxColour
GetCellDisabledTextColour() const { return m_colDisPropFore
; }
787 /** Returns current cell text colour. */
788 wxColour
GetCellTextColour() const { return m_colPropFore
; }
791 Returns number of columns currently on grid.
793 int GetColumnCount() const
795 return m_pState
->m_colWidths
.size();
798 /** Returns colour of empty space below properties. */
799 wxColour
GetEmptySpaceColour() const { return m_colEmptySpace
; }
801 /** Returns height of highest characters of used font. */
802 int GetFontHeight() const { return m_fontHeight
; }
804 /** Returns pointer to itself. Dummy function that enables same kind
805 of code to use wxPropertyGrid and wxPropertyGridManager.
807 wxPropertyGrid
* GetGrid() { return this; }
809 /** Returns rectangle of custom paint image.
811 wxRect
GetImageRect( wxPGProperty
* p
, int item
) const;
813 /** Returns size of the custom paint image in front of property.
814 If no argument is given, returns preferred size.
816 wxSize
GetImageSize( wxPGProperty
* p
= NULL
, int item
= -1 ) const;
819 /** Returns last item which could be iterated using given flags.
821 See @ref propgrid_iterator_flags.
823 wxPGProperty
* GetLastItem( int flags
= wxPG_ITERATE_DEFAULT
)
825 return m_pState
->GetLastItem(flags
);
828 const wxPGProperty
* GetLastItem( int flags
= wxPG_ITERATE_DEFAULT
) const
830 return m_pState
->GetLastItem(flags
);
834 /** Returns colour of lines between cells. */
835 wxColour
GetLineColour() const { return m_colLine
; }
837 /** Returns background colour of margin. */
838 wxColour
GetMarginColour() const { return m_colMargin
; }
840 /** Returns cell background colour of a property. */
841 wxColour
GetPropertyBackgroundColour( wxPGPropArg id
) const;
843 /** Returns cell background colour of a property. */
844 wxColour
GetPropertyTextColour( wxPGPropArg id
) const;
846 /** Returns "root property". It does not have name, etc. and it is not
847 visible. It is only useful for accessing its children.
849 wxPGProperty
* GetRoot() const { return m_pState
->m_properties
; }
851 /** Returns height of a single grid row (in pixels). */
852 int GetRowHeight() const { return m_lineHeight
; }
854 /** Returns currently selected property. */
855 wxPGProperty
* GetSelectedProperty() const { return GetSelection(); }
857 /** Returns currently selected property. */
858 wxPGProperty
* GetSelection() const
863 /** Returns current selection background colour. */
864 wxColour
GetSelectionBackgroundColour() const { return m_colSelBack
; }
866 /** Returns current selection text colour. */
867 wxColour
GetSelectionForegroundColour() const { return m_colSelFore
; }
869 /** Returns current splitter x position. */
870 int GetSplitterPosition() const
871 { return m_pState
->DoGetSplitterPosition(0); }
873 /** Returns wxTextCtrl active in currently selected property, if any. Takes
874 into account wxOwnerDrawnComboBox.
876 wxTextCtrl
* GetEditorTextCtrl() const;
878 wxPGValidationInfo
& GetValidationInfo()
880 return m_validationInfo
;
883 /** Returns current vertical spacing. */
884 int GetVerticalSpacing() const { return (int)m_vspacing
; }
886 /** Returns true if editor's value was marked modified.
888 bool IsEditorsValueModified() const
889 { return ( m_iFlags
& wxPG_FL_VALUE_MODIFIED
) ? true : false; }
891 /** Returns information about arbitrary position in the grid.
893 For wxPropertyGridHitTestResult definition, see
894 wxPropertyGridPageState::HitTest().
896 wxPropertyGridHitTestResult
HitTest( const wxPoint
& pt
) const;
898 /** Returns true if any property has been modified by the user. */
899 bool IsAnyModified() const { return (m_pState
->m_anyModified
>0); }
902 Returns true if updating is frozen (ie Freeze() called but not yet
905 bool IsFrozen() const { return (m_frozen
>0)?true:false; }
907 /** Redraws given property.
909 virtual void RefreshProperty( wxPGProperty
* p
);
912 /** Registers a new editor class.
914 Pointer to the editor class instance that should be used.
916 static wxPGEditor
* RegisterEditorClass( wxPGEditor
* editor
,
917 bool noDefCheck
= false );
920 /** Resets all colours to the original system values.
926 Editor widget is automatically created, but not focused unless focus is
927 true. This will generate wxEVT_PG_SELECT event.
931 True if selection finished successfully. Usually only fails if
932 current value in editor is not valid.
933 @see wxPropertyGrid::Unselect
935 bool SelectProperty( wxPGPropArg id
, bool focus
= false )
937 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
938 return DoSelectProperty(p
,focus
?wxPG_SEL_FOCUS
:0);
941 /** Changes keyboard shortcut to push the editor button.
943 You can set default with keycode 0. Good value for the platform is
944 guessed, but don't expect it to be very accurate.
946 void SetButtonShortcut( int keycode
,
947 bool ctrlDown
= false,
948 bool altDown
= false );
950 /** Sets category caption background colour. */
951 void SetCaptionBackgroundColour(const wxColour
& col
);
953 /** Sets category caption text colour. */
954 void SetCaptionTextColour(const wxColour
& col
);
956 /** Sets default cell background colour - applies to property cells.
957 Note that appearance of editor widgets may not be affected.
959 void SetCellBackgroundColour(const wxColour
& col
);
961 /** Sets cell text colour for disabled properties.
963 void SetCellDisabledTextColour(const wxColour
& col
);
965 /** Sets default cell text colour - applies to property name and value text.
966 Note that appearance of editor widgets may not be affected.
968 void SetCellTextColour(const wxColour
& col
);
970 /** Set number of columns (2 or more).
972 void SetColumnCount( int colCount
)
974 m_pState
->SetColumnCount(colCount
);
979 Sets the 'current' category - Append will add non-category properties
982 void SetCurrentCategory( wxPGPropArg id
)
984 wxPG_PROP_ARG_CALL_PROLOG()
985 wxPropertyCategory
* pc
= wxDynamicCast(p
, wxPropertyCategory
);
987 m_pState
->m_currentCategory
= pc
;
990 /** Sets colour of empty space below properties. */
991 void SetEmptySpaceColour(const wxColour
& col
);
993 /** Sets colour of lines between cells. */
994 void SetLineColour(const wxColour
& col
);
996 /** Sets background colour of margin. */
997 void SetMarginColour(const wxColour
& col
);
999 /** Sets background colour of property and all its children. Colours of
1000 captions are not affected. Background brush cache is optimized for often
1001 set colours to be set last.
1003 void SetPropertyBackgroundColour( wxPGPropArg id
, const wxColour
& col
);
1005 /** Resets text and background colours of given property.
1007 void SetPropertyColoursToDefault( wxPGPropArg id
);
1009 /** Sets text colour of property and all its children.
1011 void SetPropertyTextColour( wxPGPropArg id
,
1012 const wxColour
& col
,
1013 bool recursively
= true );
1016 Sets selection background colour - applies to selected property name
1019 void SetSelectionBackgroundColour(const wxColour
& col
);
1022 Sets selection foreground colour - applies to selected property name
1025 void SetSelectionTextColour(const wxColour
& col
);
1027 /** Sets x coordinate of the splitter.
1029 Splitter position cannot exceed grid size, and therefore setting it
1030 during form creation may fail as initial grid size is often smaller
1031 than desired splitter position, especially when sizers are being used.
1033 void SetSplitterPosition( int newxpos
, int col
= 0 )
1035 DoSetSplitterPosition_(newxpos
, true, col
);
1036 m_iFlags
|= wxPG_FL_SPLITTER_PRE_SET
;
1039 /** Set virtual width for this particular page. Width -1 indicates that the
1040 virtual width should be disabled. */
1041 void SetVirtualWidth( int width
);
1043 /** Sets name of a property.
1045 Name or pointer of property which name to change.
1049 void SetPropertyName( wxPGPropArg id
, const wxString
& newname
)
1051 wxPG_PROP_ARG_CALL_PROLOG()
1052 DoSetPropertyName( p
, newname
);
1056 Moves splitter as left as possible, while still allowing all
1057 labels to be shown in full.
1059 @param privateChildrenToo
1060 If @false, will still allow private children to be cropped.
1062 void SetSplitterLeft( bool privateChildrenToo
= false )
1064 m_pState
->SetSplitterLeft(privateChildrenToo
);
1067 /** Sets vertical spacing. Can be 1, 2, or 3 - a value relative to font
1068 height. Value of 2 should be default on most platforms.
1070 void SetVerticalSpacing( int vspacing
)
1072 m_vspacing
= (unsigned char)vspacing
;
1073 CalculateFontAndBitmapStuff( vspacing
);
1074 if ( !m_pState
->m_itemsAdded
) Refresh();
1077 /** Shows an brief error message that is related to a property. */
1078 void ShowPropertyError( wxPGPropArg id
, const wxString
& msg
)
1080 wxPG_PROP_ARG_CALL_PROLOG()
1081 DoShowPropertyError(p
, msg
);
1084 /** Sorts all items at all levels (except sub-properties). */
1087 /** Sorts children of a category.
1089 void SortChildren( wxPGPropArg id
);
1091 /////////////////////////////////////////////////////////////////
1093 // Following methods do not need to be (currently) documented
1095 /////////////////////////////////////////////////////////////////
1097 bool HasVirtualWidth() const
1098 { return (m_iFlags
& wxPG_FL_HAS_VIRTUAL_WIDTH
) ? true : false; }
1100 const wxPGCommonValue
* GetCommonValue( unsigned int i
) const
1102 return (wxPGCommonValue
*) m_commonValues
[i
];
1105 /** Returns number of common values.
1107 unsigned int GetCommonValueCount() const
1109 return m_commonValues
.size();
1112 /** Returns label of given common value.
1114 wxString
GetCommonValueLabel( unsigned int i
) const
1116 wxASSERT( GetCommonValue(i
) );
1117 return GetCommonValue(i
)->GetLabel();
1121 Returns index of common value that will truly change value to
1124 int GetUnspecifiedCommonValue() const { return m_cvUnspecified
; }
1126 /** Set index of common value that will truly change value to unspecified.
1127 Using -1 will set none to have such effect.
1130 void SetUnspecifiedCommonValue( int index
) { m_cvUnspecified
= index
; }
1133 Shortcut for creating dialog-caller button. Used, for example, by
1136 This should only be called by properties.
1138 wxWindow
* GenerateEditorButton( const wxPoint
& pos
, const wxSize
& sz
);
1140 /** Fixes position of wxTextCtrl-like control (wxSpinCtrl usually
1141 fits as one). Call after control has been created (but before
1144 void FixPosForTextCtrl( wxWindow
* ctrl
,
1145 const wxPoint
& offset
= wxPoint(0, 0) );
1147 /** Shortcut for creating text editor widget.
1149 Same as pos given for CreateEditor.
1151 Same as sz given for CreateEditor.
1153 Initial text for wxTextCtrl.
1155 If right-side control, such as button, also created, then create it
1156 first and pass it as this parameter.
1158 Extra style flags to pass for wxTextCtrl.
1160 Note that this should generally be called only by new classes derived
1163 wxWindow
* GenerateEditorTextCtrl( const wxPoint
& pos
,
1165 const wxString
& value
,
1166 wxWindow
* secondary
,
1170 /* Generates both textctrl and button.
1172 wxWindow
* GenerateEditorTextCtrlAndButton( const wxPoint
& pos
,
1173 const wxSize
& sz
, wxWindow
** psecondary
, int limited_editing
,
1174 wxPGProperty
* property
);
1176 /** Generates position for a widget editor dialog box.
1178 Property for which dialog is positioned.
1180 Known or over-approximated size of the dialog.
1182 Position for dialog.
1184 wxPoint
GetGoodEditorDialogPosition( wxPGProperty
* p
,
1187 // Converts escape sequences in src_str to newlines,
1188 // tabs, etc. and copies result to dst_str.
1189 static wxString
& ExpandEscapeSequences( wxString
& dst_str
,
1190 wxString
& src_str
);
1192 // Converts newlines, tabs, etc. in src_str to escape
1193 // sequences, and copies result to dst_str.
1194 static wxString
& CreateEscapeSequences( wxString
& dst_str
,
1195 wxString
& src_str
);
1198 Returns rectangle that fully contains properties between and including
1201 wxRect
GetPropertyRect( const wxPGProperty
* p1
,
1202 const wxPGProperty
* p2
) const;
1204 /** Returns pointer to current active primary editor control (NULL if none).
1206 If editor uses clipper window, pointer is returned to the actual
1207 editor, not the clipper.
1209 wxWindow
* GetEditorControl() const;
1211 /** Adjusts given position if topCtrlWnd is child of clipper window.
1213 bool AdjustPosForClipperWindow( wxWindow
* topCtrlWnd
, int* x
, int* y
);
1215 wxWindow
* GetPrimaryEditor() const
1217 return GetEditorControl();
1221 Returns pointer to current active secondary editor control (NULL if
1224 wxWindow
* GetEditorControlSecondary() const
1226 return m_wndEditor2
;
1232 Generates contents for string dst based on the contents of
1235 Format will be "(preDelim)str1(postDelim) (preDelim)str2(postDelim) and
1236 so on. Set flags to 1 inorder to convert backslashes to double-back-
1237 slashes and "(preDelims)"'s to "(preDelims)".
1239 static void ArrayStringToString( wxString
& dst
, const wxArrayString
& src
,
1240 wxChar preDelim
, wxChar postDelim
,
1243 // Mostly useful for page switching.
1244 void SwitchState( wxPropertyGridPageState
* pNewState
);
1246 /** Pass this function to Connect calls in propertyclass::CreateEditor.
1248 void OnCustomEditorEvent( wxCommandEvent
&event
);
1250 long GetInternalFlags() const { return m_iFlags
; }
1251 void SetInternalFlag( long flag
) { m_iFlags
|= flag
; }
1252 void ClearInternalFlag( long flag
) { m_iFlags
&= ~(flag
); }
1253 void IncFrozen() { m_frozen
++; }
1254 void DecFrozen() { m_frozen
--; }
1256 void OnComboItemPaint( wxPGCustomComboControl
* pCb
,int item
,wxDC
& dc
,
1257 wxRect
& rect
,int flags
);
1259 // Used by simple check box for keyboard navigation
1260 void SendNavigationKeyEvent( int dir
);
1262 /** Standardized double-to-string conversion.
1264 static void DoubleToString( wxString
& target
,
1268 wxString
* precTemplate
);
1271 Call this from wxPGProperty::OnEvent() to cause property value to be
1272 changed after the function returns (with true as return value).
1273 ValueChangeInEvent() must be used if you wish the application to be
1274 able to use wxEVT_PG_CHANGING to potentially veto the given value.
1276 void ValueChangeInEvent( wxVariant variant
)
1278 m_changeInEventValue
= variant
;
1279 m_iFlags
|= wxPG_FL_VALUE_CHANGE_IN_EVENT
;
1282 /** Returns true if given event is from first of an array of buttons
1283 (as can be in case when wxPGMultiButton is used).
1285 bool IsMainButtonEvent( const wxEvent
& event
)
1287 return (event
.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED
)
1288 && (m_wndSecId
== event
.GetId());
1291 /** Pending value is expected to be passed in PerformValidation().
1293 virtual bool DoPropertyChanged( wxPGProperty
* p
,
1294 unsigned int selFlags
= 0 );
1297 Runs all validation functionality (includes sending wxEVT_PG_CHANGING).
1298 Returns true if all tests passed.
1300 virtual bool PerformValidation( wxPGProperty
* p
, wxVariant
& pendingValue
);
1302 /** Called when validation for given property fails.
1304 Value which failed in validation.
1306 Return true if user is allowed to change to another property even
1307 if current has invalid value.
1309 To add your own validation failure behavior, override
1310 wxPropertyGrid::DoOnValidationFailure().
1312 bool OnValidationFailure( wxPGProperty
* property
, wxVariant
& invalidValue
)
1314 bool res
= DoOnValidationFailure(property
, invalidValue
);
1315 property
->SetFlag(wxPG_PROP_INVALID_VALUE
);
1319 /** Called to indicate property and editor has valid value now.
1321 void OnValidationFailureReset( wxPGProperty
* property
)
1323 if ( property
&& property
->HasFlag(wxPG_PROP_INVALID_VALUE
) )
1325 DoOnValidationFailureReset(property
);
1326 property
->ClearFlag(wxPG_PROP_INVALID_VALUE
);
1328 m_validationInfo
.m_failureMessage
.clear();
1331 /** Override in derived class to display error messages in custom manner
1332 (these message usually only result from validation failure).
1334 virtual void DoShowPropertyError( wxPGProperty
* property
,
1335 const wxString
& msg
);
1337 /** Override to customize property validation failure behavior.
1339 Value which failed in validation.
1341 Return true if user is allowed to change to another property even
1342 if current has invalid value.
1344 virtual bool DoOnValidationFailure( wxPGProperty
* property
,
1345 wxVariant
& invalidValue
);
1347 /** Override to customize resetting of property validation failure status.
1349 Property is guaranteed to have flag wxPG_PROP_INVALID_VALUE set.
1351 virtual void DoOnValidationFailureReset( wxPGProperty
* property
);
1353 int GetSpacingY() const { return m_spacingy
; }
1356 Must be called in wxPGEditor::CreateControls() if primary editor window
1357 is wxTextCtrl, just before textctrl is created.
1359 Initial text value of created wxTextCtrl.
1361 void SetupTextCtrlValue( const wxString text
) { m_prevTcValue
= text
; }
1364 Unfocuses or closes editor if one was open, but does not deselect
1367 bool UnfocusEditor();
1372 wxPropertyGridPageState used by the grid is created here.
1374 If grid is used in wxPropertyGridManager, there is no point overriding
1375 this - instead, set custom wxPropertyGridPage classes.
1377 virtual wxPropertyGridPageState
* CreateState() const;
1382 // Control font changer helper.
1383 void SetCurControlBoldFont();
1386 // Public methods for semi-public use
1387 // (not protected for optimization)
1389 bool DoSelectProperty( wxPGProperty
* p
, unsigned int flags
= 0 );
1391 // Overridden functions.
1392 virtual bool Destroy();
1393 virtual wxSize
DoGetBestSize() const;
1394 // Returns property at given y coordinate (relative to grid's top left).
1395 wxPGProperty
* GetItemAtY( int y
) const { return DoGetItemAtY(y
); }
1397 virtual void Refresh( bool eraseBackground
= true,
1398 const wxRect
*rect
= (const wxRect
*) NULL
);
1399 virtual bool SetFont( const wxFont
& font
);
1400 #if wxPG_SUPPORT_TOOLTIPS
1401 void SetToolTip( const wxString
& tipString
);
1403 virtual void Freeze();
1404 virtual void SetExtraStyle( long exStyle
);
1405 virtual void Thaw();
1410 #ifndef wxPG_ICON_WIDTH
1411 wxBitmap
*m_expandbmp
, *m_collbmp
;
1414 wxCursor
*m_cursorSizeWE
;
1416 /** wxWindow pointers to editor control(s). */
1417 wxWindow
*m_wndEditor
;
1418 wxWindow
*m_wndEditor2
;
1420 /** wxPGCanvas instance. */
1423 #if wxPG_DOUBLE_BUFFER
1424 wxBitmap
*m_doubleBuffer
;
1427 wxArrayPtrVoid
*m_windowsToDelete
;
1429 /** Local time ms when control was created. */
1430 wxLongLong m_timeCreated
;
1432 /** wxPGProperty::OnEvent can change value by setting this. */
1433 wxVariant m_changeInEventValue
;
1435 /** Id of m_wndEditor2, or its first child, if any. */
1438 /** Extra Y spacing between the items. */
1441 /** Control client area width; updated on resize. */
1444 /** Control client area height; updated on resize. */
1447 /** Current non-client width (needed when auto-centering). */
1450 /** Non-client width (auto-centering helper). */
1453 /** Previously recorded scroll start position. */
1457 The gutter spacing in front and back of the image.
1458 This determines the amount of spacing in front of each item
1462 /** Includes separator line. */
1465 /** Gutter*2 + image width. */
1468 // y spacing for expand/collapse button.
1469 int m_buttonSpacingY
;
1471 /** Extra margin for expanded sub-group items. */
1472 int m_subgroup_extramargin
;
1475 The image width of the [+] icon.
1477 This is also calculated in the gutter
1481 #ifndef wxPG_ICON_WIDTH
1484 The image height of the [+] icon.
1486 This is calculated as minimal size and to align
1491 /** Current cursor id. */
1495 This captionFont is made equal to the font of the wxScrolledWindow.
1497 As extra the bold face is set on it when this is wanted by the user
1500 wxFont m_captionFont
;
1502 int m_fontHeight
; // Height of the font.
1504 // Base keycode for triggering push button.
1505 int m_pushButKeyCode
;
1507 /** m_splitterx when drag began. */
1508 int m_startingSplitterX
;
1511 Index to splitter currently being dragged (0=one after the first
1514 int m_draggedSplitter
;
1516 /** Changed property, calculated in PerformValidation(). */
1517 wxPGProperty
* m_chgInfo_changedProperty
;
1520 Lowest property for which editing happened, but which does not have
1523 wxPGProperty
* m_chgInfo_baseChangedProperty
;
1525 /** Changed property value, calculated in PerformValidation(). */
1526 wxVariant m_chgInfo_pendingValue
;
1528 /** Passed to SetValue. */
1529 wxVariant m_chgInfo_valueList
;
1531 /** Validation information. */
1532 wxPGValidationInfo m_validationInfo
;
1534 /** Actions and keys that trigger them. */
1535 wxPGHashMapI2I m_actionTriggers
;
1541 /** Bits are used to indicate which colours are customized. */
1542 unsigned short m_coloursCustomized
;
1544 /** x - m_splitterx. */
1545 signed char m_dragOffset
;
1547 /** 0 = not dragging, 1 = drag just started, 2 = drag in progress */
1548 unsigned char m_dragStatus
;
1550 /** 0 = margin, 1 = label, 2 = value. */
1551 unsigned char m_mouseSide
;
1553 /** True when editor control is focused. */
1554 unsigned char m_editorFocused
;
1556 /** 1 if m_latsCaption is also the bottommost caption. */
1557 //unsigned char m_lastCaptionBottomnest;
1559 /** Set to 1 when graphics frozen. */
1560 unsigned char m_frozen
;
1562 unsigned char m_vspacing
;
1564 // Does triggering push button need Alt down?
1565 unsigned char m_pushButKeyCodeNeedsAlt
;
1567 // Does triggering push button need Ctrl down?
1568 unsigned char m_pushButKeyCodeNeedsCtrl
;
1570 // Used to track when Alt/Ctrl+Key was consumed.
1571 unsigned char m_keyComboConsumed
;
1573 /** 1 if in DoPropertyChanged() */
1574 unsigned char m_inDoPropertyChanged
;
1576 /** 1 if in CommitChangesFromEditor() */
1577 unsigned char m_inCommitChangesFromEditor
;
1579 /** 1 if in DoSelectProperty() */
1580 unsigned char m_inDoSelectProperty
;
1582 wxPGVFBFlags m_permanentValidationFailureBehavior
; // Set by app
1584 /** Internal flags - see wxPG_FL_XXX constants. */
1587 /** When drawing next time, clear this many item slots at the end. */
1588 int m_clearThisMany
;
1590 /** Pointer to selected property. Note that this is duplicated in
1591 m_state for better transiency between pages so that the selected
1592 item can be retained.
1594 wxPGProperty
* m_selected
;
1596 // pointer to property that has mouse hovering
1597 wxPGProperty
* m_propHover
;
1599 // EventObject for wxPropertyGridEvents
1600 wxWindow
* m_eventObject
;
1602 // What (global) window is currently focused (needed to resolve event
1604 wxWindow
* m_curFocused
;
1607 wxEvtHandler
* m_tlwHandler
;
1612 // y coordinate of property that mouse hovering
1614 // Which column's editor is selected (usually 1)?
1617 // x relative to splitter (needed for resize).
1620 // lines between cells
1622 // property labels and values are written in this colour
1623 wxColour m_colPropFore
;
1624 // or with this colour when disabled
1625 wxColour m_colDisPropFore
;
1626 // background for m_colPropFore
1627 wxColour m_colPropBack
;
1628 // text color for captions
1629 wxColour m_colCapFore
;
1630 // background color for captions
1631 wxColour m_colCapBack
;
1632 // foreground for selected property
1633 wxColour m_colSelFore
;
1634 // background for selected property (actually use background color when
1635 // control out-of-focus)
1636 wxColour m_colSelBack
;
1637 // background colour for margin
1638 wxColour m_colMargin
;
1639 // background colour for empty space below the grid
1640 wxColour m_colEmptySpace
;
1642 // NB: These *cannot* be moved to globals.
1644 // Array of background colour brushes.
1645 wxArrayPtrVoid m_arrBgBrushes
;
1646 // Array of foreground colours.
1647 wxArrayPtrVoid m_arrFgCols
;
1649 // labels when properties use common values
1650 wxArrayPtrVoid m_commonValues
;
1651 // Which cv selection really sets value to unspecified?
1652 int m_cvUnspecified
;
1654 // Used to skip excess text editor events
1655 wxString m_prevTcValue
;
1659 // Sets some members to defaults (called constructors).
1662 // Initializes some members (called by Create and complex constructor).
1665 void OnPaint(wxPaintEvent
&event
);
1667 // main event receivers
1668 void OnMouseMove( wxMouseEvent
&event
);
1669 void OnMouseMoveBottom( wxMouseEvent
&event
);
1670 void OnMouseClick( wxMouseEvent
&event
);
1671 void OnMouseRightClick( wxMouseEvent
&event
);
1672 void OnMouseDoubleClick( wxMouseEvent
&event
);
1673 void OnMouseUp( wxMouseEvent
&event
);
1674 void OnKey( wxKeyEvent
&event
);
1675 void OnKeyUp( wxKeyEvent
&event
);
1676 void OnNavigationKey( wxNavigationKeyEvent
& event
);
1677 void OnResize( wxSizeEvent
&event
);
1680 bool HandleMouseMove( int x
, unsigned int y
, wxMouseEvent
&event
);
1681 bool HandleMouseClick( int x
, unsigned int y
, wxMouseEvent
&event
);
1682 bool HandleMouseRightClick( int x
, unsigned int y
, wxMouseEvent
&event
);
1683 bool HandleMouseDoubleClick( int x
, unsigned int y
, wxMouseEvent
&event
);
1684 bool HandleMouseUp( int x
, unsigned int y
, wxMouseEvent
&event
);
1685 void HandleKeyEvent( wxKeyEvent
&event
);
1686 // Handle TAB and ESCAPE in control
1687 bool HandleChildKey( wxKeyEvent
& event
);
1689 void OnMouseEntry( wxMouseEvent
&event
);
1691 void OnIdle( wxIdleEvent
&event
);
1692 void OnFocusEvent( wxFocusEvent
&event
);
1693 void OnChildFocusEvent( wxChildFocusEvent
& event
);
1695 bool OnMouseCommon( wxMouseEvent
&event
, int* px
, int *py
);
1696 bool OnMouseChildCommon( wxMouseEvent
&event
, int* px
, int *py
);
1698 // sub-control event handlers
1699 void OnMouseClickChild( wxMouseEvent
&event
);
1700 void OnMouseRightClickChild( wxMouseEvent
&event
);
1701 void OnMouseMoveChild( wxMouseEvent
&event
);
1702 void OnMouseUpChild( wxMouseEvent
&event
);
1703 void OnChildKeyDown( wxKeyEvent
&event
);
1704 void OnChildKeyUp( wxKeyEvent
&event
);
1706 void OnCaptureChange( wxMouseCaptureChangedEvent
&event
);
1708 void OnScrollEvent( wxScrollWinEvent
&event
);
1710 void OnSysColourChanged( wxSysColourChangedEvent
&event
);
1715 Adjust the centering of the bitmap icons (collapse / expand) when the
1716 caption font changes.
1718 They need to be centered in the middle of the font, so a bit of deltaY
1719 adjustment is needed. On entry, m_captionFont must be set to window
1720 font. It will be modified properly.
1722 void CalculateFontAndBitmapStuff( int vspacing
);
1724 wxRect
GetEditorWidgetRect( wxPGProperty
* p
, int column
) const;
1726 void CorrectEditorWidgetSizeX();
1728 /** Called in RecalculateVirtualSize() to reposition control
1729 on virtual height changes.
1731 void CorrectEditorWidgetPosY();
1735 void OnScreenNote( const wxChar
* format
, ... );
1738 /** Deselect current selection, if any. Returns true if success
1739 (ie. validator did not intercept). */
1740 bool DoClearSelection();
1742 int DoDrawItems( wxDC
& dc
,
1743 const wxPGProperty
* first_item
,
1744 const wxPGProperty
* last_item
,
1745 const wxRect
* clip_rect
,
1746 bool isBuffered
) const;
1748 void DoSetPropertyValueUnspecified( wxPGProperty
* p
);
1750 /** Draws an expand/collapse (ie. +/-) button.
1752 virtual void DrawExpanderButton( wxDC
& dc
, const wxRect
& rect
,
1753 wxPGProperty
* property
) const;
1755 /** Draws items from topitemy to bottomitemy */
1756 void DrawItems( wxDC
& dc
, unsigned int topitemy
, unsigned int bottomitemy
,
1757 const wxRect
* clip_rect
= (const wxRect
*) NULL
);
1759 void DrawItems( const wxPGProperty
* p1
, const wxPGProperty
* p2
);
1761 void DrawItem( wxPGProperty
* p
)
1766 virtual void DrawItemAndChildren( wxPGProperty
* p
);
1769 Draws item, children, and consequtive parents as long as category is
1772 void DrawItemAndValueRelated( wxPGProperty
* p
);
1774 // Translate wxKeyEvent to wxPG_ACTION_XXX
1775 int KeyEventToActions(wxKeyEvent
&event
, int* pSecond
) const;
1777 int KeyEventToAction(wxKeyEvent
&event
) const
1779 return KeyEventToActions(event
, NULL
);
1782 void ImprovedClientToScreen( int* px
, int* py
);
1784 // Called by focus event handlers. newFocused is the window that becomes
1786 void HandleFocusChange( wxWindow
* newFocused
);
1788 /** Reloads all non-customized colours from system settings. */
1789 void RegainColours();
1791 bool DoEditorValidate();
1793 wxPGProperty
* DoGetItemAtY( int y
) const;
1795 void DoSetSplitterPosition_( int newxpos
,
1796 bool refresh
= true,
1797 int splitterIndex
= 0,
1798 bool allPages
= false );
1802 virtual bool DoExpand( wxPGProperty
* p
, bool sendEvent
= false );
1804 virtual bool DoCollapse( wxPGProperty
* p
, bool sendEvent
= false );
1806 // Returns nearest paint visible property (such that will be painted unless
1807 // window is scrolled or resized). If given property is paint visible, then
1808 // it itself will be returned.
1809 wxPGProperty
* GetNearestPaintVisible( wxPGProperty
* p
) const;
1811 static void RegisterDefaultEditors();
1813 // Sets m_bgColIndex to this property and all its children.
1814 void SetBackgroundColourIndex( wxPGProperty
* p
, int index
);
1816 // Sets m_fgColIndex to this property and all its children.
1817 void SetTextColourIndex( wxPGProperty
* p
, int index
, int flags
);
1819 int CacheColour( const wxColour
& colour
);
1821 void DoSetPropertyName( wxPGProperty
* p
, const wxString
& newname
);
1823 // Sets up basic event handling for child control
1824 void SetupChildEventHandling( wxWindow
* wnd
, int id
);
1826 void CustomSetCursor( int type
, bool override
= false );
1828 virtual bool ProcessEvent(wxEvent
& event
);
1829 virtual void SetWindowStyleFlag( long style
);
1832 Repositions scrollbar and underlying panel according to changed virtual
1835 void RecalculateVirtualSize( int forceXPos
= -1 );
1837 void PrepareAfterItemsAdded();
1839 bool SendEvent( int eventType
,
1841 wxVariant
* pValue
= NULL
,
1842 unsigned int selFlags
= 0 );
1844 void SetFocusOnCanvas()
1846 m_canvas
->SetFocusIgnoringChildren();
1847 m_editorFocused
= 0;
1850 bool DoHideProperty( wxPGProperty
* p
, bool hide
, int flags
);
1854 bool ButtonTriggerKeyTest( wxKeyEvent
&event
);
1856 #endif // DOXYGEN_SHOULD_SKIP_THIS
1859 DECLARE_EVENT_TABLE()
1860 #endif // #ifndef SWIG
1863 // -----------------------------------------------------------------------
1865 // Bunch of inlines that need to resolved after all classes have been defined.
1869 inline bool wxPropertyGridPageState::IsDisplayed() const
1871 return ( this == m_pPropGrid
->GetState() );
1874 inline unsigned int wxPropertyGridPageState::GetActualVirtualHeight() const
1876 return DoGetRoot()->GetChildrenHeight(GetGrid()->GetRowHeight());
1880 inline int wxPGProperty::GetDisplayedCommonValueCount() const
1882 if ( HasFlag(wxPG_PROP_USES_COMMON_VALUE
) )
1884 wxPropertyGrid
* pg
= GetGrid();
1886 return pg
->GetCommonValueCount();
1891 inline void wxPGProperty::SetEditor( const wxString
& editorName
)
1893 m_customEditor
= wxPropertyGridInterface::GetEditorByName(editorName
);
1896 inline void wxPGProperty::SetName( const wxString
& newName
)
1898 GetGrid()->SetPropertyName(this, newName
);
1901 inline bool wxPGProperty::Hide( bool hide
, int flags
)
1903 return GetGrid()->HideProperty(this, hide
, flags
);
1906 inline bool wxPGProperty::SetMaxLength( int maxLen
)
1908 return GetGrid()->SetPropertyMaxLength(this,maxLen
);
1911 // -----------------------------------------------------------------------
1916 #define wxPG_BASE_EVT_PRE_ID 1775
1918 BEGIN_DECLARE_EVENT_TYPES()
1919 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_SELECTED
, wxPG_BASE_EVT_PRE_ID
)
1920 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_CHANGING
, wxPG_BASE_EVT_PRE_ID
+1)
1921 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_CHANGED
, wxPG_BASE_EVT_PRE_ID
+2)
1922 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_HIGHLIGHTED
, wxPG_BASE_EVT_PRE_ID
+3)
1923 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_RIGHT_CLICK
, wxPG_BASE_EVT_PRE_ID
+4)
1924 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_PAGE_CHANGED
, wxPG_BASE_EVT_PRE_ID
+5)
1925 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_ITEM_COLLAPSED
, wxPG_BASE_EVT_PRE_ID
+6)
1926 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_ITEM_EXPANDED
, wxPG_BASE_EVT_PRE_ID
+7)
1927 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_DOUBLE_CLICK
, wxPG_BASE_EVT_PRE_ID
+8)
1928 END_DECLARE_EVENT_TYPES()
1931 wxEVT_PG_SELECTED
= wxPG_BASE_EVT_PRE_ID
,
1934 wxEVT_PG_HIGHLIGHTED
,
1935 wxEVT_PG_RIGHT_CLICK
,
1936 wxEVT_PG_PAGE_CHANGED
,
1937 wxEVT_PG_ITEM_COLLAPSED
,
1938 wxEVT_PG_ITEM_EXPANDED
,
1939 wxEVT_PG_DOUBLE_CLICK
1944 #define wxPG_BASE_EVT_TYPE wxEVT_PG_SELECTED
1945 #define wxPG_MAX_EVT_TYPE (wxPG_BASE_EVT_TYPE+30)
1949 typedef void (wxEvtHandler::*wxPropertyGridEventFunction
)(wxPropertyGridEvent
&);
1951 #define EVT_PG_SELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1952 #define EVT_PG_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1953 #define EVT_PG_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1954 #define EVT_PG_HIGHLIGHTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_HIGHLIGHTED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1955 #define EVT_PG_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1956 #define EVT_PG_DOUBLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_DOUBLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1957 #define EVT_PG_PAGE_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_PAGE_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1958 #define EVT_PG_ITEM_COLLAPSED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1959 #define EVT_PG_ITEM_EXPANDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1961 #define wxPropertyGridEventHandler(A) \
1962 ((wxObjectEventFunction)(wxEventFunction)(wxPropertyGridEventFunction)&A)
1967 /** @class wxPropertyGridEvent
1969 A propertygrid event holds information about events associated with
1970 wxPropertyGrid objects.
1972 @library{wxpropgrid}
1975 class WXDLLIMPEXP_PROPGRID wxPropertyGridEvent
: public wxCommandEvent
1980 wxPropertyGridEvent(wxEventType commandType
=0, int id
=0);
1982 /** Copy constructor. */
1983 wxPropertyGridEvent(const wxPropertyGridEvent
& event
);
1986 ~wxPropertyGridEvent();
1989 virtual wxEvent
* Clone() const;
1991 wxPGProperty
* GetMainParent() const
1993 wxASSERT(m_property
);
1994 return m_property
->GetMainParent();
1997 /** Returns id of associated property. */
1998 wxPGProperty
* GetProperty() const
2003 wxPGValidationInfo
& GetValidationInfo()
2005 wxASSERT(m_validationInfo
);
2006 return *m_validationInfo
;
2009 /** Returns true if you can veto the action that the event is signaling.
2011 bool CanVeto() const { return m_canVeto
; }
2014 Call this from your event handler to veto action that the event is
2017 You can only veto a shutdown if wxPropertyGridEvent::CanVeto returns
2020 Currently only wxEVT_PG_CHANGING supports vetoing.
2022 void Veto( bool veto
= true ) { m_wasVetoed
= veto
; }
2024 /** Returns value that is about to be set for wxEVT_PG_CHANGING.
2026 const wxVariant
& GetValue() const
2028 wxASSERT_MSG( m_validationInfo
,
2029 "Only call GetValue from a handler "
2030 "of event type that supports it" );
2031 return m_validationInfo
->GetValue();
2035 Set override validation failure behavior.
2037 Only effective if Veto was also called, and only allowed if event type
2038 is wxEVT_PG_CHANGING.
2040 void SetValidationFailureBehavior( wxPGVFBFlags flags
)
2042 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2043 m_validationInfo
->SetFailureBehavior( flags
);
2046 /** Sets custom failure message for this time only. Only applies if
2047 wxPG_VFB_SHOW_MESSAGE is set in validation failure flags.
2049 void SetValidationFailureMessage( const wxString
& message
)
2051 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2052 m_validationInfo
->SetFailureMessage( message
);
2056 wxPGVFBFlags
GetValidationFailureBehavior() const
2058 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2059 return m_validationInfo
->GetFailureBehavior();
2062 void SetCanVeto( bool canVeto
) { m_canVeto
= canVeto
; }
2063 bool WasVetoed() const { return m_wasVetoed
; }
2065 /** Changes the associated property. */
2066 void SetProperty( wxPGProperty
* p
) { m_property
= p
; }
2068 void SetPropertyGrid( wxPropertyGrid
* pg
) { m_pg
= pg
; }
2070 void SetupValidationInfo()
2073 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2074 m_validationInfo
= &m_pg
->GetValidationInfo();
2079 DECLARE_DYNAMIC_CLASS(wxPropertyGridEvent
)
2081 wxPGProperty
* m_property
;
2082 wxPropertyGrid
* m_pg
;
2083 wxPGValidationInfo
* m_validationInfo
;
2092 // -----------------------------------------------------------------------
2094 /** @class wxPropertyGridPopulator
2096 Allows populating wxPropertyGrid from arbitrary text source.
2098 class WXDLLIMPEXP_PROPGRID wxPropertyGridPopulator
2101 /** Default constructor.
2103 wxPropertyGridPopulator();
2106 virtual ~wxPropertyGridPopulator();
2108 void SetState( wxPropertyGridPageState
* state
);
2110 void SetGrid( wxPropertyGrid
* pg
);
2112 /** Appends a new property under bottommost parent.
2114 Property class as string.
2116 wxPGProperty
* Add( const wxString
& propClass
,
2117 const wxString
& propLabel
,
2118 const wxString
& propName
,
2119 const wxString
* propValue
,
2120 wxPGChoices
* pChoices
= NULL
);
2123 Pushes property to the back of parent array (ie it becomes bottommost
2124 parent), and starts scanning/adding children for it.
2126 When finished, parent array is returned to the original state.
2128 void AddChildren( wxPGProperty
* property
);
2130 /** Adds attribute to the bottommost property.
2132 Allowed values: "string", (same as string), "int", "bool". Empty string
2135 bool AddAttribute( const wxString
& name
,
2136 const wxString
& type
,
2137 const wxString
& value
);
2139 /** Called once in AddChildren.
2141 virtual void DoScanForChildren() = 0;
2144 Returns id of parent property for which children can currently be
2147 wxPGProperty
* GetCurParent() const
2149 return (wxPGProperty
*) m_propHierarchy
[m_propHierarchy
.size()-1];
2152 wxPropertyGridPageState
* GetState() { return m_state
; }
2153 const wxPropertyGridPageState
* GetState() const { return m_state
; }
2155 /** Like wxString::ToLong, except allows N% in addition of N.
2157 static bool ToLongPCT( const wxString
& s
, long* pval
, long max
);
2159 /** Parses strings of format "choice1"[=value1] ... "choiceN"[=valueN] into
2160 wxPGChoices. Registers parsed result using idString (if not empty).
2161 Also, if choices with given id already registered, then don't parse but
2162 return those choices instead.
2164 wxPGChoices
ParseChoices( const wxString
& choicesString
,
2165 const wxString
& idString
);
2167 /** Implement in derived class to do custom process when an error occurs.
2168 Default implementation uses wxLogError.
2170 virtual void ProcessError( const wxString
& msg
);
2174 /** Used property grid. */
2175 wxPropertyGrid
* m_pg
;
2177 /** Used property grid state. */
2178 wxPropertyGridPageState
* m_state
;
2180 /** Tree-hierarchy of added properties (that can have children). */
2181 wxArrayPGProperty m_propHierarchy
;
2183 /** Hashmap for string-id to wxPGChoicesData mapping. */
2184 wxPGHashMapS2P m_dictIdChoices
;
2187 // -----------------------------------------------------------------------
2190 // Undefine macros that are not needed outside propertygrid sources
2192 #ifndef __wxPG_SOURCE_FILE__
2193 #undef wxPG_FL_DESC_REFRESH_REQUIRED
2194 #undef wxPG_FL_SCROLLBAR_DETECTED
2195 #undef wxPG_FL_CREATEDSTATE
2196 #undef wxPG_FL_NOSTATUSBARHELP
2197 #undef wxPG_FL_SCROLLED
2198 #undef wxPG_FL_FOCUS_INSIDE_CHILD
2199 #undef wxPG_FL_FOCUS_INSIDE
2200 #undef wxPG_FL_MOUSE_INSIDE_CHILD
2201 #undef wxPG_FL_CUR_USES_CUSTOM_IMAGE
2202 #undef wxPG_FL_PRIMARY_FILLS_ENTIRE
2203 #undef wxPG_FL_VALUE_MODIFIED
2204 #undef wxPG_FL_MOUSE_INSIDE
2205 #undef wxPG_FL_FOCUSED
2206 #undef wxPG_FL_MOUSE_CAPTURED
2207 #undef wxPG_FL_INITIALIZED
2208 #undef wxPG_FL_ACTIVATION_BY_CLICK
2209 #undef wxPG_FL_DONT_CENTER_SPLITTER
2210 #undef wxPG_SUPPORT_TOOLTIPS
2211 #undef wxPG_DOUBLE_BUFFER
2212 #undef wxPG_ICON_WIDTH
2213 #undef wxPG_USE_RENDERER_NATIVE
2214 // Following are needed by the manager headers
2215 // #undef const wxString&
2220 #include "wx/propgrid/editor.h"
2221 #include "wx/propgrid/manager.h"
2224 // -----------------------------------------------------------------------
2228 #endif // _WX_PROPGRID_PROPGRID_H_