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 wxVector
<wxValidator
*> 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,
244 /** Hides page selection buttons from toolbar.
246 wxPG_EX_HIDE_PAGE_BUTTONS
= 0x01000000
250 /** Combines various styles.
252 #define wxPG_DEFAULT_STYLE (0)
254 /** Combines various styles.
256 #define wxPGMAN_DEFAULT_STYLE (0)
261 // -----------------------------------------------------------------------
264 // Ids for sub-controls
265 // NB: It should not matter what these are.
266 #define wxPG_SUBID1 2
267 #define wxPG_SUBID2 3
268 #define wxPG_SUBID_TEMP1 4
270 // -----------------------------------------------------------------------
272 /** @class wxPGCommonValue
274 wxPropertyGrid stores information about common values in these
277 NB: Common value feature is not complete, and thus not mentioned in
280 class WXDLLIMPEXP_PROPGRID wxPGCommonValue
284 wxPGCommonValue( const wxString
& label
, wxPGCellRenderer
* renderer
)
287 m_renderer
= renderer
;
290 virtual ~wxPGCommonValue()
292 m_renderer
->DecRef();
295 virtual wxString
GetEditableText() const { return m_label
; }
296 const wxString
& GetLabel() const { return m_label
; }
297 wxPGCellRenderer
* GetRenderer() const { return m_renderer
; }
301 wxPGCellRenderer
* m_renderer
;
304 // -----------------------------------------------------------------------
306 /** @section propgrid_vfbflags wxPropertyGrid Validation Failure Behavior Flags
310 enum wxPG_VALIDATION_FAILURE_BEHAVIOR_FLAGS
313 /** Prevents user from leaving property unless value is valid. If this
314 behavior flag is not used, then value change is instead cancelled.
316 wxPG_VFB_STAY_IN_PROPERTY
= 0x01,
318 /** Calls wxBell() on validation failure.
320 wxPG_VFB_BEEP
= 0x02,
322 /** Cell with invalid value will be marked (with red colour).
324 wxPG_VFB_MARK_CELL
= 0x04,
326 /** Display customizable text message explaining the situation.
328 wxPG_VFB_SHOW_MESSAGE
= 0x08,
331 wxPG_VFB_DEFAULT
= wxPG_VFB_STAY_IN_PROPERTY
|wxPG_VFB_BEEP
,
333 /** Only used internally. */
334 wxPG_VFB_UNDEFINED
= 0x80
341 typedef wxByte wxPGVFBFlags
;
346 Used to convey validation information to and from functions that
347 actually perform validation. Mostly used in custom property
350 class WXDLLIMPEXP_PROPGRID wxPGValidationInfo
352 friend class wxPropertyGrid
;
355 @return Returns failure behavior which is a combination of
356 @ref propgrid_vfbflags.
358 wxPGVFBFlags
GetFailureBehavior() const
359 { return m_failureBehavior
; }
362 Returns current failure message.
364 const wxString
& GetFailureMessage() const
365 { return m_failureMessage
; }
368 Returns reference to pending value.
370 const wxVariant
& GetValue() const
376 /** Set validation failure behavior
378 @param failureBehavior
379 Mixture of @ref propgrid_vfbflags.
381 void SetFailureBehavior(wxPGVFBFlags failureBehavior
)
382 { m_failureBehavior
= failureBehavior
; }
385 Set current failure message.
387 void SetFailureMessage(const wxString
& message
)
388 { m_failureMessage
= message
; }
391 /** Value to be validated.
395 /** Message displayed on validation failure.
397 wxString m_failureMessage
;
399 /** Validation failure behavior. Use wxPG_VFB_XXX flags.
401 wxPGVFBFlags m_failureBehavior
;
404 // -----------------------------------------------------------------------
406 /** @section propgrid_pgactions wxPropertyGrid Action Identifiers
408 These are used with wxPropertyGrid::AddActionTrigger() and
409 wxPropertyGrid::ClearActionTriggers().
413 enum wxPG_KEYBOARD_ACTIONS
415 wxPG_ACTION_INVALID
= 0,
416 wxPG_ACTION_NEXT_PROPERTY
,
417 wxPG_ACTION_PREV_PROPERTY
,
418 wxPG_ACTION_EXPAND_PROPERTY
,
419 wxPG_ACTION_COLLAPSE_PROPERTY
,
420 wxPG_ACTION_CANCEL_EDIT
,
421 wxPG_ACTION_PRESS_BUTTON
, // Causes editor button (if any) to be pressed
428 // -----------------------------------------------------------------------
431 // wxPropertyGrid::DoSelectProperty flags (selFlags)
433 // Focuses to created editor
434 #define wxPG_SEL_FOCUS 0x01
435 // Forces deletion and recreation of editor
436 #define wxPG_SEL_FORCE 0x02
437 // For example, doesn't cause EnsureVisible
438 #define wxPG_SEL_NONVISIBLE 0x04
439 // Do not validate editor's value before selecting
440 #define wxPG_SEL_NOVALIDATE 0x08
441 // Property being deselected is about to be deleted
442 #define wxPG_SEL_DELETING 0x10
443 // Property's values was set to unspecified by the user
444 #define wxPG_SEL_SETUNSPEC 0x20
445 // Property's event handler changed the value
446 #define wxPG_SEL_DIALOGVAL 0x40
449 // -----------------------------------------------------------------------
454 #define wxPG_FL_INITIALIZED 0x0001
455 // Set when creating editor controls if it was clicked on.
456 #define wxPG_FL_ACTIVATION_BY_CLICK 0x0002
457 #define wxPG_FL_DONT_CENTER_SPLITTER 0x0004
458 #define wxPG_FL_FOCUSED 0x0008
459 #define wxPG_FL_MOUSE_CAPTURED 0x0010
460 #define wxPG_FL_MOUSE_INSIDE 0x0020
461 #define wxPG_FL_VALUE_MODIFIED 0x0040
462 // don't clear background of m_wndEditor
463 #define wxPG_FL_PRIMARY_FILLS_ENTIRE 0x0080
464 // currently active editor uses custom image
465 #define wxPG_FL_CUR_USES_CUSTOM_IMAGE 0x0100
466 // cell colours override selection colours for selected cell
467 #define wxPG_FL_CELL_OVERRIDES_SEL 0x0200
468 #define wxPG_FL_SCROLLED 0x0400
469 // set when all added/inserted properties get hideable flag
470 #define wxPG_FL_ADDING_HIDEABLES 0x0800
471 // Disables showing help strings on statusbar.
472 #define wxPG_FL_NOSTATUSBARHELP 0x1000
473 // Marks that we created the state, so we have to destroy it too.
474 #define wxPG_FL_CREATEDSTATE 0x2000
475 // Set if scrollbar's existence was detected in last onresize.
476 #define wxPG_FL_SCROLLBAR_DETECTED 0x4000
477 // Set if wxPGMan requires redrawing of description text box.
478 #define wxPG_FL_DESC_REFRESH_REQUIRED 0x8000
479 // Set if contained in wxPropertyGridManager
480 #define wxPG_FL_IN_MANAGER 0x00020000
481 // Set after wxPropertyGrid is shown in its initial good size
482 #define wxPG_FL_GOOD_SIZE_SET 0x00040000
483 // Set when in SelectProperty.
484 #define wxPG_FL_IN_SELECT_PROPERTY 0x00100000
485 // Set when help string is shown in status bar
486 #define wxPG_FL_STRING_IN_STATUSBAR 0x00200000
487 // Splitter position has been custom-set by the user
488 #define wxPG_FL_SPLITTER_PRE_SET 0x00400000
489 // Validation failed. Clear on modify event.
490 #define wxPG_FL_VALIDATION_FAILED 0x00800000
491 // Set if selected is fully painted (ie. both image and text)
492 //#define wxPG_FL_SELECTED_IS_FULL_PAINT 0x01000000
493 // Set after page has been inserted to manager
494 #define wxPG_MAN_FL_PAGE_INSERTED 0x02000000
495 // Active editor control is abnormally large
496 #define wxPG_FL_ABNORMAL_EDITOR 0x04000000
497 // Recursion guard for OnCustomEditorEvent
498 #define wxPG_FL_IN_ONCUSTOMEDITOREVENT 0x08000000
499 #define wxPG_FL_VALUE_CHANGE_IN_EVENT 0x10000000
500 // Editor control width should not change on resize
501 #define wxPG_FL_FIXED_WIDTH_EDITOR 0x20000000
502 // Width of panel can be different than width of grid
503 #define wxPG_FL_HAS_VIRTUAL_WIDTH 0x40000000
504 // Prevents RecalculateVirtualSize re-entrancy
505 #define wxPG_FL_RECALCULATING_VIRTUAL_SIZE 0x80000000
507 #endif // #ifndef SWIG
509 #if !defined(__wxPG_SOURCE_FILE__) && !defined(SWIG)
510 // Reduce compile time, but still include in user app
511 #include "wx/propgrid/props.h"
514 // -----------------------------------------------------------------------
516 /** @class wxPropertyGrid
518 wxPropertyGrid is a specialized grid for editing properties
519 such as strings, numbers, flagsets, fonts, and colours. wxPropertySheet
520 used to do the very same thing, but it hasn't been updated for a while
521 and it is currently deprecated.
523 Please note that most member functions are inherited and as such not
524 documented on this page. This means you will probably also want to read
525 wxPropertyGridInterface class reference.
527 See also @ref overview_propgrid.
529 @section propgrid_window_styles_ Window Styles
531 See @ref propgrid_window_styles.
533 @section propgrid_event_handling Event Handling
535 To process input from a propertygrid control, use these event handler
536 macros to direct input to member functions that take a wxPropertyGridEvent
539 @beginEventTable{wxPropertyGridEvent}
540 @event{EVT_PG_SELECTED (id, func)}
541 Respond to wxEVT_PG_SELECTED event, generated when property value
542 has been changed by user.
543 @event{EVT_PG_CHANGING(id, func)}
544 Respond to wxEVT_PG_CHANGING event, generated when property value
545 is about to be changed by user. Use wxPropertyGridEvent::GetValue()
546 to take a peek at the pending value, and wxPropertyGridEvent::Veto()
547 to prevent change from taking place, if necessary.
548 @event{EVT_PG_HIGHLIGHTED(id, func)}
549 Respond to wxEVT_PG_HIGHLIGHTED event, which occurs when mouse
550 moves over a property. Event's property is NULL if hovered area does
551 not belong to any property.
552 @event{EVT_PG_RIGHT_CLICK(id, func)}
553 Respond to wxEVT_PG_RIGHT_CLICK event, which occurs when property is
554 clicked on with right mouse button.
555 @event{EVT_PG_DOUBLE_CLICK(id, func)}
556 Respond to wxEVT_PG_DOUBLE_CLICK event, which occurs when property is
557 double-clicked onwith left mouse button.
558 @event{EVT_PG_ITEM_COLLAPSED(id, func)}
559 Respond to wxEVT_PG_ITEM_COLLAPSED event, generated when user collapses
560 a property or category..
561 @event{EVT_PG_ITEM_EXPANDED(id, func)}
562 Respond to wxEVT_PG_ITEM_EXPANDED event, generated when user expands
563 a property or category..
568 - Use Freeze() and Thaw() respectively to disable and enable drawing. This
569 will also delay sorting etc. miscellaneous calculations to the last
575 class WXDLLIMPEXP_PROPGRID
576 wxPropertyGrid
: public wxScrolledWindow
, public wxPropertyGridInterface
578 friend class wxPropertyGridPageState
;
579 friend class wxPropertyGridInterface
;
580 friend class wxPropertyGridManager
;
581 friend class wxPGCanvas
;
584 DECLARE_DYNAMIC_CLASS(wxPropertyGrid
)
589 %pythonAppend wxPropertyGrid
{
590 self
._setOORInfo(self
)
591 self
.DoDefaultTypeMappings()
592 self
.edited_objects
= {}
593 self
.DoDefaultValueTypeMappings()
594 if not hasattr(self
.__class__
,'_vt2setter'):
595 self
.__class__
._vt2setter
= {}
597 %pythonAppend
wxPropertyGrid() ""
599 wxPropertyGrid( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
600 const wxPoint
& pos
= wxDefaultPosition
,
601 const wxSize
& size
= wxDefaultSize
,
602 long style
= wxPG_DEFAULT_STYLE
,
603 const wxChar
* name
= wxPyPropertyGridNameStr
);
604 %RenameCtor
(PrePropertyGrid
, wxPropertyGrid());
608 Two step constructor.
610 Call Create when this constructor is called to build up the
615 /** The default constructor. The styles to be used are styles valid for
616 the wxWindow and wxScrolledWindow.
617 @see @link wndflags Additional Window Styles@endlink
619 wxPropertyGrid( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
620 const wxPoint
& pos
= wxDefaultPosition
,
621 const wxSize
& size
= wxDefaultSize
,
622 long style
= wxPG_DEFAULT_STYLE
,
623 const wxChar
* name
= wxPropertyGridNameStr
);
626 virtual ~wxPropertyGrid();
629 /** Adds given key combination to trigger given action.
631 Which action to trigger. See @link pgactions List of list of
632 wxPropertyGrid actions@endlink.
634 void AddActionTrigger( int action
, int keycode
, int modifiers
= 0 );
637 This static function enables or disables automatic use of
638 wxGetTranslation for following strings: wxEnumProperty list labels,
639 wxFlagsProperty sub-property labels.
643 static void AutoGetTranslation( bool enable
);
646 Changes value of a property, as if from an editor.
648 Use this instead of SetPropertyValue() if you need the value to run
649 through validation process, and also send the property change event.
652 Returns true if value was successfully changed.
654 bool ChangePropertyValue( wxPGPropArg id
, wxVariant newValue
);
657 Centers the splitter.
659 If argument is true, automatic splitter centering is enabled (only
660 applicapple if style wxPG_SPLITTER_AUTO_CENTER was defined).
662 void CenterSplitter( bool enable_auto_centering
= false );
664 /** Deletes all properties.
666 virtual void Clear();
668 /** Clears action triggers for given action.
670 Which action to trigger. See @link pgactions List of list of
671 wxPropertyGrid actions@endlink.
673 void ClearActionTriggers( int action
);
675 /** Forces updating the value of property from the editor control.
677 Note that wxEVT_PG_CHANGING and wxEVT_PG_CHANGED are dispatched using
678 ProcessEvent, meaning your event handlers will be called immediately.
681 Returns true if anything was changed.
683 virtual bool CommitChangesFromEditor( wxUint32 flags
= 0 );
688 Whenever the control is created without any parameters, use Create to
689 actually create it. Don't access the control's public methods before
690 this is called @see @link wndflags Additional Window Styles@endlink
692 bool Create( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
693 const wxPoint
& pos
= wxDefaultPosition
,
694 const wxSize
& size
= wxDefaultSize
,
695 long style
= wxPG_DEFAULT_STYLE
,
696 const wxChar
* name
= wxPropertyGridNameStr
);
699 Call when editor widget's contents is modified.
701 For example, this is called when changes text in wxTextCtrl (used in
702 wxStringProperty and wxIntProperty).
705 This function should only be called by custom properties.
707 @see wxPGProperty::OnEvent()
709 void EditorsValueWasModified() { m_iFlags
|= wxPG_FL_VALUE_MODIFIED
; }
711 /** Reverse of EditorsValueWasModified().
714 This function should only be called by custom properties.
716 void EditorsValueWasNotModified()
718 m_iFlags
&= ~(wxPG_FL_VALUE_MODIFIED
);
722 Enables or disables (shows/hides) categories according to parameter
725 bool EnableCategories( bool enable
);
727 /** Scrolls and/or expands items to ensure that the given item is visible.
728 Returns true if something was actually done.
730 bool EnsureVisible( wxPGPropArg id
);
733 Reduces column sizes to minimum possible that contents are still
734 visibly (naturally some margin space will be applied as well).
737 Minimum size for the grid to still display everything.
740 Does not work well with wxPG_SPLITTER_AUTO_CENTER window style.
742 This function only works properly if grid size prior to call was already
745 Note that you can also get calculated column widths by calling
746 GetState->GetColumnWidth() immediately after this function returns.
750 wxSize sz
= m_pState
->DoFitColumns();
755 Returns wxWindow that the properties are painted on, and which should
756 be used as the parent for editor controls.
758 wxPanel
* GetPanel() const
763 /** Returns current category caption background colour. */
764 wxColour
GetCaptionBackgroundColour() const { return m_colCapBack
; }
766 wxFont
& GetCaptionFont() { return m_captionFont
; }
768 const wxFont
& GetCaptionFont() const { return m_captionFont
; }
770 /** Returns current category caption text colour. */
771 wxColour
GetCaptionForegroundColour() const { return m_colCapFore
; }
773 /** Returns current cell background colour. */
774 wxColour
GetCellBackgroundColour() const { return m_colPropBack
; }
776 /** Returns current cell text colour when disabled. */
777 wxColour
GetCellDisabledTextColour() const { return m_colDisPropFore
; }
779 /** Returns current cell text colour. */
780 wxColour
GetCellTextColour() const { return m_colPropFore
; }
783 Returns number of columns currently on grid.
785 unsigned int GetColumnCount() const
787 return (unsigned int) m_pState
->m_colWidths
.size();
790 /** Returns colour of empty space below properties. */
791 wxColour
GetEmptySpaceColour() const { return m_colEmptySpace
; }
793 /** Returns height of highest characters of used font. */
794 int GetFontHeight() const { return m_fontHeight
; }
796 /** Returns pointer to itself. Dummy function that enables same kind
797 of code to use wxPropertyGrid and wxPropertyGridManager.
799 wxPropertyGrid
* GetGrid() { return this; }
801 /** Returns rectangle of custom paint image.
803 wxRect
GetImageRect( wxPGProperty
* p
, int item
) const;
805 /** Returns size of the custom paint image in front of property.
806 If no argument is given, returns preferred size.
808 wxSize
GetImageSize( wxPGProperty
* p
= NULL
, int item
= -1 ) const;
811 /** Returns last item which could be iterated using given flags.
813 See @ref propgrid_iterator_flags.
815 wxPGProperty
* GetLastItem( int flags
= wxPG_ITERATE_DEFAULT
)
817 return m_pState
->GetLastItem(flags
);
820 const wxPGProperty
* GetLastItem( int flags
= wxPG_ITERATE_DEFAULT
) const
822 return m_pState
->GetLastItem(flags
);
826 /** Returns colour of lines between cells. */
827 wxColour
GetLineColour() const { return m_colLine
; }
829 /** Returns background colour of margin. */
830 wxColour
GetMarginColour() const { return m_colMargin
; }
833 Returns most up-to-date value of selected property. This will return
834 value different from GetSelectedProperty()->GetValue() only when text
835 editor is activate and string edited by user represents valid,
836 uncommitted property value.
838 wxVariant
GetUncommittedPropertyValue();
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 /** Sets category caption background colour. */
942 void SetCaptionBackgroundColour(const wxColour
& col
);
944 /** Sets category caption text colour. */
945 void SetCaptionTextColour(const wxColour
& col
);
947 /** Sets default cell background colour - applies to property cells.
948 Note that appearance of editor widgets may not be affected.
950 void SetCellBackgroundColour(const wxColour
& col
);
952 /** Sets cell text colour for disabled properties.
954 void SetCellDisabledTextColour(const wxColour
& col
);
956 /** Sets default cell text colour - applies to property name and value text.
957 Note that appearance of editor widgets may not be affected.
959 void SetCellTextColour(const wxColour
& col
);
961 /** Set number of columns (2 or more).
963 void SetColumnCount( int colCount
)
965 m_pState
->SetColumnCount(colCount
);
970 Sets the 'current' category - Append will add non-category properties
973 void SetCurrentCategory( wxPGPropArg id
)
975 wxPG_PROP_ARG_CALL_PROLOG()
976 wxPropertyCategory
* pc
= wxDynamicCast(p
, wxPropertyCategory
);
978 m_pState
->m_currentCategory
= pc
;
981 /** Sets colour of empty space below properties. */
982 void SetEmptySpaceColour(const wxColour
& col
);
984 /** Sets colour of lines between cells. */
985 void SetLineColour(const wxColour
& col
);
987 /** Sets background colour of margin. */
988 void SetMarginColour(const wxColour
& col
);
990 /** Sets background colour of property and all its children. Colours of
991 captions are not affected. Background brush cache is optimized for often
992 set colours to be set last.
994 void SetPropertyBackgroundColour( wxPGPropArg id
, const wxColour
& col
);
996 /** Resets text and background colours of given property.
998 void SetPropertyColoursToDefault( wxPGPropArg id
);
1000 /** Sets text colour of property and all its children.
1002 void SetPropertyTextColour( wxPGPropArg id
,
1003 const wxColour
& col
,
1004 bool recursively
= true );
1007 Sets selection background colour - applies to selected property name
1010 void SetSelectionBackgroundColour(const wxColour
& col
);
1013 Sets selection foreground colour - applies to selected property name
1016 void SetSelectionTextColour(const wxColour
& col
);
1018 /** Sets x coordinate of the splitter.
1020 Splitter position cannot exceed grid size, and therefore setting it
1021 during form creation may fail as initial grid size is often smaller
1022 than desired splitter position, especially when sizers are being used.
1024 void SetSplitterPosition( int newxpos
, int col
= 0 )
1026 DoSetSplitterPosition_(newxpos
, true, col
);
1027 m_iFlags
|= wxPG_FL_SPLITTER_PRE_SET
;
1030 /** Set virtual width for this particular page. Width -1 indicates that the
1031 virtual width should be disabled. */
1032 void SetVirtualWidth( int width
);
1035 Moves splitter as left as possible, while still allowing all
1036 labels to be shown in full.
1038 @param privateChildrenToo
1039 If @false, will still allow private children to be cropped.
1041 void SetSplitterLeft( bool privateChildrenToo
= false )
1043 m_pState
->SetSplitterLeft(privateChildrenToo
);
1046 /** Sets vertical spacing. Can be 1, 2, or 3 - a value relative to font
1047 height. Value of 2 should be default on most platforms.
1049 void SetVerticalSpacing( int vspacing
)
1051 m_vspacing
= (unsigned char)vspacing
;
1052 CalculateFontAndBitmapStuff( vspacing
);
1053 if ( !m_pState
->m_itemsAdded
) Refresh();
1056 /** Shows an brief error message that is related to a property. */
1057 void ShowPropertyError( wxPGPropArg id
, const wxString
& msg
)
1059 wxPG_PROP_ARG_CALL_PROLOG()
1060 DoShowPropertyError(p
, msg
);
1063 /** Sorts all items at all levels (except sub-properties). */
1066 /** Sorts children of a category.
1068 void SortChildren( wxPGPropArg id
);
1070 /////////////////////////////////////////////////////////////////
1072 // Following methods do not need to be (currently) documented
1074 /////////////////////////////////////////////////////////////////
1076 bool HasVirtualWidth() const
1077 { return (m_iFlags
& wxPG_FL_HAS_VIRTUAL_WIDTH
) ? true : false; }
1079 const wxPGCommonValue
* GetCommonValue( unsigned int i
) const
1081 return (wxPGCommonValue
*) m_commonValues
[i
];
1084 /** Returns number of common values.
1086 unsigned int GetCommonValueCount() const
1088 return (unsigned int) m_commonValues
.size();
1091 /** Returns label of given common value.
1093 wxString
GetCommonValueLabel( unsigned int i
) const
1095 wxASSERT( GetCommonValue(i
) );
1096 return GetCommonValue(i
)->GetLabel();
1100 Returns index of common value that will truly change value to
1103 int GetUnspecifiedCommonValue() const { return m_cvUnspecified
; }
1105 /** Set index of common value that will truly change value to unspecified.
1106 Using -1 will set none to have such effect.
1109 void SetUnspecifiedCommonValue( int index
) { m_cvUnspecified
= index
; }
1112 Shortcut for creating dialog-caller button. Used, for example, by
1115 This should only be called by properties.
1117 wxWindow
* GenerateEditorButton( const wxPoint
& pos
, const wxSize
& sz
);
1119 /** Fixes position of wxTextCtrl-like control (wxSpinCtrl usually
1120 fits as one). Call after control has been created (but before
1123 void FixPosForTextCtrl( wxWindow
* ctrl
,
1124 const wxPoint
& offset
= wxPoint(0, 0) );
1126 /** Shortcut for creating text editor widget.
1128 Same as pos given for CreateEditor.
1130 Same as sz given for CreateEditor.
1132 Initial text for wxTextCtrl.
1134 If right-side control, such as button, also created, then create it
1135 first and pass it as this parameter.
1137 Extra style flags to pass for wxTextCtrl.
1139 Note that this should generally be called only by new classes derived
1142 wxWindow
* GenerateEditorTextCtrl( const wxPoint
& pos
,
1144 const wxString
& value
,
1145 wxWindow
* secondary
,
1149 /* Generates both textctrl and button.
1151 wxWindow
* GenerateEditorTextCtrlAndButton( const wxPoint
& pos
,
1152 const wxSize
& sz
, wxWindow
** psecondary
, int limited_editing
,
1153 wxPGProperty
* property
);
1155 /** Generates position for a widget editor dialog box.
1157 Property for which dialog is positioned.
1159 Known or over-approximated size of the dialog.
1161 Position for dialog.
1163 wxPoint
GetGoodEditorDialogPosition( wxPGProperty
* p
,
1166 // Converts escape sequences in src_str to newlines,
1167 // tabs, etc. and copies result to dst_str.
1168 static wxString
& ExpandEscapeSequences( wxString
& dst_str
,
1169 wxString
& src_str
);
1171 // Converts newlines, tabs, etc. in src_str to escape
1172 // sequences, and copies result to dst_str.
1173 static wxString
& CreateEscapeSequences( wxString
& dst_str
,
1174 wxString
& src_str
);
1177 Returns rectangle that fully contains properties between and including
1180 wxRect
GetPropertyRect( const wxPGProperty
* p1
,
1181 const wxPGProperty
* p2
) const;
1183 /** Returns pointer to current active primary editor control (NULL if none).
1185 wxWindow
* GetEditorControl() const;
1187 wxWindow
* GetPrimaryEditor() const
1189 return GetEditorControl();
1193 Returns pointer to current active secondary editor control (NULL if
1196 wxWindow
* GetEditorControlSecondary() const
1198 return m_wndEditor2
;
1204 Generates contents for string dst based on the contents of
1207 Format will be "(preDelim)str1(postDelim) (preDelim)str2(postDelim) and
1208 so on. Set flags to 1 inorder to convert backslashes to double-back-
1209 slashes and "(preDelims)"'s to "(preDelims)".
1211 static void ArrayStringToString( wxString
& dst
, const wxArrayString
& src
,
1212 wxChar preDelim
, wxChar postDelim
,
1215 // Mostly useful for page switching.
1216 void SwitchState( wxPropertyGridPageState
* pNewState
);
1218 /** Pass this function to Connect calls in propertyclass::CreateEditor.
1220 void OnCustomEditorEvent( wxCommandEvent
&event
);
1222 long GetInternalFlags() const { return m_iFlags
; }
1223 bool HasInternalFlag( long flag
) const
1224 { return (m_iFlags
& flag
) ? true : false; }
1225 void SetInternalFlag( long flag
) { m_iFlags
|= flag
; }
1226 void ClearInternalFlag( long flag
) { m_iFlags
&= ~(flag
); }
1227 void IncFrozen() { m_frozen
++; }
1228 void DecFrozen() { m_frozen
--; }
1230 void OnComboItemPaint( wxPGCustomComboControl
* pCb
,int item
,wxDC
& dc
,
1231 wxRect
& rect
,int flags
);
1233 /** Standardized double-to-string conversion.
1235 static void DoubleToString( wxString
& target
,
1239 wxString
* precTemplate
);
1242 Call this from wxPGProperty::OnEvent() to cause property value to be
1243 changed after the function returns (with true as return value).
1244 ValueChangeInEvent() must be used if you wish the application to be
1245 able to use wxEVT_PG_CHANGING to potentially veto the given value.
1247 void ValueChangeInEvent( wxVariant variant
)
1249 m_changeInEventValue
= variant
;
1250 m_iFlags
|= wxPG_FL_VALUE_CHANGE_IN_EVENT
;
1253 /** Returns true if given event is from first of an array of buttons
1254 (as can be in case when wxPGMultiButton is used).
1256 bool IsMainButtonEvent( const wxEvent
& event
)
1258 return (event
.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED
)
1259 && (m_wndSecId
== event
.GetId());
1262 /** Pending value is expected to be passed in PerformValidation().
1264 virtual bool DoPropertyChanged( wxPGProperty
* p
,
1265 unsigned int selFlags
= 0 );
1267 /** Called when validation for given property fails.
1269 Value which failed in validation.
1271 Return true if user is allowed to change to another property even
1272 if current has invalid value.
1274 To add your own validation failure behavior, override
1275 wxPropertyGrid::DoOnValidationFailure().
1277 bool OnValidationFailure( wxPGProperty
* property
, wxVariant
& invalidValue
)
1279 bool res
= DoOnValidationFailure(property
, invalidValue
);
1280 property
->SetFlag(wxPG_PROP_INVALID_VALUE
);
1284 /** Called to indicate property and editor has valid value now.
1286 void OnValidationFailureReset( wxPGProperty
* property
)
1288 if ( property
&& property
->HasFlag(wxPG_PROP_INVALID_VALUE
) )
1290 DoOnValidationFailureReset(property
);
1291 property
->ClearFlag(wxPG_PROP_INVALID_VALUE
);
1293 m_validationInfo
.m_failureMessage
.clear();
1296 /** Override in derived class to display error messages in custom manner
1297 (these message usually only result from validation failure).
1299 virtual void DoShowPropertyError( wxPGProperty
* property
,
1300 const wxString
& msg
);
1302 /** Override to customize property validation failure behavior.
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 virtual bool DoOnValidationFailure( wxPGProperty
* property
,
1310 wxVariant
& invalidValue
);
1312 /** Override to customize resetting of property validation failure status.
1314 Property is guaranteed to have flag wxPG_PROP_INVALID_VALUE set.
1316 virtual void DoOnValidationFailureReset( wxPGProperty
* property
);
1318 int GetSpacingY() const { return m_spacingy
; }
1321 Must be called in wxPGEditor::CreateControls() if primary editor window
1322 is wxTextCtrl, just before textctrl is created.
1324 Initial text value of created wxTextCtrl.
1326 void SetupTextCtrlValue( const wxString text
) { m_prevTcValue
= text
; }
1329 Unfocuses or closes editor if one was open, but does not deselect
1332 bool UnfocusEditor();
1337 wxPropertyGridPageState used by the grid is created here.
1339 If grid is used in wxPropertyGridManager, there is no point overriding
1340 this - instead, set custom wxPropertyGridPage classes.
1342 virtual wxPropertyGridPageState
* CreateState() const;
1344 enum PerformValidationFlags
1346 SendEvtChanging
= 0x0001,
1347 IsStandaloneValidation
= 0x0002 // Not called in response to event
1351 Runs all validation functionality (includes sending wxEVT_PG_CHANGING).
1352 Returns true if all tests passed. Implement in derived class to
1353 add additional validation behavior.
1355 virtual bool PerformValidation( wxPGProperty
* p
,
1356 wxVariant
& pendingValue
,
1357 int flags
= SendEvtChanging
);
1361 // Control font changer helper.
1362 void SetCurControlBoldFont();
1365 // Public methods for semi-public use
1366 // (not protected for optimization)
1368 bool DoSelectProperty( wxPGProperty
* p
, unsigned int flags
= 0 );
1370 // Overridden functions.
1371 virtual bool Destroy();
1372 virtual wxSize
DoGetBestSize() const;
1373 // Returns property at given y coordinate (relative to grid's top left).
1374 wxPGProperty
* GetItemAtY( int y
) const { return DoGetItemAtY(y
); }
1376 virtual void Refresh( bool eraseBackground
= true,
1377 const wxRect
*rect
= (const wxRect
*) NULL
);
1378 virtual bool SetFont( const wxFont
& font
);
1379 #if wxPG_SUPPORT_TOOLTIPS
1380 void SetToolTip( const wxString
& tipString
);
1382 virtual void Freeze();
1383 virtual void SetExtraStyle( long exStyle
);
1384 virtual void Thaw();
1389 #ifndef wxPG_ICON_WIDTH
1390 wxBitmap
*m_expandbmp
, *m_collbmp
;
1393 wxCursor
*m_cursorSizeWE
;
1395 /** wxWindow pointers to editor control(s). */
1396 wxWindow
*m_wndEditor
;
1397 wxWindow
*m_wndEditor2
;
1399 /** wxPGCanvas instance. */
1402 #if wxPG_DOUBLE_BUFFER
1403 wxBitmap
*m_doubleBuffer
;
1406 /** Local time ms when control was created. */
1407 wxLongLong m_timeCreated
;
1409 /** wxPGProperty::OnEvent can change value by setting this. */
1410 wxVariant m_changeInEventValue
;
1412 /** Id of m_wndEditor2, or its first child, if any. */
1415 /** Extra Y spacing between the items. */
1418 /** Control client area width; updated on resize. */
1421 /** Control client area height; updated on resize. */
1424 /** Current non-client width (needed when auto-centering). */
1427 /** Non-client width (auto-centering helper). */
1430 /** Previously recorded scroll start position. */
1434 The gutter spacing in front and back of the image.
1435 This determines the amount of spacing in front of each item
1439 /** Includes separator line. */
1442 /** Gutter*2 + image width. */
1445 // y spacing for expand/collapse button.
1446 int m_buttonSpacingY
;
1448 /** Extra margin for expanded sub-group items. */
1449 int m_subgroup_extramargin
;
1452 The image width of the [+] icon.
1454 This is also calculated in the gutter
1458 #ifndef wxPG_ICON_WIDTH
1461 The image height of the [+] icon.
1463 This is calculated as minimal size and to align
1468 /** Current cursor id. */
1472 This captionFont is made equal to the font of the wxScrolledWindow.
1474 As extra the bold face is set on it when this is wanted by the user
1477 wxFont m_captionFont
;
1479 int m_fontHeight
; // Height of the font.
1481 /** m_splitterx when drag began. */
1482 int m_startingSplitterX
;
1485 Index to splitter currently being dragged (0=one after the first
1488 int m_draggedSplitter
;
1490 /** Changed property, calculated in PerformValidation(). */
1491 wxPGProperty
* m_chgInfo_changedProperty
;
1494 Lowest property for which editing happened, but which does not have
1497 wxPGProperty
* m_chgInfo_baseChangedProperty
;
1499 /** Changed property value, calculated in PerformValidation(). */
1500 wxVariant m_chgInfo_pendingValue
;
1502 /** Passed to SetValue. */
1503 wxVariant m_chgInfo_valueList
;
1505 /** Validation information. */
1506 wxPGValidationInfo m_validationInfo
;
1508 /** Actions and keys that trigger them. */
1509 wxPGHashMapI2I m_actionTriggers
;
1515 /** Bits are used to indicate which colours are customized. */
1516 unsigned short m_coloursCustomized
;
1518 /** x - m_splitterx. */
1519 signed char m_dragOffset
;
1521 /** 0 = not dragging, 1 = drag just started, 2 = drag in progress */
1522 unsigned char m_dragStatus
;
1524 /** 0 = margin, 1 = label, 2 = value. */
1525 unsigned char m_mouseSide
;
1527 /** True when editor control is focused. */
1528 unsigned char m_editorFocused
;
1530 /** 1 if m_latsCaption is also the bottommost caption. */
1531 //unsigned char m_lastCaptionBottomnest;
1533 /** Set to 1 when graphics frozen. */
1534 unsigned char m_frozen
;
1536 unsigned char m_vspacing
;
1538 // Used to track when Alt/Ctrl+Key was consumed.
1539 unsigned char m_keyComboConsumed
;
1541 /** 1 if in DoPropertyChanged() */
1542 unsigned char m_inDoPropertyChanged
;
1544 /** 1 if in CommitChangesFromEditor() */
1545 unsigned char m_inCommitChangesFromEditor
;
1547 /** 1 if in DoSelectProperty() */
1548 unsigned char m_inDoSelectProperty
;
1550 wxPGVFBFlags m_permanentValidationFailureBehavior
; // Set by app
1552 /** Internal flags - see wxPG_FL_XXX constants. */
1555 /** When drawing next time, clear this many item slots at the end. */
1556 int m_clearThisMany
;
1558 /** Pointer to selected property. Note that this is duplicated in
1559 m_state for better transiency between pages so that the selected
1560 item can be retained.
1562 wxPGProperty
* m_selected
;
1564 // pointer to property that has mouse hovering
1565 wxPGProperty
* m_propHover
;
1567 // EventObject for wxPropertyGridEvents
1568 wxWindow
* m_eventObject
;
1570 // What (global) window is currently focused (needed to resolve event
1572 wxWindow
* m_curFocused
;
1575 wxEvtHandler
* m_tlwHandler
;
1580 // y coordinate of property that mouse hovering
1582 // Which column's editor is selected (usually 1)?
1585 // x relative to splitter (needed for resize).
1588 // lines between cells
1590 // property labels and values are written in this colour
1591 wxColour m_colPropFore
;
1592 // or with this colour when disabled
1593 wxColour m_colDisPropFore
;
1594 // background for m_colPropFore
1595 wxColour m_colPropBack
;
1596 // text color for captions
1597 wxColour m_colCapFore
;
1598 // background color for captions
1599 wxColour m_colCapBack
;
1600 // foreground for selected property
1601 wxColour m_colSelFore
;
1602 // background for selected property (actually use background color when
1603 // control out-of-focus)
1604 wxColour m_colSelBack
;
1605 // background colour for margin
1606 wxColour m_colMargin
;
1607 // background colour for empty space below the grid
1608 wxColour m_colEmptySpace
;
1610 // NB: These *cannot* be moved to globals.
1612 // Array of background colour brushes.
1613 wxArrayPtrVoid m_arrBgBrushes
;
1615 // Array of foreground colours.
1616 wxArrayPtrVoid m_arrFgCols
;
1618 // labels when properties use common values
1619 wxVector
<wxPGCommonValue
*> m_commonValues
;
1621 // Which cv selection really sets value to unspecified?
1622 int m_cvUnspecified
;
1624 // Used to skip excess text editor events
1625 wxString m_prevTcValue
;
1629 // Sets some members to defaults (called constructors).
1632 // Initializes some members (called by Create and complex constructor).
1635 void OnPaint(wxPaintEvent
&event
);
1637 // main event receivers
1638 void OnMouseMove( wxMouseEvent
&event
);
1639 void OnMouseMoveBottom( wxMouseEvent
&event
);
1640 void OnMouseClick( wxMouseEvent
&event
);
1641 void OnMouseRightClick( wxMouseEvent
&event
);
1642 void OnMouseDoubleClick( wxMouseEvent
&event
);
1643 void OnMouseUp( wxMouseEvent
&event
);
1644 void OnKey( wxKeyEvent
&event
);
1645 void OnKeyUp( wxKeyEvent
&event
);
1646 void OnResize( wxSizeEvent
&event
);
1649 bool HandleMouseMove( int x
, unsigned int y
, wxMouseEvent
&event
);
1650 bool HandleMouseClick( int x
, unsigned int y
, wxMouseEvent
&event
);
1651 bool HandleMouseRightClick( int x
, unsigned int y
, wxMouseEvent
&event
);
1652 bool HandleMouseDoubleClick( int x
, unsigned int y
, wxMouseEvent
&event
);
1653 bool HandleMouseUp( int x
, unsigned int y
, wxMouseEvent
&event
);
1654 void HandleKeyEvent( wxKeyEvent
&event
);
1655 // Handle TAB and ESCAPE in control
1656 bool HandleChildKey( wxKeyEvent
& event
);
1658 void OnMouseEntry( wxMouseEvent
&event
);
1660 void OnIdle( wxIdleEvent
&event
);
1661 void OnFocusEvent( wxFocusEvent
&event
);
1662 void OnChildFocusEvent( wxChildFocusEvent
& event
);
1664 bool OnMouseCommon( wxMouseEvent
&event
, int* px
, int *py
);
1665 bool OnMouseChildCommon( wxMouseEvent
&event
, int* px
, int *py
);
1667 // sub-control event handlers
1668 void OnMouseClickChild( wxMouseEvent
&event
);
1669 void OnMouseRightClickChild( wxMouseEvent
&event
);
1670 void OnMouseMoveChild( wxMouseEvent
&event
);
1671 void OnMouseUpChild( wxMouseEvent
&event
);
1672 void OnChildKeyDown( wxKeyEvent
&event
);
1673 void OnChildKeyUp( wxKeyEvent
&event
);
1675 void OnCaptureChange( wxMouseCaptureChangedEvent
&event
);
1677 void OnScrollEvent( wxScrollWinEvent
&event
);
1679 void OnSysColourChanged( wxSysColourChangedEvent
&event
);
1684 Adjust the centering of the bitmap icons (collapse / expand) when the
1685 caption font changes.
1687 They need to be centered in the middle of the font, so a bit of deltaY
1688 adjustment is needed. On entry, m_captionFont must be set to window
1689 font. It will be modified properly.
1691 void CalculateFontAndBitmapStuff( int vspacing
);
1693 wxRect
GetEditorWidgetRect( wxPGProperty
* p
, int column
) const;
1695 void CorrectEditorWidgetSizeX();
1697 /** Called in RecalculateVirtualSize() to reposition control
1698 on virtual height changes.
1700 void CorrectEditorWidgetPosY();
1704 void OnScreenNote( const wxChar
* format
, ... );
1707 /** Deselect current selection, if any. Returns true if success
1708 (ie. validator did not intercept). */
1709 bool DoClearSelection();
1711 int DoDrawItems( wxDC
& dc
,
1712 const wxPGProperty
* first_item
,
1713 const wxPGProperty
* last_item
,
1714 const wxRect
* clip_rect
,
1715 bool isBuffered
) const;
1717 void DoSetPropertyValueUnspecified( wxPGProperty
* p
);
1719 /** Draws an expand/collapse (ie. +/-) button.
1721 virtual void DrawExpanderButton( wxDC
& dc
, const wxRect
& rect
,
1722 wxPGProperty
* property
) const;
1724 /** Draws items from topitemy to bottomitemy */
1725 void DrawItems( wxDC
& dc
, unsigned int topitemy
, unsigned int bottomitemy
,
1726 const wxRect
* clip_rect
= (const wxRect
*) NULL
);
1728 void DrawItems( const wxPGProperty
* p1
, const wxPGProperty
* p2
);
1730 void DrawItem( wxPGProperty
* p
)
1735 virtual void DrawItemAndChildren( wxPGProperty
* p
);
1738 Draws item, children, and consequtive parents as long as category is
1741 void DrawItemAndValueRelated( wxPGProperty
* p
);
1743 // Translate wxKeyEvent to wxPG_ACTION_XXX
1744 int KeyEventToActions(wxKeyEvent
&event
, int* pSecond
) const;
1746 int KeyEventToAction(wxKeyEvent
&event
) const
1748 return KeyEventToActions(event
, NULL
);
1751 void ImprovedClientToScreen( int* px
, int* py
);
1753 // Called by focus event handlers. newFocused is the window that becomes
1755 void HandleFocusChange( wxWindow
* newFocused
);
1757 /** Reloads all non-customized colours from system settings. */
1758 void RegainColours();
1760 bool DoEditorValidate();
1762 wxPGProperty
* DoGetItemAtY( int y
) const;
1764 void DoSetSplitterPosition_( int newxpos
,
1765 bool refresh
= true,
1766 int splitterIndex
= 0,
1767 bool allPages
= false );
1771 virtual bool DoExpand( wxPGProperty
* p
, bool sendEvent
= false );
1773 virtual bool DoCollapse( wxPGProperty
* p
, bool sendEvent
= false );
1775 // Returns nearest paint visible property (such that will be painted unless
1776 // window is scrolled or resized). If given property is paint visible, then
1777 // it itself will be returned.
1778 wxPGProperty
* GetNearestPaintVisible( wxPGProperty
* p
) const;
1780 static void RegisterDefaultEditors();
1782 // Sets m_bgColIndex to this property and all its children.
1783 void SetBackgroundColourIndex( wxPGProperty
* p
, int index
);
1785 // Sets m_fgColIndex to this property and all its children.
1786 void SetTextColourIndex( wxPGProperty
* p
, int index
, int flags
);
1788 int CacheColour( const wxColour
& colour
);
1790 // Sets up basic event handling for child control
1791 void SetupChildEventHandling( wxWindow
* wnd
);
1793 void CustomSetCursor( int type
, bool override
= false );
1795 virtual bool ProcessEvent(wxEvent
& event
);
1796 virtual void SetWindowStyleFlag( long style
);
1799 Repositions scrollbar and underlying panel according to changed virtual
1802 void RecalculateVirtualSize( int forceXPos
= -1 );
1804 void PrepareAfterItemsAdded();
1806 bool SendEvent( int eventType
,
1808 wxVariant
* pValue
= NULL
,
1809 unsigned int selFlags
= 0 );
1811 void SetFocusOnCanvas();
1813 bool DoHideProperty( wxPGProperty
* p
, bool hide
, int flags
);
1817 bool ButtonTriggerKeyTest( int action
, wxKeyEvent
& event
);
1819 DECLARE_EVENT_TABLE()
1820 #endif // #ifndef SWIG
1823 // -----------------------------------------------------------------------
1825 // Bunch of inlines that need to resolved after all classes have been defined.
1829 inline bool wxPropertyGridPageState::IsDisplayed() const
1831 return ( this == m_pPropGrid
->GetState() );
1834 inline unsigned int wxPropertyGridPageState::GetActualVirtualHeight() const
1836 return DoGetRoot()->GetChildrenHeight(GetGrid()->GetRowHeight());
1840 inline int wxPGProperty::GetDisplayedCommonValueCount() const
1842 if ( HasFlag(wxPG_PROP_USES_COMMON_VALUE
) )
1844 wxPropertyGrid
* pg
= GetGrid();
1846 return (int) pg
->GetCommonValueCount();
1851 inline void wxPGProperty::SetEditor( const wxString
& editorName
)
1853 m_customEditor
= wxPropertyGridInterface::GetEditorByName(editorName
);
1856 inline void wxPGProperty::SetName( const wxString
& newName
)
1858 GetGrid()->SetPropertyName(this, newName
);
1861 inline bool wxPGProperty::Hide( bool hide
, int flags
)
1863 return GetGrid()->HideProperty(this, hide
, flags
);
1866 inline bool wxPGProperty::SetMaxLength( int maxLen
)
1868 return GetGrid()->SetPropertyMaxLength(this,maxLen
);
1871 // -----------------------------------------------------------------------
1876 #define wxPG_BASE_EVT_PRE_ID 1775
1878 BEGIN_DECLARE_EVENT_TYPES()
1879 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_SELECTED
, wxPG_BASE_EVT_PRE_ID
)
1880 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_CHANGING
, wxPG_BASE_EVT_PRE_ID
+1)
1881 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_CHANGED
, wxPG_BASE_EVT_PRE_ID
+2)
1882 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_HIGHLIGHTED
, wxPG_BASE_EVT_PRE_ID
+3)
1883 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_RIGHT_CLICK
, wxPG_BASE_EVT_PRE_ID
+4)
1884 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_PAGE_CHANGED
, wxPG_BASE_EVT_PRE_ID
+5)
1885 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_ITEM_COLLAPSED
, wxPG_BASE_EVT_PRE_ID
+6)
1886 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_ITEM_EXPANDED
, wxPG_BASE_EVT_PRE_ID
+7)
1887 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_DOUBLE_CLICK
, wxPG_BASE_EVT_PRE_ID
+8)
1888 END_DECLARE_EVENT_TYPES()
1891 wxEVT_PG_SELECTED
= wxPG_BASE_EVT_PRE_ID
,
1894 wxEVT_PG_HIGHLIGHTED
,
1895 wxEVT_PG_RIGHT_CLICK
,
1896 wxEVT_PG_PAGE_CHANGED
,
1897 wxEVT_PG_ITEM_COLLAPSED
,
1898 wxEVT_PG_ITEM_EXPANDED
,
1899 wxEVT_PG_DOUBLE_CLICK
1904 #define wxPG_BASE_EVT_TYPE wxEVT_PG_SELECTED
1905 #define wxPG_MAX_EVT_TYPE (wxPG_BASE_EVT_TYPE+30)
1909 typedef void (wxEvtHandler::*wxPropertyGridEventFunction
)(wxPropertyGridEvent
&);
1911 #define EVT_PG_SELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1912 #define EVT_PG_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1913 #define EVT_PG_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1914 #define EVT_PG_HIGHLIGHTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_HIGHLIGHTED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1915 #define EVT_PG_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1916 #define EVT_PG_DOUBLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_DOUBLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1917 #define EVT_PG_PAGE_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_PAGE_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1918 #define EVT_PG_ITEM_COLLAPSED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1919 #define EVT_PG_ITEM_EXPANDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1921 #define wxPropertyGridEventHandler(A) \
1922 ((wxObjectEventFunction)(wxEventFunction)(wxPropertyGridEventFunction)&A)
1927 /** @class wxPropertyGridEvent
1929 A propertygrid event holds information about events associated with
1930 wxPropertyGrid objects.
1932 @library{wxpropgrid}
1935 class WXDLLIMPEXP_PROPGRID wxPropertyGridEvent
: public wxCommandEvent
1940 wxPropertyGridEvent(wxEventType commandType
=0, int id
=0);
1942 /** Copy constructor. */
1943 wxPropertyGridEvent(const wxPropertyGridEvent
& event
);
1946 ~wxPropertyGridEvent();
1949 virtual wxEvent
* Clone() const;
1951 wxPGProperty
* GetMainParent() const
1953 wxASSERT(m_property
);
1954 return m_property
->GetMainParent();
1957 /** Returns id of associated property. */
1958 wxPGProperty
* GetProperty() const
1963 wxPGValidationInfo
& GetValidationInfo()
1965 wxASSERT(m_validationInfo
);
1966 return *m_validationInfo
;
1969 /** Returns true if you can veto the action that the event is signaling.
1971 bool CanVeto() const { return m_canVeto
; }
1974 Call this from your event handler to veto action that the event is
1977 You can only veto a shutdown if wxPropertyGridEvent::CanVeto returns
1980 Currently only wxEVT_PG_CHANGING supports vetoing.
1982 void Veto( bool veto
= true ) { m_wasVetoed
= veto
; }
1984 /** Returns value that is about to be set for wxEVT_PG_CHANGING.
1986 const wxVariant
& GetValue() const
1988 wxASSERT_MSG( m_validationInfo
,
1989 "Only call GetValue from a handler "
1990 "of event type that supports it" );
1991 return m_validationInfo
->GetValue();
1995 Set override validation failure behavior.
1997 Only effective if Veto was also called, and only allowed if event type
1998 is wxEVT_PG_CHANGING.
2000 void SetValidationFailureBehavior( wxPGVFBFlags flags
)
2002 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2003 m_validationInfo
->SetFailureBehavior( flags
);
2006 /** Sets custom failure message for this time only. Only applies if
2007 wxPG_VFB_SHOW_MESSAGE is set in validation failure flags.
2009 void SetValidationFailureMessage( const wxString
& message
)
2011 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2012 m_validationInfo
->SetFailureMessage( message
);
2016 wxPGVFBFlags
GetValidationFailureBehavior() const
2018 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2019 return m_validationInfo
->GetFailureBehavior();
2022 void SetCanVeto( bool canVeto
) { m_canVeto
= canVeto
; }
2023 bool WasVetoed() const { return m_wasVetoed
; }
2025 /** Changes the associated property. */
2026 void SetProperty( wxPGProperty
* p
) { m_property
= p
; }
2028 void SetPropertyGrid( wxPropertyGrid
* pg
) { m_pg
= pg
; }
2030 void SetupValidationInfo()
2033 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2034 m_validationInfo
= &m_pg
->GetValidationInfo();
2039 DECLARE_DYNAMIC_CLASS(wxPropertyGridEvent
)
2041 wxPGProperty
* m_property
;
2042 wxPropertyGrid
* m_pg
;
2043 wxPGValidationInfo
* m_validationInfo
;
2052 // -----------------------------------------------------------------------
2054 /** @class wxPropertyGridPopulator
2056 Allows populating wxPropertyGrid from arbitrary text source.
2058 class WXDLLIMPEXP_PROPGRID wxPropertyGridPopulator
2061 /** Default constructor.
2063 wxPropertyGridPopulator();
2066 virtual ~wxPropertyGridPopulator();
2068 void SetState( wxPropertyGridPageState
* state
);
2070 void SetGrid( wxPropertyGrid
* pg
);
2072 /** Appends a new property under bottommost parent.
2074 Property class as string.
2076 wxPGProperty
* Add( const wxString
& propClass
,
2077 const wxString
& propLabel
,
2078 const wxString
& propName
,
2079 const wxString
* propValue
,
2080 wxPGChoices
* pChoices
= NULL
);
2083 Pushes property to the back of parent array (ie it becomes bottommost
2084 parent), and starts scanning/adding children for it.
2086 When finished, parent array is returned to the original state.
2088 void AddChildren( wxPGProperty
* property
);
2090 /** Adds attribute to the bottommost property.
2092 Allowed values: "string", (same as string), "int", "bool". Empty string
2095 bool AddAttribute( const wxString
& name
,
2096 const wxString
& type
,
2097 const wxString
& value
);
2099 /** Called once in AddChildren.
2101 virtual void DoScanForChildren() = 0;
2104 Returns id of parent property for which children can currently be
2107 wxPGProperty
* GetCurParent() const
2109 return (wxPGProperty
*) m_propHierarchy
[m_propHierarchy
.size()-1];
2112 wxPropertyGridPageState
* GetState() { return m_state
; }
2113 const wxPropertyGridPageState
* GetState() const { return m_state
; }
2115 /** Like wxString::ToLong, except allows N% in addition of N.
2117 static bool ToLongPCT( const wxString
& s
, long* pval
, long max
);
2119 /** Parses strings of format "choice1"[=value1] ... "choiceN"[=valueN] into
2120 wxPGChoices. Registers parsed result using idString (if not empty).
2121 Also, if choices with given id already registered, then don't parse but
2122 return those choices instead.
2124 wxPGChoices
ParseChoices( const wxString
& choicesString
,
2125 const wxString
& idString
);
2127 /** Implement in derived class to do custom process when an error occurs.
2128 Default implementation uses wxLogError.
2130 virtual void ProcessError( const wxString
& msg
);
2134 /** Used property grid. */
2135 wxPropertyGrid
* m_pg
;
2137 /** Used property grid state. */
2138 wxPropertyGridPageState
* m_state
;
2140 /** Tree-hierarchy of added properties (that can have children). */
2141 wxArrayPGProperty m_propHierarchy
;
2143 /** Hashmap for string-id to wxPGChoicesData mapping. */
2144 wxPGHashMapS2P m_dictIdChoices
;
2147 // -----------------------------------------------------------------------
2150 // Undefine macros that are not needed outside propertygrid sources
2152 #ifndef __wxPG_SOURCE_FILE__
2153 #undef wxPG_FL_DESC_REFRESH_REQUIRED
2154 #undef wxPG_FL_SCROLLBAR_DETECTED
2155 #undef wxPG_FL_CREATEDSTATE
2156 #undef wxPG_FL_NOSTATUSBARHELP
2157 #undef wxPG_FL_SCROLLED
2158 #undef wxPG_FL_FOCUS_INSIDE_CHILD
2159 #undef wxPG_FL_FOCUS_INSIDE
2160 #undef wxPG_FL_MOUSE_INSIDE_CHILD
2161 #undef wxPG_FL_CUR_USES_CUSTOM_IMAGE
2162 #undef wxPG_FL_PRIMARY_FILLS_ENTIRE
2163 #undef wxPG_FL_VALUE_MODIFIED
2164 #undef wxPG_FL_MOUSE_INSIDE
2165 #undef wxPG_FL_FOCUSED
2166 #undef wxPG_FL_MOUSE_CAPTURED
2167 #undef wxPG_FL_INITIALIZED
2168 #undef wxPG_FL_ACTIVATION_BY_CLICK
2169 #undef wxPG_FL_DONT_CENTER_SPLITTER
2170 #undef wxPG_SUPPORT_TOOLTIPS
2171 #undef wxPG_DOUBLE_BUFFER
2172 #undef wxPG_ICON_WIDTH
2173 #undef wxPG_USE_RENDERER_NATIVE
2174 // Following are needed by the manager headers
2175 // #undef const wxString&
2178 // -----------------------------------------------------------------------
2182 #endif // _WX_PROPGRID_PROPGRID_H_