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
,
424 wxPG_ACTION_PRESS_BUTTON
, // Causes editor button (if any) to be pressed
431 // -----------------------------------------------------------------------
434 // wxPropertyGrid::DoSelectProperty flags (selFlags)
436 // Focuses to created editor
437 #define wxPG_SEL_FOCUS 0x01
438 // Forces deletion and recreation of editor
439 #define wxPG_SEL_FORCE 0x02
440 // For example, doesn't cause EnsureVisible
441 #define wxPG_SEL_NONVISIBLE 0x04
442 // Do not validate editor's value before selecting
443 #define wxPG_SEL_NOVALIDATE 0x08
444 // Property being deselected is about to be deleted
445 #define wxPG_SEL_DELETING 0x10
446 // Property's values was set to unspecified by the user
447 #define wxPG_SEL_SETUNSPEC 0x20
448 // Property's event handler changed the value
449 #define wxPG_SEL_DIALOGVAL 0x40
452 // -----------------------------------------------------------------------
457 #define wxPG_FL_INITIALIZED 0x0001
458 // Set when creating editor controls if it was clicked on.
459 #define wxPG_FL_ACTIVATION_BY_CLICK 0x0002
460 #define wxPG_FL_DONT_CENTER_SPLITTER 0x0004
461 #define wxPG_FL_FOCUSED 0x0008
462 #define wxPG_FL_MOUSE_CAPTURED 0x0010
463 #define wxPG_FL_MOUSE_INSIDE 0x0020
464 #define wxPG_FL_VALUE_MODIFIED 0x0040
465 // don't clear background of m_wndEditor
466 #define wxPG_FL_PRIMARY_FILLS_ENTIRE 0x0080
467 // currently active editor uses custom image
468 #define wxPG_FL_CUR_USES_CUSTOM_IMAGE 0x0100
469 // cell colours override selection colours for selected cell
470 #define wxPG_FL_CELL_OVERRIDES_SEL 0x0200
471 #define wxPG_FL_SCROLLED 0x0400
472 // set when all added/inserted properties get hideable flag
473 #define wxPG_FL_ADDING_HIDEABLES 0x0800
474 // Disables showing help strings on statusbar.
475 #define wxPG_FL_NOSTATUSBARHELP 0x1000
476 // Marks that we created the state, so we have to destroy it too.
477 #define wxPG_FL_CREATEDSTATE 0x2000
478 // Set if scrollbar's existence was detected in last onresize.
479 #define wxPG_FL_SCROLLBAR_DETECTED 0x4000
480 // Set if wxPGMan requires redrawing of description text box.
481 #define wxPG_FL_DESC_REFRESH_REQUIRED 0x8000
482 // Set if contained in wxPropertyGridManager
483 #define wxPG_FL_IN_MANAGER 0x00020000
484 // Set after wxPropertyGrid is shown in its initial good size
485 #define wxPG_FL_GOOD_SIZE_SET 0x00040000
486 // Set when in SelectProperty.
487 #define wxPG_FL_IN_SELECT_PROPERTY 0x00100000
488 // Set when help string is shown in status bar
489 #define wxPG_FL_STRING_IN_STATUSBAR 0x00200000
490 // Splitter position has been custom-set by the user
491 #define wxPG_FL_SPLITTER_PRE_SET 0x00400000
492 // Validation failed. Clear on modify event.
493 #define wxPG_FL_VALIDATION_FAILED 0x00800000
494 // Set if selected is fully painted (ie. both image and text)
495 //#define wxPG_FL_SELECTED_IS_FULL_PAINT 0x01000000
496 // Set after page has been inserted to manager
497 #define wxPG_MAN_FL_PAGE_INSERTED 0x02000000
498 // Active editor control is abnormally large
499 #define wxPG_FL_ABNORMAL_EDITOR 0x04000000
500 // Recursion guard for OnCustomEditorEvent
501 #define wxPG_FL_IN_ONCUSTOMEDITOREVENT 0x08000000
502 #define wxPG_FL_VALUE_CHANGE_IN_EVENT 0x10000000
503 // Editor control width should not change on resize
504 #define wxPG_FL_FIXED_WIDTH_EDITOR 0x20000000
505 // Width of panel can be different than width of grid
506 #define wxPG_FL_HAS_VIRTUAL_WIDTH 0x40000000
507 // Prevents RecalculateVirtualSize re-entrancy
508 #define wxPG_FL_RECALCULATING_VIRTUAL_SIZE 0x80000000
510 #endif // #ifndef SWIG
512 #if !defined(__wxPG_SOURCE_FILE__) && !defined(SWIG)
513 // Reduce compile time, but still include in user app
514 #include "wx/propgrid/props.h"
517 // -----------------------------------------------------------------------
519 /** @class wxPropertyGrid
521 wxPropertyGrid is a specialized grid for editing properties
522 such as strings, numbers, flagsets, fonts, and colours. wxPropertySheet
523 used to do the very same thing, but it hasn't been updated for a while
524 and it is currently deprecated.
526 Please note that most member functions are inherited and as such not
527 documented on this page. This means you will probably also want to read
528 wxPropertyGridInterface class reference.
530 See also @ref overview_propgrid.
532 @section propgrid_window_styles_ Window Styles
534 See @ref propgrid_window_styles.
536 @section propgrid_event_handling Event Handling
538 To process input from a propertygrid control, use these event handler
539 macros to direct input to member functions that take a wxPropertyGridEvent
542 @beginEventTable{wxPropertyGridEvent}
543 @event{EVT_PG_SELECTED (id, func)}
544 Respond to wxEVT_PG_SELECTED event, generated when property value
545 has been changed by user.
546 @event{EVT_PG_CHANGING(id, func)}
547 Respond to wxEVT_PG_CHANGING event, generated when property value
548 is about to be changed by user. Use wxPropertyGridEvent::GetValue()
549 to take a peek at the pending value, and wxPropertyGridEvent::Veto()
550 to prevent change from taking place, if necessary.
551 @event{EVT_PG_HIGHLIGHTED(id, func)}
552 Respond to wxEVT_PG_HIGHLIGHTED event, which occurs when mouse
553 moves over a property. Event's property is NULL if hovered area does
554 not belong to any property.
555 @event{EVT_PG_RIGHT_CLICK(id, func)}
556 Respond to wxEVT_PG_RIGHT_CLICK event, which occurs when property is
557 clicked on with right mouse button.
558 @event{EVT_PG_DOUBLE_CLICK(id, func)}
559 Respond to wxEVT_PG_DOUBLE_CLICK event, which occurs when property is
560 double-clicked onwith left mouse button.
561 @event{EVT_PG_ITEM_COLLAPSED(id, func)}
562 Respond to wxEVT_PG_ITEM_COLLAPSED event, generated when user collapses
563 a property or category..
564 @event{EVT_PG_ITEM_EXPANDED(id, func)}
565 Respond to wxEVT_PG_ITEM_EXPANDED event, generated when user expands
566 a property or category..
571 - Use Freeze() and Thaw() respectively to disable and enable drawing. This
572 will also delay sorting etc. miscellaneous calculations to the last
578 class WXDLLIMPEXP_PROPGRID
579 wxPropertyGrid
: public wxScrolledWindow
, public wxPropertyGridInterface
581 friend class wxPropertyGridPageState
;
582 friend class wxPropertyGridInterface
;
583 friend class wxPropertyGridManager
;
584 friend class wxPGCanvas
;
587 DECLARE_DYNAMIC_CLASS(wxPropertyGrid
)
592 %pythonAppend wxPropertyGrid
{
593 self
._setOORInfo(self
)
594 self
.DoDefaultTypeMappings()
595 self
.edited_objects
= {}
596 self
.DoDefaultValueTypeMappings()
597 if not hasattr(self
.__class__
,'_vt2setter'):
598 self
.__class__
._vt2setter
= {}
600 %pythonAppend
wxPropertyGrid() ""
602 wxPropertyGrid( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
603 const wxPoint
& pos
= wxDefaultPosition
,
604 const wxSize
& size
= wxDefaultSize
,
605 long style
= wxPG_DEFAULT_STYLE
,
606 const wxChar
* name
= wxPyPropertyGridNameStr
);
607 %RenameCtor
(PrePropertyGrid
, wxPropertyGrid());
611 Two step constructor.
613 Call Create when this constructor is called to build up the
618 /** The default constructor. The styles to be used are styles valid for
619 the wxWindow and wxScrolledWindow.
620 @see @link wndflags Additional Window Styles@endlink
622 wxPropertyGrid( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
623 const wxPoint
& pos
= wxDefaultPosition
,
624 const wxSize
& size
= wxDefaultSize
,
625 long style
= wxPG_DEFAULT_STYLE
,
626 const wxChar
* name
= wxPropertyGridNameStr
);
629 virtual ~wxPropertyGrid();
632 /** Adds given key combination to trigger given action.
634 Which action to trigger. See @link pgactions List of list of
635 wxPropertyGrid actions@endlink.
637 void AddActionTrigger( int action
, int keycode
, int modifiers
= 0 );
640 This static function enables or disables automatic use of
641 wxGetTranslation for following strings: wxEnumProperty list labels,
642 wxFlagsProperty sub-property labels.
646 static void AutoGetTranslation( bool enable
);
649 Changes value of a property, as if from an editor.
651 Use this instead of SetPropertyValue() if you need the value to run
652 through validation process, and also send the property change event.
655 Returns true if value was successfully changed.
657 bool ChangePropertyValue( wxPGPropArg id
, wxVariant newValue
);
660 Centers the splitter.
662 If argument is true, automatic splitter centering is enabled (only
663 applicapple if style wxPG_SPLITTER_AUTO_CENTER was defined).
665 void CenterSplitter( bool enable_auto_centering
= false );
667 /** Deletes all properties.
669 virtual void Clear();
671 /** Clears action triggers for given action.
673 Which action to trigger. See @link pgactions List of list of
674 wxPropertyGrid actions@endlink.
676 void ClearActionTriggers( int action
);
678 /** Forces updating the value of property from the editor control.
680 Note that wxEVT_PG_CHANGING and wxEVT_PG_CHANGED are dispatched using
681 ProcessEvent, meaning your event handlers will be called immediately.
684 Returns true if anything was changed.
686 virtual bool CommitChangesFromEditor( wxUint32 flags
= 0 );
691 Whenever the control is created without any parameters, use Create to
692 actually create it. Don't access the control's public methods before
693 this is called @see @link wndflags Additional Window Styles@endlink
695 bool Create( wxWindow
*parent
, wxWindowID id
= wxID_ANY
,
696 const wxPoint
& pos
= wxDefaultPosition
,
697 const wxSize
& size
= wxDefaultSize
,
698 long style
= wxPG_DEFAULT_STYLE
,
699 const wxChar
* name
= wxPropertyGridNameStr
);
702 Call when editor widget's contents is modified.
704 For example, this is called when changes text in wxTextCtrl (used in
705 wxStringProperty and wxIntProperty).
708 This function should only be called by custom properties.
710 @see wxPGProperty::OnEvent()
712 void EditorsValueWasModified() { m_iFlags
|= wxPG_FL_VALUE_MODIFIED
; }
714 /** Reverse of EditorsValueWasModified().
717 This function should only be called by custom properties.
719 void EditorsValueWasNotModified()
721 m_iFlags
&= ~(wxPG_FL_VALUE_MODIFIED
);
725 Enables or disables (shows/hides) categories according to parameter
728 bool EnableCategories( bool enable
);
730 /** Scrolls and/or expands items to ensure that the given item is visible.
731 Returns true if something was actually done.
733 bool EnsureVisible( wxPGPropArg id
);
736 Reduces column sizes to minimum possible that contents are still
737 visibly (naturally some margin space will be applied as well).
740 Minimum size for the grid to still display everything.
743 Does not work well with wxPG_SPLITTER_AUTO_CENTER window style.
745 This function only works properly if grid size prior to call was already
748 Note that you can also get calculated column widths by calling
749 GetState->GetColumnWidth() immediately after this function returns.
753 wxSize sz
= m_pState
->DoFitColumns();
758 Returns wxWindow that the properties are painted on, and which should
759 be used as the parent for editor controls.
761 wxPanel
* GetPanel() const
766 /** Returns current category caption background colour. */
767 wxColour
GetCaptionBackgroundColour() const { return m_colCapBack
; }
769 wxFont
& GetCaptionFont() { return m_captionFont
; }
771 const wxFont
& GetCaptionFont() const { return m_captionFont
; }
773 /** Returns current category caption text colour. */
774 wxColour
GetCaptionForegroundColour() const { return m_colCapFore
; }
776 /** Returns current cell background colour. */
777 wxColour
GetCellBackgroundColour() const { return m_colPropBack
; }
779 /** Returns current cell text colour when disabled. */
780 wxColour
GetCellDisabledTextColour() const { return m_colDisPropFore
; }
782 /** Returns current cell text colour. */
783 wxColour
GetCellTextColour() const { return m_colPropFore
; }
786 Returns number of columns currently on grid.
788 unsigned int GetColumnCount() const
790 return (unsigned int) m_pState
->m_colWidths
.size();
793 /** Returns colour of empty space below properties. */
794 wxColour
GetEmptySpaceColour() const { return m_colEmptySpace
; }
796 /** Returns height of highest characters of used font. */
797 int GetFontHeight() const { return m_fontHeight
; }
799 /** Returns pointer to itself. Dummy function that enables same kind
800 of code to use wxPropertyGrid and wxPropertyGridManager.
802 wxPropertyGrid
* GetGrid() { return this; }
804 /** Returns rectangle of custom paint image.
806 wxRect
GetImageRect( wxPGProperty
* p
, int item
) const;
808 /** Returns size of the custom paint image in front of property.
809 If no argument is given, returns preferred size.
811 wxSize
GetImageSize( wxPGProperty
* p
= NULL
, int item
= -1 ) const;
814 /** Returns last item which could be iterated using given flags.
816 See @ref propgrid_iterator_flags.
818 wxPGProperty
* GetLastItem( int flags
= wxPG_ITERATE_DEFAULT
)
820 return m_pState
->GetLastItem(flags
);
823 const wxPGProperty
* GetLastItem( int flags
= wxPG_ITERATE_DEFAULT
) const
825 return m_pState
->GetLastItem(flags
);
829 /** Returns colour of lines between cells. */
830 wxColour
GetLineColour() const { return m_colLine
; }
832 /** Returns background colour of margin. */
833 wxColour
GetMarginColour() const { return m_colMargin
; }
836 Returns most up-to-date value of selected property. This will return
837 value different from GetSelectedProperty()->GetValue() only when text
838 editor is activate and string edited by user represents valid,
839 uncommitted property value.
841 wxVariant
GetUncommittedPropertyValue();
843 /** Returns cell background colour of a property. */
844 wxColour
GetPropertyBackgroundColour( wxPGPropArg id
) const;
846 /** Returns cell background colour of a property. */
847 wxColour
GetPropertyTextColour( wxPGPropArg id
) const;
849 /** Returns "root property". It does not have name, etc. and it is not
850 visible. It is only useful for accessing its children.
852 wxPGProperty
* GetRoot() const { return m_pState
->m_properties
; }
854 /** Returns height of a single grid row (in pixels). */
855 int GetRowHeight() const { return m_lineHeight
; }
857 /** Returns currently selected property. */
858 wxPGProperty
* GetSelectedProperty() const { return GetSelection(); }
860 /** Returns currently selected property. */
861 wxPGProperty
* GetSelection() const
866 /** Returns current selection background colour. */
867 wxColour
GetSelectionBackgroundColour() const { return m_colSelBack
; }
869 /** Returns current selection text colour. */
870 wxColour
GetSelectionForegroundColour() const { return m_colSelFore
; }
872 /** Returns current splitter x position. */
873 int GetSplitterPosition() const
874 { return m_pState
->DoGetSplitterPosition(0); }
876 /** Returns wxTextCtrl active in currently selected property, if any. Takes
877 into account wxOwnerDrawnComboBox.
879 wxTextCtrl
* GetEditorTextCtrl() const;
881 wxPGValidationInfo
& GetValidationInfo()
883 return m_validationInfo
;
886 /** Returns current vertical spacing. */
887 int GetVerticalSpacing() const { return (int)m_vspacing
; }
889 /** Returns true if editor's value was marked modified.
891 bool IsEditorsValueModified() const
892 { return ( m_iFlags
& wxPG_FL_VALUE_MODIFIED
) ? true : false; }
894 /** Returns information about arbitrary position in the grid.
896 For wxPropertyGridHitTestResult definition, see
897 wxPropertyGridPageState::HitTest().
899 wxPropertyGridHitTestResult
HitTest( const wxPoint
& pt
) const;
901 /** Returns true if any property has been modified by the user. */
902 bool IsAnyModified() const { return (m_pState
->m_anyModified
>0); }
905 Returns true if updating is frozen (ie Freeze() called but not yet
908 bool IsFrozen() const { return (m_frozen
>0)?true:false; }
910 /** Redraws given property.
912 virtual void RefreshProperty( wxPGProperty
* p
);
915 /** Registers a new editor class.
917 Pointer to the editor class instance that should be used.
919 static wxPGEditor
* RegisterEditorClass( wxPGEditor
* editor
,
920 bool noDefCheck
= false );
923 /** Resets all colours to the original system values.
929 Editor widget is automatically created, but not focused unless focus is
930 true. This will generate wxEVT_PG_SELECT event.
934 True if selection finished successfully. Usually only fails if
935 current value in editor is not valid.
936 @see wxPropertyGrid::Unselect
938 bool SelectProperty( wxPGPropArg id
, bool focus
= false )
940 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
941 return DoSelectProperty(p
,focus
?wxPG_SEL_FOCUS
:0);
944 /** Sets category caption background colour. */
945 void SetCaptionBackgroundColour(const wxColour
& col
);
947 /** Sets category caption text colour. */
948 void SetCaptionTextColour(const wxColour
& col
);
950 /** Sets default cell background colour - applies to property cells.
951 Note that appearance of editor widgets may not be affected.
953 void SetCellBackgroundColour(const wxColour
& col
);
955 /** Sets cell text colour for disabled properties.
957 void SetCellDisabledTextColour(const wxColour
& col
);
959 /** Sets default cell text colour - applies to property name and value text.
960 Note that appearance of editor widgets may not be affected.
962 void SetCellTextColour(const wxColour
& col
);
964 /** Set number of columns (2 or more).
966 void SetColumnCount( int colCount
)
968 m_pState
->SetColumnCount(colCount
);
973 Sets the 'current' category - Append will add non-category properties
976 void SetCurrentCategory( wxPGPropArg id
)
978 wxPG_PROP_ARG_CALL_PROLOG()
979 wxPropertyCategory
* pc
= wxDynamicCast(p
, wxPropertyCategory
);
981 m_pState
->m_currentCategory
= pc
;
984 /** Sets colour of empty space below properties. */
985 void SetEmptySpaceColour(const wxColour
& col
);
987 /** Sets colour of lines between cells. */
988 void SetLineColour(const wxColour
& col
);
990 /** Sets background colour of margin. */
991 void SetMarginColour(const wxColour
& col
);
993 /** Sets background colour of property and all its children. Colours of
994 captions are not affected. Background brush cache is optimized for often
995 set colours to be set last.
997 void SetPropertyBackgroundColour( wxPGPropArg id
, const wxColour
& col
);
999 /** Resets text and background colours of given property.
1001 void SetPropertyColoursToDefault( wxPGPropArg id
);
1003 /** Sets text colour of property and all its children.
1005 void SetPropertyTextColour( wxPGPropArg id
,
1006 const wxColour
& col
,
1007 bool recursively
= true );
1010 Sets selection background colour - applies to selected property name
1013 void SetSelectionBackgroundColour(const wxColour
& col
);
1016 Sets selection foreground colour - applies to selected property name
1019 void SetSelectionTextColour(const wxColour
& col
);
1021 /** Sets x coordinate of the splitter.
1023 Splitter position cannot exceed grid size, and therefore setting it
1024 during form creation may fail as initial grid size is often smaller
1025 than desired splitter position, especially when sizers are being used.
1027 void SetSplitterPosition( int newxpos
, int col
= 0 )
1029 DoSetSplitterPosition_(newxpos
, true, col
);
1030 m_iFlags
|= wxPG_FL_SPLITTER_PRE_SET
;
1033 /** Set virtual width for this particular page. Width -1 indicates that the
1034 virtual width should be disabled. */
1035 void SetVirtualWidth( int width
);
1038 Moves splitter as left as possible, while still allowing all
1039 labels to be shown in full.
1041 @param privateChildrenToo
1042 If @false, will still allow private children to be cropped.
1044 void SetSplitterLeft( bool privateChildrenToo
= false )
1046 m_pState
->SetSplitterLeft(privateChildrenToo
);
1049 /** Sets vertical spacing. Can be 1, 2, or 3 - a value relative to font
1050 height. Value of 2 should be default on most platforms.
1052 void SetVerticalSpacing( int vspacing
)
1054 m_vspacing
= (unsigned char)vspacing
;
1055 CalculateFontAndBitmapStuff( vspacing
);
1056 if ( !m_pState
->m_itemsAdded
) Refresh();
1059 /** Shows an brief error message that is related to a property. */
1060 void ShowPropertyError( wxPGPropArg id
, const wxString
& msg
)
1062 wxPG_PROP_ARG_CALL_PROLOG()
1063 DoShowPropertyError(p
, msg
);
1066 /** Sorts all items at all levels (except sub-properties). */
1069 /** Sorts children of a category.
1071 void SortChildren( wxPGPropArg id
);
1073 /////////////////////////////////////////////////////////////////
1075 // Following methods do not need to be (currently) documented
1077 /////////////////////////////////////////////////////////////////
1079 bool HasVirtualWidth() const
1080 { return (m_iFlags
& wxPG_FL_HAS_VIRTUAL_WIDTH
) ? true : false; }
1082 const wxPGCommonValue
* GetCommonValue( unsigned int i
) const
1084 return (wxPGCommonValue
*) m_commonValues
[i
];
1087 /** Returns number of common values.
1089 unsigned int GetCommonValueCount() const
1091 return (unsigned int) m_commonValues
.size();
1094 /** Returns label of given common value.
1096 wxString
GetCommonValueLabel( unsigned int i
) const
1098 wxASSERT( GetCommonValue(i
) );
1099 return GetCommonValue(i
)->GetLabel();
1103 Returns index of common value that will truly change value to
1106 int GetUnspecifiedCommonValue() const { return m_cvUnspecified
; }
1108 /** Set index of common value that will truly change value to unspecified.
1109 Using -1 will set none to have such effect.
1112 void SetUnspecifiedCommonValue( int index
) { m_cvUnspecified
= index
; }
1115 Shortcut for creating dialog-caller button. Used, for example, by
1118 This should only be called by properties.
1120 wxWindow
* GenerateEditorButton( const wxPoint
& pos
, const wxSize
& sz
);
1122 /** Fixes position of wxTextCtrl-like control (wxSpinCtrl usually
1123 fits as one). Call after control has been created (but before
1126 void FixPosForTextCtrl( wxWindow
* ctrl
,
1127 const wxPoint
& offset
= wxPoint(0, 0) );
1129 /** Shortcut for creating text editor widget.
1131 Same as pos given for CreateEditor.
1133 Same as sz given for CreateEditor.
1135 Initial text for wxTextCtrl.
1137 If right-side control, such as button, also created, then create it
1138 first and pass it as this parameter.
1140 Extra style flags to pass for wxTextCtrl.
1142 Note that this should generally be called only by new classes derived
1145 wxWindow
* GenerateEditorTextCtrl( const wxPoint
& pos
,
1147 const wxString
& value
,
1148 wxWindow
* secondary
,
1152 /* Generates both textctrl and button.
1154 wxWindow
* GenerateEditorTextCtrlAndButton( const wxPoint
& pos
,
1155 const wxSize
& sz
, wxWindow
** psecondary
, int limited_editing
,
1156 wxPGProperty
* property
);
1158 /** Generates position for a widget editor dialog box.
1160 Property for which dialog is positioned.
1162 Known or over-approximated size of the dialog.
1164 Position for dialog.
1166 wxPoint
GetGoodEditorDialogPosition( wxPGProperty
* p
,
1169 // Converts escape sequences in src_str to newlines,
1170 // tabs, etc. and copies result to dst_str.
1171 static wxString
& ExpandEscapeSequences( wxString
& dst_str
,
1172 wxString
& src_str
);
1174 // Converts newlines, tabs, etc. in src_str to escape
1175 // sequences, and copies result to dst_str.
1176 static wxString
& CreateEscapeSequences( wxString
& dst_str
,
1177 wxString
& src_str
);
1180 Returns rectangle that fully contains properties between and including
1183 wxRect
GetPropertyRect( const wxPGProperty
* p1
,
1184 const wxPGProperty
* p2
) const;
1186 /** Returns pointer to current active primary editor control (NULL if none).
1188 wxWindow
* GetEditorControl() const;
1190 wxWindow
* GetPrimaryEditor() const
1192 return GetEditorControl();
1196 Returns pointer to current active secondary editor control (NULL if
1199 wxWindow
* GetEditorControlSecondary() const
1201 return m_wndEditor2
;
1207 Generates contents for string dst based on the contents of
1210 Format will be "(preDelim)str1(postDelim) (preDelim)str2(postDelim) and
1211 so on. Set flags to 1 inorder to convert backslashes to double-back-
1212 slashes and "(preDelims)"'s to "(preDelims)".
1214 static void ArrayStringToString( wxString
& dst
, const wxArrayString
& src
,
1215 wxChar preDelim
, wxChar postDelim
,
1218 // Mostly useful for page switching.
1219 void SwitchState( wxPropertyGridPageState
* pNewState
);
1221 /** Pass this function to Connect calls in propertyclass::CreateEditor.
1223 void OnCustomEditorEvent( wxCommandEvent
&event
);
1225 long GetInternalFlags() const { return m_iFlags
; }
1226 bool HasInternalFlag( long flag
) const
1227 { return (m_iFlags
& flag
) ? true : false; }
1228 void SetInternalFlag( long flag
) { m_iFlags
|= flag
; }
1229 void ClearInternalFlag( long flag
) { m_iFlags
&= ~(flag
); }
1230 void IncFrozen() { m_frozen
++; }
1231 void DecFrozen() { m_frozen
--; }
1233 void OnComboItemPaint( wxPGCustomComboControl
* pCb
,int item
,wxDC
& dc
,
1234 wxRect
& rect
,int flags
);
1236 /** Standardized double-to-string conversion.
1238 static void DoubleToString( wxString
& target
,
1242 wxString
* precTemplate
);
1245 Call this from wxPGProperty::OnEvent() to cause property value to be
1246 changed after the function returns (with true as return value).
1247 ValueChangeInEvent() must be used if you wish the application to be
1248 able to use wxEVT_PG_CHANGING to potentially veto the given value.
1250 void ValueChangeInEvent( wxVariant variant
)
1252 m_changeInEventValue
= variant
;
1253 m_iFlags
|= wxPG_FL_VALUE_CHANGE_IN_EVENT
;
1256 /** Returns true if given event is from first of an array of buttons
1257 (as can be in case when wxPGMultiButton is used).
1259 bool IsMainButtonEvent( const wxEvent
& event
)
1261 return (event
.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED
)
1262 && (m_wndSecId
== event
.GetId());
1265 /** Pending value is expected to be passed in PerformValidation().
1267 virtual bool DoPropertyChanged( wxPGProperty
* p
,
1268 unsigned int selFlags
= 0 );
1270 /** Called when validation for given property fails.
1272 Value which failed in validation.
1274 Return true if user is allowed to change to another property even
1275 if current has invalid value.
1277 To add your own validation failure behavior, override
1278 wxPropertyGrid::DoOnValidationFailure().
1280 bool OnValidationFailure( wxPGProperty
* property
, wxVariant
& invalidValue
)
1282 bool res
= DoOnValidationFailure(property
, invalidValue
);
1283 property
->SetFlag(wxPG_PROP_INVALID_VALUE
);
1287 /** Called to indicate property and editor has valid value now.
1289 void OnValidationFailureReset( wxPGProperty
* property
)
1291 if ( property
&& property
->HasFlag(wxPG_PROP_INVALID_VALUE
) )
1293 DoOnValidationFailureReset(property
);
1294 property
->ClearFlag(wxPG_PROP_INVALID_VALUE
);
1296 m_validationInfo
.m_failureMessage
.clear();
1299 /** Override in derived class to display error messages in custom manner
1300 (these message usually only result from validation failure).
1302 virtual void DoShowPropertyError( wxPGProperty
* property
,
1303 const wxString
& msg
);
1305 /** Override to customize property validation failure behavior.
1307 Value which failed in validation.
1309 Return true if user is allowed to change to another property even
1310 if current has invalid value.
1312 virtual bool DoOnValidationFailure( wxPGProperty
* property
,
1313 wxVariant
& invalidValue
);
1315 /** Override to customize resetting of property validation failure status.
1317 Property is guaranteed to have flag wxPG_PROP_INVALID_VALUE set.
1319 virtual void DoOnValidationFailureReset( wxPGProperty
* property
);
1321 int GetSpacingY() const { return m_spacingy
; }
1324 Must be called in wxPGEditor::CreateControls() if primary editor window
1325 is wxTextCtrl, just before textctrl is created.
1327 Initial text value of created wxTextCtrl.
1329 void SetupTextCtrlValue( const wxString text
) { m_prevTcValue
= text
; }
1332 Unfocuses or closes editor if one was open, but does not deselect
1335 bool UnfocusEditor();
1340 wxPropertyGridPageState used by the grid is created here.
1342 If grid is used in wxPropertyGridManager, there is no point overriding
1343 this - instead, set custom wxPropertyGridPage classes.
1345 virtual wxPropertyGridPageState
* CreateState() const;
1347 enum PerformValidationFlags
1349 SendEvtChanging
= 0x0001,
1350 IsStandaloneValidation
= 0x0002 // Not called in response to event
1354 Runs all validation functionality (includes sending wxEVT_PG_CHANGING).
1355 Returns true if all tests passed. Implement in derived class to
1356 add additional validation behavior.
1358 virtual bool PerformValidation( wxPGProperty
* p
,
1359 wxVariant
& pendingValue
,
1360 int flags
= SendEvtChanging
);
1364 // Control font changer helper.
1365 void SetCurControlBoldFont();
1368 // Public methods for semi-public use
1369 // (not protected for optimization)
1371 bool DoSelectProperty( wxPGProperty
* p
, unsigned int flags
= 0 );
1373 // Overridden functions.
1374 virtual bool Destroy();
1375 virtual wxSize
DoGetBestSize() const;
1376 // Returns property at given y coordinate (relative to grid's top left).
1377 wxPGProperty
* GetItemAtY( int y
) const { return DoGetItemAtY(y
); }
1379 virtual void Refresh( bool eraseBackground
= true,
1380 const wxRect
*rect
= (const wxRect
*) NULL
);
1381 virtual bool SetFont( const wxFont
& font
);
1382 #if wxPG_SUPPORT_TOOLTIPS
1383 void SetToolTip( const wxString
& tipString
);
1385 virtual void Freeze();
1386 virtual void SetExtraStyle( long exStyle
);
1387 virtual void Thaw();
1392 #ifndef wxPG_ICON_WIDTH
1393 wxBitmap
*m_expandbmp
, *m_collbmp
;
1396 wxCursor
*m_cursorSizeWE
;
1398 /** wxWindow pointers to editor control(s). */
1399 wxWindow
*m_wndEditor
;
1400 wxWindow
*m_wndEditor2
;
1402 /** wxPGCanvas instance. */
1405 #if wxPG_DOUBLE_BUFFER
1406 wxBitmap
*m_doubleBuffer
;
1409 /** Local time ms when control was created. */
1410 wxLongLong m_timeCreated
;
1412 /** wxPGProperty::OnEvent can change value by setting this. */
1413 wxVariant m_changeInEventValue
;
1415 /** Id of m_wndEditor2, or its first child, if any. */
1418 /** Extra Y spacing between the items. */
1421 /** Control client area width; updated on resize. */
1424 /** Control client area height; updated on resize. */
1427 /** Current non-client width (needed when auto-centering). */
1430 /** Non-client width (auto-centering helper). */
1433 /** Previously recorded scroll start position. */
1437 The gutter spacing in front and back of the image.
1438 This determines the amount of spacing in front of each item
1442 /** Includes separator line. */
1445 /** Gutter*2 + image width. */
1448 // y spacing for expand/collapse button.
1449 int m_buttonSpacingY
;
1451 /** Extra margin for expanded sub-group items. */
1452 int m_subgroup_extramargin
;
1455 The image width of the [+] icon.
1457 This is also calculated in the gutter
1461 #ifndef wxPG_ICON_WIDTH
1464 The image height of the [+] icon.
1466 This is calculated as minimal size and to align
1471 /** Current cursor id. */
1475 This captionFont is made equal to the font of the wxScrolledWindow.
1477 As extra the bold face is set on it when this is wanted by the user
1480 wxFont m_captionFont
;
1482 int m_fontHeight
; // Height of the font.
1484 /** m_splitterx when drag began. */
1485 int m_startingSplitterX
;
1488 Index to splitter currently being dragged (0=one after the first
1491 int m_draggedSplitter
;
1493 /** Changed property, calculated in PerformValidation(). */
1494 wxPGProperty
* m_chgInfo_changedProperty
;
1497 Lowest property for which editing happened, but which does not have
1500 wxPGProperty
* m_chgInfo_baseChangedProperty
;
1502 /** Changed property value, calculated in PerformValidation(). */
1503 wxVariant m_chgInfo_pendingValue
;
1505 /** Passed to SetValue. */
1506 wxVariant m_chgInfo_valueList
;
1508 /** Validation information. */
1509 wxPGValidationInfo m_validationInfo
;
1511 /** Actions and keys that trigger them. */
1512 wxPGHashMapI2I m_actionTriggers
;
1518 /** Bits are used to indicate which colours are customized. */
1519 unsigned short m_coloursCustomized
;
1521 /** x - m_splitterx. */
1522 signed char m_dragOffset
;
1524 /** 0 = not dragging, 1 = drag just started, 2 = drag in progress */
1525 unsigned char m_dragStatus
;
1527 /** 0 = margin, 1 = label, 2 = value. */
1528 unsigned char m_mouseSide
;
1530 /** True when editor control is focused. */
1531 unsigned char m_editorFocused
;
1533 /** 1 if m_latsCaption is also the bottommost caption. */
1534 //unsigned char m_lastCaptionBottomnest;
1536 /** Set to 1 when graphics frozen. */
1537 unsigned char m_frozen
;
1539 unsigned char m_vspacing
;
1541 // Used to track when Alt/Ctrl+Key was consumed.
1542 unsigned char m_keyComboConsumed
;
1544 /** 1 if in DoPropertyChanged() */
1545 unsigned char m_inDoPropertyChanged
;
1547 /** 1 if in CommitChangesFromEditor() */
1548 unsigned char m_inCommitChangesFromEditor
;
1550 /** 1 if in DoSelectProperty() */
1551 unsigned char m_inDoSelectProperty
;
1553 wxPGVFBFlags m_permanentValidationFailureBehavior
; // Set by app
1555 /** Internal flags - see wxPG_FL_XXX constants. */
1558 /** When drawing next time, clear this many item slots at the end. */
1559 int m_clearThisMany
;
1561 /** Pointer to selected property. Note that this is duplicated in
1562 m_state for better transiency between pages so that the selected
1563 item can be retained.
1565 wxPGProperty
* m_selected
;
1567 // pointer to property that has mouse hovering
1568 wxPGProperty
* m_propHover
;
1570 // EventObject for wxPropertyGridEvents
1571 wxWindow
* m_eventObject
;
1573 // What (global) window is currently focused (needed to resolve event
1575 wxWindow
* m_curFocused
;
1578 wxEvtHandler
* m_tlwHandler
;
1583 // y coordinate of property that mouse hovering
1585 // Which column's editor is selected (usually 1)?
1588 // x relative to splitter (needed for resize).
1591 // lines between cells
1593 // property labels and values are written in this colour
1594 wxColour m_colPropFore
;
1595 // or with this colour when disabled
1596 wxColour m_colDisPropFore
;
1597 // background for m_colPropFore
1598 wxColour m_colPropBack
;
1599 // text color for captions
1600 wxColour m_colCapFore
;
1601 // background color for captions
1602 wxColour m_colCapBack
;
1603 // foreground for selected property
1604 wxColour m_colSelFore
;
1605 // background for selected property (actually use background color when
1606 // control out-of-focus)
1607 wxColour m_colSelBack
;
1608 // background colour for margin
1609 wxColour m_colMargin
;
1610 // background colour for empty space below the grid
1611 wxColour m_colEmptySpace
;
1613 // NB: These *cannot* be moved to globals.
1615 // Array of background colour brushes.
1616 wxArrayPtrVoid m_arrBgBrushes
;
1618 // Array of foreground colours.
1619 wxArrayPtrVoid m_arrFgCols
;
1621 // labels when properties use common values
1622 wxVector
<wxPGCommonValue
*> m_commonValues
;
1624 // Which cv selection really sets value to unspecified?
1625 int m_cvUnspecified
;
1627 // Used to skip excess text editor events
1628 wxString m_prevTcValue
;
1632 // Sets some members to defaults (called constructors).
1635 // Initializes some members (called by Create and complex constructor).
1638 void OnPaint(wxPaintEvent
&event
);
1640 // main event receivers
1641 void OnMouseMove( wxMouseEvent
&event
);
1642 void OnMouseMoveBottom( wxMouseEvent
&event
);
1643 void OnMouseClick( wxMouseEvent
&event
);
1644 void OnMouseRightClick( wxMouseEvent
&event
);
1645 void OnMouseDoubleClick( wxMouseEvent
&event
);
1646 void OnMouseUp( wxMouseEvent
&event
);
1647 void OnKey( wxKeyEvent
&event
);
1648 void OnKeyUp( wxKeyEvent
&event
);
1649 void OnResize( wxSizeEvent
&event
);
1652 bool HandleMouseMove( int x
, unsigned int y
, wxMouseEvent
&event
);
1653 bool HandleMouseClick( int x
, unsigned int y
, wxMouseEvent
&event
);
1654 bool HandleMouseRightClick( int x
, unsigned int y
, wxMouseEvent
&event
);
1655 bool HandleMouseDoubleClick( int x
, unsigned int y
, wxMouseEvent
&event
);
1656 bool HandleMouseUp( int x
, unsigned int y
, wxMouseEvent
&event
);
1657 void HandleKeyEvent( wxKeyEvent
&event
);
1658 // Handle TAB and ESCAPE in control
1659 bool HandleChildKey( wxKeyEvent
& event
);
1661 void OnMouseEntry( wxMouseEvent
&event
);
1663 void OnIdle( wxIdleEvent
&event
);
1664 void OnFocusEvent( wxFocusEvent
&event
);
1665 void OnChildFocusEvent( wxChildFocusEvent
& event
);
1667 bool OnMouseCommon( wxMouseEvent
&event
, int* px
, int *py
);
1668 bool OnMouseChildCommon( wxMouseEvent
&event
, int* px
, int *py
);
1670 // sub-control event handlers
1671 void OnMouseClickChild( wxMouseEvent
&event
);
1672 void OnMouseRightClickChild( wxMouseEvent
&event
);
1673 void OnMouseMoveChild( wxMouseEvent
&event
);
1674 void OnMouseUpChild( wxMouseEvent
&event
);
1675 void OnChildKeyDown( wxKeyEvent
&event
);
1676 void OnChildKeyUp( wxKeyEvent
&event
);
1678 void OnCaptureChange( wxMouseCaptureChangedEvent
&event
);
1680 void OnScrollEvent( wxScrollWinEvent
&event
);
1682 void OnSysColourChanged( wxSysColourChangedEvent
&event
);
1687 Adjust the centering of the bitmap icons (collapse / expand) when the
1688 caption font changes.
1690 They need to be centered in the middle of the font, so a bit of deltaY
1691 adjustment is needed. On entry, m_captionFont must be set to window
1692 font. It will be modified properly.
1694 void CalculateFontAndBitmapStuff( int vspacing
);
1696 wxRect
GetEditorWidgetRect( wxPGProperty
* p
, int column
) const;
1698 void CorrectEditorWidgetSizeX();
1700 /** Called in RecalculateVirtualSize() to reposition control
1701 on virtual height changes.
1703 void CorrectEditorWidgetPosY();
1707 void OnScreenNote( const wxChar
* format
, ... );
1710 /** Deselect current selection, if any. Returns true if success
1711 (ie. validator did not intercept). */
1712 bool DoClearSelection();
1714 int DoDrawItems( wxDC
& dc
,
1715 const wxPGProperty
* first_item
,
1716 const wxPGProperty
* last_item
,
1717 const wxRect
* clip_rect
,
1718 bool isBuffered
) const;
1720 void DoSetPropertyValueUnspecified( wxPGProperty
* p
);
1722 /** Draws an expand/collapse (ie. +/-) button.
1724 virtual void DrawExpanderButton( wxDC
& dc
, const wxRect
& rect
,
1725 wxPGProperty
* property
) const;
1727 /** Draws items from topitemy to bottomitemy */
1728 void DrawItems( wxDC
& dc
, unsigned int topitemy
, unsigned int bottomitemy
,
1729 const wxRect
* clip_rect
= (const wxRect
*) NULL
);
1731 void DrawItems( const wxPGProperty
* p1
, const wxPGProperty
* p2
);
1733 void DrawItem( wxPGProperty
* p
)
1738 virtual void DrawItemAndChildren( wxPGProperty
* p
);
1741 Draws item, children, and consequtive parents as long as category is
1744 void DrawItemAndValueRelated( wxPGProperty
* p
);
1746 // Translate wxKeyEvent to wxPG_ACTION_XXX
1747 int KeyEventToActions(wxKeyEvent
&event
, int* pSecond
) const;
1749 int KeyEventToAction(wxKeyEvent
&event
) const
1751 return KeyEventToActions(event
, NULL
);
1754 void ImprovedClientToScreen( int* px
, int* py
);
1756 // Called by focus event handlers. newFocused is the window that becomes
1758 void HandleFocusChange( wxWindow
* newFocused
);
1760 /** Reloads all non-customized colours from system settings. */
1761 void RegainColours();
1763 bool DoEditorValidate();
1765 wxPGProperty
* DoGetItemAtY( int y
) const;
1767 void DoSetSplitterPosition_( int newxpos
,
1768 bool refresh
= true,
1769 int splitterIndex
= 0,
1770 bool allPages
= false );
1774 virtual bool DoExpand( wxPGProperty
* p
, bool sendEvent
= false );
1776 virtual bool DoCollapse( wxPGProperty
* p
, bool sendEvent
= false );
1778 // Returns nearest paint visible property (such that will be painted unless
1779 // window is scrolled or resized). If given property is paint visible, then
1780 // it itself will be returned.
1781 wxPGProperty
* GetNearestPaintVisible( wxPGProperty
* p
) const;
1783 static void RegisterDefaultEditors();
1785 // Sets m_bgColIndex to this property and all its children.
1786 void SetBackgroundColourIndex( wxPGProperty
* p
, int index
);
1788 // Sets m_fgColIndex to this property and all its children.
1789 void SetTextColourIndex( wxPGProperty
* p
, int index
, int flags
);
1791 int CacheColour( const wxColour
& colour
);
1793 // Sets up basic event handling for child control
1794 void SetupChildEventHandling( wxWindow
* wnd
);
1796 void CustomSetCursor( int type
, bool override
= false );
1798 virtual bool ProcessEvent(wxEvent
& event
);
1799 virtual void SetWindowStyleFlag( long style
);
1802 Repositions scrollbar and underlying panel according to changed virtual
1805 void RecalculateVirtualSize( int forceXPos
= -1 );
1807 void PrepareAfterItemsAdded();
1809 bool SendEvent( int eventType
,
1811 wxVariant
* pValue
= NULL
,
1812 unsigned int selFlags
= 0 );
1814 void SetFocusOnCanvas();
1816 bool DoHideProperty( wxPGProperty
* p
, bool hide
, int flags
);
1820 bool ButtonTriggerKeyTest( int action
, wxKeyEvent
& event
);
1822 DECLARE_EVENT_TABLE()
1823 #endif // #ifndef SWIG
1826 // -----------------------------------------------------------------------
1828 // Bunch of inlines that need to resolved after all classes have been defined.
1832 inline bool wxPropertyGridPageState::IsDisplayed() const
1834 return ( this == m_pPropGrid
->GetState() );
1837 inline unsigned int wxPropertyGridPageState::GetActualVirtualHeight() const
1839 return DoGetRoot()->GetChildrenHeight(GetGrid()->GetRowHeight());
1843 inline int wxPGProperty::GetDisplayedCommonValueCount() const
1845 if ( HasFlag(wxPG_PROP_USES_COMMON_VALUE
) )
1847 wxPropertyGrid
* pg
= GetGrid();
1849 return (int) pg
->GetCommonValueCount();
1854 inline void wxPGProperty::SetEditor( const wxString
& editorName
)
1856 m_customEditor
= wxPropertyGridInterface::GetEditorByName(editorName
);
1859 inline void wxPGProperty::SetName( const wxString
& newName
)
1861 GetGrid()->SetPropertyName(this, newName
);
1864 inline bool wxPGProperty::Hide( bool hide
, int flags
)
1866 return GetGrid()->HideProperty(this, hide
, flags
);
1869 inline bool wxPGProperty::SetMaxLength( int maxLen
)
1871 return GetGrid()->SetPropertyMaxLength(this,maxLen
);
1874 // -----------------------------------------------------------------------
1879 #define wxPG_BASE_EVT_PRE_ID 1775
1881 BEGIN_DECLARE_EVENT_TYPES()
1882 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_SELECTED
, wxPG_BASE_EVT_PRE_ID
)
1883 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_CHANGING
, wxPG_BASE_EVT_PRE_ID
+1)
1884 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_CHANGED
, wxPG_BASE_EVT_PRE_ID
+2)
1885 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_HIGHLIGHTED
, wxPG_BASE_EVT_PRE_ID
+3)
1886 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_RIGHT_CLICK
, wxPG_BASE_EVT_PRE_ID
+4)
1887 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_PAGE_CHANGED
, wxPG_BASE_EVT_PRE_ID
+5)
1888 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_ITEM_COLLAPSED
, wxPG_BASE_EVT_PRE_ID
+6)
1889 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_ITEM_EXPANDED
, wxPG_BASE_EVT_PRE_ID
+7)
1890 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_DOUBLE_CLICK
, wxPG_BASE_EVT_PRE_ID
+8)
1891 END_DECLARE_EVENT_TYPES()
1894 wxEVT_PG_SELECTED
= wxPG_BASE_EVT_PRE_ID
,
1897 wxEVT_PG_HIGHLIGHTED
,
1898 wxEVT_PG_RIGHT_CLICK
,
1899 wxEVT_PG_PAGE_CHANGED
,
1900 wxEVT_PG_ITEM_COLLAPSED
,
1901 wxEVT_PG_ITEM_EXPANDED
,
1902 wxEVT_PG_DOUBLE_CLICK
1907 #define wxPG_BASE_EVT_TYPE wxEVT_PG_SELECTED
1908 #define wxPG_MAX_EVT_TYPE (wxPG_BASE_EVT_TYPE+30)
1912 typedef void (wxEvtHandler::*wxPropertyGridEventFunction
)(wxPropertyGridEvent
&);
1914 #define EVT_PG_SELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1915 #define EVT_PG_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1916 #define EVT_PG_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1917 #define EVT_PG_HIGHLIGHTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_HIGHLIGHTED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1918 #define EVT_PG_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1919 #define EVT_PG_DOUBLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_DOUBLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1920 #define EVT_PG_PAGE_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_PAGE_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1921 #define EVT_PG_ITEM_COLLAPSED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1922 #define EVT_PG_ITEM_EXPANDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1924 #define wxPropertyGridEventHandler(A) \
1925 ((wxObjectEventFunction)(wxEventFunction)(wxPropertyGridEventFunction)&A)
1930 /** @class wxPropertyGridEvent
1932 A propertygrid event holds information about events associated with
1933 wxPropertyGrid objects.
1935 @library{wxpropgrid}
1938 class WXDLLIMPEXP_PROPGRID wxPropertyGridEvent
: public wxCommandEvent
1943 wxPropertyGridEvent(wxEventType commandType
=0, int id
=0);
1945 /** Copy constructor. */
1946 wxPropertyGridEvent(const wxPropertyGridEvent
& event
);
1949 ~wxPropertyGridEvent();
1952 virtual wxEvent
* Clone() const;
1954 wxPGProperty
* GetMainParent() const
1956 wxASSERT(m_property
);
1957 return m_property
->GetMainParent();
1960 /** Returns id of associated property. */
1961 wxPGProperty
* GetProperty() const
1966 wxPGValidationInfo
& GetValidationInfo()
1968 wxASSERT(m_validationInfo
);
1969 return *m_validationInfo
;
1972 /** Returns true if you can veto the action that the event is signaling.
1974 bool CanVeto() const { return m_canVeto
; }
1977 Call this from your event handler to veto action that the event is
1980 You can only veto a shutdown if wxPropertyGridEvent::CanVeto returns
1983 Currently only wxEVT_PG_CHANGING supports vetoing.
1985 void Veto( bool veto
= true ) { m_wasVetoed
= veto
; }
1987 /** Returns value that is about to be set for wxEVT_PG_CHANGING.
1989 const wxVariant
& GetValue() const
1991 wxASSERT_MSG( m_validationInfo
,
1992 "Only call GetValue from a handler "
1993 "of event type that supports it" );
1994 return m_validationInfo
->GetValue();
1998 Set override validation failure behavior.
2000 Only effective if Veto was also called, and only allowed if event type
2001 is wxEVT_PG_CHANGING.
2003 void SetValidationFailureBehavior( wxPGVFBFlags flags
)
2005 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2006 m_validationInfo
->SetFailureBehavior( flags
);
2009 /** Sets custom failure message for this time only. Only applies if
2010 wxPG_VFB_SHOW_MESSAGE is set in validation failure flags.
2012 void SetValidationFailureMessage( const wxString
& message
)
2014 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2015 m_validationInfo
->SetFailureMessage( message
);
2019 wxPGVFBFlags
GetValidationFailureBehavior() const
2021 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2022 return m_validationInfo
->GetFailureBehavior();
2025 void SetCanVeto( bool canVeto
) { m_canVeto
= canVeto
; }
2026 bool WasVetoed() const { return m_wasVetoed
; }
2028 /** Changes the associated property. */
2029 void SetProperty( wxPGProperty
* p
) { m_property
= p
; }
2031 void SetPropertyGrid( wxPropertyGrid
* pg
) { m_pg
= pg
; }
2033 void SetupValidationInfo()
2036 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2037 m_validationInfo
= &m_pg
->GetValidationInfo();
2042 DECLARE_DYNAMIC_CLASS(wxPropertyGridEvent
)
2044 wxPGProperty
* m_property
;
2045 wxPropertyGrid
* m_pg
;
2046 wxPGValidationInfo
* m_validationInfo
;
2055 // -----------------------------------------------------------------------
2057 /** @class wxPropertyGridPopulator
2059 Allows populating wxPropertyGrid from arbitrary text source.
2061 class WXDLLIMPEXP_PROPGRID wxPropertyGridPopulator
2064 /** Default constructor.
2066 wxPropertyGridPopulator();
2069 virtual ~wxPropertyGridPopulator();
2071 void SetState( wxPropertyGridPageState
* state
);
2073 void SetGrid( wxPropertyGrid
* pg
);
2075 /** Appends a new property under bottommost parent.
2077 Property class as string.
2079 wxPGProperty
* Add( const wxString
& propClass
,
2080 const wxString
& propLabel
,
2081 const wxString
& propName
,
2082 const wxString
* propValue
,
2083 wxPGChoices
* pChoices
= NULL
);
2086 Pushes property to the back of parent array (ie it becomes bottommost
2087 parent), and starts scanning/adding children for it.
2089 When finished, parent array is returned to the original state.
2091 void AddChildren( wxPGProperty
* property
);
2093 /** Adds attribute to the bottommost property.
2095 Allowed values: "string", (same as string), "int", "bool". Empty string
2098 bool AddAttribute( const wxString
& name
,
2099 const wxString
& type
,
2100 const wxString
& value
);
2102 /** Called once in AddChildren.
2104 virtual void DoScanForChildren() = 0;
2107 Returns id of parent property for which children can currently be
2110 wxPGProperty
* GetCurParent() const
2112 return (wxPGProperty
*) m_propHierarchy
[m_propHierarchy
.size()-1];
2115 wxPropertyGridPageState
* GetState() { return m_state
; }
2116 const wxPropertyGridPageState
* GetState() const { return m_state
; }
2118 /** Like wxString::ToLong, except allows N% in addition of N.
2120 static bool ToLongPCT( const wxString
& s
, long* pval
, long max
);
2122 /** Parses strings of format "choice1"[=value1] ... "choiceN"[=valueN] into
2123 wxPGChoices. Registers parsed result using idString (if not empty).
2124 Also, if choices with given id already registered, then don't parse but
2125 return those choices instead.
2127 wxPGChoices
ParseChoices( const wxString
& choicesString
,
2128 const wxString
& idString
);
2130 /** Implement in derived class to do custom process when an error occurs.
2131 Default implementation uses wxLogError.
2133 virtual void ProcessError( const wxString
& msg
);
2137 /** Used property grid. */
2138 wxPropertyGrid
* m_pg
;
2140 /** Used property grid state. */
2141 wxPropertyGridPageState
* m_state
;
2143 /** Tree-hierarchy of added properties (that can have children). */
2144 wxArrayPGProperty m_propHierarchy
;
2146 /** Hashmap for string-id to wxPGChoicesData mapping. */
2147 wxPGHashMapS2P m_dictIdChoices
;
2150 // -----------------------------------------------------------------------
2153 // Undefine macros that are not needed outside propertygrid sources
2155 #ifndef __wxPG_SOURCE_FILE__
2156 #undef wxPG_FL_DESC_REFRESH_REQUIRED
2157 #undef wxPG_FL_SCROLLBAR_DETECTED
2158 #undef wxPG_FL_CREATEDSTATE
2159 #undef wxPG_FL_NOSTATUSBARHELP
2160 #undef wxPG_FL_SCROLLED
2161 #undef wxPG_FL_FOCUS_INSIDE_CHILD
2162 #undef wxPG_FL_FOCUS_INSIDE
2163 #undef wxPG_FL_MOUSE_INSIDE_CHILD
2164 #undef wxPG_FL_CUR_USES_CUSTOM_IMAGE
2165 #undef wxPG_FL_PRIMARY_FILLS_ENTIRE
2166 #undef wxPG_FL_VALUE_MODIFIED
2167 #undef wxPG_FL_MOUSE_INSIDE
2168 #undef wxPG_FL_FOCUSED
2169 #undef wxPG_FL_MOUSE_CAPTURED
2170 #undef wxPG_FL_INITIALIZED
2171 #undef wxPG_FL_ACTIVATION_BY_CLICK
2172 #undef wxPG_FL_DONT_CENTER_SPLITTER
2173 #undef wxPG_SUPPORT_TOOLTIPS
2174 #undef wxPG_DOUBLE_BUFFER
2175 #undef wxPG_ICON_WIDTH
2176 #undef wxPG_USE_RENDERER_NATIVE
2177 // Following are needed by the manager headers
2178 // #undef const wxString&
2181 // -----------------------------------------------------------------------
2185 #endif // _WX_PROPGRID_PROPGRID_H_