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 wxVector
<wxPGChoiceEntry
*>::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" );
651 wxASSERT( m_refCount
>= 0 );
652 if ( m_refCount
== 0 )
657 wxVector
<wxPGChoiceEntry
*> 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
)
861 /** Version that works with wxArrayString and wxArrayInt. */
862 void Set( const wxArrayString
& labels
,
863 const wxArrayInt
& values
= wxArrayInt() )
872 // Creates exclusive copy of current choices
875 if ( m_data
->m_refCount
!= 1 )
877 wxPGChoicesData
* data
= new wxPGChoicesData();
878 data
->CopyDataFrom(m_data
);
884 // Returns data, increases refcount.
885 wxPGChoicesData
* GetData()
887 wxASSERT( m_data
->m_refCount
!= 0xFFFFFFF );
888 m_data
->m_refCount
++;
892 // Returns plain data ptr - no refcounting stuff is done.
893 wxPGChoicesData
* GetDataPtr() const { return m_data
; }
895 // Changes ownership of data to you.
896 wxPGChoicesData
* ExtractData()
898 wxPGChoicesData
* data
= m_data
;
899 m_data
= wxPGChoicesEmptyData
;
903 wxArrayString
GetLabels() const;
906 void operator= (const wxPGChoices
& a
)
908 AssignData(a
.m_data
);
911 wxPGChoiceEntry
& operator[](unsigned int i
)
916 const wxPGChoiceEntry
& operator[](unsigned int i
) const
922 wxPGChoicesData
* m_data
;
929 // -----------------------------------------------------------------------
931 /** @class wxPGProperty
933 wxPGProperty is base class for all wxPropertyGrid properties.
935 NB: Full class overview is now only present in
936 interface/wx/propgrid/property.h.
941 class WXDLLIMPEXP_PROPGRID wxPGProperty
: public wxObject
943 friend class wxPropertyGrid
;
944 friend class wxPropertyGridInterface
;
945 friend class wxPropertyGridPageState
;
946 friend class wxPropertyGridPopulator
;
947 friend class wxStringProperty
; // Proper "<composed>" support requires this
949 DECLARE_ABSTRACT_CLASS(wxPGProperty
)
952 typedef wxUint32 FlagType
;
954 /** Basic constructor.
959 Non-abstract property classes should have constructor of this style:
963 // If T is a class, then it should be a constant reference
964 // (e.g. const T& ) instead.
965 MyProperty( const wxString& label, const wxString& name, T value )
968 // Generally recommended way to set the initial value
969 // (as it should work in pretty much 100% of cases).
974 // If has private child properties then create them here, e.g.:
975 // AddChild( new wxStringProperty( "Subprop 1",
977 // value.GetSubProp1() ) );
982 wxPGProperty( const wxString
& label
, const wxString
& name
);
986 It is customary for derived properties to implement this.
988 virtual ~wxPGProperty();
990 /** This virtual function is called after m_value has been set.
993 - If m_value was set to Null variant (ie. unspecified value),
994 OnSetValue() will not be called.
995 - m_value may be of any variant type. Typically properties internally
996 support only one variant type, and as such OnSetValue() provides a
997 good opportunity to convert
998 supported values into internal type.
999 - Default implementation does nothing.
1001 virtual void OnSetValue();
1003 /** Override this to return something else than m_value as the value.
1005 virtual wxVariant
DoGetValue() const { return m_value
; }
1007 #if !defined(SWIG) || defined(CREATE_VCW)
1008 /** Implement this function in derived class to check the value.
1009 Return true if it is ok. Returning false prevents property change events
1013 - Default implementation always returns true.
1015 virtual bool ValidateValue( wxVariant
& value
,
1016 wxPGValidationInfo
& validationInfo
) const;
1019 Converts text into wxVariant value appropriate for this property.
1022 On function entry this is the old value (should not be wxNullVariant
1023 in normal cases). Translated value must be assigned back to it.
1026 Text to be translated into variant.
1029 If wxPG_FULL_VALUE is set, returns complete, storable value instead
1030 of displayable one (they may be different).
1031 If wxPG_COMPOSITE_FRAGMENT is set, text is interpreted as a part of
1032 composite property string value (as generated by GetValueAsString()
1033 called with this same flag).
1035 @return Returns @true if resulting wxVariant value was different.
1037 @remarks Default implementation converts semicolon delimited tokens into
1038 child values. Only works for properties with children.
1040 You might want to take into account that m_value is Null variant
1041 if property value is unspecified (which is usually only case if
1042 you explicitly enabled that sort behavior).
1044 virtual bool StringToValue( wxVariant
& variant
,
1045 const wxString
& text
,
1046 int argFlags
= 0 ) const;
1049 Converts integer (possibly a choice selection) into wxVariant value
1050 appropriate for this property.
1053 On function entry this is the old value (should not be wxNullVariant
1054 in normal cases). Translated value must be assigned back to it.
1057 Integer to be translated into variant.
1060 If wxPG_FULL_VALUE is set, returns complete, storable value instead
1063 @return Returns @true if resulting wxVariant value was different.
1066 - If property is not supposed to use choice or spinctrl or other editor
1067 with int-based value, it is not necessary to implement this method.
1068 - Default implementation simply assign given int to m_value.
1069 - If property uses choice control, and displays a dialog on some choice
1070 items, then it is preferred to display that dialog in IntToValue
1072 - You might want to take into account that m_value is Null variant if
1073 property value is unspecified (which is usually only case if you
1074 explicitly enabled that sort behavior).
1076 virtual bool IntToValue( wxVariant
& value
,
1078 int argFlags
= 0 ) const;
1079 #endif // !defined(SWIG) || defined(CREATE_VCW)
1082 /** Returns text representation of property's value.
1085 If wxPG_FULL_VALUE is set, returns complete, storable string value
1086 instead of displayable. If wxPG_EDITABLE_VALUE is set, returns
1087 string value that must be editable in textctrl. If
1088 wxPG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to
1089 display as a part of composite property string value.
1092 Default implementation returns string composed from text
1093 representations of child properties.
1095 virtual wxString
GetValueAsString( int argFlags
= 0 ) const;
1097 /** Converts string to a value, and if successful, calls SetValue() on it.
1098 Default behavior is to do nothing.
1100 String to get the value from.
1102 true if value was changed.
1104 bool SetValueFromString( const wxString
& text
, int flags
= 0 );
1106 /** Converts integer to a value, and if succesful, calls SetValue() on it.
1107 Default behavior is to do nothing.
1109 Int to get the value from.
1111 If has wxPG_FULL_VALUE, then the value given is a actual value and
1114 True if value was changed.
1116 bool SetValueFromInt( long value
, int flags
= 0 );
1119 Returns size of the custom painted image in front of property.
1121 This method must be overridden to return non-default value if
1122 OnCustomPaint is to be called.
1124 Normally -1, but can be an index to the property's list of items.
1126 - Default behavior is to return wxSize(0,0), which means no image.
1127 - Default image width or height is indicated with dimension -1.
1128 - You can also return wxPG_DEFAULT_IMAGE_SIZE, i.e. wxSize(-1, -1).
1130 virtual wxSize
OnMeasureImage( int item
= -1 ) const;
1133 Events received by editor widgets are processed here.
1135 Note that editor class usually processes most events. Some, such as
1136 button press events of TextCtrlAndButton class, can be handled here.
1137 Also, if custom handling for regular events is desired, then that can
1138 also be done (for example, wxSystemColourProperty custom handles
1139 wxEVT_COMMAND_CHOICE_SELECTED to display colour picker dialog when
1140 'custom' selection is made).
1142 If the event causes value to be changed, SetValueInEvent()
1143 should be called to set the new value.
1148 Should return true if any changes in value should be reported.
1150 If property uses choice control, and displays a dialog on some choice
1151 items, then it is preferred to display that dialog in IntToValue
1154 virtual bool OnEvent( wxPropertyGrid
* propgrid
,
1155 wxWindow
* wnd_primary
,
1159 Called after value of a child property has been altered.
1161 Note that this function is usually called at the time that value of
1162 this property, or given child property, is still pending for change.
1164 Sample pseudo-code implementation:
1167 void MyProperty::ChildChanged( wxVariant& thisValue,
1169 wxVariant& childValue ) const
1171 // Acquire reference to actual type of data stored in variant
1172 // (TFromVariant only exists if wxPropertyGrid's wxVariant-macros
1173 // were used to create the variant class).
1174 T& data = TFromVariant(thisValue);
1176 // Copy childValue into data.
1177 switch ( childIndex )
1180 data.SetSubProp1( childvalue.GetLong() );
1183 data.SetSubProp2( childvalue.GetString() );
1191 Value of this property, that should be altered.
1193 Index of child changed (you can use Item(childIndex) to get).
1195 Value of the child property.
1197 virtual void ChildChanged( wxVariant
& thisValue
,
1199 wxVariant
& childValue
) const;
1201 /** Returns pointer to an instance of used editor.
1203 virtual const wxPGEditor
* DoGetEditorClass() const;
1205 /** Returns pointer to the wxValidator that should be used
1206 with the editor of this property (NULL for no validator).
1207 Setting validator explicitly via SetPropertyValidator
1210 In most situations, code like this should work well
1211 (macros are used to maintain one actual validator instance,
1212 so on the second call the function exits within the first
1217 wxValidator* wxMyPropertyClass::DoGetValidator () const
1219 WX_PG_DOGETVALIDATOR_ENTRY()
1221 wxMyValidator* validator = new wxMyValidator(...);
1223 ... prepare validator...
1225 WX_PG_DOGETVALIDATOR_EXIT(validator)
1231 You can get common filename validator by returning
1232 wxFileProperty::GetClassValidator(). wxDirProperty,
1233 for example, uses it.
1235 virtual wxValidator
* DoGetValidator () const;
1238 Override to paint an image in front of the property value text or
1239 drop-down list item (but only if wxPGProperty::OnMeasureImage is
1240 overridden as well).
1242 If property's OnMeasureImage() returns size that has height != 0 but
1243 less than row height ( < 0 has special meanings), wxPropertyGrid calls
1244 this method to draw a custom image in a limited area in front of the
1245 editor control or value text/graphics, and if control has drop-down
1246 list, then the image is drawn there as well (even in the case
1247 OnMeasureImage() returned higher height than row height).
1249 NOTE: Following applies when OnMeasureImage() returns a "flexible"
1250 height ( using wxPG_FLEXIBLE_SIZE(W,H) macro), which implies variable
1251 height items: If rect.x is < 0, then this is a measure item call, which
1252 means that dc is invalid and only thing that should be done is to set
1253 paintdata.m_drawnHeight to the height of the image of item at index
1254 paintdata.m_choiceItem. This call may be done even as often as once
1255 every drop-down popup show.
1260 Box reserved for custom graphics. Includes surrounding rectangle,
1261 if any. If x is < 0, then this is a measure item call (see above).
1263 wxPGPaintData structure with much useful data.
1266 - You can actually exceed rect width, but if you do so then
1267 paintdata.m_drawnWidth must be set to the full width drawn in
1269 - Due to technical reasons, rect's height will be default even if
1270 custom height was reported during measure call.
1271 - Brush is guaranteed to be default background colour. It has been
1272 already used to clear the background of area being painted. It
1274 - Pen is guaranteed to be 1-wide 'black' (or whatever is the proper
1275 colour) pen for drawing framing rectangle. It can be changed as
1278 @see GetValueAsString()
1280 virtual void OnCustomPaint( wxDC
& dc
,
1282 wxPGPaintData
& paintdata
);
1285 Returns used wxPGCellRenderer instance for given property column
1288 Default implementation returns editor's renderer for all columns.
1290 virtual wxPGCellRenderer
* GetCellRenderer( int column
) const;
1292 /** Returns which choice is currently selected. Only applies to properties
1295 Needs to reimplemented in derived class if property value does not
1296 map directly to a choice. Integer as index, bool, and string usually do.
1298 virtual int GetChoiceSelection() const;
1301 Refresh values of child properties.
1303 Automatically called after value is set.
1305 virtual void RefreshChildren();
1307 /** Special handling for attributes of this property.
1309 If returns false, then the attribute will be automatically stored in
1312 Default implementation simply returns false.
1314 virtual bool DoSetAttribute( const wxString
& name
, wxVariant
& value
);
1316 /** Returns value of an attribute.
1318 Override if custom handling of attributes is needed.
1320 Default implementation simply return NULL variant.
1322 virtual wxVariant
DoGetAttribute( const wxString
& name
) const;
1324 /** Returns instance of a new wxPGEditorDialogAdapter instance, which is
1325 used when user presses the (optional) button next to the editor control;
1327 Default implementation returns NULL (ie. no action is generated when
1330 virtual wxPGEditorDialogAdapter
* GetEditorDialog() const;
1332 /** Returns wxPGCell of given column, NULL if none. If valid
1333 object is returned, caller will gain its ownership.
1335 wxPGCell
* AcquireCell( unsigned int column
)
1337 if ( column
>= m_cells
.size() )
1340 wxPGCell
* cell
= (wxPGCell
*) m_cells
[column
];
1341 m_cells
[column
] = NULL
;
1345 /** Append a new choice to property's list of choices.
1347 int AddChoice( const wxString
& label
, int value
= wxPG_INVALID_VALUE
)
1349 return InsertChoice(label
, wxNOT_FOUND
, value
);
1353 Returns true if children of this property are component values (for
1354 instance, points size, face name, and is_underlined are component
1357 bool AreChildrenComponents() const
1359 if ( m_flags
& (wxPG_PROP_COMPOSED_VALUE
|wxPG_PROP_AGGREGATE
) )
1366 Removes entry from property's wxPGChoices and editor control (if it is
1369 If selected item is deleted, then the value is set to unspecified.
1371 void DeleteChoice( int index
);
1374 Call to enable or disable usage of common value (integer value that can
1375 be selected for properties instead of their normal values) for this
1378 Common values are disabled by the default for all properties.
1380 void EnableCommonValue( bool enable
= true )
1382 if ( enable
) SetFlag( wxPG_PROP_USES_COMMON_VALUE
);
1383 else ClearFlag( wxPG_PROP_USES_COMMON_VALUE
);
1386 /** Composes text from values of child properties. */
1387 void GenerateComposedValue( wxString
& text
, int argFlags
= 0 ) const;
1389 /** Returns property's label. */
1390 const wxString
& GetLabel() const { return m_label
; }
1392 /** Returns property's name with all (non-category, non-root) parents. */
1393 wxString
GetName() const;
1396 Returns property's base name (ie parent's name is not added in any
1399 const wxString
& GetBaseName() const { return m_name
; }
1401 /** Returns read-only reference to property's list of choices.
1403 const wxPGChoices
& GetChoices() const
1408 /** Returns coordinate to the top y of the property. Note that the
1409 position of scrollbars is not taken into account.
1413 wxVariant
GetValue() const
1415 return DoGetValue();
1419 /** Returns reference to the internal stored value. GetValue is preferred
1420 way to get the actual value, since GetValueRef ignores DoGetValue,
1421 which may override stored value.
1423 wxVariant
& GetValueRef()
1428 const wxVariant
& GetValueRef() const
1434 /** To acquire property's value as string, you should use this
1435 function (instead of GetValueAsString()), as it may produce
1436 more accurate value in future versions.
1438 wxString
GetValueString( int argFlags
= 0 ) const;
1440 void UpdateControl( wxWindow
* primary
);
1442 /** Returns wxPGCell of given column, NULL if none. wxPGProperty
1443 will retain ownership of the cell object.
1445 wxPGCell
* GetCell( unsigned int column
) const
1447 if ( column
>= m_cells
.size() )
1450 return (wxPGCell
*) m_cells
[column
];
1453 /** Return number of displayed common values for this property.
1455 int GetDisplayedCommonValueCount() const;
1457 wxString
GetDisplayedString() const
1459 return GetValueString(0);
1462 /** Returns property grid where property lies. */
1463 wxPropertyGrid
* GetGrid() const;
1465 /** Returns owner wxPropertyGrid, but only if one is currently on a page
1466 displaying this property. */
1467 wxPropertyGrid
* GetGridIfDisplayed() const;
1469 /** Returns highest level non-category, non-root parent. Useful when you
1470 have nested wxCustomProperties/wxParentProperties.
1472 Thus, if immediate parent is root or category, this will return the
1475 wxPGProperty
* GetMainParent() const;
1477 /** Return parent of property */
1478 wxPGProperty
* GetParent() const { return m_parent
; }
1480 /** Returns true if property has editable wxTextCtrl when selected.
1483 Altough disabled properties do not displayed editor, they still
1484 return True here as being disabled is considered a temporary
1485 condition (unlike being read-only or having limited editing enabled).
1487 bool IsTextEditable() const;
1489 bool IsValueUnspecified() const
1491 return m_value
.IsNull();
1494 FlagType
HasFlag( FlagType flag
) const
1496 return ( m_flags
& flag
);
1499 /** Returns comma-delimited string of property attributes.
1501 const wxPGAttributeStorage
& GetAttributes() const
1503 return m_attributes
;
1506 /** Returns m_attributes as list wxVariant.
1508 wxVariant
GetAttributesAsList() const;
1510 FlagType
GetFlags() const
1515 const wxPGEditor
* GetEditorClass() const;
1517 wxString
GetValueType() const
1519 return m_value
.GetType();
1522 /** Returns editor used for given column. NULL for no editor.
1524 const wxPGEditor
* GetColumnEditor( int column
) const
1527 return GetEditorClass();
1532 /** Returns common value selected for this property. -1 for none.
1534 int GetCommonValue() const
1536 return m_commonValue
;
1539 /** Returns true if property has even one visible child.
1541 bool HasVisibleChildren() const;
1543 /** Inserts a new choice to property's list of choices.
1545 int InsertChoice( const wxString
& label
, int index
, int value
= wxPG_INVALID_VALUE
);
1548 Returns true if this property is actually a wxPropertyCategory.
1550 bool IsCategory() const { return HasFlag(wxPG_PROP_CATEGORY
)?true:false; }
1552 /** Returns true if this property is actually a wxRootProperty.
1554 bool IsRoot() const { return (m_parent
== NULL
); }
1556 /** Returns true if this is a sub-property. */
1557 bool IsSubProperty() const
1559 wxPGProperty
* parent
= (wxPGProperty
*)m_parent
;
1560 if ( parent
&& !parent
->IsCategory() )
1565 /** Returns last visible sub-property, recursively.
1567 const wxPGProperty
* GetLastVisibleSubItem() const;
1569 wxVariant
GetDefaultValue() const;
1571 int GetMaxLength() const
1573 return (int) m_maxLen
;
1577 Determines, recursively, if all children are not unspecified.
1580 Assumes members in this wxVariant list as pending
1583 bool AreAllChildrenSpecified( wxVariant
* pendingList
= NULL
) const;
1585 /** Updates composed values of parent non-category properties, recursively.
1586 Returns topmost property updated.
1589 - Must not call SetValue() (as can be called in it).
1591 wxPGProperty
* UpdateParentValues();
1593 /** Returns true if containing grid uses wxPG_EX_AUTO_UNSPECIFIED_VALUES.
1595 bool UsesAutoUnspecified() const
1597 return HasFlag(wxPG_PROP_AUTO_UNSPECIFIED
)?true:false;
1600 wxBitmap
* GetValueImage() const
1602 return m_valueBitmap
;
1605 wxVariant
GetAttribute( const wxString
& name
) const;
1608 Returns named attribute, as string, if found.
1610 Otherwise defVal is returned.
1612 wxString
GetAttribute( const wxString
& name
, const wxString
& defVal
) const;
1615 Returns named attribute, as long, if found.
1617 Otherwise defVal is returned.
1619 long GetAttributeAsLong( const wxString
& name
, long defVal
) const;
1622 Returns named attribute, as double, if found.
1624 Otherwise defVal is returned.
1626 double GetAttributeAsDouble( const wxString
& name
, double defVal
) const;
1628 unsigned int GetDepth() const { return (unsigned int)m_depth
; }
1630 /** Gets flags as a'|' delimited string. Note that flag names are not
1631 prepended with 'wxPG_PROP_'.
1633 String will only be made to include flags combined by this parameter.
1635 wxString
GetFlagsAsString( FlagType flagsMask
) const;
1637 /** Returns position in parent's array. */
1638 unsigned int GetIndexInParent() const
1640 return (unsigned int)m_arrIndex
;
1643 /** Hides or reveals the property.
1645 true for hide, false for reveal.
1647 By default changes are applied recursively. Set this paramter
1648 wxPG_DONT_RECURSE to prevent this.
1650 inline bool Hide( bool hide
, int flags
= wxPG_RECURSE
);
1652 bool IsExpanded() const
1653 { return (!(m_flags
& wxPG_PROP_COLLAPSED
) && GetChildCount()); }
1655 /** Returns true if all parents expanded.
1657 bool IsVisible() const;
1659 bool IsEnabled() const { return !(m_flags
& wxPG_PROP_DISABLED
); }
1661 /** If property's editor is created this forces its recreation.
1662 Useful in SetAttribute etc. Returns true if actually did anything.
1664 bool RecreateEditor();
1666 /** If property's editor is active, then update it's value.
1668 void RefreshEditor();
1670 /** Sets an attribute for this property.
1672 Text identifier of attribute. See @ref propgrid_property_attributes.
1676 void SetAttribute( const wxString
& name
, wxVariant value
);
1678 void SetAttributes( const wxPGAttributeStorage
& attributes
);
1681 /** Sets editor for a property.
1684 For builtin editors, use wxPGEditor_X, where X is builtin editor's
1685 name (TextCtrl, Choice, etc. see wxPGEditor documentation for full
1688 For custom editors, use pointer you received from
1689 wxPropertyGrid::RegisterEditorClass().
1691 void SetEditor( const wxPGEditor
* editor
)
1693 m_customEditor
= editor
;
1697 /** Sets editor for a property.
1699 inline void SetEditor( const wxString
& editorName
);
1701 /** Sets cell information for given column.
1703 Note that the property takes ownership of given wxPGCell instance.
1705 void SetCell( int column
, wxPGCell
* cellObj
);
1707 /** Sets common value selected for this property. -1 for none.
1709 void SetCommonValue( int commonValue
)
1711 m_commonValue
= commonValue
;
1714 /** Sets flags from a '|' delimited string. Note that flag names are not
1715 prepended with 'wxPG_PROP_'.
1717 void SetFlagsFromString( const wxString
& str
);
1719 /** Sets property's "is it modified?" flag. Affects children recursively.
1721 void SetModifiedStatus( bool modified
)
1723 SetFlagRecursively(wxPG_PROP_MODIFIED
, modified
);
1726 /** Call in OnEvent(), OnButtonClick() etc. to change the property value
1727 based on user input.
1730 This method is const since it doesn't actually modify value, but posts
1731 given variant as pending value, stored in wxPropertyGrid.
1733 void SetValueInEvent( wxVariant value
) const;
1736 Call this to set value of the property.
1738 Unlike methods in wxPropertyGrid, this does not automatically update
1742 Use wxPropertyGrid::ChangePropertyValue() instead if you need to run
1743 through validation process and send property change event.
1745 If you need to change property value in event, based on user input, use
1746 SetValueInEvent() instead.
1749 Pointer to list variant that contains child values. Used to indicate
1750 which children should be marked as modified.
1752 Various flags (for instance, wxPG_SETVAL_REFRESH_EDITOR).
1754 void SetValue( wxVariant value
, wxVariant
* pList
= NULL
, int flags
= 0 );
1756 /** Set wxBitmap in front of the value. This bitmap may be ignored
1757 by custom cell renderers.
1759 void SetValueImage( wxBitmap
& bmp
);
1761 /** If property has choices and they are not yet exclusive, new such copy
1762 of them will be created.
1764 void SetChoicesExclusive()
1766 m_choices
.SetExclusive();
1769 /** Sets selected choice and changes property value.
1771 Tries to retain value type, although currently if it is not string,
1772 then it is forced to integer.
1774 void SetChoiceSelection( int newValue
);
1776 void SetExpanded( bool expanded
)
1778 if ( !expanded
) m_flags
|= wxPG_PROP_COLLAPSED
;
1779 else m_flags
&= ~wxPG_PROP_COLLAPSED
;
1782 void SetFlag( FlagType flag
) { m_flags
|= flag
; }
1784 void SetFlagRecursively( FlagType flag
, bool set
);
1786 void SetHelpString( const wxString
& helpString
)
1788 m_helpString
= helpString
;
1791 void SetLabel( const wxString
& label
) { m_label
= label
; }
1793 inline void SetName( const wxString
& newName
);
1795 void SetValueToUnspecified()
1797 wxVariant val
; // Create NULL variant
1801 #if wxUSE_VALIDATORS
1802 /** Sets wxValidator for a property*/
1803 void SetValidator( const wxValidator
& validator
)
1805 m_validator
= wxDynamicCast(validator
.Clone(),wxValidator
);
1808 /** Gets assignable version of property's validator. */
1809 wxValidator
* GetValidator() const
1813 return DoGetValidator();
1815 #endif // #if wxUSE_VALIDATORS
1817 /** Updates property value in case there were last minute
1818 changes. If value was unspecified, it will be set to default.
1819 Use only for properties that have TextCtrl-based editor.
1821 If you have code similar to
1823 // Update the value in case of last minute changes
1824 if ( primary && propgrid->IsEditorsValueModified() )
1825 GetEditorClass()->CopyValueFromControl( this, primary );
1827 in wxPGProperty::OnEvent wxEVT_COMMAND_BUTTON_CLICKED handler,
1828 then replace it with call to this method.
1830 True if value changed.
1832 bool PrepareValueForDialogEditing( wxPropertyGrid
* propgrid
);
1835 /** Returns client data (void*) of a property.
1837 void* GetClientData() const
1839 return m_clientData
;
1842 /** Sets client data (void*) of a property.
1844 This untyped client data has to be deleted manually.
1846 void SetClientData( void* clientData
)
1848 m_clientData
= clientData
;
1851 /** Returns client object of a property.
1853 void SetClientObject(wxClientData
* clientObject
)
1855 delete m_clientObject
;
1856 m_clientObject
= clientObject
;
1859 /** Sets managed client object of a property.
1861 wxClientData
*GetClientObject() const { return m_clientObject
; }
1864 /** Sets new set of choices for property.
1867 This operation clears the property value.
1869 bool SetChoices( wxPGChoices
& choices
);
1871 /** Set max length of text in text editor.
1873 inline bool SetMaxLength( int maxLen
);
1875 /** Call with 'false' in OnSetValue to cancel value changes after all
1876 (ie. cancel 'true' returned by StringToValue() or IntToValue()).
1878 void SetWasModified( bool set
= true )
1880 if ( set
) m_flags
|= wxPG_PROP_WAS_MODIFIED
;
1881 else m_flags
&= ~wxPG_PROP_WAS_MODIFIED
;
1884 const wxString
& GetHelpString() const
1886 return m_helpString
;
1889 void ClearFlag( FlagType flag
) { m_flags
&= ~(flag
); }
1891 // Use, for example, to detect if item is inside collapsed section.
1892 bool IsSomeParent( wxPGProperty
* candidate_parent
) const;
1895 Adapts list variant into proper value using consecutive
1898 void AdaptListToValue( wxVariant
& list
, wxVariant
* value
) const;
1900 /** This is used by properties that have fixed sub-properties. */
1901 void AddChild( wxPGProperty
* prop
);
1903 /** Returns height of children, recursively, and
1904 by taking expanded/collapsed status into account.
1906 iMax is used when finding property y-positions.
1908 int GetChildrenHeight( int lh
, int iMax
= -1 ) const;
1910 /** Returns number of child properties */
1911 unsigned int GetChildCount() const { return m_children
.size(); }
1913 /** Returns sub-property at index i. */
1914 wxPGProperty
* Item( size_t i
) const
1915 { return m_children
[i
]; }
1917 /** Returns last sub-property.
1919 wxPGProperty
* Last() const { return m_children
.back(); }
1921 /** Returns index of given child property. */
1922 int Index( const wxPGProperty
* p
) const;
1924 /** Deletes all sub-properties. */
1927 // Puts correct indexes to children
1928 void FixIndexesOfChildren( size_t starthere
= 0 );
1931 // Returns wxPropertyGridPageState in which this property resides.
1932 wxPropertyGridPageState
* GetParentState() const { return m_parentState
; }
1935 wxPGProperty
* GetItemAtY( unsigned int y
,
1937 unsigned int* nextItemY
) const;
1939 /** Returns (direct) child property with given name (or NULL if not found).
1941 wxPGProperty
* GetPropertyByName( const wxString
& name
) const;
1945 DocStr(GetClientData
,
1946 "Returns the client data object for a property", "");
1947 PyObject
* GetClientData() {
1948 wxPyClientData
* data
= (wxPyClientData
*)self
->GetClientObject();
1950 Py_INCREF(data
->m_obj
);
1958 DocStr(SetClientData
,
1959 "Associate the given client data.", "");
1960 void SetClientData(PyObject
* clientData
) {
1961 wxPyClientData
* data
= new wxPyClientData(clientData
);
1962 self
->SetClientObject(data
);
1966 GetClientObject
= GetClientData
1967 SetClientObject
= SetClientData
1973 static wxString
* sm_wxPG_LABEL
;
1975 /** This member is public so scripting language bindings
1976 wrapper code can access it freely.
1981 /** Returns text for given column.
1983 wxString
GetColumnText( unsigned int col
) const;
1985 /** Returns (direct) child property with given name (or NULL if not found),
1989 Start looking for the child at this index.
1992 Does not support scope (ie. Parent.Child notation).
1994 wxPGProperty
* GetPropertyByNameWH( const wxString
& name
,
1995 unsigned int hintIndex
) const;
1997 /** This is used by Insert etc. */
1998 void AddChild2( wxPGProperty
* prop
,
2000 bool correct_mode
= true );
2002 void DoSetName(const wxString
& str
) { m_name
= str
; }
2004 // Call for after sub-properties added with AddChild
2005 void PrepareSubProperties();
2007 // Removes child property with given pointer. Does not delete it.
2008 void RemoveChild( wxPGProperty
* p
);
2010 void SetParentalType( int flag
)
2012 m_flags
&= ~(wxPG_PROP_PROPERTY
|wxPG_PROP_PARENTAL_FLAGS
);
2016 void SetParentState( wxPropertyGridPageState
* pstate
)
2017 { m_parentState
= pstate
; }
2019 // Call after fixed sub-properties added/removed after creation.
2020 // if oldSelInd >= 0 and < new max items, then selection is
2022 void SubPropsChanged( int oldSelInd
= -1 );
2024 int GetY2( int lh
) const;
2028 wxPGProperty
* m_parent
;
2029 wxPropertyGridPageState
* m_parentState
;
2031 wxClientData
* m_clientObject
;
2033 // Overrides editor returned by property class
2034 const wxPGEditor
* m_customEditor
;
2035 #if wxUSE_VALIDATORS
2036 // Editor is going to get this validator
2037 wxValidator
* m_validator
;
2039 // Show this in front of the value
2041 // TODO: Can bitmap be implemented with wxPGCell?
2042 wxBitmap
* m_valueBitmap
;
2045 wxPGAttributeStorage m_attributes
;
2046 wxArrayPGProperty m_children
;
2048 // Extended cell information
2049 wxArrayPtrVoid m_cells
;
2051 // Choices shown in drop-down list of editor control.
2052 wxPGChoices m_choices
;
2054 // Help shown in statusbar or help box.
2055 wxString m_helpString
;
2057 // Index in parent's property array.
2058 unsigned int m_arrIndex
;
2060 // If not -1, then overrides m_value
2065 // Maximum length (mainly for string properties). Could be in some sort of
2066 // wxBaseStringProperty, but currently, for maximum flexibility and
2067 // compatibility, we'll stick it here. Anyway, we had 3 excess bytes to use
2068 // so short int will fit in just fine.
2071 // Root has 0, categories etc. at that level 1, etc.
2072 unsigned char m_depth
;
2074 // m_depthBgCol indicates width of background colour between margin and item
2075 // (essentially this is category's depth, if none then equals m_depth).
2076 unsigned char m_depthBgCol
;
2078 unsigned char m_bgColIndex
; // Background brush index.
2079 unsigned char m_fgColIndex
; // Foreground colour index.
2082 // Called in constructors.
2084 void Init( const wxString
& label
, const wxString
& name
);
2085 #endif // #ifndef SWIG
2088 // -----------------------------------------------------------------------
2091 // Property class declaration helper macros
2092 // (wxPGRootPropertyClass and wxPropertyCategory require this).
2095 #define WX_PG_DECLARE_DOGETEDITORCLASS \
2096 virtual const wxPGEditor* DoGetEditorClass() const;
2099 #define WX_PG_DECLARE_PROPERTY_CLASS(CLASSNAME) \
2101 DECLARE_DYNAMIC_CLASS(CLASSNAME) \
2102 WX_PG_DECLARE_DOGETEDITORCLASS \
2105 #define WX_PG_DECLARE_PROPERTY_CLASS(CLASSNAME)
2108 // Implements sans constructor function. Also, first arg is class name, not
2110 #define WX_PG_IMPLEMENT_PROPERTY_CLASS_PLAIN(PROPNAME,T,EDITOR) \
2111 const wxPGEditor* PROPNAME::DoGetEditorClass() const \
2113 return wxPGEditor_##EDITOR; \
2116 // -----------------------------------------------------------------------
2120 /** @class wxPGRootProperty
2122 Root parent property.
2124 class WXDLLIMPEXP_PROPGRID wxPGRootProperty
: public wxPGProperty
2127 WX_PG_DECLARE_PROPERTY_CLASS(wxPGRootProperty
)
2132 virtual ~wxPGRootProperty();
2134 virtual bool StringToValue( wxVariant
&, const wxString
&, int ) const
2142 // -----------------------------------------------------------------------
2144 /** @class wxPropertyCategory
2146 Category (caption) property.
2148 class WXDLLIMPEXP_PROPGRID wxPropertyCategory
: public wxPGProperty
2150 friend class wxPropertyGrid
;
2151 friend class wxPropertyGridPageState
;
2152 WX_PG_DECLARE_PROPERTY_CLASS(wxPropertyCategory
)
2155 /** Default constructor is only used in special cases. */
2156 wxPropertyCategory();
2158 wxPropertyCategory( const wxString
& label
,
2159 const wxString
& name
= wxPG_LABEL
);
2160 ~wxPropertyCategory();
2162 int GetTextExtent( const wxWindow
* wnd
, const wxFont
& font
) const;
2165 virtual wxString
GetValueAsString( int argFlags
) const;
2167 void SetTextColIndex( unsigned int colInd
)
2168 { m_capFgColIndex
= (wxByte
) colInd
; }
2169 unsigned int GetTextColIndex() const
2170 { return (unsigned int) m_capFgColIndex
; }
2172 void CalculateTextExtent( wxWindow
* wnd
, const wxFont
& font
);
2174 int m_textExtent
; // pre-calculated length of text
2175 wxByte m_capFgColIndex
; // caption text colour index
2183 // -----------------------------------------------------------------------
2185 #endif // wxUSE_PROPGRID
2187 #endif // _WX_PROPGRID_PROPERTY_H_