property.h File Reference

#define	wxPG_PROP_MAX   wxPG_PROP_AUTO_UNSPECIFIED
	Topmost flag. More...
#define	wxPG_PROP_PARENTAL_FLAGS
	Property with children must have one of these set, otherwise iterators will not work correctly. More...
#define	wxPG_STRING_STORED_FLAGS    (wxPG_PROP_DISABLED|wxPG_PROP_HIDDEN|wxPG_PROP_NOEDITOR|wxPG_PROP_COLLAPSED)
	Combination of flags that can be stored by GetFlagsAsString(). More...
enum	wxPGPropertyFlags {   wxPG_PROP_MODIFIED ,   wxPG_PROP_DISABLED ,   wxPG_PROP_HIDDEN ,   wxPG_PROP_CUSTOMIMAGE ,   wxPG_PROP_NOEDITOR ,   wxPG_PROP_COLLAPSED ,   wxPG_PROP_INVALID_VALUE ,   wxPG_PROP_WAS_MODIFIED ,   wxPG_PROP_AGGREGATE ,   wxPG_PROP_CHILDREN_ARE_COPIES ,   wxPG_PROP_PROPERTY ,   wxPG_PROP_CATEGORY ,   wxPG_PROP_MISC_PARENT ,   wxPG_PROP_READONLY ,   wxPG_PROP_COMPOSED_VALUE ,   wxPG_PROP_USES_COMMON_VALUE ,   wxPG_PROP_AUTO_UNSPECIFIED ,   wxPG_PROP_CLASS_SPECIFIC_1 ,   wxPG_PROP_CLASS_SPECIFIC_2 ,   wxPG_PROP_BEING_DELETED }

Classes
class	wxPGPaintData
	Contains information related to property's OnCustomPaint. More...
class	wxPGProperty
	wxPGProperty is base class for all wxPropertyGrid properties and as such it is not intended to be instantiated directly. More...
class	wxPGCellRenderer
	Base class for wxPropertyGrid cell renderers. More...
class	wxPGDefaultRenderer
	Default cell renderer, that can handles the common scenarios. More...
class	wxPGCellData
class	wxPGCell
	Base class for wxPropertyGrid cell information. More...
