1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/propgrid/property.h
3 // Purpose: wxPGProperty and related support classes
4 // Author: Jaakko Salli
8 // Copyright: (c) Jaakko Salli
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_PROPGRID_PROPERTY_H_
13 #define _WX_PROPGRID_PROPERTY_H_
17 #include "wx/propgrid/propgriddefs.h"
19 // -----------------------------------------------------------------------
21 #define wxNullProperty ((wxPGProperty*)NULL)
24 /** @class wxPGPaintData
26 Contains information relayed to property's OnCustomPaint.
30 /** wxPropertyGrid. */
31 const wxPropertyGrid
* m_parent
;
34 Normally -1, otherwise index to drop-down list item that has to be
39 /** Set to drawn width in OnCustomPaint (optional). */
43 In a measure item call, set this to the height of item at m_choiceItem
53 // space between vertical sides of a custom image
54 #define wxPG_CUSTOM_IMAGE_SPACINGY 1
56 // space between caption and selection rectangle,
57 #define wxPG_CAPRECTXMARGIN 2
59 // horizontally and vertically
60 #define wxPG_CAPRECTYMARGIN 1
63 /** @class wxPGCellRenderer
65 Base class for wxPropertyGrid cell renderers.
67 class WXDLLIMPEXP_PROPGRID wxPGCellRenderer
71 wxPGCellRenderer( unsigned int refCount
= 1 )
72 : m_refCount(refCount
) { }
73 virtual ~wxPGCellRenderer() { }
78 Selected
= 0x00010000,
82 virtual void Render( wxDC
& dc
,
84 const wxPropertyGrid
* propertyGrid
,
85 wxPGProperty
* property
,
88 int flags
) const = 0;
90 /** Returns size of the image in front of the editable area.
92 If property is NULL, then this call is for a custom value. In that case
93 the item is index to wxPropertyGrid's custom values.
95 virtual wxSize
GetImageSize( const wxPGProperty
* property
,
99 /** Paints property category selection rectangle.
101 virtual void DrawCaptionSelectionRect( wxDC
& dc
,
103 int w
, int h
) const;
105 /** Utility to draw vertically centered text.
107 void DrawText( wxDC
& dc
,
110 const wxString
& text
) const;
113 Utility to draw editor's value, or vertically aligned text if editor is
116 void DrawEditorValue( wxDC
& dc
, const wxRect
& rect
,
117 int xOffset
, const wxString
& text
,
118 wxPGProperty
* property
,
119 const wxPGEditor
* editor
) const;
121 /** Utility to render cell bitmap and set text colour plus bg brush colour.
123 Returns image width that, for instance, can be passed to DrawText.
125 int PreDrawCell( wxDC
& dc
,
127 const wxPGCell
& cell
,
144 unsigned int m_refCount
;
150 Base class for simple wxPropertyGrid cell information.
152 class WXDLLIMPEXP_PROPGRID wxPGCell
156 wxPGCell( const wxString
& text
,
157 const wxBitmap
& bitmap
= wxNullBitmap
,
158 const wxColour
& fgCol
= wxNullColour
,
159 const wxColour
& bgCol
= wxNullColour
);
161 virtual ~wxPGCell() { }
163 void SetText( const wxString
& text
) { m_text
= text
; }
164 void SetBitmap( const wxBitmap
& bitmap
) { m_bitmap
= bitmap
; }
165 void SetFgCol( const wxColour
& col
) { m_fgCol
= col
; }
166 void SetBgCol( const wxColour
& col
) { m_bgCol
= col
; }
168 const wxString
& GetText() const { return m_text
; }
169 const wxBitmap
& GetBitmap() const { return m_bitmap
; }
170 const wxColour
& GetFgCol() const { return m_fgCol
; }
171 const wxColour
& GetBgCol() const { return m_bgCol
; }
181 /** @class wxPGDefaultRenderer
183 Default cell renderer, that can handles the common
186 class WXDLLIMPEXP_PROPGRID wxPGDefaultRenderer
: public wxPGCellRenderer
189 virtual void Render( wxDC
& dc
,
191 const wxPropertyGrid
* propertyGrid
,
192 wxPGProperty
* property
,
197 virtual wxSize
GetImageSize( const wxPGProperty
* property
,
204 // -----------------------------------------------------------------------
206 /** @class wxPGAttributeStorage
208 wxPGAttributeStorage is somewhat optimized storage for
209 key=variant pairs (ie. a map).
211 class WXDLLIMPEXP_PROPGRID wxPGAttributeStorage
214 wxPGAttributeStorage();
215 ~wxPGAttributeStorage();
217 void Set( const wxString
& name
, const wxVariant
& value
);
218 size_t GetCount() const { return m_map
.size(); }
219 wxVariant
FindValue( const wxString
& name
) const
221 wxPGHashMapS2P::const_iterator it
= m_map
.find(name
);
222 if ( it
!= m_map
.end() )
224 wxVariantData
* data
= (wxVariantData
*) it
->second
;
226 return wxVariant(data
, it
->first
);
231 typedef wxPGHashMapS2P::const_iterator const_iterator
;
232 const_iterator
StartIteration() const
234 return m_map
.begin();
236 bool GetNext( const_iterator
& it
, wxVariant
& variant
) const
238 if ( it
== m_map
.end() )
241 wxVariantData
* data
= (wxVariantData
*) it
->second
;
243 variant
.SetData(data
);
244 variant
.SetName(it
->first
);
250 wxPGHashMapS2P m_map
;
255 // -----------------------------------------------------------------------
257 /** @section propgrid_propflags wxPGProperty Flags
261 enum wxPG_PROPERTY_FLAGS
264 /** Indicates bold font.
266 wxPG_PROP_MODIFIED
= 0x0001,
268 /** Disables ('greyed' text and editor does not activate) property.
270 wxPG_PROP_DISABLED
= 0x0002,
272 /** Hider button will hide this property.
274 wxPG_PROP_HIDDEN
= 0x0004,
276 /** This property has custom paint image just in front of its value.
277 If property only draws custom images into a popup list, then this
278 flag should not be set.
280 wxPG_PROP_CUSTOMIMAGE
= 0x0008,
282 /** Do not create text based editor for this property (but button-triggered
283 dialog and choice are ok).
285 wxPG_PROP_NOEDITOR
= 0x0010,
287 /** Property is collapsed, ie. it's children are hidden.
289 wxPG_PROP_COLLAPSED
= 0x0020,
292 If property is selected, then indicates that validation failed for pending
295 If property is not selected, then indicates that the the actual property
296 value has failed validation (NB: this behavior is not currently supported,
297 but may be used in future).
299 wxPG_PROP_INVALID_VALUE
= 0x0040,
303 /** Switched via SetWasModified(). Temporary flag - only used when
304 setting/changing property value.
306 wxPG_PROP_WAS_MODIFIED
= 0x0200,
309 If set, then child properties (if any) are private, and should be
310 "invisible" to the application.
312 wxPG_PROP_AGGREGATE
= 0x0400,
314 /** If set, then child properties (if any) are copies and should not
317 wxPG_PROP_CHILDREN_ARE_COPIES
= 0x0800,
320 Classifies this item as a non-category.
322 Used for faster item type identification.
324 wxPG_PROP_PROPERTY
= 0x1000,
327 Classifies this item as a category.
329 Used for faster item type identification.
331 wxPG_PROP_CATEGORY
= 0x2000,
333 /** Classifies this item as a property that has children, but is not aggregate
334 (ie children are not private).
336 wxPG_PROP_MISC_PARENT
= 0x4000,
338 /** Property is read-only. Editor is still created.
340 wxPG_PROP_READONLY
= 0x8000,
343 // NB: FLAGS ABOVE 0x8000 CANNOT BE USED WITH PROPERTY ITERATORS
346 /** Property's value is composed from values of child properties.
348 This flag cannot be used with property iterators.
350 wxPG_PROP_COMPOSED_VALUE
= 0x00010000,
352 /** Common value of property is selectable in editor.
354 This flag cannot be used with property iterators.
356 wxPG_PROP_USES_COMMON_VALUE
= 0x00020000,
358 /** Property can be set to unspecified value via editor.
359 Currently, this applies to following properties:
360 - wxIntProperty, wxUIntProperty, wxFloatProperty, wxEditEnumProperty:
364 This flag cannot be used with property iterators.
366 wxPG_PROP_AUTO_UNSPECIFIED
= 0x00040000,
368 /** Indicates the bit useable by derived properties.
370 wxPG_PROP_CLASS_SPECIFIC_1
= 0x00080000,
372 /** Indicates the bit useable by derived properties.
374 wxPG_PROP_CLASS_SPECIFIC_2
= 0x00100000
380 #define wxPG_PROP_MAX wxPG_PROP_AUTO_UNSPECIFIED
382 /** Property with children must have one of these set, otherwise iterators
383 will not work correctly.
384 Code should automatically take care of this, however.
386 #define wxPG_PROP_PARENTAL_FLAGS \
387 (wxPG_PROP_AGGREGATE|wxPG_PROP_CATEGORY|wxPG_PROP_MISC_PARENT)
392 // Amalgam of flags that should be inherited by sub-properties
393 #define wxPG_INHERITED_PROPFLAGS (wxPG_PROP_HIDDEN|wxPG_PROP_NOEDITOR)
395 // Combination of flags that can be stored by GetFlagsAsString
396 #define wxPG_STRING_STORED_FLAGS \
397 (wxPG_PROP_DISABLED|wxPG_PROP_HIDDEN|wxPG_PROP_NOEDITOR|wxPG_PROP_COLLAPSED)
399 // -----------------------------------------------------------------------
404 @section propgrid_property_attributes wxPropertyGrid Property Attribute
407 wxPGProperty::SetAttribute() and
408 wxPropertyGridInterface::SetPropertyAttribute() accept one of these as
409 attribute name argument.
411 You can use strings instead of constants. However, some of these
412 constants are redefined to use cached strings which may reduce
413 your binary size by some amount.
418 /** Set default value for property.
420 #define wxPG_ATTR_DEFAULT_VALUE wxS("DefaultValue")
422 /** Universal, int or double. Minimum value for numeric properties.
424 #define wxPG_ATTR_MIN wxS("Min")
426 /** Universal, int or double. Maximum value for numeric properties.
428 #define wxPG_ATTR_MAX wxS("Max")
430 /** Universal, string. When set, will be shown as text after the displayed
431 text value. Alternatively, if third column is enabled, text will be shown
432 there (for any type of property).
434 #define wxPG_ATTR_UNITS wxS("Units")
436 /** Universal, string. When set, will be shown in property's value cell
437 when displayed value string is empty, or value is unspecified.
439 #define wxPG_ATTR_INLINE_HELP wxS("InlineHelp")
441 /** wxBoolProperty specific, int, default 0. When 1 sets bool property to
442 use checkbox instead of choice.
444 #define wxPG_BOOL_USE_CHECKBOX wxS("UseCheckbox")
446 /** wxBoolProperty specific, int, default 0. When 1 sets bool property value
447 to cycle on double click (instead of showing the popup listbox).
449 #define wxPG_BOOL_USE_DOUBLE_CLICK_CYCLING wxS("UseDClickCycling")
452 wxFloatProperty (and similar) specific, int, default -1.
454 Sets the (max) precision used when floating point value is rendered as
455 text. The default -1 means infinite precision.
457 #define wxPG_FLOAT_PRECISION wxS("Precision")
460 The text will be echoed as asterisks (wxTE_PASSWORD will be passed to
463 #define wxPG_STRING_PASSWORD wxS("Password")
465 /** Define base used by a wxUIntProperty. Valid constants are
466 wxPG_BASE_OCT, wxPG_BASE_DEC, wxPG_BASE_HEX and wxPG_BASE_HEXL
467 (lowercase characters).
469 #define wxPG_UINT_BASE wxS("Base")
471 /** Define prefix rendered to wxUIntProperty. Accepted constants
472 wxPG_PREFIX_NONE, wxPG_PREFIX_0x, and wxPG_PREFIX_DOLLAR_SIGN.
473 <b>Note:</b> Only wxPG_PREFIX_NONE works with Decimal and Octal
476 #define wxPG_UINT_PREFIX wxS("Prefix")
479 wxFileProperty/wxImageFileProperty specific, wxChar*, default is
481 Sets the wildcard used in the triggered wxFileDialog. Format is the same.
483 #define wxPG_FILE_WILDCARD wxS("Wildcard")
485 /** wxFileProperty/wxImageFileProperty specific, int, default 1.
486 When 0, only the file name is shown (i.e. drive and directory are hidden).
488 #define wxPG_FILE_SHOW_FULL_PATH wxS("ShowFullPath")
490 /** Specific to wxFileProperty and derived properties, wxString, default empty.
491 If set, then the filename is shown relative to the given path string.
493 #define wxPG_FILE_SHOW_RELATIVE_PATH wxS("ShowRelativePath")
496 Specific to wxFileProperty and derived properties, wxString, default is
499 Sets the initial path of where to look for files.
501 #define wxPG_FILE_INITIAL_PATH wxS("InitialPath")
503 /** Specific to wxFileProperty and derivatives, wxString, default is empty.
504 Sets a specific title for the dir dialog.
506 #define wxPG_FILE_DIALOG_TITLE wxS("DialogTitle")
508 /** Specific to wxDirProperty, wxString, default is empty.
509 Sets a specific message for the dir dialog.
511 #define wxPG_DIR_DIALOG_MESSAGE wxS("DialogMessage")
513 /** Sets displayed date format for wxDateProperty.
515 #define wxPG_DATE_FORMAT wxS("DateFormat")
517 /** Sets wxDatePickerCtrl window style used with wxDateProperty. Default
518 is wxDP_DEFAULT | wxDP_SHOWCENTURY.
520 #define wxPG_DATE_PICKER_STYLE wxS("PickerStyle")
522 /** SpinCtrl editor, int or double. How much number changes when button is
523 pressed (or up/down on keybard).
525 #define wxPG_ATTR_SPINCTRL_STEP wxS("Step")
527 /** SpinCtrl editor, bool. If true, value wraps at Min/Max.
529 #define wxPG_ATTR_SPINCTRL_WRAP wxS("Wrap")
532 wxMultiChoiceProperty, int.
533 If 0, no user strings allowed. If 1, user strings appear before list
534 strings. If 2, user strings appear after list string.
536 #define wxPG_ATTR_MULTICHOICE_USERSTRINGMODE wxS("UserStringMode")
539 wxColourProperty and its kind, int, default 1.
541 Setting this attribute to 0 hides custom colour from property's list of
544 #define wxPG_COLOUR_ALLOW_CUSTOM wxS("AllowCustom")
549 // Redefine attribute macros to use cached strings
551 #define wxPG_ATTR_MIN wxPGGlobalVars->m_strMin
553 #define wxPG_ATTR_MAX wxPGGlobalVars->m_strMax
554 #undef wxPG_ATTR_UNITS
555 #define wxPG_ATTR_UNITS wxPGGlobalVars->m_strUnits
556 #undef wxPG_ATTR_INLINE_HELP
557 #define wxPG_ATTR_INLINE_HELP wxPGGlobalVars->m_strInlineHelp
561 // -----------------------------------------------------------------------
565 /** @class wxPGChoiceEntry
566 Data of a single wxPGChoices choice.
568 class WXDLLIMPEXP_PROPGRID wxPGChoiceEntry
: public wxPGCell
572 wxPGChoiceEntry( const wxPGChoiceEntry
& entry
);
573 wxPGChoiceEntry( const wxString
& label
,
574 int value
= wxPG_INVALID_VALUE
)
575 : wxPGCell(), m_value(value
)
580 wxPGChoiceEntry( const wxString
& label
,
582 const wxBitmap
& bitmap
,
583 const wxColour
& fgCol
= wxNullColour
,
584 const wxColour
& bgCol
= wxNullColour
)
585 : wxPGCell(label
, bitmap
, fgCol
, bgCol
), m_value(value
)
589 virtual ~wxPGChoiceEntry()
593 void SetValue( int value
) { m_value
= value
; }
595 int GetValue() const { return m_value
; }
597 bool HasValue() const { return (m_value
!= wxPG_INVALID_VALUE
); }
604 typedef void* wxPGChoicesId
;
606 class WXDLLIMPEXP_PROPGRID wxPGChoicesData
608 friend class wxPGChoices
;
610 // Constructor sets m_refCount to 1.
613 void CopyDataFrom( wxPGChoicesData
* data
);
615 // Takes ownership of 'item'
616 void Insert( int index
, wxPGChoiceEntry
* item
)
618 wxArrayPtrVoid::iterator it
;
622 index
= m_items
.size();
626 it
= m_items
.begin() + index
;
629 // Need to fix value?
630 if ( item
->GetValue() == wxPG_INVALID_VALUE
)
631 item
->SetValue(index
);
633 m_items
.insert(it
, item
);
636 // Delete all entries
639 size_t GetCount() const { return m_items
.size(); }
641 wxPGChoiceEntry
* Item( unsigned int i
) const
643 wxCHECK_MSG( i
< GetCount(), NULL
, "invalid index" );
645 return (wxPGChoiceEntry
*) m_items
[i
];
651 wxASSERT( m_refCount
>= 0 );
652 if ( m_refCount
== 0 )
657 wxArrayPtrVoid m_items
;
659 // So that multiple properties can use the same set
662 virtual ~wxPGChoicesData();
665 #define wxPGChoicesEmptyData ((wxPGChoicesData*)NULL)
669 /** @class wxPGChoices
671 Helper class for managing choices of wxPropertyGrid properties.
672 Each entry can have label, value, bitmap, text colour, and background
678 class WXDLLIMPEXP_PROPGRID wxPGChoices
681 typedef long ValArrItem
;
683 /** Default constructor. */
689 /** Copy constructor. */
690 wxPGChoices( const wxPGChoices
& a
)
692 if ( a
.m_data
!= wxPGChoicesEmptyData
)
695 m_data
->m_refCount
++;
700 wxPGChoices( const wxChar
** labels
, const long* values
= NULL
)
707 wxPGChoices( const wxArrayString
& labels
,
708 const wxArrayInt
& values
= wxArrayInt() )
714 /** Simple interface constructor. */
715 wxPGChoices( wxPGChoicesData
* data
)
731 If did not have own copies, creates them now. If was empty, identical
732 to set except that creates copies.
734 void Add( const wxChar
** labels
, const ValArrItem
* values
= NULL
);
736 /** Version that works with wxArrayString. */
737 void Add( const wxArrayString
& arr
, const ValArrItem
* values
= NULL
);
739 /** Version that works with wxArrayString and wxArrayInt. */
740 void Add( const wxArrayString
& arr
, const wxArrayInt
& arrint
);
742 /** Adds single item. */
743 wxPGChoiceEntry
& Add( const wxString
& label
,
744 int value
= wxPG_INVALID_VALUE
);
746 /** Adds a single item, with bitmap. */
747 wxPGChoiceEntry
& Add( const wxString
& label
,
748 const wxBitmap
& bitmap
,
749 int value
= wxPG_INVALID_VALUE
);
751 /** Adds a single item with full entry information. */
752 wxPGChoiceEntry
& Add( const wxPGChoiceEntry
& entry
)
754 return Insert(entry
, -1);
757 /** Adds single item. */
758 wxPGChoiceEntry
& AddAsSorted( const wxString
& label
,
759 int value
= wxPG_INVALID_VALUE
);
761 void Assign( const wxPGChoices
& a
)
763 AssignData(a
.m_data
);
766 void AssignData( wxPGChoicesData
* data
);
768 /** Delete all choices. */
771 if ( m_data
!= wxPGChoicesEmptyData
)
777 if ( m_data
== wxPGChoicesEmptyData
)
778 m_data
= new wxPGChoicesData();
781 /** Gets a unsigned number identifying this list. */
782 wxPGChoicesId
GetId() const { return (wxPGChoicesId
) m_data
; };
784 const wxString
& GetLabel( size_t ind
) const
786 return Item(ind
).GetText();
789 size_t GetCount () const
794 return m_data
->GetCount();
797 int GetValue( size_t ind
) const { return Item(ind
).GetValue(); }
799 /** Returns array of values matching the given strings. Unmatching strings
800 result in wxPG_INVALID_VALUE entry in array.
802 wxArrayInt
GetValuesForStrings( const wxArrayString
& strings
) const;
804 /** Returns array of indices matching given strings. Unmatching strings
805 are added to 'unmatched', if not NULL.
807 wxArrayInt
GetIndicesForStrings( const wxArrayString
& strings
,
808 wxArrayString
* unmatched
= NULL
) const;
810 /** Returns true if choices in general are likely to have values
811 (depens on that all entries have values or none has)
813 bool HasValues() const;
815 bool HasValue( unsigned int i
) const
816 { return (i
< m_data
->GetCount()) && m_data
->Item(i
)->HasValue(); }
818 int Index( const wxString
& str
) const;
819 int Index( int val
) const;
821 /** Inserts single item. */
822 wxPGChoiceEntry
& Insert( const wxString
& label
,
824 int value
= wxPG_INVALID_VALUE
);
826 /** Inserts a single item with full entry information. */
827 wxPGChoiceEntry
& Insert( const wxPGChoiceEntry
& entry
, int index
);
829 /** Returns false if this is a constant empty set of choices,
830 which should not be modified.
834 return ( m_data
!= wxPGChoicesEmptyData
);
837 const wxPGChoiceEntry
& Item( unsigned int i
) const
840 return *m_data
->Item(i
);
843 wxPGChoiceEntry
& Item( unsigned int i
)
846 return *m_data
->Item(i
);
849 /** Removes count items starting at position nIndex. */
850 void RemoveAt(size_t nIndex
, size_t count
= 1);
853 /** Does not create copies for itself. */
854 void Set( const wxChar
** labels
, const long* values
= NULL
)
860 /** Version that works with wxArrayString.
861 TODO: Deprecate this.
863 void Set( wxArrayString
& arr
, const long* values
= (const long*) NULL
)
870 /** Version that works with wxArrayString and wxArrayInt. */
871 void Set( const wxArrayString
& labels
,
872 const wxArrayInt
& values
= wxArrayInt() )
881 // Creates exclusive copy of current choices
884 if ( m_data
->m_refCount
!= 1 )
886 wxPGChoicesData
* data
= new wxPGChoicesData();
887 data
->CopyDataFrom(m_data
);
893 // Returns data, increases refcount.
894 wxPGChoicesData
* GetData()
896 wxASSERT( m_data
->m_refCount
!= 0xFFFFFFF );
897 m_data
->m_refCount
++;
901 // Returns plain data ptr - no refcounting stuff is done.
902 wxPGChoicesData
* GetDataPtr() const { return m_data
; }
904 // Changes ownership of data to you.
905 wxPGChoicesData
* ExtractData()
907 wxPGChoicesData
* data
= m_data
;
908 m_data
= wxPGChoicesEmptyData
;
912 wxArrayString
GetLabels() const;
915 void operator= (const wxPGChoices
& a
)
917 AssignData(a
.m_data
);
920 wxPGChoiceEntry
& operator[](unsigned int i
)
925 const wxPGChoiceEntry
& operator[](unsigned int i
) const
931 wxPGChoicesData
* m_data
;
938 // -----------------------------------------------------------------------
940 /** @class wxPGProperty
942 wxPGProperty is base class for all wxPropertyGrid properties.
944 NB: Full class overview is now only present in
945 interface/wx/propgrid/property.h.
950 class WXDLLIMPEXP_PROPGRID wxPGProperty
: public wxObject
952 friend class wxPropertyGrid
;
953 friend class wxPropertyGridInterface
;
954 friend class wxPropertyGridPageState
;
955 friend class wxPropertyGridPopulator
;
956 friend class wxStringProperty
; // Proper "<composed>" support requires this
958 DECLARE_ABSTRACT_CLASS(wxPGProperty
)
961 typedef wxUint32 FlagType
;
963 /** Basic constructor.
968 Non-abstract property classes should have constructor of this style:
972 // If T is a class, then it should be a constant reference
973 // (e.g. const T& ) instead.
974 MyProperty( const wxString& label, const wxString& name, T value )
977 // Generally recommended way to set the initial value
978 // (as it should work in pretty much 100% of cases).
983 // If has private child properties then create them here, e.g.:
984 // AddChild( new wxStringProperty( "Subprop 1",
986 // value.GetSubProp1() ) );
991 wxPGProperty( const wxString
& label
, const wxString
& name
);
995 It is customary for derived properties to implement this.
997 virtual ~wxPGProperty();
999 /** This virtual function is called after m_value has been set.
1002 - If m_value was set to Null variant (ie. unspecified value),
1003 OnSetValue() will not be called.
1004 - m_value may be of any variant type. Typically properties internally
1005 support only one variant type, and as such OnSetValue() provides a
1006 good opportunity to convert
1007 supported values into internal type.
1008 - Default implementation does nothing.
1010 virtual void OnSetValue();
1012 /** Override this to return something else than m_value as the value.
1014 virtual wxVariant
DoGetValue() const { return m_value
; }
1016 #if !defined(SWIG) || defined(CREATE_VCW)
1017 /** Implement this function in derived class to check the value.
1018 Return true if it is ok. Returning false prevents property change events
1022 - Default implementation always returns true.
1024 virtual bool ValidateValue( wxVariant
& value
,
1025 wxPGValidationInfo
& validationInfo
) const;
1028 Converts 'text' into proper value 'variant'.
1029 Returns true if new (different than m_value) value could be interpreted
1032 If wxPG_FULL_VALUE is set, returns complete, storable value instead
1033 of displayable one (they may be different).
1034 If wxPG_COMPOSITE_FRAGMENT is set, text is interpreted as a part of
1035 composite property string value (as generated by GetValueAsString()
1036 called with this same flag).
1039 Default implementation converts semicolon delimited tokens into child
1040 values. Only works for properties with children.
1042 virtual bool StringToValue( wxVariant
& variant
,
1043 const wxString
& text
,
1044 int argFlags
= 0 ) const;
1047 Converts 'number' (including choice selection) into proper value
1050 Returns true if new (different than m_value) value could be interpreted
1054 If wxPG_FULL_VALUE is set, returns complete, storable value instead
1058 - If property is not supposed to use choice or spinctrl or other editor
1059 with int-based value, it is not necessary to implement this method.
1060 - Default implementation simply assign given int to m_value.
1061 - If property uses choice control, and displays a dialog on some choice
1062 items, then it is preferred to display that dialog in IntToValue
1065 virtual bool IntToValue( wxVariant
& value
,
1067 int argFlags
= 0 ) const;
1068 #endif // !defined(SWIG) || defined(CREATE_VCW)
1071 /** Returns text representation of property's value.
1074 If wxPG_FULL_VALUE is set, returns complete, storable string value
1075 instead of displayable. If wxPG_EDITABLE_VALUE is set, returns
1076 string value that must be editable in textctrl. If
1077 wxPG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to
1078 display as a part of composite property string value.
1081 Default implementation returns string composed from text
1082 representations of child properties.
1084 virtual wxString
GetValueAsString( int argFlags
= 0 ) const;
1086 /** Converts string to a value, and if successful, calls SetValue() on it.
1087 Default behavior is to do nothing.
1089 String to get the value from.
1091 true if value was changed.
1093 bool SetValueFromString( const wxString
& text
, int flags
= 0 );
1095 /** Converts integer to a value, and if succesful, calls SetValue() on it.
1096 Default behavior is to do nothing.
1098 Int to get the value from.
1100 If has wxPG_FULL_VALUE, then the value given is a actual value and
1103 True if value was changed.
1105 bool SetValueFromInt( long value
, int flags
= 0 );
1108 Returns size of the custom painted image in front of property.
1110 This method must be overridden to return non-default value if
1111 OnCustomPaint is to be called.
1113 Normally -1, but can be an index to the property's list of items.
1115 - Default behavior is to return wxSize(0,0), which means no image.
1116 - Default image width or height is indicated with dimension -1.
1117 - You can also return wxPG_DEFAULT_IMAGE_SIZE, i.e. wxSize(-1, -1).
1119 virtual wxSize
OnMeasureImage( int item
= -1 ) const;
1122 Events received by editor widgets are processed here.
1124 Note that editor class usually processes most events. Some, such as
1125 button press events of TextCtrlAndButton class, can be handled here.
1126 Also, if custom handling for regular events is desired, then that can
1127 also be done (for example, wxSystemColourProperty custom handles
1128 wxEVT_COMMAND_CHOICE_SELECTED to display colour picker dialog when
1129 'custom' selection is made).
1131 If the event causes value to be changed, SetValueInEvent()
1132 should be called to set the new value.
1137 Should return true if any changes in value should be reported.
1139 If property uses choice control, and displays a dialog on some choice
1140 items, then it is preferred to display that dialog in IntToValue
1143 virtual bool OnEvent( wxPropertyGrid
* propgrid
,
1144 wxWindow
* wnd_primary
,
1148 Called after value of a child property has been altered.
1150 Note that this function is usually called at the time that value of
1151 this property, or given child property, is still pending for change.
1153 Sample pseudo-code implementation:
1156 void MyProperty::ChildChanged( wxVariant& thisValue,
1158 wxVariant& childValue ) const
1160 // Acquire reference to actual type of data stored in variant
1161 // (TFromVariant only exists if wxPropertyGrid's wxVariant-macros
1162 // were used to create the variant class).
1163 T& data = TFromVariant(thisValue);
1165 // Copy childValue into data.
1166 switch ( childIndex )
1169 data.SetSubProp1( childvalue.GetLong() );
1172 data.SetSubProp2( childvalue.GetString() );
1180 Value of this property, that should be altered.
1182 Index of child changed (you can use Item(childIndex) to get).
1184 Value of the child property.
1186 virtual void ChildChanged( wxVariant
& thisValue
,
1188 wxVariant
& childValue
) const;
1190 /** Returns pointer to an instance of used editor.
1192 virtual const wxPGEditor
* DoGetEditorClass() const;
1194 /** Returns pointer to the wxValidator that should be used
1195 with the editor of this property (NULL for no validator).
1196 Setting validator explicitly via SetPropertyValidator
1199 In most situations, code like this should work well
1200 (macros are used to maintain one actual validator instance,
1201 so on the second call the function exits within the first
1206 wxValidator* wxMyPropertyClass::DoGetValidator () const
1208 WX_PG_DOGETVALIDATOR_ENTRY()
1210 wxMyValidator* validator = new wxMyValidator(...);
1212 ... prepare validator...
1214 WX_PG_DOGETVALIDATOR_EXIT(validator)
1220 You can get common filename validator by returning
1221 wxFileProperty::GetClassValidator(). wxDirProperty,
1222 for example, uses it.
1224 virtual wxValidator
* DoGetValidator () const;
1227 Override to paint an image in front of the property value text or
1228 drop-down list item (but only if wxPGProperty::OnMeasureImage is
1229 overridden as well).
1231 If property's OnMeasureImage() returns size that has height != 0 but
1232 less than row height ( < 0 has special meanings), wxPropertyGrid calls
1233 this method to draw a custom image in a limited area in front of the
1234 editor control or value text/graphics, and if control has drop-down
1235 list, then the image is drawn there as well (even in the case
1236 OnMeasureImage() returned higher height than row height).
1238 NOTE: Following applies when OnMeasureImage() returns a "flexible"
1239 height ( using wxPG_FLEXIBLE_SIZE(W,H) macro), which implies variable
1240 height items: If rect.x is < 0, then this is a measure item call, which
1241 means that dc is invalid and only thing that should be done is to set
1242 paintdata.m_drawnHeight to the height of the image of item at index
1243 paintdata.m_choiceItem. This call may be done even as often as once
1244 every drop-down popup show.
1249 Box reserved for custom graphics. Includes surrounding rectangle,
1250 if any. If x is < 0, then this is a measure item call (see above).
1252 wxPGPaintData structure with much useful data.
1255 - You can actually exceed rect width, but if you do so then
1256 paintdata.m_drawnWidth must be set to the full width drawn in
1258 - Due to technical reasons, rect's height will be default even if
1259 custom height was reported during measure call.
1260 - Brush is guaranteed to be default background colour. It has been
1261 already used to clear the background of area being painted. It
1263 - Pen is guaranteed to be 1-wide 'black' (or whatever is the proper
1264 colour) pen for drawing framing rectangle. It can be changed as
1267 @see GetValueAsString()
1269 virtual void OnCustomPaint( wxDC
& dc
,
1271 wxPGPaintData
& paintdata
);
1274 Returns used wxPGCellRenderer instance for given property column
1277 Default implementation returns editor's renderer for all columns.
1279 virtual wxPGCellRenderer
* GetCellRenderer( int column
) const;
1281 /** Returns which choice is currently selected. Only applies to properties
1284 Needs to reimplemented in derived class if property value does not
1285 map directly to a choice. Integer as index, bool, and string usually do.
1287 virtual int GetChoiceSelection() const;
1290 Refresh values of child properties.
1292 Automatically called after value is set.
1294 virtual void RefreshChildren();
1296 /** Special handling for attributes of this property.
1298 If returns false, then the attribute will be automatically stored in
1301 Default implementation simply returns false.
1303 virtual bool DoSetAttribute( const wxString
& name
, wxVariant
& value
);
1305 /** Returns value of an attribute.
1307 Override if custom handling of attributes is needed.
1309 Default implementation simply return NULL variant.
1311 virtual wxVariant
DoGetAttribute( const wxString
& name
) const;
1313 /** Returns instance of a new wxPGEditorDialogAdapter instance, which is
1314 used when user presses the (optional) button next to the editor control;
1316 Default implementation returns NULL (ie. no action is generated when
1319 virtual wxPGEditorDialogAdapter
* GetEditorDialog() const;
1321 /** Returns wxPGCell of given column, NULL if none. If valid
1322 object is returned, caller will gain its ownership.
1324 wxPGCell
* AcquireCell( unsigned int column
)
1326 if ( column
>= m_cells
.size() )
1329 wxPGCell
* cell
= (wxPGCell
*) m_cells
[column
];
1330 m_cells
[column
] = NULL
;
1334 /** Append a new choice to property's list of choices.
1336 int AddChoice( const wxString
& label
, int value
= wxPG_INVALID_VALUE
)
1338 return InsertChoice(label
, wxNOT_FOUND
, value
);
1342 Returns true if children of this property are component values (for
1343 instance, points size, face name, and is_underlined are component
1346 bool AreChildrenComponents() const
1348 if ( m_flags
& (wxPG_PROP_COMPOSED_VALUE
|wxPG_PROP_AGGREGATE
) )
1355 Removes entry from property's wxPGChoices and editor control (if it is
1358 If selected item is deleted, then the value is set to unspecified.
1360 void DeleteChoice( int index
);
1363 Call to enable or disable usage of common value (integer value that can
1364 be selected for properties instead of their normal values) for this
1367 Common values are disabled by the default for all properties.
1369 void EnableCommonValue( bool enable
= true )
1371 if ( enable
) SetFlag( wxPG_PROP_USES_COMMON_VALUE
);
1372 else ClearFlag( wxPG_PROP_USES_COMMON_VALUE
);
1375 /** Composes text from values of child properties. */
1376 void GenerateComposedValue( wxString
& text
, int argFlags
= 0 ) const;
1378 /** Returns property's label. */
1379 const wxString
& GetLabel() const { return m_label
; }
1381 /** Returns property's name with all (non-category, non-root) parents. */
1382 wxString
GetName() const;
1385 Returns property's base name (ie parent's name is not added in any
1388 const wxString
& GetBaseName() const { return m_name
; }
1390 /** Returns read-only reference to property's list of choices.
1392 const wxPGChoices
& GetChoices() const
1397 /** Returns coordinate to the top y of the property. Note that the
1398 position of scrollbars is not taken into account.
1402 wxVariant
GetValue() const
1404 return DoGetValue();
1408 /** Returns reference to the internal stored value. GetValue is preferred
1409 way to get the actual value, since GetValueRef ignores DoGetValue,
1410 which may override stored value.
1412 wxVariant
& GetValueRef()
1417 const wxVariant
& GetValueRef() const
1423 /** To acquire property's value as string, you should use this
1424 function (instead of GetValueAsString()), as it may produce
1425 more accurate value in future versions.
1427 wxString
GetValueString( int argFlags
= 0 ) const;
1429 void UpdateControl( wxWindow
* primary
);
1431 /** Returns wxPGCell of given column, NULL if none. wxPGProperty
1432 will retain ownership of the cell object.
1434 wxPGCell
* GetCell( unsigned int column
) const
1436 if ( column
>= m_cells
.size() )
1439 return (wxPGCell
*) m_cells
[column
];
1442 /** Return number of displayed common values for this property.
1444 int GetDisplayedCommonValueCount() const;
1446 wxString
GetDisplayedString() const
1448 return GetValueString(0);
1451 /** Returns property grid where property lies. */
1452 wxPropertyGrid
* GetGrid() const;
1454 /** Returns owner wxPropertyGrid, but only if one is currently on a page
1455 displaying this property. */
1456 wxPropertyGrid
* GetGridIfDisplayed() const;
1458 /** Returns highest level non-category, non-root parent. Useful when you
1459 have nested wxCustomProperties/wxParentProperties.
1461 Thus, if immediate parent is root or category, this will return the
1464 wxPGProperty
* GetMainParent() const;
1466 /** Return parent of property */
1467 wxPGProperty
* GetParent() const { return m_parent
; }
1469 /** Returns true if property has editable wxTextCtrl when selected.
1472 Altough disabled properties do not displayed editor, they still
1473 return True here as being disabled is considered a temporary
1474 condition (unlike being read-only or having limited editing enabled).
1476 bool IsTextEditable() const;
1478 bool IsValueUnspecified() const
1480 return m_value
.IsNull();
1483 FlagType
HasFlag( FlagType flag
) const
1485 return ( m_flags
& flag
);
1488 /** Returns comma-delimited string of property attributes.
1490 const wxPGAttributeStorage
& GetAttributes() const
1492 return m_attributes
;
1495 /** Returns m_attributes as list wxVariant.
1497 wxVariant
GetAttributesAsList() const;
1499 FlagType
GetFlags() const
1504 const wxPGEditor
* GetEditorClass() const;
1506 wxString
GetValueType() const
1508 return m_value
.GetType();
1511 /** Returns editor used for given column. NULL for no editor.
1513 const wxPGEditor
* GetColumnEditor( int column
) const
1516 return GetEditorClass();
1521 /** Returns common value selected for this property. -1 for none.
1523 int GetCommonValue() const
1525 return m_commonValue
;
1528 /** Returns true if property has even one visible child.
1530 bool HasVisibleChildren() const;
1532 /** Inserts a new choice to property's list of choices.
1534 int InsertChoice( const wxString
& label
, int index
, int value
= wxPG_INVALID_VALUE
);
1537 Returns true if this property is actually a wxPropertyCategory.
1539 bool IsCategory() const { return HasFlag(wxPG_PROP_CATEGORY
)?true:false; }
1541 /** Returns true if this property is actually a wxRootProperty.
1543 bool IsRoot() const { return (m_parent
== NULL
); }
1545 /** Returns true if this is a sub-property. */
1546 bool IsSubProperty() const
1548 wxPGProperty
* parent
= (wxPGProperty
*)m_parent
;
1549 if ( parent
&& !parent
->IsCategory() )
1554 /** Returns last visible sub-property, recursively.
1556 const wxPGProperty
* GetLastVisibleSubItem() const;
1558 wxVariant
GetDefaultValue() const;
1560 int GetMaxLength() const
1562 return (int) m_maxLen
;
1566 Determines, recursively, if all children are not unspecified.
1568 Takes values in given list into account.
1570 bool AreAllChildrenSpecified( wxVariant
* pendingList
= NULL
) const;
1572 /** Updates composed values of parent non-category properties, recursively.
1573 Returns topmost property updated.
1576 - Must not call SetValue() (as can be called in it).
1578 wxPGProperty
* UpdateParentValues();
1580 /** Returns true if containing grid uses wxPG_EX_AUTO_UNSPECIFIED_VALUES.
1582 FlagType
UsesAutoUnspecified() const
1584 return HasFlag(wxPG_PROP_AUTO_UNSPECIFIED
);
1587 wxBitmap
* GetValueImage() const
1589 return m_valueBitmap
;
1592 wxVariant
GetAttribute( const wxString
& name
) const;
1595 Returns named attribute, as string, if found.
1597 Otherwise defVal is returned.
1599 wxString
GetAttribute( const wxString
& name
, const wxString
& defVal
) const;
1602 Returns named attribute, as long, if found.
1604 Otherwise defVal is returned.
1606 long GetAttributeAsLong( const wxString
& name
, long defVal
) const;
1609 Returns named attribute, as double, if found.
1611 Otherwise defVal is returned.
1613 double GetAttributeAsDouble( const wxString
& name
, double defVal
) const;
1615 unsigned int GetArrIndex() const { return m_arrIndex
; }
1617 unsigned int GetDepth() const { return (unsigned int)m_depth
; }
1619 /** Gets flags as a'|' delimited string. Note that flag names are not
1620 prepended with 'wxPG_PROP_'.
1622 String will only be made to include flags combined by this parameter.
1624 wxString
GetFlagsAsString( FlagType flagsMask
) const;
1626 /** Returns position in parent's array. */
1627 unsigned int GetIndexInParent() const
1629 return (unsigned int)m_arrIndex
;
1632 /** Hides or reveals the property.
1634 true for hide, false for reveal.
1636 By default changes are applied recursively. Set this paramter
1637 wxPG_DONT_RECURSE to prevent this.
1639 inline bool Hide( bool hide
, int flags
= wxPG_RECURSE
);
1641 bool IsExpanded() const
1642 { return (!(m_flags
& wxPG_PROP_COLLAPSED
) && GetChildCount()); }
1644 /** Returns true if all parents expanded.
1646 bool IsVisible() const;
1648 bool IsEnabled() const { return !(m_flags
& wxPG_PROP_DISABLED
); }
1650 /** If property's editor is created this forces its recreation.
1651 Useful in SetAttribute etc. Returns true if actually did anything.
1653 bool RecreateEditor();
1655 /** If property's editor is active, then update it's value.
1657 void RefreshEditor();
1659 /** Sets an attribute for this property.
1661 Text identifier of attribute. See @ref propgrid_property_attributes.
1665 void SetAttribute( const wxString
& name
, wxVariant value
);
1667 void SetAttributes( const wxPGAttributeStorage
& attributes
);
1670 /** Sets editor for a property.
1673 For builtin editors, use wxPGEditor_X, where X is builtin editor's
1674 name (TextCtrl, Choice, etc. see wxPGEditor documentation for full
1677 For custom editors, use pointer you received from
1678 wxPropertyGrid::RegisterEditorClass().
1680 void SetEditor( const wxPGEditor
* editor
)
1682 m_customEditor
= editor
;
1686 /** Sets editor for a property.
1688 inline void SetEditor( const wxString
& editorName
);
1690 /** Sets cell information for given column.
1692 Note that the property takes ownership of given wxPGCell instance.
1694 void SetCell( int column
, wxPGCell
* cellObj
);
1696 /** Sets common value selected for this property. -1 for none.
1698 void SetCommonValue( int commonValue
)
1700 m_commonValue
= commonValue
;
1703 /** Sets flags from a '|' delimited string. Note that flag names are not
1704 prepended with 'wxPG_PROP_'.
1706 void SetFlagsFromString( const wxString
& str
);
1708 /** Sets property's "is it modified?" flag. Affects children recursively.
1710 void SetModifiedStatus( bool modified
)
1712 SetFlagRecursively(wxPG_PROP_MODIFIED
, modified
);
1715 /** Call in OnEvent(), OnButtonClick() etc. to change the property value
1716 based on user input.
1719 This method is const since it doesn't actually modify value, but posts
1720 given variant as pending value, stored in wxPropertyGrid.
1722 void SetValueInEvent( wxVariant value
) const;
1725 Call this to set value of the property.
1727 Unlike methods in wxPropertyGrid, this does not automatically update
1731 Use wxPropertyGrid::ChangePropertyValue() instead if you need to run
1732 through validation process and send property change event.
1734 If you need to change property value in event, based on user input, use
1735 SetValueInEvent() instead.
1738 Pointer to list variant that contains child values. Used to indicate
1739 which children should be marked as modified.
1741 Various flags (for instance, wxPG_SETVAL_REFRESH_EDITOR).
1743 void SetValue( wxVariant value
, wxVariant
* pList
= NULL
, int flags
= 0 );
1745 /** Set wxBitmap in front of the value. This bitmap may be ignored
1746 by custom cell renderers.
1748 void SetValueImage( wxBitmap
& bmp
);
1750 /** If property has choices and they are not yet exclusive, new such copy
1751 of them will be created.
1753 void SetChoicesExclusive()
1755 m_choices
.SetExclusive();
1758 /** Sets selected choice and changes property value.
1760 Tries to retain value type, although currently if it is not string,
1761 then it is forced to integer.
1763 void SetChoiceSelection( int newValue
);
1765 void SetExpanded( bool expanded
)
1767 if ( !expanded
) m_flags
|= wxPG_PROP_COLLAPSED
;
1768 else m_flags
&= ~wxPG_PROP_COLLAPSED
;
1771 void SetFlag( FlagType flag
) { m_flags
|= flag
; }
1773 void SetFlagRecursively( FlagType flag
, bool set
);
1775 void SetHelpString( const wxString
& helpString
)
1777 m_helpString
= helpString
;
1780 void SetLabel( const wxString
& label
) { m_label
= label
; }
1782 inline void SetName( const wxString
& newName
);
1784 void SetValueToUnspecified()
1786 wxVariant val
; // Create NULL variant
1790 #if wxUSE_VALIDATORS
1791 /** Sets wxValidator for a property*/
1792 void SetValidator( const wxValidator
& validator
)
1794 m_validator
= wxDynamicCast(validator
.Clone(),wxValidator
);
1797 /** Gets assignable version of property's validator. */
1798 wxValidator
* GetValidator() const
1802 return DoGetValidator();
1804 #endif // #if wxUSE_VALIDATORS
1806 /** Updates property value in case there were last minute
1807 changes. If value was unspecified, it will be set to default.
1808 Use only for properties that have TextCtrl-based editor.
1810 If you have code similar to
1812 // Update the value in case of last minute changes
1813 if ( primary && propgrid->IsEditorsValueModified() )
1814 GetEditorClass()->CopyValueFromControl( this, primary );
1816 in wxPGProperty::OnEvent wxEVT_COMMAND_BUTTON_CLICKED handler,
1817 then replace it with call to this method.
1819 True if value changed.
1821 bool PrepareValueForDialogEditing( wxPropertyGrid
* propgrid
);
1824 /** Returns client data (void*) of a property.
1826 void* GetClientData() const
1828 return m_clientData
;
1831 /** Sets client data (void*) of a property.
1833 This untyped client data has to be deleted manually.
1835 void SetClientData( void* clientData
)
1837 m_clientData
= clientData
;
1840 /** Returns client object of a property.
1842 void SetClientObject(wxClientData
* clientObject
)
1844 delete m_clientObject
;
1845 m_clientObject
= clientObject
;
1848 /** Sets managed client object of a property.
1850 wxClientData
*GetClientObject() const { return m_clientObject
; }
1853 /** Sets new set of choices for property.
1856 This operation clears the property value.
1858 bool SetChoices( wxPGChoices
& choices
);
1860 /** Sets new set of choices for property.
1862 bool SetChoices( const wxArrayString
& labels
,
1863 const wxArrayInt
& values
= wxArrayInt() )
1865 wxPGChoices
chs(labels
, values
);
1866 return SetChoices(chs
);
1869 /** Set max length of text in text editor.
1871 inline bool SetMaxLength( int maxLen
);
1873 /** Call with 'false' in OnSetValue to cancel value changes after all
1874 (ie. cancel 'true' returned by StringToValue() or IntToValue()).
1876 void SetWasModified( bool set
= true )
1878 if ( set
) m_flags
|= wxPG_PROP_WAS_MODIFIED
;
1879 else m_flags
&= ~wxPG_PROP_WAS_MODIFIED
;
1882 const wxString
& GetHelpString() const
1884 return m_helpString
;
1887 void ClearFlag( FlagType flag
) { m_flags
&= ~(flag
); }
1889 // Use, for example, to detect if item is inside collapsed section.
1890 bool IsSomeParent( wxPGProperty
* candidate_parent
) const;
1893 Adapts list variant into proper value using consecutive
1896 void AdaptListToValue( wxVariant
& list
, wxVariant
* value
) const;
1898 /** This is used by properties that have fixed sub-properties. */
1899 void AddChild( wxPGProperty
* prop
);
1901 /** Returns height of children, recursively, and
1902 by taking expanded/collapsed status into account.
1904 iMax is used when finding property y-positions.
1906 int GetChildrenHeight( int lh
, int iMax
= -1 ) const;
1908 /** Returns number of child properties */
1909 unsigned int GetChildCount() const { return m_children
.GetCount(); }
1911 /** Returns sub-property at index i. */
1912 wxPGProperty
* Item( size_t i
) const
1913 { return (wxPGProperty
*)m_children
.Item(i
); }
1915 /** Returns last sub-property.
1917 wxPGProperty
* Last() const { return (wxPGProperty
*)m_children
.Last(); }
1919 /** Returns index of given sub-property. */
1920 int Index( const wxPGProperty
* p
) const
1921 { return m_children
.Index((wxPGProperty
*)p
); }
1923 /** Deletes all sub-properties. */
1926 // Puts correct indexes to children
1927 void FixIndexesOfChildren( size_t starthere
= 0 );
1930 // Returns wxPropertyGridPageState in which this property resides.
1931 wxPropertyGridPageState
* GetParentState() const { return m_parentState
; }
1934 wxPGProperty
* GetItemAtY( unsigned int y
,
1936 unsigned int* nextItemY
) const;
1938 /** Returns (direct) child property with given name (or NULL if not found).
1940 wxPGProperty
* GetPropertyByName( const wxString
& name
) const;
1944 DocStr(GetClientData
,
1945 "Returns the client data object for a property", "");
1946 PyObject
* GetClientData() {
1947 wxPyClientData
* data
= (wxPyClientData
*)self
->GetClientObject();
1949 Py_INCREF(data
->m_obj
);
1957 DocStr(SetClientData
,
1958 "Associate the given client data.", "");
1959 void SetClientData(PyObject
* clientData
) {
1960 wxPyClientData
* data
= new wxPyClientData(clientData
);
1961 self
->SetClientObject(data
);
1965 GetClientObject
= GetClientData
1966 SetClientObject
= SetClientData
1972 static wxString
* sm_wxPG_LABEL
;
1974 /** This member is public so scripting language bindings
1975 wrapper code can access it freely.
1980 /** Returns text for given column.
1982 wxString
GetColumnText( unsigned int col
) const;
1984 /** Returns (direct) child property with given name (or NULL if not found),
1988 Start looking for the child at this index.
1991 Does not support scope (ie. Parent.Child notation).
1993 wxPGProperty
* GetPropertyByNameWH( const wxString
& name
,
1994 unsigned int hintIndex
) const;
1996 /** This is used by Insert etc. */
1997 void AddChild2( wxPGProperty
* prop
,
1999 bool correct_mode
= true );
2001 void DoSetName(const wxString
& str
) { m_name
= str
; }
2003 // Call for after sub-properties added with AddChild
2004 void PrepareSubProperties();
2006 void SetParentalType( int flag
)
2008 m_flags
&= ~(wxPG_PROP_PROPERTY
|wxPG_PROP_PARENTAL_FLAGS
);
2012 void SetParentState( wxPropertyGridPageState
* pstate
)
2013 { m_parentState
= pstate
; }
2015 // Call after fixed sub-properties added/removed after creation.
2016 // if oldSelInd >= 0 and < new max items, then selection is
2018 void SubPropsChanged( int oldSelInd
= -1 );
2020 int GetY2( int lh
) const;
2024 wxPGProperty
* m_parent
;
2025 wxPropertyGridPageState
* m_parentState
;
2027 wxClientData
* m_clientObject
;
2029 // Overrides editor returned by property class
2030 const wxPGEditor
* m_customEditor
;
2031 #if wxUSE_VALIDATORS
2032 // Editor is going to get this validator
2033 wxValidator
* m_validator
;
2035 // Show this in front of the value
2037 // TODO: Can bitmap be implemented with wxPGCell?
2038 wxBitmap
* m_valueBitmap
;
2041 wxPGAttributeStorage m_attributes
;
2042 wxArrayPtrVoid m_children
;
2044 // Extended cell information
2045 wxArrayPtrVoid m_cells
;
2047 // Choices shown in drop-down list of editor control.
2048 wxPGChoices m_choices
;
2050 // Help shown in statusbar or help box.
2051 wxString m_helpString
;
2053 // Index in parent's property array.
2054 unsigned int m_arrIndex
;
2056 // If not -1, then overrides m_value
2061 // Maximum length (mainly for string properties). Could be in some sort of
2062 // wxBaseStringProperty, but currently, for maximum flexibility and
2063 // compatibility, we'll stick it here. Anyway, we had 3 excess bytes to use
2064 // so short int will fit in just fine.
2067 // Root has 0, categories etc. at that level 1, etc.
2068 unsigned char m_depth
;
2070 // m_depthBgCol indicates width of background colour between margin and item
2071 // (essentially this is category's depth, if none then equals m_depth).
2072 unsigned char m_depthBgCol
;
2074 unsigned char m_bgColIndex
; // Background brush index.
2075 unsigned char m_fgColIndex
; // Foreground colour index.
2078 // Called in constructors.
2080 void Init( const wxString
& label
, const wxString
& name
);
2081 #endif // #ifndef SWIG
2084 // -----------------------------------------------------------------------
2087 // Property class declaration helper macros
2088 // (wxPGRootPropertyClass and wxPropertyCategory require this).
2091 #define WX_PG_DECLARE_DOGETEDITORCLASS \
2092 virtual const wxPGEditor* DoGetEditorClass() const;
2095 #define WX_PG_DECLARE_PROPERTY_CLASS(CLASSNAME) \
2097 DECLARE_DYNAMIC_CLASS(CLASSNAME) \
2098 WX_PG_DECLARE_DOGETEDITORCLASS \
2101 #define WX_PG_DECLARE_PROPERTY_CLASS(CLASSNAME)
2104 // Implements sans constructor function. Also, first arg is class name, not
2106 #define WX_PG_IMPLEMENT_PROPERTY_CLASS_PLAIN(PROPNAME,T,EDITOR) \
2107 const wxPGEditor* PROPNAME::DoGetEditorClass() const \
2109 return wxPGEditor_##EDITOR; \
2112 // -----------------------------------------------------------------------
2116 /** @class wxPGRootProperty
2118 Root parent property.
2120 class WXDLLIMPEXP_PROPGRID wxPGRootProperty
: public wxPGProperty
2123 WX_PG_DECLARE_PROPERTY_CLASS(wxPGRootProperty
)
2128 virtual ~wxPGRootProperty();
2130 virtual bool StringToValue( wxVariant
&, const wxString
&, int ) const
2138 // -----------------------------------------------------------------------
2140 /** @class wxPropertyCategory
2142 Category (caption) property.
2144 class WXDLLIMPEXP_PROPGRID wxPropertyCategory
: public wxPGProperty
2146 friend class wxPropertyGrid
;
2147 friend class wxPropertyGridPageState
;
2148 WX_PG_DECLARE_PROPERTY_CLASS(wxPropertyCategory
)
2151 /** Default constructor is only used in special cases. */
2152 wxPropertyCategory();
2154 wxPropertyCategory( const wxString
& label
,
2155 const wxString
& name
= wxPG_LABEL
);
2156 ~wxPropertyCategory();
2158 int GetTextExtent( const wxWindow
* wnd
, const wxFont
& font
) const;
2161 virtual wxString
GetValueAsString( int argFlags
) const;
2163 void SetTextColIndex( unsigned int colInd
)
2164 { m_capFgColIndex
= (wxByte
) colInd
; }
2165 unsigned int GetTextColIndex() const
2166 { return (unsigned int) m_capFgColIndex
; }
2168 void CalculateTextExtent( wxWindow
* wnd
, const wxFont
& font
);
2170 int m_textExtent
; // pre-calculated length of text
2171 wxByte m_capFgColIndex
; // caption text colour index
2179 // -----------------------------------------------------------------------
2181 #endif // wxUSE_PROPGRID
2183 #endif // _WX_PROPGRID_PROPERTY_H_