Refer to predefined constants in documentation

This commit is contained in:
Artur Wieczorek
2019-05-12 11:20:51 +02:00
parent b2ea56b4e9
commit d9da2feaf2
4 changed files with 34 additions and 31 deletions

View File

@@ -238,10 +238,10 @@ protected:
calling wxMultiChoiceProperty::GetValueAsArrayInt(). calling wxMultiChoiceProperty::GetValueAsArrayInt().
<b>Supported special attributes:</b> <b>Supported special attributes:</b>
- "UserStringMode": If > 0, allow user to manually enter strings that are - ::wxPG_ATTR_MULTICHOICE_USERSTRINGMODE: If > 0, allow user to manually
not in the list of choices. If this value is 1, user strings are enter strings that are not in the list of choices. If this value is 1,
preferably placed in front of valid choices. If value is 2, then those user strings are preferably placed in front of valid choices. If value is
strings will placed behind valid choices. 2, then those strings will placed behind valid choices.
*/ */
class wxMultiChoiceProperty : public wxPGProperty class wxMultiChoiceProperty : public wxPGProperty
{ {
@@ -292,9 +292,9 @@ protected:
Property representing wxDateTime. Property representing wxDateTime.
<b>Supported special attributes:</b> <b>Supported special attributes:</b>
- "DateFormat": Determines displayed date format. - ::wxPG_DATE_FORMAT: Determines displayed date format.
- "PickerStyle": Determines window style used with wxDatePickerCtrl. - ::wxPG_DATE_PICKER_STYLE: Determines window style used with wxDatePickerCtrl.
Default is wxDP_DEFAULT | wxDP_SHOWCENTURY. Using wxDP_ALLOWNONE Default is ::wxDP_DEFAULT | ::wxDP_SHOWCENTURY. Using ::wxDP_ALLOWNONE
enables additional support for unspecified property value. enables additional support for unspecified property value.
*/ */
class wxDateProperty : public wxPGProperty class wxDateProperty : public wxPGProperty

View File

@@ -1423,7 +1423,7 @@ public:
Returns map-like storage of property's attributes. Returns map-like storage of property's attributes.
@remarks @remarks
If extra style wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set, If extra style ::wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set,
then builtin-attributes are not included in the storage. then builtin-attributes are not included in the storage.
*/ */
const wxPGAttributeStorage& GetAttributes() const; const wxPGAttributeStorage& GetAttributes() const;

View File

@@ -411,7 +411,7 @@ public:
Returns map-like storage of property's attributes. Returns map-like storage of property's attributes.
@remarks @remarks
Note that if extra style wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set, Note that if extra style ::wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES is set,
then builtin-attributes are not included in the storage. then builtin-attributes are not included in the storage.
*/ */
const wxPGAttributeStorage& GetPropertyAttributes( wxPGPropArg id ) const; const wxPGAttributeStorage& GetPropertyAttributes( wxPGPropArg id ) const;

View File

@@ -35,7 +35,8 @@ public:
Basic property with string value. Basic property with string value.
<b>Supported special attributes:</b> <b>Supported special attributes:</b>
- "Password": set to 1 in order to enable wxTE_PASSWORD on the editor. - ::wxPG_STRING_PASSWORD: set to @true in order to enable ::wxTE_PASSWORD
on the editor.
@remarks @remarks
- If value "<composed>" is set, then actual value is formed (or composed) - If value "<composed>" is set, then actual value is formed (or composed)
@@ -140,7 +141,7 @@ public:
<b>Supported special attributes:</b> <b>Supported special attributes:</b>
- "Min", "Max": Specify acceptable value range. - ::wxPG_ATTR_MIN, ::wxPG_ATTR_MAX: Specify acceptable value range.
*/ */
class wxIntProperty : public wxPGProperty class wxIntProperty : public wxPGProperty
{ {
@@ -181,13 +182,13 @@ public:
Seamlessly supports 64-bit integer (wxULongLong) on overflow. Seamlessly supports 64-bit integer (wxULongLong) on overflow.
<b>Supported special attributes:</b> <b>Supported special attributes:</b>
- "Min", "Max": Specify acceptable value range. - ::wxPG_ATTR_MIN, ::wxPG_ATTR_MAX: Specify acceptable value range.
- "Base": Define base. Valid constants are wxPG_BASE_OCT, wxPG_BASE_DEC, - ::wxPG_UINT_BASE: Define base. Valid constants are ::wxPG_BASE_OCT,
wxPG_BASE_HEX and wxPG_BASE_HEXL (lowercase characters). Arbitrary bases ::wxPG_BASE_DEC, ::wxPG_BASE_HEX and ::wxPG_BASE_HEXL (lowercase characters).
are <b>not</b> supported. Arbitrary bases are <b>not</b> supported.
- "Prefix": Possible values are wxPG_PREFIX_NONE, wxPG_PREFIX_0x, and - ::wxPG_UINT_PREFIX: Possible values are ::wxPG_PREFIX_NONE, ::wxPG_PREFIX_0x,
wxPG_PREFIX_DOLLAR_SIGN. Only wxPG_PREFIX_NONE works with Decimal and Octal and ::wxPG_PREFIX_DOLLAR_SIGN. Only ::wxPG_PREFIX_NONE works with Decimal
numbers. and Octal numbers.
@remarks @remarks
- For example how to use seamless 64-bit integer support, see wxIntProperty - For example how to use seamless 64-bit integer support, see wxIntProperty
@@ -226,8 +227,8 @@ protected:
Basic property with double-precision floating point value. Basic property with double-precision floating point value.
<b>Supported special attributes:</b> <b>Supported special attributes:</b>
- "Precision": Sets the (max) precision used when floating point value is - ::wxPG_FLOAT_PRECISION: Sets the (max) precision used when floating point
rendered as text. The default -1 means infinite precision. value is rendered as text. The default -1 means infinite precision.
*/ */
class wxFloatProperty : public wxPGProperty class wxFloatProperty : public wxPGProperty
{ {
@@ -267,8 +268,10 @@ protected:
Basic property with boolean value. Basic property with boolean value.
<b>Supported special attributes:</b> <b>Supported special attributes:</b>
- "UseCheckbox": Set to 1 to use check box editor instead of combo box. - ::wxPG_BOOL_USE_CHECKBOX: Set to @true to use check box editor instead
- "UseDClickCycling": Set to 1 to cycle combo box instead showing the list. of combo box.
- ::wxPG_BOOL_USE_DOUBLE_CLICK_CYCLING: Set to @true to cycle combo box
instead showing the list.
*/ */
class wxBoolProperty : public wxPGProperty class wxBoolProperty : public wxPGProperty
{ {
@@ -508,14 +511,14 @@ public:
Like wxLongStringProperty, but the button triggers file selector instead. Like wxLongStringProperty, but the button triggers file selector instead.
<b>Supported special attributes:</b> <b>Supported special attributes:</b>
- "Wildcard": Sets wildcard (see wxFileDialog for format details), "All - ::wxPG_FILE_WILDCARD: Sets wildcard (see wxFileDialog for format details),
files..." is default. "All files..." is default.
- "ShowFullPath": Default 1. When 0, only the file name is shown (i.e. drive - ::wxPG_FILE_SHOW_FULL_PATH: Default 1. When 0, only the file name is shown
and directory are hidden). (i.e. drive and directory are hidden).
- "ShowRelativePath": If set, then the filename is shown relative to the - ::wxPG_FILE_SHOW_RELATIVE_PATH: If set, then the filename is shown relative
given path string. to the given path string.
- "InitialPath": Sets the initial path of where to look for files. - ::wxPG_FILE_INITIAL_PATH: Sets the initial path of where to look for files.
- "DialogTitle": Sets a specific title for the dir dialog. - ::wxPG_FILE_DIALOG_TITL: Sets a specific title for the dir dialog.
- ::wxPG_FILE_DIALOG_STYLE: Sets a specific wxFileDialog style for the file - ::wxPG_FILE_DIALOG_STYLE: Sets a specific wxFileDialog style for the file
dialog (since 2.9.4). dialog (since 2.9.4).
*/ */
@@ -607,7 +610,7 @@ public:
Like wxLongStringProperty, but the button triggers dir selector instead. Like wxLongStringProperty, but the button triggers dir selector instead.
<b>Supported special attributes:</b> <b>Supported special attributes:</b>
- "DialogMessage": Sets specific message in the dir selector. - ::wxPG_DIR_DIALOG_MESSAGE: Sets specific message in the dir selector.
*/ */
class wxDirProperty : public wxLongStringProperty class wxDirProperty : public wxLongStringProperty
{ {