class	wxPGAttributeStorage
	wxPGAttributeStorage is somewhat optimized storage for key=variant pairs (i.e. More...
class	wxPGChoiceEntry
	Data of a single wxPGChoices choice. More...
class	wxPGChoicesData
class	wxPGChoices
	Helper class for managing choices of wxPropertyGrid properties. More...
class	wxPGRootProperty
	Root parent property. More...
class	wxPropertyCategory
	Category (caption) property. More...

Macros
#define	wxNullProperty   ((wxPGProperty*)NULL)
#define	wxPGChoicesEmptyData   ((wxPGChoicesData*)NULL)
#define	wxPG_ATTR_DEFAULT_VALUE   wxS("DefaultValue")
	Set default value for property. More...
#define	wxPG_ATTR_MIN   wxS("Min")
	Built-in attribute specific to wxNumericProperty and derived properties, like wxIntProperty, wxUIntProperty, wxFloatProperty, int or double. More...
#define	wxPG_ATTR_MAX   wxS("Max")
	Built-in attribute specific to wxNumericProperty and derived properties, like wxIntProperty, wxUIntProperty, wxFloatProperty, int or double. More...
#define	wxPG_ATTR_UNITS   wxS("Units")
	Universal, wxString. More...
#define	wxPG_ATTR_HINT   wxS("Hint")
	When set, will be shown as 'greyed' text in property's value cell when the actual displayed value is blank. More...
#define	wxPG_ATTR_AUTOCOMPLETE   wxS("AutoComplete")
	Universal, wxArrayString. More...
#define	wxPG_BOOL_USE_CHECKBOX   wxS("UseCheckbox")
	wxBoolProperty and wxFlagsProperty specific built-in attribute. More...
#define	wxPG_BOOL_USE_DOUBLE_CLICK_CYCLING   wxS("UseDClickCycling")
	wxBoolProperty and wxFlagsProperty specific built-in attribute. More...
#define	wxPG_FLOAT_PRECISION   wxS("Precision")
	wxFloatProperty (and similar) specific built-in attribute of type int. More...
#define	wxPG_STRING_PASSWORD   wxS("Password")
	Built-in attribute of type bool. More...
#define	wxPG_UINT_BASE   wxS("Base")
	Built-in attribute to define base used by a wxUIntProperty. More...
#define	wxPG_UINT_PREFIX   wxS("Prefix")
	Built-in attribute to define prefix rendered to wxUIntProperty. More...
#define	wxPG_DIALOG_TITLE   wxS("DialogTitle")
	Built-in attribute specific to wxEditorDialogProperty and derivatives, wxString, default is empty. More...
#define	wxPG_FILE_WILDCARD   wxS("Wildcard")
	wxFileProperty and wxImageFileProperty specific built-in attribute, wxChar*, default is detected/varies. More...
#define	wxPG_FILE_SHOW_FULL_PATH   wxS("ShowFullPath")
	wxFileProperty and wxImageFileProperty specific built-in attribute, bool, default true. More...
#define	wxPG_FILE_SHOW_RELATIVE_PATH   wxS("ShowRelativePath")
	Built-in attribute specific to wxFileProperty and derived properties, wxString, default empty. More...
#define	wxPG_FILE_INITIAL_PATH   wxS("InitialPath")
	Built-in attribute specific to wxFileProperty and derived properties, wxString, default is empty. More...
#define	wxPG_FILE_DIALOG_STYLE   wxS("DialogStyle")
	Built-in attribute specific to wxFileProperty and derivatives, long, default is 0. More...
#define	wxPG_ARRAY_DELIMITER   wxS("Delimiter")
	Built-in attribute to set wxArrayStringProperty's string delimiter character. More...
#define	wxPG_DATE_FORMAT   wxS("DateFormat")
	Built-in attribute to set displayed date format for wxDateProperty. More...
#define	wxPG_DATE_PICKER_STYLE   wxS("PickerStyle")
	Built-in attribute to set wxDatePickerCtrl window style used with wxDateProperty. More...
#define	wxPG_ATTR_SPINCTRL_STEP   wxS("Step")
	Built-in attribute specific to wxNumericProperty and derived properties, like wxIntProperty, wxUIntProperty, wxFloatProperty, used by SpinCtrl editor, int or double type. More...
#define	wxPG_ATTR_SPINCTRL_WRAP   wxS("Wrap")
	Built-in attribute specific to wxNumericProperty and derived properties, like wxIntProperty, wxUIntProperty, wxFloatProperty, used by SpinCtrl editor, bool. More...
#define	wxPG_ATTR_SPINCTRL_MOTION   wxS("MotionSpin")
	Built-in attribute specific to wxNumericProperty and derived properties, like wxIntProperty, wxUIntProperty, wxFloatProperty, used by SpinCtrl editor, bool. More...
#define	wxPG_ATTR_MULTICHOICE_USERSTRINGMODE   wxS("UserStringMode")
	Built-in attribute of wxMultiChoiceProperty, int type. More...
#define	wxPG_COLOUR_ALLOW_CUSTOM   wxS("AllowCustom")
	Built-in attribute of wxColourProperty and its kind, type of bool, default value is true. More...
#define	wxPG_COLOUR_HAS_ALPHA   wxS("HasAlpha")
	Built-in attribute of wxColourProperty and its kind, bool type. More...

Macro Definition Documentation

wxNullProperty

#define wxNullProperty   ((wxPGProperty*)NULL)

wxPG_ARRAY_DELIMITER

#define wxPG_ARRAY_DELIMITER   wxS("Delimiter")

Built-in attribute to set wxArrayStringProperty's string delimiter character.

If this is a quotation mark or hyphen, then strings will be quoted instead (with given character).

Default delimiter is quotation mark.

wxPG_ATTR_AUTOCOMPLETE

#define wxPG_ATTR_AUTOCOMPLETE   wxS("AutoComplete")

Universal, wxArrayString.

Set to enable auto-completion in any wxTextCtrl-based property editor.

wxPG_ATTR_DEFAULT_VALUE

#define wxPG_ATTR_DEFAULT_VALUE   wxS("DefaultValue")

Set default value for property.

wxPropertyGrid Property Attribute Identifiers

wxPGProperty::SetAttribute() and wxPropertyGridInterface::SetPropertyAttribute() accept one of these as attribute name argument.

You can use strings instead of constants. However, some of these constants are redefined to use cached strings which may reduce your binary size by some amount.

If wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES style is applied to wxPropertyGrid, attributes denoted as built-in are not stored into property's attribute storage (thus they are write-only) .

wxPG_ATTR_HINT

#define wxPG_ATTR_HINT   wxS("Hint")

When set, will be shown as 'greyed' text in property's value cell when the actual displayed value is blank.

wxPG_ATTR_MAX

#define wxPG_ATTR_MAX   wxS("Max")

Built-in attribute specific to wxNumericProperty and derived properties, like wxIntProperty, wxUIntProperty, wxFloatProperty, int or double.

Maximum value for the property.

wxPG_ATTR_MIN

#define wxPG_ATTR_MIN   wxS("Min")

Built-in attribute specific to wxNumericProperty and derived properties, like wxIntProperty, wxUIntProperty, wxFloatProperty, int or double.

Minimum value for the property.

wxPG_ATTR_MULTICHOICE_USERSTRINGMODE

#define wxPG_ATTR_MULTICHOICE_USERSTRINGMODE   wxS("UserStringMode")

Built-in attribute of wxMultiChoiceProperty, int type.

Default value is 0. If set to 0, no user strings allowed. If 1, user strings appear before list strings. If 2, user strings appear after list string.

wxPG_ATTR_SPINCTRL_MOTION

#define wxPG_ATTR_SPINCTRL_MOTION   wxS("MotionSpin")

Built-in attribute specific to wxNumericProperty and derived properties, like wxIntProperty, wxUIntProperty, wxFloatProperty, used by SpinCtrl editor, bool.

If true, value can also by changed by moving mouse when left mouse button is being pressed.

wxPG_ATTR_SPINCTRL_STEP

#define wxPG_ATTR_SPINCTRL_STEP   wxS("Step")

Built-in attribute specific to wxNumericProperty and derived properties, like wxIntProperty, wxUIntProperty, wxFloatProperty, used by SpinCtrl editor, int or double type.

How much number changes when button is pressed (or up/down on keyboard).

wxPG_ATTR_SPINCTRL_WRAP

#define wxPG_ATTR_SPINCTRL_WRAP   wxS("Wrap")

Built-in attribute specific to wxNumericProperty and derived properties, like wxIntProperty, wxUIntProperty, wxFloatProperty, used by SpinCtrl editor, bool.

If true, value wraps at Min/Max.

wxPG_ATTR_UNITS

#define wxPG_ATTR_UNITS   wxS("Units")

Universal, wxString.

When set, will be shown as text after the displayed text value. Alternatively, if third column is enabled, text will be shown there (for any type of property).

wxPG_BOOL_USE_CHECKBOX

#define wxPG_BOOL_USE_CHECKBOX   wxS("UseCheckbox")

wxBoolProperty and wxFlagsProperty specific built-in attribute.

Value type is bool. Default value is false.

When set to true, bool property will use check box instead of a combo box as its editor control. If you set this attribute for a wxFlagsProperty, it is automatically applied to child bool properties.

wxPG_BOOL_USE_DOUBLE_CLICK_CYCLING

#define wxPG_BOOL_USE_DOUBLE_CLICK_CYCLING   wxS("UseDClickCycling")

wxBoolProperty and wxFlagsProperty specific built-in attribute.

Value type is bool. Default value is true.

Set to true for the bool property to cycle value on double click (instead of showing the popup listbox). If you set this attribute for a wxFlagsProperty, it is automatically applied to child bool properties.

wxPG_COLOUR_ALLOW_CUSTOM

#define wxPG_COLOUR_ALLOW_CUSTOM   wxS("AllowCustom")

Built-in attribute of wxColourProperty and its kind, type of bool, default value is true.

Setting this attribute to false hides custom colour from property's list of choices.

wxPG_COLOUR_HAS_ALPHA

#define wxPG_COLOUR_HAS_ALPHA   wxS("HasAlpha")

Built-in attribute of wxColourProperty and its kind, bool type.

Default value is false. Set this attribute to true in order to support editing alpha colour component.

wxPG_DATE_FORMAT

#define wxPG_DATE_FORMAT   wxS("DateFormat")

Built-in attribute to set displayed date format for wxDateProperty.

wxPG_DATE_PICKER_STYLE

#define wxPG_DATE_PICKER_STYLE   wxS("PickerStyle")

Built-in attribute to set wxDatePickerCtrl window style used with wxDateProperty.

Default is wxDP_DEFAULT | wxDP_SHOWCENTURY. Using wxDP_ALLOWNONE will enable better unspecified value support in the editor.

wxPG_DIALOG_TITLE

#define wxPG_DIALOG_TITLE   wxS("DialogTitle")

Built-in attribute specific to wxEditorDialogProperty and derivatives, wxString, default is empty.

Sets a specific title for the editor dialog.

Since

3.1.3

wxPG_FILE_DIALOG_STYLE

#define wxPG_FILE_DIALOG_STYLE   wxS("DialogStyle")

Built-in attribute specific to wxFileProperty and derivatives, long, default is 0.

Sets a specific wxFileDialog style for the file dialog, e.g. wxFD_SAVE.

Since

2.9.4

wxPG_FILE_INITIAL_PATH

#define wxPG_FILE_INITIAL_PATH   wxS("InitialPath")

Built-in attribute specific to wxFileProperty and derived properties, wxString, default is empty.

Sets the initial path of where to look for files.

wxPG_FILE_SHOW_FULL_PATH

#define wxPG_FILE_SHOW_FULL_PATH   wxS("ShowFullPath")

wxFileProperty and wxImageFileProperty specific built-in attribute, bool, default true.

When false, only the file name is shown (i.e. drive and directory are hidden).

wxPG_FILE_SHOW_RELATIVE_PATH

#define wxPG_FILE_SHOW_RELATIVE_PATH   wxS("ShowRelativePath")

Built-in attribute specific to wxFileProperty and derived properties, wxString, default empty.

If set, then the filename is shown relative to the given path string.

wxPG_FILE_WILDCARD

#define wxPG_FILE_WILDCARD   wxS("Wildcard")

wxFileProperty and wxImageFileProperty specific built-in attribute, wxChar*, default is detected/varies.

Sets the wildcard used in the triggered wxFileDialog. Format is the same.

wxPG_FLOAT_PRECISION

#define wxPG_FLOAT_PRECISION   wxS("Precision")

wxFloatProperty (and similar) specific built-in attribute of type int.

Default value is -1. Sets the (max) precision used when floating point value is rendered as text. The default -1 means infinite precision.

wxPG_PROP_MAX

#define wxPG_PROP_MAX   wxPG_PROP_AUTO_UNSPECIFIED

Topmost flag.

wxPG_PROP_PARENTAL_FLAGS

#define wxPG_PROP_PARENTAL_FLAGS

Value:

    ((wxPGPropertyFlags)(wxPG_PROP_AGGREGATE | \
                         wxPG_PROP_CATEGORY | \
                         wxPG_PROP_MISC_PARENT))

Property with children must have one of these set, otherwise iterators will not work correctly.

Code should automatically take care of this, however.

wxPG_STRING_PASSWORD

#define wxPG_STRING_PASSWORD   wxS("Password")

Built-in attribute of type bool.

Default value is false, When set tu true, the text will be echoed as asterisks (wxTE_PASSWORD will be passed to textctrl etc.).

wxPG_STRING_STORED_FLAGS

#define wxPG_STRING_STORED_FLAGS    (wxPG_PROP_DISABLED|wxPG_PROP_HIDDEN|wxPG_PROP_NOEDITOR|wxPG_PROP_COLLAPSED)

Combination of flags that can be stored by GetFlagsAsString().

wxPG_UINT_BASE

#define wxPG_UINT_BASE   wxS("Base")

Built-in attribute to define base used by a wxUIntProperty.

Valid constants are wxPG_BASE_OCT, wxPG_BASE_DEC, wxPG_BASE_HEX and wxPG_BASE_HEXL (lowercase characters).

wxPG_UINT_PREFIX

#define wxPG_UINT_PREFIX   wxS("Prefix")

Built-in attribute to define prefix rendered to wxUIntProperty.

Accepted constants wxPG_PREFIX_NONE, wxPG_PREFIX_0x and wxPG_PREFIX_DOLLAR_SIGN.

Remarks

Only wxPG_PREFIX_NONE works with decimal and octal numbers.

wxPGChoicesEmptyData

#define wxPGChoicesEmptyData   ((wxPGChoicesData*)NULL)

Enumeration Type Documentation

wxPGPropertyFlags

enum wxPGPropertyFlags

wxPGProperty Flags

Enumerator
wxPG_PROP_MODIFIED	Indicates bold font.
wxPG_PROP_DISABLED	Disables ('greyed' text and editor does not activate) property.
wxPG_PROP_HIDDEN	Hider button will hide this property.
wxPG_PROP_CUSTOMIMAGE	This property has custom paint image just in front of its value. If property only draws custom images into a popup list, then this flag should not be set.
wxPG_PROP_NOEDITOR	Do not create text based editor for this property (but button-triggered dialog and choice are ok).
wxPG_PROP_COLLAPSED	Property is collapsed, ie. it's children are hidden.
wxPG_PROP_INVALID_VALUE	If property is selected, then indicates that validation failed for pending value. If property is not selected, then indicates that the actual property value has failed validation (NB: this behaviour is not currently supported, but may be used in the future).
wxPG_PROP_WAS_MODIFIED	Switched via SetWasModified(). Temporary flag - only used when setting/changing property value.
wxPG_PROP_AGGREGATE	If set, then child properties (if any) are private, and should be "invisible" to the application.
wxPG_PROP_CHILDREN_ARE_COPIES	If set, then child properties (if any) are copies and should not be deleted in dtor.
wxPG_PROP_PROPERTY	Classifies this item as a non-category. Used for faster item type identification.
wxPG_PROP_CATEGORY	Classifies this item as a category. Used for faster item type identification.
wxPG_PROP_MISC_PARENT	Classifies this item as a property that has children, but is not aggregate (i.e. children are not private).
wxPG_PROP_READONLY	Property is read-only. Editor is still created for wxTextCtrl-based property editors. For others, editor is not usually created because they do implement wxTE_READONLY style or equivalent.
wxPG_PROP_COMPOSED_VALUE	Property's value is composed from values of child properties. Remarks This flag cannot be used with property iterators.
wxPG_PROP_USES_COMMON_VALUE	Common value of property is selectable in editor. Remarks This flag cannot be used with property iterators.
wxPG_PROP_AUTO_UNSPECIFIED	Property can be set to unspecified value via editor. Currently, this applies to following properties: wxIntProperty, wxUIntProperty, wxFloatProperty, wxEditEnumProperty: Clear the text field Remarks This flag cannot be used with property iterators. See also wxPGProperty::SetAutoUnspecified()
wxPG_PROP_CLASS_SPECIFIC_1	Indicates the bit usable by derived properties.
wxPG_PROP_CLASS_SPECIFIC_2	Indicates the bit usable by derived properties.
wxPG_PROP_BEING_DELETED	Indicates that the property is being deleted and should be ignored.