property.h File Reference

Classes

class  wxPGProperty
 wxPGProperty is base class for all wxPropertyGrid properties. More...
class  wxPGCell
 Base class for wxPropertyGrid cell information. More...
class  wxPGChoices
 Helper class for managing choices of wxPropertyGrid properties. More...

Defines

#define wxNullProperty   ((wxPGProperty*)NULL)



#define wxPG_ATTR_DEFAULT_VALUE   wxS("DefaultValue")
 Set default value for property.
#define wxPG_ATTR_MIN   wxS("Min")
 Universal, int or double.
#define wxPG_ATTR_MAX   wxS("Max")
 Universal, int or double.
#define wxPG_ATTR_UNITS   wxS("Units")
 Universal, string.
#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")
#define wxPG_ATTR_AUTOCOMPLETE   wxS("AutoComplete")
 Universal, wxArrayString.
#define wxPG_BOOL_USE_CHECKBOX   wxS("UseCheckbox")
 wxBoolProperty and wxFlagsProperty specific.
#define wxPG_BOOL_USE_DOUBLE_CLICK_CYCLING   wxS("UseDClickCycling")
 wxBoolProperty and wxFlagsProperty specific.
#define wxPG_FLOAT_PRECISION   wxS("Precision")
 wxFloatProperty (and similar) specific, int, default -1.
#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.
#define wxPG_UINT_PREFIX   wxS("Prefix")
 Define prefix rendered to wxUIntProperty.
#define wxPG_FILE_WILDCARD   wxS("Wildcard")
 wxFileProperty/wxImageFileProperty specific, wxChar*, default is detected/varies.
#define wxPG_FILE_SHOW_FULL_PATH   wxS("ShowFullPath")
 wxFileProperty/wxImageFileProperty specific, int, default 1.
#define wxPG_FILE_SHOW_RELATIVE_PATH   wxS("ShowRelativePath")
 Specific to wxFileProperty and derived properties, wxString, default empty.
#define wxPG_FILE_INITIAL_PATH   wxS("InitialPath")
 Specific to wxFileProperty and derived properties, wxString, default is empty.
#define wxPG_FILE_DIALOG_TITLE   wxS("DialogTitle")
 Specific to wxFileProperty and derivatives, wxString, default is empty.
#define wxPG_DIR_DIALOG_MESSAGE   wxS("DialogMessage")
 Specific to wxDirProperty, wxString, default is empty.
#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.
#define wxPG_ATTR_SPINCTRL_STEP   wxS("Step")
 SpinCtrl editor, int or double.
#define wxPG_ATTR_SPINCTRL_WRAP   wxS("Wrap")
 SpinCtrl editor, bool.
#define wxPG_ATTR_SPINCTRL_MOTIONSPIN   wxS("MotionSpin")
 SpinCtrl editor, bool.
#define wxPG_ATTR_MULTICHOICE_USERSTRINGMODE   wxS("UserStringMode")
 wxMultiChoiceProperty, int.
#define wxPG_COLOUR_ALLOW_CUSTOM   wxS("AllowCustom")
 wxColourProperty and its kind, int, default 1.

Define Documentation

#define wxNullProperty   ((wxPGProperty*)NULL)
#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 keybard).

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

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines



wxWidgets logo

[ top ]