Version: 3.0.4
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...
 
enum  wxPGPropertyFlags {
  wxPG_PROP_MODIFIED = 0x0001,
  wxPG_PROP_DISABLED = 0x0002,
  wxPG_PROP_HIDDEN = 0x0004,
  wxPG_PROP_CUSTOMIMAGE = 0x0008,
  wxPG_PROP_NOEDITOR = 0x0010,
  wxPG_PROP_COLLAPSED = 0x0020,
  wxPG_PROP_INVALID_VALUE = 0x0040,
  wxPG_PROP_WAS_MODIFIED = 0x0200,
  wxPG_PROP_AGGREGATE = 0x0400,
  wxPG_PROP_CHILDREN_ARE_COPIES = 0x0800,
  wxPG_PROP_PROPERTY = 0x1000,
  wxPG_PROP_CATEGORY = 0x2000,
  wxPG_PROP_MISC_PARENT = 0x4000,
  wxPG_PROP_READONLY = 0x8000,
  wxPG_PROP_COMPOSED_VALUE = 0x00010000,
  wxPG_PROP_USES_COMMON_VALUE = 0x00020000,
  wxPG_PROP_AUTO_UNSPECIFIED = 0x00040000,
  wxPG_PROP_CLASS_SPECIFIC_1 = 0x00080000,
  wxPG_PROP_CLASS_SPECIFIC_2 = 0x00100000,
  wxPG_PROP_BEING_DELETED = 0x00200000
}
 

Classes

class  wxPGPaintData
 Contains information relayed to property's OnCustomPaint. 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 (ie. More...
 
class  wxPGProperty
 wxPGProperty is base class for all wxPropertyGrid properties. More...
 
class  wxPropertyCategory
 Category (caption) property. More...
 
class  wxPGChoiceEntry
 Data of a single wxPGChoices choice. More...
 
class  wxPGChoicesData
 
class  wxPGChoices
 Helper class for managing choices of wxPropertyGrid properties. More...
 

Macros

#define wxNullProperty   ((wxPGProperty*)NULL)
 
#define wxPG_CUSTOM_IMAGE_SPACINGY   1
 
#define wxPG_CAPRECTXMARGIN   2
 
#define wxPG_CAPRECTYMARGIN   1
 
#define wxPGChoicesEmptyData   ((wxPGChoicesData*)NULL)
 
#define wxPG_ATTR_DEFAULT_VALUE   wxS("DefaultValue")
 Set default value for property. More...
 
#define wxPG_ATTR_MIN   wxS("Min")
 Universal, int or double. More...
 
#define wxPG_ATTR_MAX   wxS("Max")
 Universal, int or double. More...
 
#define wxPG_ATTR_UNITS   wxS("Units")
 Universal, string. 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_INLINE_HELP   wxS("InlineHelp")
 
#define wxPG_ATTR_AUTOCOMPLETE   wxS("AutoComplete")
 Universal, wxArrayString. More...
 
#define wxPG_BOOL_USE_CHECKBOX   wxS("UseCheckbox")
 wxBoolProperty and wxFlagsProperty specific. More...
 
#define wxPG_BOOL_USE_DOUBLE_CLICK_CYCLING   wxS("UseDClickCycling")
 wxBoolProperty and wxFlagsProperty specific. More...
 
#define wxPG_FLOAT_PRECISION   wxS("Precision")
 wxFloatProperty (and similar) specific, int, default -1. More...
 
#define wxPG_STRING_PASSWORD   wxS("Password")
 The text will be echoed as asterisks (wxTE_PASSWORD will be passed to textctrl etc). More...
 
#define wxPG_UINT_BASE   wxS("Base")
 Define base used by a wxUIntProperty. More...
 
#define wxPG_UINT_PREFIX   wxS("Prefix")
 Define prefix rendered to wxUIntProperty. More...
 
#define wxPG_FILE_WILDCARD   wxS("Wildcard")
 wxFileProperty/wxImageFileProperty specific, wxChar*, default is detected/varies. More...
 
