wxPropertyGrid Property Attribute Identifiers


Detailed Description

wxPropertyGrid::SetPropertyAttribute() accepts one of these as attrname 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.


Defines

#define wxPG_ATTR_INLINE_HELP   wxT("InlineHelp")
#define wxPG_ATTR_MAX   wxT("Max")
#define wxPG_ATTR_MIN   wxT("Min")
#define wxPG_ATTR_MULTICHOICE_USERSTRINGMODE   wxT("UserStringMode")
#define wxPG_ATTR_SPINCTRL_STEP   wxT("Step")
#define wxPG_ATTR_SPINCTRL_WRAP   wxT("Wrap")
#define wxPG_ATTR_UNITS   wxT("Units")
#define wxPG_BOOL_USE_CHECKBOX   wxT("UseCheckbox")
#define wxPG_BOOL_USE_DOUBLE_CLICK_CYCLING   wxT("UseDClickCycling")
#define wxPG_COLOUR_ALLOW_CUSTOM   wxT("AllowCustom")
#define wxPG_CUSTOM_PAINT_CALLBACK   wxT("PaintCallback")
#define wxPG_CUSTOM_PRIVATE_CHILDREN   wxT("PrivateChildren")
#define wxPG_DATE_FORMAT   wxT("DateFormat")
#define wxPG_DATE_PICKER_STYLE   wxT("PickerStyle")
#define wxPG_DIR_DIALOG_MESSAGE   wxT("DialogMessage")
#define wxPG_FILE_DIALOG_TITLE   wxT("DialogTitle")
#define wxPG_FILE_INITIAL_PATH   wxT("InitialPath")
#define wxPG_FILE_SHOW_FULL_PATH   wxT("ShowFullPath")
#define wxPG_FILE_SHOW_RELATIVE_PATH   wxT("ShowRelativePath")
#define wxPG_FILE_WILDCARD   wxT("Wildcard")
#define wxPG_FLOAT_PRECISION   wxT("Precision")
#define wxPG_STRING_PASSWORD   wxT("Password")
#define wxPG_UINT_BASE   wxT("Base")
#define wxPG_UINT_PREFIX   wxT("Prefix")


Define Documentation

#define wxPG_ATTR_INLINE_HELP   wxT("InlineHelp")

Universal, string.

When set, will be shown in property's value cell when displayed value string is empty, or value is unspecified.

#define wxPG_ATTR_MAX   wxT("Max")

Universal, int or double.

Maximum value for numeric properties.

#define wxPG_ATTR_MIN   wxT("Min")

Universal, int or double.

Minimum value for numeric properties.

#define wxPG_ATTR_MULTICHOICE_USERSTRINGMODE   wxT("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_STEP   wxT("Step")

SpinCtrl editor, int or double.

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

#define wxPG_ATTR_SPINCTRL_WRAP   wxT("Wrap")

SpinCtrl editor, bool.

If true, value wraps at Min/Max.

#define wxPG_ATTR_UNITS   wxT("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   wxT("UseCheckbox")

wxBoolProperty specific, int, default 0.

When 1 sets bool property to use checkbox instead of choice.

#define wxPG_BOOL_USE_DOUBLE_CLICK_CYCLING   wxT("UseDClickCycling")

wxBoolProperty specific, int, default 0.

When 1 sets bool property value to cycle on double click (instead of showing the popup listbox).

#define wxPG_COLOUR_ALLOW_CUSTOM   wxT("AllowCustom")

wxColourProperty and its kind, int, default 1.

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

#define wxPG_CUSTOM_PAINT_CALLBACK   wxT("PaintCallback")

wxCustomProperty specific, void*.

Sets callback function (of type wxPGPaintCallback) that is called whenever image in front of property needs to be repainted. This attribute takes precedence over bitmap set with wxPG_CUSTOM_IMAGE, and it is only proper way to draw images to wxCustomProperty's drop down choices list.

Remarks:
Callback must handle measure calls (i.e. when rect.x < 0, set paintdata.m_drawnHeight to height of item in question).

#define wxPG_CUSTOM_PRIVATE_CHILDREN   wxT("PrivateChildren")

wxCustomProperty specific, int, default 0.

Setting to 1 makes children private (ie. sets wxPG_PROP_AGGREGATE flag), similar to other properties with fixed children.

Remarks:
  • Children must be added when this attribute has value 0. Otherwise there will be an assertion failure.
  • Changed event occurs on the parent only.

#define wxPG_DATE_FORMAT   wxT("DateFormat")

Sets displayed date format for wxDateProperty.

#define wxPG_DATE_PICKER_STYLE   wxT("PickerStyle")

Sets wxDatePickerCtrl window style used with wxDateProperty.

Default is wxDP_DEFAULT | wxDP_SHOWCENTURY.

#define wxPG_DIR_DIALOG_MESSAGE   wxT("DialogMessage")

Specific to wxDirProperty, wxString, default is empty.

Sets a specific message for the dir dialog.

#define wxPG_FILE_DIALOG_TITLE   wxT("DialogTitle")

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

Sets a specific title for the dir dialog.

#define wxPG_FILE_INITIAL_PATH   wxT("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   wxT("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   wxT("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   wxT("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   wxT("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   wxT("Password")

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

#define wxPG_UINT_BASE   wxT("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   wxT("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.


Generated on Sun Nov 2 12:30:01 2008 for wxPropertyGrid by  doxygen 1.5.5