1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/propgrid/propgrid.h
3 // Purpose: wxPropertyGrid
4 // Author: Jaakko Salli
8 // Copyright: (c) Jaakko Salli
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_PROPGRID_PROPGRID_H_
13 #define _WX_PROPGRID_PROPGRID_H_
17 #include "wx/dcclient.h"
18 #include "wx/scrolwin.h"
19 #include "wx/tooltip.h"
20 #include "wx/datetime.h"
22 #include "wx/propgrid/property.h"
23 #include "wx/propgrid/propgridiface.h"
27 extern WXDLLIMPEXP_PROPGRID
const wxChar
*wxPropertyGridNameStr
;
31 // -----------------------------------------------------------------------
33 // -----------------------------------------------------------------------
37 // This is required for sharing common global variables.
38 class WXDLLIMPEXP_PROPGRID wxPGGlobalVarsClass
42 wxPGGlobalVarsClass();
43 ~wxPGGlobalVarsClass();
45 // Used by advprops, but here to make things easier.
46 wxString m_pDefaultImageWildcard
;
48 // Map of editor class instances (keys are name string).
49 wxPGHashMapS2P m_mapEditorClasses
;
52 wxArrayPtrVoid m_arrValidators
; // These wxValidators need to be freed
55 wxPGHashMapS2P m_dictPropertyClassInfo
; // PropertyName -> ClassInfo
57 wxPGChoices
* m_fontFamilyChoices
;
59 // Replace with your own to affect all properties using default renderer.
60 wxPGCellRenderer
* m_defaultRenderer
;
62 wxPGChoices m_boolChoices
;
64 wxVariant m_vEmptyString
;
66 wxVariant m_vMinusOne
;
70 // Cached constant strings
71 wxPGCachedString m_strstring
;
72 wxPGCachedString m_strlong
;
73 wxPGCachedString m_strbool
;
74 wxPGCachedString m_strlist
;
76 wxPGCachedString m_strMin
;
77 wxPGCachedString m_strMax
;
78 wxPGCachedString m_strUnits
;
79 wxPGCachedString m_strInlineHelp
;
81 // If true then some things are automatically translated
82 bool m_autoGetTranslation
;
84 // > 0 if errors cannot or should not be shown in statusbar etc.
87 int m_extraStyle
; // global extra style
93 int HasExtraStyle( int style
) const { return (m_extraStyle
& style
); }
96 extern WXDLLIMPEXP_PROPGRID wxPGGlobalVarsClass
* wxPGGlobalVars
;
98 #define wxPGVariant_EmptyString (wxPGGlobalVars->m_vEmptyString)
99 #define wxPGVariant_Zero (wxPGGlobalVars->m_vZero)
100 #define wxPGVariant_MinusOne (wxPGGlobalVars->m_vMinusOne)
101 #define wxPGVariant_True (wxPGGlobalVars->m_vTrue)
102 #define wxPGVariant_False (wxPGGlobalVars->m_vFalse)
104 #define wxPGVariant_Bool(A) (A?wxPGVariant_True:wxPGVariant_False)
108 // -----------------------------------------------------------------------
110 /** @section propgrid_window_styles wxPropertyGrid Window Styles
112 SetWindowStyleFlag method can be used to modify some of these at run-time.
115 enum wxPG_WINDOW_STYLES
118 /** This will cause Sort() automatically after an item is added.
119 When inserting a lot of items in this mode, it may make sense to
120 use Freeze() before operations and Thaw() afterwards to increase
123 wxPG_AUTO_SORT
= 0x00000010,
125 /** Categories are not initially shown (even if added).
126 IMPORTANT NOTE: If you do not plan to use categories, then this
127 style will waste resources.
128 This flag can also be changed using wxPropertyGrid::EnableCategories method.
130 wxPG_HIDE_CATEGORIES
= 0x00000020,
132 /* This style combines non-categoric mode and automatic sorting.
134 wxPG_ALPHABETIC_MODE
= (wxPG_HIDE_CATEGORIES
|wxPG_AUTO_SORT
),
136 /** Modified values are shown in bold font. Changing this requires Refresh()
139 wxPG_BOLD_MODIFIED
= 0x00000040,
141 /** When wxPropertyGrid is resized, splitter moves to the center. This
142 behavior stops once the user manually moves the splitter.
144 wxPG_SPLITTER_AUTO_CENTER
= 0x00000080,
146 /** Display tooltips for cell text that cannot be shown completely. If
147 wxUSE_TOOLTIPS is 0, then this doesn't have any effect.
149 wxPG_TOOLTIPS
= 0x00000100,
151 /** Disables margin and hides all expand/collapse buttons that would appear
152 outside the margin (for sub-properties). Toggling this style automatically
153 expands all collapsed items.
155 wxPG_HIDE_MARGIN
= 0x00000200,
157 /** This style prevents user from moving the splitter.
159 wxPG_STATIC_SPLITTER
= 0x00000400,
161 /** Combination of other styles that make it impossible for user to modify
164 wxPG_STATIC_LAYOUT
= (wxPG_HIDE_MARGIN
|wxPG_STATIC_SPLITTER
),
166 /** Disables wxTextCtrl based editors for properties which
167 can be edited in another way.
169 Equals calling wxPropertyGrid::LimitPropertyEditing for all added
172 wxPG_LIMITED_EDITING
= 0x00000800,
174 /** wxPropertyGridManager only: Show toolbar for mode and page selection. */
175 wxPG_TOOLBAR
= 0x00001000,
177 /** wxPropertyGridManager only: Show adjustable text box showing description
178 or help text, if available, for currently selected property.
180 wxPG_DESCRIPTION
= 0x00002000
184 enum wxPG_EX_WINDOW_STYLES
188 NOTE: wxPG_EX_xxx are extra window styles and must be set using
189 SetExtraStyle() member function.
191 Speeds up switching to wxPG_HIDE_CATEGORIES mode. Initially, if
192 wxPG_HIDE_CATEGORIES is not defined, the non-categorized data storage is
193 not activated, and switching the mode first time becomes somewhat slower.
194 wxPG_EX_INIT_NOCAT activates the non-categorized data storage right away.
195 IMPORTANT NOTE: If you do plan not switching to non-categoric mode, or if
196 you don't plan to use categories at all, then using this style will result
197 in waste of resources.
200 wxPG_EX_INIT_NOCAT
= 0x00001000,
202 /** Extended window style that sets wxPropertyGridManager toolbar to not
205 wxPG_EX_NO_FLAT_TOOLBAR
= 0x00002000,
207 /** Shows alphabetic/categoric mode buttons from toolbar.
209 wxPG_EX_MODE_BUTTONS
= 0x00008000,
211 /** Show property help strings as tool tips instead as text on the status bar.
212 You can set the help strings using SetPropertyHelpString member function.
214 wxPG_EX_HELP_AS_TOOLTIPS
= 0x00010000,
216 /** Prevent TAB from focusing to wxButtons. This behavior was default
217 in version 1.2.0 and earlier.
218 NOTE! Tabbing to button doesn't work yet. Problem seems to be that on wxMSW
219 atleast the button doesn't properly propagate key events (yes, I'm using
222 //wxPG_EX_NO_TAB_TO_BUTTON = 0x00020000,
224 /** Allows relying on native double-buffering.
226 wxPG_EX_NATIVE_DOUBLE_BUFFERING
= 0x00080000,
228 /** Set this style to let user have ability to set values of properties to
229 unspecified state. Same as setting wxPG_PROP_AUTO_UNSPECIFIED for
232 wxPG_EX_AUTO_UNSPECIFIED_VALUES
= 0x00200000,
235 If this style is used, built-in attributes (such as wxPG_FLOAT_PRECISION
236 and wxPG_STRING_PASSWORD) are not stored into property's attribute storage
237 (thus they are not readable).
239 Note that this option is global, and applies to all wxPG property
242 wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES
= 0x00400000,
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 wxPGValidationInfo
352 friend class wxPropertyGrid
;
355 @return Returns failure behavior which is a combination of
356 @ref propgrid_vfbflags.
358 wxPGVFBFlags
GetFailureBehavior();
361 Returns current failure message.
363 const wxString
& GetFailureMessage() const
364 { return m_failureMessage
; }
367 Returns reference to pending value.
369 const wxVariant
& GetValue() const
375 /** Set validation failure behavior
377 @param failureBehavior
378 Mixture of @ref propgrid_vfbflags.
380 void SetFailureBehavior(wxPGVFBFlags failureBehavior
)
381 { m_failureBehavior
= failureBehavior
; }
384 Set current failure message.
386 void SetFailureMessage(const wxString
& message
)
387 { m_failureMessage
= message
; }
390 /** Value to be validated.
394 /** Message displayed on validation failure.
396 wxString m_failureMessage
;
398 /** Validation failure behavior. Use wxPG_VFB_XXX flags.
400 wxPGVFBFlags m_failureBehavior
;
403 // -----------------------------------------------------------------------
405 /** @section propgrid_pgactions wxPropertyGrid Action Identifiers
407 These are used with wxPropertyGrid::AddActionTrigger() and
408 wxPropertyGrid::ClearActionTriggers().
412 enum wxPG_KEYBOARD_ACTIONS
414 wxPG_ACTION_INVALID
= 0,
415 wxPG_ACTION_NEXT_PROPERTY
,
416 wxPG_ACTION_PREV_PROPERTY
,
417 wxPG_ACTION_EXPAND_PROPERTY
,
418 wxPG_ACTION_COLLAPSE_PROPERTY
,
419 wxPG_ACTION_CANCEL_EDIT
,
429 // -----------------------------------------------------------------------
432 // wxPropertyGrid::DoSelectProperty flags (selFlags)
434 // Focuses to created editor
435 #define wxPG_SEL_FOCUS 0x01
436 // Forces deletion and recreation of editor
437 #define wxPG_SEL_FORCE 0x02
438 // For example, doesn't cause EnsureVisible
439 #define wxPG_SEL_NONVISIBLE 0x04
440 // Do not validate editor's value before selecting
441 #define wxPG_SEL_NOVALIDATE 0x08
442 // Property being deselected is about to be deleted
443 #define wxPG_SEL_DELETING 0x10
444 // Property's values was set to unspecified by the user
445 #define wxPG_SEL_SETUNSPEC 0x20
446 // Property's event handler changed the value
447 #define wxPG_SEL_DIALOGVAL 0x40
450 // -----------------------------------------------------------------------
455 #define wxPG_FL_INITIALIZED 0x0001
456 // Set when creating editor controls if it was clicked on.
457 #define wxPG_FL_ACTIVATION_BY_CLICK 0x0002
458 #define wxPG_FL_DONT_CENTER_SPLITTER 0x0004
459 #define wxPG_FL_FOCUSED 0x0008
460 #define wxPG_FL_MOUSE_CAPTURED 0x0010
461 #define wxPG_FL_MOUSE_INSIDE 0x0020
462 #define wxPG_FL_VALUE_MODIFIED 0x0040
463 // don't clear background of m_wndEditor
464 #define wxPG_FL_PRIMARY_FILLS_ENTIRE 0x0080
465 // currently active editor uses custom image
466 #define wxPG_FL_CUR_USES_CUSTOM_IMAGE 0x0100
467 // cell colours override selection colours for selected cell
468 #define wxPG_FL_CELL_OVERRIDES_SEL 0x0200
469 #define wxPG_FL_SCROLLED 0x0400
470 // set when all added/inserted properties get hideable flag
471 #define wxPG_FL_ADDING_HIDEABLES 0x0800
472 // Disables showing help strings on statusbar.
473 #define wxPG_FL_NOSTATUSBARHELP 0x1000
474 // Marks that we created the state, so we have to destroy it too.
475 #define wxPG_FL_CREATEDSTATE 0x2000
476 // Set if scrollbar's existence was detected in last onresize.
477 #define wxPG_FL_SCROLLBAR_DETECTED 0x4000
478 // Set if wxPGMan requires redrawing of description text box.
479 #define wxPG_FL_DESC_REFRESH_REQUIRED 0x8000
480 // Set if contained in wxPropertyGridManager
481 #define wxPG_FL_IN_MANAGER 0x00020000
482 // Set after wxPropertyGrid is shown in its initial good size
483 #define wxPG_FL_GOOD_SIZE_SET 0x00040000
484 // Next navigation key event will get ignored
485 #define wxPG_FL_IGNORE_NEXT_NAVKEY 0x00080000
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 int GetColumnCount() const
790 return 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
; }
835 /** Returns cell background colour of a property. */
836 wxColour
GetPropertyBackgroundColour( wxPGPropArg id
) const;
838 /** Returns cell background colour of a property. */
839 wxColour
GetPropertyTextColour( wxPGPropArg id
) const;
841 /** Returns "root property". It does not have name, etc. and it is not
842 visible. It is only useful for accessing its children.
844 wxPGProperty
* GetRoot() const { return m_pState
->m_properties
; }
846 /** Returns height of a single grid row (in pixels). */
847 int GetRowHeight() const { return m_lineHeight
; }
849 /** Returns currently selected property. */
850 wxPGProperty
* GetSelectedProperty() const { return GetSelection(); }
852 /** Returns currently selected property. */
853 wxPGProperty
* GetSelection() const
858 /** Returns current selection background colour. */
859 wxColour
GetSelectionBackgroundColour() const { return m_colSelBack
; }
861 /** Returns current selection text colour. */
862 wxColour
GetSelectionForegroundColour() const { return m_colSelFore
; }
864 /** Returns current splitter x position. */
865 int GetSplitterPosition() const
866 { return m_pState
->DoGetSplitterPosition(0); }
868 /** Returns wxTextCtrl active in currently selected property, if any. Takes
869 into account wxOwnerDrawnComboBox.
871 wxTextCtrl
* GetEditorTextCtrl() const;
873 wxPGValidationInfo
& GetValidationInfo()
875 return m_validationInfo
;
878 /** Returns current vertical spacing. */
879 int GetVerticalSpacing() const { return (int)m_vspacing
; }
881 /** Returns true if editor's value was marked modified.
883 bool IsEditorsValueModified() const
884 { return ( m_iFlags
& wxPG_FL_VALUE_MODIFIED
) ? true : false; }
886 /** Returns information about arbitrary position in the grid.
888 For wxPropertyGridHitTestResult definition, see
889 wxPropertyGridPageState::HitTest().
891 wxPropertyGridHitTestResult
HitTest( const wxPoint
& pt
) const;
893 /** Returns true if any property has been modified by the user. */
894 bool IsAnyModified() const { return (m_pState
->m_anyModified
>0); }
897 Returns true if updating is frozen (ie Freeze() called but not yet
900 bool IsFrozen() const { return (m_frozen
>0)?true:false; }
902 /** Redraws given property.
904 virtual void RefreshProperty( wxPGProperty
* p
);
907 /** Registers a new editor class.
909 Pointer to the editor class instance that should be used.
911 static wxPGEditor
* RegisterEditorClass( wxPGEditor
* editor
,
912 bool noDefCheck
= false );
915 /** Resets all colours to the original system values.
921 Editor widget is automatically created, but not focused unless focus is
922 true. This will generate wxEVT_PG_SELECT event.
926 True if selection finished successfully. Usually only fails if
927 current value in editor is not valid.
928 @see wxPropertyGrid::Unselect
930 bool SelectProperty( wxPGPropArg id
, bool focus
= false )
932 wxPG_PROP_ARG_CALL_PROLOG_RETVAL(false)
933 return DoSelectProperty(p
,focus
?wxPG_SEL_FOCUS
:0);
936 /** Changes keyboard shortcut to push the editor button.
938 You can set default with keycode 0. Good value for the platform is
939 guessed, but don't expect it to be very accurate.
941 void SetButtonShortcut( int keycode
,
942 bool ctrlDown
= false,
943 bool altDown
= false );
945 /** Sets category caption background colour. */
946 void SetCaptionBackgroundColour(const wxColour
& col
);
948 /** Sets category caption text colour. */
949 void SetCaptionTextColour(const wxColour
& col
);
951 /** Sets default cell background colour - applies to property cells.
952 Note that appearance of editor widgets may not be affected.
954 void SetCellBackgroundColour(const wxColour
& col
);
956 /** Sets cell text colour for disabled properties.
958 void SetCellDisabledTextColour(const wxColour
& col
);
960 /** Sets default cell text colour - applies to property name and value text.
961 Note that appearance of editor widgets may not be affected.
963 void SetCellTextColour(const wxColour
& col
);
965 /** Set number of columns (2 or more).
967 void SetColumnCount( int colCount
)
969 m_pState
->SetColumnCount(colCount
);
974 Sets the 'current' category - Append will add non-category properties
977 void SetCurrentCategory( wxPGPropArg id
)
979 wxPG_PROP_ARG_CALL_PROLOG()
980 wxPropertyCategory
* pc
= wxDynamicCast(p
, wxPropertyCategory
);
982 m_pState
->m_currentCategory
= pc
;
985 /** Sets colour of empty space below properties. */
986 void SetEmptySpaceColour(const wxColour
& col
);
988 /** Sets colour of lines between cells. */
989 void SetLineColour(const wxColour
& col
);
991 /** Sets background colour of margin. */
992 void SetMarginColour(const wxColour
& col
);
994 /** Sets background colour of property and all its children. Colours of
995 captions are not affected. Background brush cache is optimized for often
996 set colours to be set last.
998 void SetPropertyBackgroundColour( wxPGPropArg id
, const wxColour
& col
);
1000 /** Resets text and background colours of given property.
1002 void SetPropertyColoursToDefault( wxPGPropArg id
);
1004 /** Sets text colour of property and all its children.
1006 void SetPropertyTextColour( wxPGPropArg id
,
1007 const wxColour
& col
,
1008 bool recursively
= true );
1011 Sets selection background colour - applies to selected property name
1014 void SetSelectionBackgroundColour(const wxColour
& col
);
1017 Sets selection foreground colour - applies to selected property name
1020 void SetSelectionTextColour(const wxColour
& col
);
1022 /** Sets x coordinate of the splitter.
1024 Splitter position cannot exceed grid size, and therefore setting it
1025 during form creation may fail as initial grid size is often smaller
1026 than desired splitter position, especially when sizers are being used.
1028 void SetSplitterPosition( int newxpos
, int col
= 0 )
1030 DoSetSplitterPosition_(newxpos
, true, col
);
1031 m_iFlags
|= wxPG_FL_SPLITTER_PRE_SET
;
1034 /** Set virtual width for this particular page. Width -1 indicates that the
1035 virtual width should be disabled. */
1036 void SetVirtualWidth( int width
);
1039 Moves splitter as left as possible, while still allowing all
1040 labels to be shown in full.
1042 @param privateChildrenToo
1043 If @false, will still allow private children to be cropped.
1045 void SetSplitterLeft( bool privateChildrenToo
= false )
1047 m_pState
->SetSplitterLeft(privateChildrenToo
);
1050 /** Sets vertical spacing. Can be 1, 2, or 3 - a value relative to font
1051 height. Value of 2 should be default on most platforms.
1053 void SetVerticalSpacing( int vspacing
)
1055 m_vspacing
= (unsigned char)vspacing
;
1056 CalculateFontAndBitmapStuff( vspacing
);
1057 if ( !m_pState
->m_itemsAdded
) Refresh();
1060 /** Shows an brief error message that is related to a property. */
1061 void ShowPropertyError( wxPGPropArg id
, const wxString
& msg
)
1063 wxPG_PROP_ARG_CALL_PROLOG()
1064 DoShowPropertyError(p
, msg
);
1067 /** Sorts all items at all levels (except sub-properties). */
1070 /** Sorts children of a category.
1072 void SortChildren( wxPGPropArg id
);
1074 /////////////////////////////////////////////////////////////////
1076 // Following methods do not need to be (currently) documented
1078 /////////////////////////////////////////////////////////////////
1080 bool HasVirtualWidth() const
1081 { return (m_iFlags
& wxPG_FL_HAS_VIRTUAL_WIDTH
) ? true : false; }
1083 const wxPGCommonValue
* GetCommonValue( unsigned int i
) const
1085 return (wxPGCommonValue
*) m_commonValues
[i
];
1088 /** Returns number of common values.
1090 unsigned int GetCommonValueCount() const
1092 return m_commonValues
.size();
1095 /** Returns label of given common value.
1097 wxString
GetCommonValueLabel( unsigned int i
) const
1099 wxASSERT( GetCommonValue(i
) );
1100 return GetCommonValue(i
)->GetLabel();
1104 Returns index of common value that will truly change value to
1107 int GetUnspecifiedCommonValue() const { return m_cvUnspecified
; }
1109 /** Set index of common value that will truly change value to unspecified.
1110 Using -1 will set none to have such effect.
1113 void SetUnspecifiedCommonValue( int index
) { m_cvUnspecified
= index
; }
1116 Shortcut for creating dialog-caller button. Used, for example, by
1119 This should only be called by properties.
1121 wxWindow
* GenerateEditorButton( const wxPoint
& pos
, const wxSize
& sz
);
1123 /** Fixes position of wxTextCtrl-like control (wxSpinCtrl usually
1124 fits as one). Call after control has been created (but before
1127 void FixPosForTextCtrl( wxWindow
* ctrl
,
1128 const wxPoint
& offset
= wxPoint(0, 0) );
1130 /** Shortcut for creating text editor widget.
1132 Same as pos given for CreateEditor.
1134 Same as sz given for CreateEditor.
1136 Initial text for wxTextCtrl.
1138 If right-side control, such as button, also created, then create it
1139 first and pass it as this parameter.
1141 Extra style flags to pass for wxTextCtrl.
1143 Note that this should generally be called only by new classes derived
1146 wxWindow
* GenerateEditorTextCtrl( const wxPoint
& pos
,
1148 const wxString
& value
,
1149 wxWindow
* secondary
,
1153 /* Generates both textctrl and button.
1155 wxWindow
* GenerateEditorTextCtrlAndButton( const wxPoint
& pos
,
1156 const wxSize
& sz
, wxWindow
** psecondary
, int limited_editing
,
1157 wxPGProperty
* property
);
1159 /** Generates position for a widget editor dialog box.
1161 Property for which dialog is positioned.
1163 Known or over-approximated size of the dialog.
1165 Position for dialog.
1167 wxPoint
GetGoodEditorDialogPosition( wxPGProperty
* p
,
1170 // Converts escape sequences in src_str to newlines,
1171 // tabs, etc. and copies result to dst_str.
1172 static wxString
& ExpandEscapeSequences( wxString
& dst_str
,
1173 wxString
& src_str
);
1175 // Converts newlines, tabs, etc. in src_str to escape
1176 // sequences, and copies result to dst_str.
1177 static wxString
& CreateEscapeSequences( wxString
& dst_str
,
1178 wxString
& src_str
);
1181 Returns rectangle that fully contains properties between and including
1184 wxRect
GetPropertyRect( const wxPGProperty
* p1
,
1185 const wxPGProperty
* p2
) const;
1187 /** Returns pointer to current active primary editor control (NULL if none).
1189 If editor uses clipper window, pointer is returned to the actual
1190 editor, not the clipper.
1192 wxWindow
* GetEditorControl() const;
1194 /** Adjusts given position if topCtrlWnd is child of clipper window.
1196 bool AdjustPosForClipperWindow( wxWindow
* topCtrlWnd
, int* x
, int* y
);
1198 wxWindow
* GetPrimaryEditor() const
1200 return GetEditorControl();
1204 Returns pointer to current active secondary editor control (NULL if
1207 wxWindow
* GetEditorControlSecondary() const
1209 return m_wndEditor2
;
1215 Generates contents for string dst based on the contents of
1218 Format will be "(preDelim)str1(postDelim) (preDelim)str2(postDelim) and
1219 so on. Set flags to 1 inorder to convert backslashes to double-back-
1220 slashes and "(preDelims)"'s to "(preDelims)".
1222 static void ArrayStringToString( wxString
& dst
, const wxArrayString
& src
,
1223 wxChar preDelim
, wxChar postDelim
,
1226 // Mostly useful for page switching.
1227 void SwitchState( wxPropertyGridPageState
* pNewState
);
1229 /** Pass this function to Connect calls in propertyclass::CreateEditor.
1231 void OnCustomEditorEvent( wxCommandEvent
&event
);
1233 long GetInternalFlags() const { return m_iFlags
; }
1234 void SetInternalFlag( long flag
) { m_iFlags
|= flag
; }
1235 void ClearInternalFlag( long flag
) { m_iFlags
&= ~(flag
); }
1236 void IncFrozen() { m_frozen
++; }
1237 void DecFrozen() { m_frozen
--; }
1239 void OnComboItemPaint( wxPGCustomComboControl
* pCb
,int item
,wxDC
& dc
,
1240 wxRect
& rect
,int flags
);
1242 // Used by simple check box for keyboard navigation
1243 void SendNavigationKeyEvent( int dir
);
1245 /** Standardized double-to-string conversion.
1247 static void DoubleToString( wxString
& target
,
1251 wxString
* precTemplate
);
1254 Call this from wxPGProperty::OnEvent() to cause property value to be
1255 changed after the function returns (with true as return value).
1256 ValueChangeInEvent() must be used if you wish the application to be
1257 able to use wxEVT_PG_CHANGING to potentially veto the given value.
1259 void ValueChangeInEvent( wxVariant variant
)
1261 m_changeInEventValue
= variant
;
1262 m_iFlags
|= wxPG_FL_VALUE_CHANGE_IN_EVENT
;
1265 /** Returns true if given event is from first of an array of buttons
1266 (as can be in case when wxPGMultiButton is used).
1268 bool IsMainButtonEvent( const wxEvent
& event
)
1270 return (event
.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED
)
1271 && (m_wndSecId
== event
.GetId());
1274 /** Pending value is expected to be passed in PerformValidation().
1276 virtual bool DoPropertyChanged( wxPGProperty
* p
,
1277 unsigned int selFlags
= 0 );
1280 Runs all validation functionality (includes sending wxEVT_PG_CHANGING).
1281 Returns true if all tests passed.
1283 virtual bool PerformValidation( wxPGProperty
* p
, wxVariant
& pendingValue
);
1285 /** Called when validation for given property fails.
1287 Value which failed in validation.
1289 Return true if user is allowed to change to another property even
1290 if current has invalid value.
1292 To add your own validation failure behavior, override
1293 wxPropertyGrid::DoOnValidationFailure().
1295 bool OnValidationFailure( wxPGProperty
* property
, wxVariant
& invalidValue
)
1297 bool res
= DoOnValidationFailure(property
, invalidValue
);
1298 property
->SetFlag(wxPG_PROP_INVALID_VALUE
);
1302 /** Called to indicate property and editor has valid value now.
1304 void OnValidationFailureReset( wxPGProperty
* property
)
1306 if ( property
&& property
->HasFlag(wxPG_PROP_INVALID_VALUE
) )
1308 DoOnValidationFailureReset(property
);
1309 property
->ClearFlag(wxPG_PROP_INVALID_VALUE
);
1311 m_validationInfo
.m_failureMessage
.clear();
1314 /** Override in derived class to display error messages in custom manner
1315 (these message usually only result from validation failure).
1317 virtual void DoShowPropertyError( wxPGProperty
* property
,
1318 const wxString
& msg
);
1320 /** Override to customize property validation failure behavior.
1322 Value which failed in validation.
1324 Return true if user is allowed to change to another property even
1325 if current has invalid value.
1327 virtual bool DoOnValidationFailure( wxPGProperty
* property
,
1328 wxVariant
& invalidValue
);
1330 /** Override to customize resetting of property validation failure status.
1332 Property is guaranteed to have flag wxPG_PROP_INVALID_VALUE set.
1334 virtual void DoOnValidationFailureReset( wxPGProperty
* property
);
1336 int GetSpacingY() const { return m_spacingy
; }
1339 Must be called in wxPGEditor::CreateControls() if primary editor window
1340 is wxTextCtrl, just before textctrl is created.
1342 Initial text value of created wxTextCtrl.
1344 void SetupTextCtrlValue( const wxString text
) { m_prevTcValue
= text
; }
1347 Unfocuses or closes editor if one was open, but does not deselect
1350 bool UnfocusEditor();
1355 wxPropertyGridPageState used by the grid is created here.
1357 If grid is used in wxPropertyGridManager, there is no point overriding
1358 this - instead, set custom wxPropertyGridPage classes.
1360 virtual wxPropertyGridPageState
* CreateState() const;
1365 // Control font changer helper.
1366 void SetCurControlBoldFont();
1369 // Public methods for semi-public use
1370 // (not protected for optimization)
1372 bool DoSelectProperty( wxPGProperty
* p
, unsigned int flags
= 0 );
1374 // Overridden functions.
1375 virtual bool Destroy();
1376 virtual wxSize
DoGetBestSize() const;
1377 // Returns property at given y coordinate (relative to grid's top left).
1378 wxPGProperty
* GetItemAtY( int y
) const { return DoGetItemAtY(y
); }
1380 virtual void Refresh( bool eraseBackground
= true,
1381 const wxRect
*rect
= (const wxRect
*) NULL
);
1382 virtual bool SetFont( const wxFont
& font
);
1383 #if wxPG_SUPPORT_TOOLTIPS
1384 void SetToolTip( const wxString
& tipString
);
1386 virtual void Freeze();
1387 virtual void SetExtraStyle( long exStyle
);
1388 virtual void Thaw();
1393 #ifndef wxPG_ICON_WIDTH
1394 wxBitmap
*m_expandbmp
, *m_collbmp
;
1397 wxCursor
*m_cursorSizeWE
;
1399 /** wxWindow pointers to editor control(s). */
1400 wxWindow
*m_wndEditor
;
1401 wxWindow
*m_wndEditor2
;
1403 /** wxPGCanvas instance. */
1406 #if wxPG_DOUBLE_BUFFER
1407 wxBitmap
*m_doubleBuffer
;
1410 wxArrayPtrVoid
*m_windowsToDelete
;
1412 /** Local time ms when control was created. */
1413 wxLongLong m_timeCreated
;
1415 /** wxPGProperty::OnEvent can change value by setting this. */
1416 wxVariant m_changeInEventValue
;
1418 /** Id of m_wndEditor2, or its first child, if any. */
1421 /** Extra Y spacing between the items. */
1424 /** Control client area width; updated on resize. */
1427 /** Control client area height; updated on resize. */
1430 /** Current non-client width (needed when auto-centering). */
1433 /** Non-client width (auto-centering helper). */
1436 /** Previously recorded scroll start position. */
1440 The gutter spacing in front and back of the image.
1441 This determines the amount of spacing in front of each item
1445 /** Includes separator line. */
1448 /** Gutter*2 + image width. */
1451 // y spacing for expand/collapse button.
1452 int m_buttonSpacingY
;
1454 /** Extra margin for expanded sub-group items. */
1455 int m_subgroup_extramargin
;
1458 The image width of the [+] icon.
1460 This is also calculated in the gutter
1464 #ifndef wxPG_ICON_WIDTH
1467 The image height of the [+] icon.
1469 This is calculated as minimal size and to align
1474 /** Current cursor id. */
1478 This captionFont is made equal to the font of the wxScrolledWindow.
1480 As extra the bold face is set on it when this is wanted by the user
1483 wxFont m_captionFont
;
1485 int m_fontHeight
; // Height of the font.
1487 // Base keycode for triggering push button.
1488 int m_pushButKeyCode
;
1490 /** m_splitterx when drag began. */
1491 int m_startingSplitterX
;
1494 Index to splitter currently being dragged (0=one after the first
1497 int m_draggedSplitter
;
1499 /** Changed property, calculated in PerformValidation(). */
1500 wxPGProperty
* m_chgInfo_changedProperty
;
1503 Lowest property for which editing happened, but which does not have
1506 wxPGProperty
* m_chgInfo_baseChangedProperty
;
1508 /** Changed property value, calculated in PerformValidation(). */
1509 wxVariant m_chgInfo_pendingValue
;
1511 /** Passed to SetValue. */
1512 wxVariant m_chgInfo_valueList
;
1514 /** Validation information. */
1515 wxPGValidationInfo m_validationInfo
;
1517 /** Actions and keys that trigger them. */
1518 wxPGHashMapI2I m_actionTriggers
;
1524 /** Bits are used to indicate which colours are customized. */
1525 unsigned short m_coloursCustomized
;
1527 /** x - m_splitterx. */
1528 signed char m_dragOffset
;
1530 /** 0 = not dragging, 1 = drag just started, 2 = drag in progress */
1531 unsigned char m_dragStatus
;
1533 /** 0 = margin, 1 = label, 2 = value. */
1534 unsigned char m_mouseSide
;
1536 /** True when editor control is focused. */
1537 unsigned char m_editorFocused
;
1539 /** 1 if m_latsCaption is also the bottommost caption. */
1540 //unsigned char m_lastCaptionBottomnest;
1542 /** Set to 1 when graphics frozen. */
1543 unsigned char m_frozen
;
1545 unsigned char m_vspacing
;
1547 // Does triggering push button need Alt down?
1548 unsigned char m_pushButKeyCodeNeedsAlt
;
1550 // Does triggering push button need Ctrl down?
1551 unsigned char m_pushButKeyCodeNeedsCtrl
;
1553 // Used to track when Alt/Ctrl+Key was consumed.
1554 unsigned char m_keyComboConsumed
;
1556 /** 1 if in DoPropertyChanged() */
1557 unsigned char m_inDoPropertyChanged
;
1559 /** 1 if in CommitChangesFromEditor() */
1560 unsigned char m_inCommitChangesFromEditor
;
1562 /** 1 if in DoSelectProperty() */
1563 unsigned char m_inDoSelectProperty
;
1565 wxPGVFBFlags m_permanentValidationFailureBehavior
; // Set by app
1567 /** Internal flags - see wxPG_FL_XXX constants. */
1570 /** When drawing next time, clear this many item slots at the end. */
1571 int m_clearThisMany
;
1573 /** Pointer to selected property. Note that this is duplicated in
1574 m_state for better transiency between pages so that the selected
1575 item can be retained.
1577 wxPGProperty
* m_selected
;
1579 // pointer to property that has mouse hovering
1580 wxPGProperty
* m_propHover
;
1582 // EventObject for wxPropertyGridEvents
1583 wxWindow
* m_eventObject
;
1585 // What (global) window is currently focused (needed to resolve event
1587 wxWindow
* m_curFocused
;
1590 wxEvtHandler
* m_tlwHandler
;
1595 // y coordinate of property that mouse hovering
1597 // Which column's editor is selected (usually 1)?
1600 // x relative to splitter (needed for resize).
1603 // lines between cells
1605 // property labels and values are written in this colour
1606 wxColour m_colPropFore
;
1607 // or with this colour when disabled
1608 wxColour m_colDisPropFore
;
1609 // background for m_colPropFore
1610 wxColour m_colPropBack
;
1611 // text color for captions
1612 wxColour m_colCapFore
;
1613 // background color for captions
1614 wxColour m_colCapBack
;
1615 // foreground for selected property
1616 wxColour m_colSelFore
;
1617 // background for selected property (actually use background color when
1618 // control out-of-focus)
1619 wxColour m_colSelBack
;
1620 // background colour for margin
1621 wxColour m_colMargin
;
1622 // background colour for empty space below the grid
1623 wxColour m_colEmptySpace
;
1625 // NB: These *cannot* be moved to globals.
1627 // Array of background colour brushes.
1628 wxArrayPtrVoid m_arrBgBrushes
;
1629 // Array of foreground colours.
1630 wxArrayPtrVoid m_arrFgCols
;
1632 // labels when properties use common values
1633 wxArrayPtrVoid m_commonValues
;
1634 // Which cv selection really sets value to unspecified?
1635 int m_cvUnspecified
;
1637 // Used to skip excess text editor events
1638 wxString m_prevTcValue
;
1642 // Sets some members to defaults (called constructors).
1645 // Initializes some members (called by Create and complex constructor).
1648 void OnPaint(wxPaintEvent
&event
);
1650 // main event receivers
1651 void OnMouseMove( wxMouseEvent
&event
);
1652 void OnMouseMoveBottom( wxMouseEvent
&event
);
1653 void OnMouseClick( wxMouseEvent
&event
);
1654 void OnMouseRightClick( wxMouseEvent
&event
);
1655 void OnMouseDoubleClick( wxMouseEvent
&event
);
1656 void OnMouseUp( wxMouseEvent
&event
);
1657 void OnKey( wxKeyEvent
&event
);
1658 void OnKeyUp( wxKeyEvent
&event
);
1659 void OnNavigationKey( wxNavigationKeyEvent
& event
);
1660 void OnResize( wxSizeEvent
&event
);
1663 bool HandleMouseMove( int x
, unsigned int y
, wxMouseEvent
&event
);
1664 bool HandleMouseClick( int x
, unsigned int y
, wxMouseEvent
&event
);
1665 bool HandleMouseRightClick( int x
, unsigned int y
, wxMouseEvent
&event
);
1666 bool HandleMouseDoubleClick( int x
, unsigned int y
, wxMouseEvent
&event
);
1667 bool HandleMouseUp( int x
, unsigned int y
, wxMouseEvent
&event
);
1668 void HandleKeyEvent( wxKeyEvent
&event
);
1669 // Handle TAB and ESCAPE in control
1670 bool HandleChildKey( wxKeyEvent
& event
);
1672 void OnMouseEntry( wxMouseEvent
&event
);
1674 void OnIdle( wxIdleEvent
&event
);
1675 void OnFocusEvent( wxFocusEvent
&event
);
1676 void OnChildFocusEvent( wxChildFocusEvent
& event
);
1678 bool OnMouseCommon( wxMouseEvent
&event
, int* px
, int *py
);
1679 bool OnMouseChildCommon( wxMouseEvent
&event
, int* px
, int *py
);
1681 // sub-control event handlers
1682 void OnMouseClickChild( wxMouseEvent
&event
);
1683 void OnMouseRightClickChild( wxMouseEvent
&event
);
1684 void OnMouseMoveChild( wxMouseEvent
&event
);
1685 void OnMouseUpChild( wxMouseEvent
&event
);
1686 void OnChildKeyDown( wxKeyEvent
&event
);
1687 void OnChildKeyUp( wxKeyEvent
&event
);
1689 void OnCaptureChange( wxMouseCaptureChangedEvent
&event
);
1691 void OnScrollEvent( wxScrollWinEvent
&event
);
1693 void OnSysColourChanged( wxSysColourChangedEvent
&event
);
1698 Adjust the centering of the bitmap icons (collapse / expand) when the
1699 caption font changes.
1701 They need to be centered in the middle of the font, so a bit of deltaY
1702 adjustment is needed. On entry, m_captionFont must be set to window
1703 font. It will be modified properly.
1705 void CalculateFontAndBitmapStuff( int vspacing
);
1707 wxRect
GetEditorWidgetRect( wxPGProperty
* p
, int column
) const;
1709 void CorrectEditorWidgetSizeX();
1711 /** Called in RecalculateVirtualSize() to reposition control
1712 on virtual height changes.
1714 void CorrectEditorWidgetPosY();
1718 void OnScreenNote( const wxChar
* format
, ... );
1721 /** Deselect current selection, if any. Returns true if success
1722 (ie. validator did not intercept). */
1723 bool DoClearSelection();
1725 int DoDrawItems( wxDC
& dc
,
1726 const wxPGProperty
* first_item
,
1727 const wxPGProperty
* last_item
,
1728 const wxRect
* clip_rect
,
1729 bool isBuffered
) const;
1731 void DoSetPropertyValueUnspecified( wxPGProperty
* p
);
1733 /** Draws an expand/collapse (ie. +/-) button.
1735 virtual void DrawExpanderButton( wxDC
& dc
, const wxRect
& rect
,
1736 wxPGProperty
* property
) const;
1738 /** Draws items from topitemy to bottomitemy */
1739 void DrawItems( wxDC
& dc
, unsigned int topitemy
, unsigned int bottomitemy
,
1740 const wxRect
* clip_rect
= (const wxRect
*) NULL
);
1742 void DrawItems( const wxPGProperty
* p1
, const wxPGProperty
* p2
);
1744 void DrawItem( wxPGProperty
* p
)
1749 virtual void DrawItemAndChildren( wxPGProperty
* p
);
1752 Draws item, children, and consequtive parents as long as category is
1755 void DrawItemAndValueRelated( wxPGProperty
* p
);
1757 // Translate wxKeyEvent to wxPG_ACTION_XXX
1758 int KeyEventToActions(wxKeyEvent
&event
, int* pSecond
) const;
1760 int KeyEventToAction(wxKeyEvent
&event
) const
1762 return KeyEventToActions(event
, NULL
);
1765 void ImprovedClientToScreen( int* px
, int* py
);
1767 // Called by focus event handlers. newFocused is the window that becomes
1769 void HandleFocusChange( wxWindow
* newFocused
);
1771 /** Reloads all non-customized colours from system settings. */
1772 void RegainColours();
1774 bool DoEditorValidate();
1776 wxPGProperty
* DoGetItemAtY( int y
) const;
1778 void DoSetSplitterPosition_( int newxpos
,
1779 bool refresh
= true,
1780 int splitterIndex
= 0,
1781 bool allPages
= false );
1785 virtual bool DoExpand( wxPGProperty
* p
, bool sendEvent
= false );
1787 virtual bool DoCollapse( wxPGProperty
* p
, bool sendEvent
= false );
1789 // Returns nearest paint visible property (such that will be painted unless
1790 // window is scrolled or resized). If given property is paint visible, then
1791 // it itself will be returned.
1792 wxPGProperty
* GetNearestPaintVisible( wxPGProperty
* p
) const;
1794 static void RegisterDefaultEditors();
1796 // Sets m_bgColIndex to this property and all its children.
1797 void SetBackgroundColourIndex( wxPGProperty
* p
, int index
);
1799 // Sets m_fgColIndex to this property and all its children.
1800 void SetTextColourIndex( wxPGProperty
* p
, int index
, int flags
);
1802 int CacheColour( const wxColour
& colour
);
1804 // Sets up basic event handling for child control
1805 void SetupChildEventHandling( wxWindow
* wnd
, int id
);
1807 void CustomSetCursor( int type
, bool override
= false );
1809 virtual bool ProcessEvent(wxEvent
& event
);
1810 virtual void SetWindowStyleFlag( long style
);
1813 Repositions scrollbar and underlying panel according to changed virtual
1816 void RecalculateVirtualSize( int forceXPos
= -1 );
1818 void PrepareAfterItemsAdded();
1820 bool SendEvent( int eventType
,
1822 wxVariant
* pValue
= NULL
,
1823 unsigned int selFlags
= 0 );
1825 void SetFocusOnCanvas()
1827 m_canvas
->SetFocusIgnoringChildren();
1828 m_editorFocused
= 0;
1831 bool DoHideProperty( wxPGProperty
* p
, bool hide
, int flags
);
1835 bool ButtonTriggerKeyTest( wxKeyEvent
&event
);
1837 #endif // DOXYGEN_SHOULD_SKIP_THIS
1840 DECLARE_EVENT_TABLE()
1841 #endif // #ifndef SWIG
1844 // -----------------------------------------------------------------------
1846 // Bunch of inlines that need to resolved after all classes have been defined.
1850 inline bool wxPropertyGridPageState::IsDisplayed() const
1852 return ( this == m_pPropGrid
->GetState() );
1855 inline unsigned int wxPropertyGridPageState::GetActualVirtualHeight() const
1857 return DoGetRoot()->GetChildrenHeight(GetGrid()->GetRowHeight());
1861 inline int wxPGProperty::GetDisplayedCommonValueCount() const
1863 if ( HasFlag(wxPG_PROP_USES_COMMON_VALUE
) )
1865 wxPropertyGrid
* pg
= GetGrid();
1867 return pg
->GetCommonValueCount();
1872 inline void wxPGProperty::SetEditor( const wxString
& editorName
)
1874 m_customEditor
= wxPropertyGridInterface::GetEditorByName(editorName
);
1877 inline void wxPGProperty::SetName( const wxString
& newName
)
1879 GetGrid()->SetPropertyName(this, newName
);
1882 inline bool wxPGProperty::Hide( bool hide
, int flags
)
1884 return GetGrid()->HideProperty(this, hide
, flags
);
1887 inline bool wxPGProperty::SetMaxLength( int maxLen
)
1889 return GetGrid()->SetPropertyMaxLength(this,maxLen
);
1892 // -----------------------------------------------------------------------
1897 #define wxPG_BASE_EVT_PRE_ID 1775
1899 BEGIN_DECLARE_EVENT_TYPES()
1900 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_SELECTED
, wxPG_BASE_EVT_PRE_ID
)
1901 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_CHANGING
, wxPG_BASE_EVT_PRE_ID
+1)
1902 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_CHANGED
, wxPG_BASE_EVT_PRE_ID
+2)
1903 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_HIGHLIGHTED
, wxPG_BASE_EVT_PRE_ID
+3)
1904 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_RIGHT_CLICK
, wxPG_BASE_EVT_PRE_ID
+4)
1905 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_PAGE_CHANGED
, wxPG_BASE_EVT_PRE_ID
+5)
1906 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_ITEM_COLLAPSED
, wxPG_BASE_EVT_PRE_ID
+6)
1907 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_ITEM_EXPANDED
, wxPG_BASE_EVT_PRE_ID
+7)
1908 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_PROPGRID
, wxEVT_PG_DOUBLE_CLICK
, wxPG_BASE_EVT_PRE_ID
+8)
1909 END_DECLARE_EVENT_TYPES()
1912 wxEVT_PG_SELECTED
= wxPG_BASE_EVT_PRE_ID
,
1915 wxEVT_PG_HIGHLIGHTED
,
1916 wxEVT_PG_RIGHT_CLICK
,
1917 wxEVT_PG_PAGE_CHANGED
,
1918 wxEVT_PG_ITEM_COLLAPSED
,
1919 wxEVT_PG_ITEM_EXPANDED
,
1920 wxEVT_PG_DOUBLE_CLICK
1925 #define wxPG_BASE_EVT_TYPE wxEVT_PG_SELECTED
1926 #define wxPG_MAX_EVT_TYPE (wxPG_BASE_EVT_TYPE+30)
1930 typedef void (wxEvtHandler::*wxPropertyGridEventFunction
)(wxPropertyGridEvent
&);
1932 #define EVT_PG_SELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1933 #define EVT_PG_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1934 #define EVT_PG_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1935 #define EVT_PG_HIGHLIGHTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_HIGHLIGHTED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1936 #define EVT_PG_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1937 #define EVT_PG_DOUBLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_DOUBLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1938 #define EVT_PG_PAGE_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_PAGE_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1939 #define EVT_PG_ITEM_COLLAPSED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1940 #define EVT_PG_ITEM_EXPANDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_PG_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxPropertyGridEventFunction, & fn ), (wxObject *) NULL ),
1942 #define wxPropertyGridEventHandler(A) \
1943 ((wxObjectEventFunction)(wxEventFunction)(wxPropertyGridEventFunction)&A)
1948 /** @class wxPropertyGridEvent
1950 A propertygrid event holds information about events associated with
1951 wxPropertyGrid objects.
1953 @library{wxpropgrid}
1956 class WXDLLIMPEXP_PROPGRID wxPropertyGridEvent
: public wxCommandEvent
1961 wxPropertyGridEvent(wxEventType commandType
=0, int id
=0);
1963 /** Copy constructor. */
1964 wxPropertyGridEvent(const wxPropertyGridEvent
& event
);
1967 ~wxPropertyGridEvent();
1970 virtual wxEvent
* Clone() const;
1972 wxPGProperty
* GetMainParent() const
1974 wxASSERT(m_property
);
1975 return m_property
->GetMainParent();
1978 /** Returns id of associated property. */
1979 wxPGProperty
* GetProperty() const
1984 wxPGValidationInfo
& GetValidationInfo()
1986 wxASSERT(m_validationInfo
);
1987 return *m_validationInfo
;
1990 /** Returns true if you can veto the action that the event is signaling.
1992 bool CanVeto() const { return m_canVeto
; }
1995 Call this from your event handler to veto action that the event is
1998 You can only veto a shutdown if wxPropertyGridEvent::CanVeto returns
2001 Currently only wxEVT_PG_CHANGING supports vetoing.
2003 void Veto( bool veto
= true ) { m_wasVetoed
= veto
; }
2005 /** Returns value that is about to be set for wxEVT_PG_CHANGING.
2007 const wxVariant
& GetValue() const
2009 wxASSERT_MSG( m_validationInfo
,
2010 "Only call GetValue from a handler "
2011 "of event type that supports it" );
2012 return m_validationInfo
->GetValue();
2016 Set override validation failure behavior.
2018 Only effective if Veto was also called, and only allowed if event type
2019 is wxEVT_PG_CHANGING.
2021 void SetValidationFailureBehavior( wxPGVFBFlags flags
)
2023 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2024 m_validationInfo
->SetFailureBehavior( flags
);
2027 /** Sets custom failure message for this time only. Only applies if
2028 wxPG_VFB_SHOW_MESSAGE is set in validation failure flags.
2030 void SetValidationFailureMessage( const wxString
& message
)
2032 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2033 m_validationInfo
->SetFailureMessage( message
);
2037 wxPGVFBFlags
GetValidationFailureBehavior() const
2039 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2040 return m_validationInfo
->GetFailureBehavior();
2043 void SetCanVeto( bool canVeto
) { m_canVeto
= canVeto
; }
2044 bool WasVetoed() const { return m_wasVetoed
; }
2046 /** Changes the associated property. */
2047 void SetProperty( wxPGProperty
* p
) { m_property
= p
; }
2049 void SetPropertyGrid( wxPropertyGrid
* pg
) { m_pg
= pg
; }
2051 void SetupValidationInfo()
2054 wxASSERT( GetEventType() == wxEVT_PG_CHANGING
);
2055 m_validationInfo
= &m_pg
->GetValidationInfo();
2060 DECLARE_DYNAMIC_CLASS(wxPropertyGridEvent
)
2062 wxPGProperty
* m_property
;
2063 wxPropertyGrid
* m_pg
;
2064 wxPGValidationInfo
* m_validationInfo
;
2073 // -----------------------------------------------------------------------
2075 /** @class wxPropertyGridPopulator
2077 Allows populating wxPropertyGrid from arbitrary text source.
2079 class WXDLLIMPEXP_PROPGRID wxPropertyGridPopulator
2082 /** Default constructor.
2084 wxPropertyGridPopulator();
2087 virtual ~wxPropertyGridPopulator();
2089 void SetState( wxPropertyGridPageState
* state
);
2091 void SetGrid( wxPropertyGrid
* pg
);
2093 /** Appends a new property under bottommost parent.
2095 Property class as string.
2097 wxPGProperty
* Add( const wxString
& propClass
,
2098 const wxString
& propLabel
,
2099 const wxString
& propName
,
2100 const wxString
* propValue
,
2101 wxPGChoices
* pChoices
= NULL
);
2104 Pushes property to the back of parent array (ie it becomes bottommost
2105 parent), and starts scanning/adding children for it.
2107 When finished, parent array is returned to the original state.
2109 void AddChildren( wxPGProperty
* property
);
2111 /** Adds attribute to the bottommost property.
2113 Allowed values: "string", (same as string), "int", "bool". Empty string
2116 bool AddAttribute( const wxString
& name
,
2117 const wxString
& type
,
2118 const wxString
& value
);
2120 /** Called once in AddChildren.
2122 virtual void DoScanForChildren() = 0;
2125 Returns id of parent property for which children can currently be
2128 wxPGProperty
* GetCurParent() const
2130 return (wxPGProperty
*) m_propHierarchy
[m_propHierarchy
.size()-1];
2133 wxPropertyGridPageState
* GetState() { return m_state
; }
2134 const wxPropertyGridPageState
* GetState() const { return m_state
; }
2136 /** Like wxString::ToLong, except allows N% in addition of N.
2138 static bool ToLongPCT( const wxString
& s
, long* pval
, long max
);
2140 /** Parses strings of format "choice1"[=value1] ... "choiceN"[=valueN] into
2141 wxPGChoices. Registers parsed result using idString (if not empty).
2142 Also, if choices with given id already registered, then don't parse but
2143 return those choices instead.
2145 wxPGChoices
ParseChoices( const wxString
& choicesString
,
2146 const wxString
& idString
);
2148 /** Implement in derived class to do custom process when an error occurs.
2149 Default implementation uses wxLogError.
2151 virtual void ProcessError( const wxString
& msg
);
2155 /** Used property grid. */
2156 wxPropertyGrid
* m_pg
;
2158 /** Used property grid state. */
2159 wxPropertyGridPageState
* m_state
;
2161 /** Tree-hierarchy of added properties (that can have children). */
2162 wxArrayPGProperty m_propHierarchy
;
2164 /** Hashmap for string-id to wxPGChoicesData mapping. */
2165 wxPGHashMapS2P m_dictIdChoices
;
2168 // -----------------------------------------------------------------------
2171 // Undefine macros that are not needed outside propertygrid sources
2173 #ifndef __wxPG_SOURCE_FILE__
2174 #undef wxPG_FL_DESC_REFRESH_REQUIRED
2175 #undef wxPG_FL_SCROLLBAR_DETECTED
2176 #undef wxPG_FL_CREATEDSTATE
2177 #undef wxPG_FL_NOSTATUSBARHELP
2178 #undef wxPG_FL_SCROLLED
2179 #undef wxPG_FL_FOCUS_INSIDE_CHILD
2180 #undef wxPG_FL_FOCUS_INSIDE
2181 #undef wxPG_FL_MOUSE_INSIDE_CHILD
2182 #undef wxPG_FL_CUR_USES_CUSTOM_IMAGE
2183 #undef wxPG_FL_PRIMARY_FILLS_ENTIRE
2184 #undef wxPG_FL_VALUE_MODIFIED
2185 #undef wxPG_FL_MOUSE_INSIDE
2186 #undef wxPG_FL_FOCUSED
2187 #undef wxPG_FL_MOUSE_CAPTURED
2188 #undef wxPG_FL_INITIALIZED
2189 #undef wxPG_FL_ACTIVATION_BY_CLICK
2190 #undef wxPG_FL_DONT_CENTER_SPLITTER
2191 #undef wxPG_SUPPORT_TOOLTIPS
2192 #undef wxPG_DOUBLE_BUFFER
2193 #undef wxPG_ICON_WIDTH
2194 #undef wxPG_USE_RENDERER_NATIVE
2195 // Following are needed by the manager headers
2196 // #undef const wxString&
2201 #include "wx/propgrid/editor.h"
2202 #include "wx/propgrid/manager.h"
2205 // -----------------------------------------------------------------------
2209 #endif // _WX_PROPGRID_PROPGRID_H_