#define wxPG_FILE_SHOW_FULL_PATH   wxS("ShowFullPath")
 wxFileProperty/wxImageFileProperty specific, int, default 1. More...
 
#define wxPG_FILE_SHOW_RELATIVE_PATH   wxS("ShowRelativePath")
 Specific to wxFileProperty and derived properties, wxString, default empty. More...
 
#define wxPG_FILE_INITIAL_PATH   wxS("InitialPath")
 Specific to wxFileProperty and derived properties, wxString, default is empty. More...
 
#define wxPG_FILE_DIALOG_TITLE   wxS("DialogTitle")
 Specific to wxFileProperty and derivatives, wxString, default is empty. More...
 
#define wxPG_FILE_DIALOG_STYLE   wxS("DialogStyle")
 Specific to wxFileProperty and derivatives, long, default is 0. More...
 
#define wxPG_DIR_DIALOG_MESSAGE   wxS("DialogMessage")
 Specific to wxDirProperty, wxString, default is empty. More...
 
#define wxPG_ARRAY_DELIMITER   wxS("Delimiter")
 wxArrayStringProperty's string delimiter character. More...
 
#define wxPG_DATE_FORMAT   wxS("DateFormat")
 Sets displayed date format for wxDateProperty. More...
 
#define wxPG_DATE_PICKER_STYLE   wxS("PickerStyle")
 Sets wxDatePickerCtrl window style used with wxDateProperty. More...
 
#define wxPG_ATTR_SPINCTRL_STEP   wxS("Step")
 SpinCtrl editor, int or double. More...
 
#define wxPG_ATTR_SPINCTRL_WRAP   wxS("Wrap")
 SpinCtrl editor, bool. More...
 
#define wxPG_ATTR_SPINCTRL_MOTIONSPIN   wxS("MotionSpin")
 SpinCtrl editor, bool. More...
 
#define wxPG_ATTR_MULTICHOICE_USERSTRINGMODE   wxS("UserStringMode")
 wxMultiChoiceProperty, int. More...
 
#define wxPG_COLOUR_ALLOW_CUSTOM   wxS("AllowCustom")
 wxColourProperty and its kind, int, default 1. More...
 
#define wxPG_COLOUR_HAS_ALPHA   wxS("HasAlpha")
 wxColourProperty and its kind: Set to True in order to support editing alpha colour component. More...
 

Macro Definition Documentation

#define wxNullProperty   ((wxPGProperty*)NULL)
#define wxPG_ARRAY_DELIMITER   wxS("Delimiter")

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.

#define wxPG_ATTR_AUTOCOMPLETE   wxS("AutoComplete")

Universal, wxArrayString.

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

#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.

#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.

#define wxPG_ATTR_INLINE_HELP   wxS("InlineHelp")
Deprecated:
Use "Hint" (wxPG_ATTR_HINT) instead.
#define wxPG_ATTR_MAX   wxS("Max")

Universal, int or double.

Maximum value for numeric properties.

#define wxPG_ATTR_MIN   wxS("Min")

Universal, int or double.

Minimum value for numeric properties.

#define wxPG_ATTR_MULTICHOICE_USERSTRINGMODE   wxS("UserStringMode")

wxMultiChoiceProperty, int.

If 0, no user strings allowed. If 1, user strings appear before list strings. If 2, user strings appear after list string.

#define wxPG_ATTR_SPINCTRL_MOTIONSPIN   wxS("MotionSpin")

SpinCtrl editor, bool.

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

#define wxPG_ATTR_SPINCTRL_STEP   wxS("Step")

SpinCtrl editor, int or double.

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

#define wxPG_ATTR_SPINCTRL_WRAP   wxS("Wrap")

SpinCtrl editor, bool.

If true, value wraps at Min/Max.

#define wxPG_ATTR_UNITS   wxS("Units")

Universal, string.

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).

#define wxPG_BOOL_USE_CHECKBOX   wxS("UseCheckbox")

wxBoolProperty and wxFlagsProperty specific.

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.

#define wxPG_BOOL_USE_DOUBLE_CLICK_CYCLING   wxS("UseDClickCycling")

wxBoolProperty and wxFlagsProperty specific.

Value type is bool. Default value is False.

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.

#define wxPG_CAPRECTXMARGIN   2
#define wxPG_CAPRECTYMARGIN   1
#define wxPG_COLOUR_ALLOW_CUSTOM   wxS("AllowCustom")

wxColourProperty and its kind, int, default 1.

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

#define wxPG_COLOUR_HAS_ALPHA   wxS("HasAlpha")

wxColourProperty and its kind: Set to True in order to support editing alpha colour component.

#define wxPG_CUSTOM_IMAGE_SPACINGY   1
#define wxPG_DATE_FORMAT   wxS("DateFormat")

Sets displayed date format for wxDateProperty.

#define wxPG_DATE_PICKER_STYLE   wxS("PickerStyle")

Sets wxDatePickerCtrl window style used with wxDateProperty.

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

#define wxPG_DIR_DIALOG_MESSAGE   wxS("DialogMessage")

Specific to wxDirProperty, wxString, default is empty.

Sets a specific message for the dir dialog.

#define wxPG_FILE_DIALOG_STYLE   wxS("DialogStyle")

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
#define wxPG_FILE_DIALOG_TITLE   wxS("DialogTitle")

Specific to wxFileProperty and derivatives, wxString, default is empty.

Sets a specific title for the dir dialog.

#define wxPG_FILE_INITIAL_PATH   wxS("InitialPath")

Specific to wxFileProperty and derived properties, wxString, default is empty.

Sets the initial path of where to look for files.

#define wxPG_FILE_SHOW_FULL_PATH   wxS("ShowFullPath")

wxFileProperty/wxImageFileProperty specific, int, default 1.

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

#define wxPG_FILE_SHOW_RELATIVE_PATH   wxS("ShowRelativePath")

Specific to wxFileProperty and derived properties, wxString, default empty.

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

#define wxPG_FILE_WILDCARD   wxS("Wildcard")

wxFileProperty/wxImageFileProperty specific, wxChar*, default is detected/varies.

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

#define wxPG_FLOAT_PRECISION   wxS("Precision")

wxFloatProperty (and similar) specific, int, default -1.

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

#define wxPG_PROP_MAX   wxPG_PROP_AUTO_UNSPECIFIED

Topmost flag.

#define wxPG_PROP_PARENTAL_FLAGS
Value:
Classifies this item as a property that has children, but is not aggregate (ie children are not priva...
Definition: property.h:545
wxPGPropertyFlags
Definition: property.h:470
Classifies this item as a category.
Definition: property.h:540
If set, then child properties (if any) are private, and should be "invisible" to the application...
Definition: property.h:521

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

Code should automatically take care of this, however.

#define wxPG_STRING_PASSWORD   wxS("Password")

The text will be echoed as asterisks (wxTE_PASSWORD will be passed to textctrl etc).

#define wxPG_UINT_BASE   wxS("Base")

Define base used by a wxUIntProperty.

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

#define wxPG_UINT_PREFIX   wxS("Prefix")

Define prefix rendered to wxUIntProperty.

Accepted constants wxPG_PREFIX_NONE, wxPG_PREFIX_0x, and wxPG_PREFIX_DOLLAR_SIGN. Note: Only wxPG_PREFIX_NONE works with Decimal and Octal numbers.

#define wxPGChoicesEmptyData   ((wxPGChoicesData*)NULL)

Enumeration Type Documentation

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 (ie 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:

Remarks
This flag cannot be used with property iterators.
See also
wxPGProperty::SetAutoUnspecified()
wxPG_PROP_CLASS_SPECIFIC_1 

Indicates the bit useable by derived properties.

wxPG_PROP_CLASS_SPECIFIC_2 

Indicates the bit useable by derived properties.

wxPG_PROP_BEING_DELETED 

Indicates that the property is being deleted and should be ignored.