Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated documentation for some wxPropertyGrid classes.

Browse Source 
Updated documentation for wxPGEditor, wxPropertyGridPage, wxPropertyGridManager, wx*Property classes.
Removed doxygen-style comments from header files.
This commit is contained in:
Artur Wieczorek
2016-07-23 23:38:39 +02:00
parent b3d4c870da
commit cd96c664dd
10 changed files with 579 additions and 771 deletions
Download Patch File Download Diff File Expand all files Collapse all files

242
include/wx/propgrid/props.h
View File

@@ -61,11 +61,8 @@ WX_PG_IMPLEMENT_PROPERTY_CLASS_PLAIN(NAME, T, EDITOR)
// -----------------------------------------------------------------------
/** @class wxPGInDialogValidator
@ingroup classes
Creates and manages a temporary wxTextCtrl for validation purposes.
Uses wxPropertyGrid's current editor, if available.
*/
// Creates and manages a temporary wxTextCtrl for validation purposes.
// Uses wxPropertyGrid's current editor, if available.
class WXDLLIMPEXP_PROPGRID wxPGInDialogValidator
{
public:
@@ -95,17 +92,9 @@ private:
#define wxPG_PROP_PASSWORD wxPG_PROP_CLASS_SPECIFIC_2
/** @class wxStringProperty
@ingroup classes
Basic property with string value.
<b>Supported special attributes:</b>
- "Password": set to 1 in order to enable wxTE_PASSWORD on the editor.
@remarks
- If value "<composed>" is set, then actual value is formed (or composed)
from values of child properties.
*/
// Basic property with string value.
// If value "<composed>" is set, then actual value is formed (or composed)
// from values of child properties.
class WXDLLIMPEXP_PROPGRID wxStringProperty : public wxPGProperty
{
WX_PG_DECLARE_PROPERTY_CLASS(wxStringProperty)
@@ -122,8 +111,7 @@ public:
virtual bool DoSetAttribute( const wxString& name, wxVariant& value ) wxOVERRIDE;
/** This is updated so "<composed>" special value can be handled.
*/
// This is updated so "<composed>" special value can be handled.
virtual void OnSetValue() wxOVERRIDE;
protected:
@@ -131,20 +119,16 @@ protected:
// -----------------------------------------------------------------------
/** Constants used with NumericValidation<>().
*/
// Constants used with NumericValidation<>().
enum wxPGNumericValidationConstants
{
/** Instead of modifying the value, show an error message.
*/
// Instead of modifying the value, show an error message.
wxPG_PROPERTY_VALIDATION_ERROR_MESSAGE = 0,
/** Modify value, but stick with the limitations.
*/
// Modify value, but stick with the limitations.
wxPG_PROPERTY_VALIDATION_SATURATE = 1,
/** Modify value, wrap around on overflow.
*/
// Modify value, wrap around on overflow.
wxPG_PROPERTY_VALIDATION_WRAP = 2
};
@@ -152,9 +136,7 @@ enum wxPGNumericValidationConstants
#if wxUSE_VALIDATORS
/**
A more comprehensive numeric validator class.
*/
// A more comprehensive numeric validator class.
class WXDLLIMPEXP_PROPGRID wxNumericPropertyValidator : public wxTextValidator
{
public:
@@ -173,47 +155,8 @@ public:
#endif // wxUSE_VALIDATORS
/** @class wxIntProperty
@ingroup classes
Basic property with integer value.
Seamlessly supports 64-bit integer (wxLongLong) on overflow.
<b>Example how to use seamless 64-bit integer support</b>
Getting value:
@code
wxLongLong_t value = pg->GetPropertyValueAsLongLong();
@endcode
or
@code
wxLongLong value;
wxVariant variant = property->GetValue();
if ( variant.IsType("longlong") )
value = variant.GetLongLong();
else
value = variant.GetLong();
@endcode
Setting value:
@code
pg->SetPropertyValue(longLongVal);
@endcode
or
@code
property->SetValue(WXVARIANT(longLongVal));
@endcode
<b>Supported special attributes:</b>
- "Min", "Max": Specify acceptable value range.
*/
// Basic property with integer value.
// Seamlessly supports 64-bit integer (wxLongLong) on overflow.
class WXDLLIMPEXP_PROPGRID wxIntProperty : public wxPGProperty
{
WX_PG_DECLARE_PROPERTY_CLASS(wxIntProperty)
@@ -240,8 +183,7 @@ public:
static wxValidator* GetClassValidator();
virtual wxValidator* DoGetValidator() const wxOVERRIDE;
/** Validation helpers.
*/
// Validation helpers.
#if wxUSE_LONGLONG
static bool DoValidation( const wxPGProperty* property,
wxLongLong& value,
@@ -268,24 +210,8 @@ protected:
// -----------------------------------------------------------------------
/** @class wxUIntProperty
@ingroup classes
Basic property with unsigned integer value.
Seamlessly supports 64-bit integer (wxULongLong) on overflow.
<b>Supported special attributes:</b>
- "Min", "Max": Specify acceptable value range.
- "Base": Define base. Valid constants are wxPG_BASE_OCT, wxPG_BASE_DEC,
wxPG_BASE_HEX and wxPG_BASE_HEXL (lowercase characters). Arbitrary bases
are <b>not</b> supported.
- "Prefix": Possible values are wxPG_PREFIX_NONE, wxPG_PREFIX_0x, and
wxPG_PREFIX_DOLLAR_SIGN. Only wxPG_PREFIX_NONE works with Decimal and Octal
numbers.
@remarks
- For example how to use seamless 64-bit integer support, see wxIntProperty
documentation (just use wxULongLong instead of wxLongLong).
*/
// Basic property with unsigned integer value.
// Seamlessly supports 64-bit integer (wxULongLong) on overflow.
class WXDLLIMPEXP_PROPGRID wxUIntProperty : public wxPGProperty
{
WX_PG_DECLARE_PROPERTY_CLASS(wxUIntProperty)
@@ -339,14 +265,7 @@ private:
// -----------------------------------------------------------------------
/** @class wxFloatProperty
@ingroup classes
Basic property with double-precision floating point value.
<b>Supported special attributes:</b>
- "Precision": Sets the (max) precision used when floating point value is
rendered as text. The default -1 means infinite precision.
*/
// Basic property with double-precision floating point value.
class WXDLLIMPEXP_PROPGRID wxFloatProperty : public wxPGProperty
{
WX_PG_DECLARE_PROPERTY_CLASS(wxFloatProperty)
@@ -366,8 +285,7 @@ public:
virtual bool ValidateValue( wxVariant& value,
wxPGValidationInfo& validationInfo ) const wxOVERRIDE;
/** Validation helper.
*/
// Validation helper.
static bool DoValidation( const wxPGProperty* property,
double& value,
wxPGValidationInfo* pValidationInfo,
@@ -382,14 +300,7 @@ protected:
// -----------------------------------------------------------------------
/** @class wxBoolProperty
@ingroup classes
Basic property with boolean value.
<b>Supported special attributes:</b>
- "UseCheckbox": Set to 1 to use check box editor instead of combo box.
- "UseDClickCycling": Set to 1 to cycle combo box instead showing the list.
*/
// Basic property with boolean value.
class WXDLLIMPEXP_PROPGRID wxBoolProperty : public wxPGProperty
{
WX_PG_DECLARE_PROPERTY_CLASS(wxBoolProperty)
@@ -415,17 +326,12 @@ public:
// changed (i.e. returns NULL in GetPropertyChoices).
#define wxPG_PROP_STATIC_CHOICES wxPG_PROP_CLASS_SPECIFIC_1
/** @class wxEnumProperty
@ingroup classes
You can derive custom properties with choices from this class. See
wxBaseEnumProperty for remarks.
@remarks
- Updating private index is important. You can do this either by calling
SetIndex() in IntToValue, and then letting wxBaseEnumProperty::OnSetValue
be called (by not implementing it, or by calling super class function in
it) -OR- you can just call SetIndex in OnSetValue.
*/
// Represents a single selection from a list of choices
// You can derive custom properties with choices from this class.
// Updating private index is important. You can do this either by calling
// SetIndex() in IntToValue, and then letting wxBaseEnumProperty::OnSetValue
// be called (by not implementing it, or by calling super class function in
// it) -OR- you can just call SetIndex in OnSetValue.
class WXDLLIMPEXP_PROPGRID wxEnumProperty : public wxPGProperty
{
WX_PG_DECLARE_PROPERTY_CLASS(wxEnumProperty)
@@ -531,14 +437,9 @@ private:
// -----------------------------------------------------------------------
/** @class wxEditEnumProperty
@ingroup classes
wxEnumProperty with wxString value and writable combo box editor.
@remarks
Uses int value, similar to wxEnumProperty, unless text entered by user is
is not in choices (in which case string value is used).
*/
// wxEnumProperty with wxString value and writable combo box editor.
// Uses int value, similar to wxEnumProperty, unless text entered by user is
// is not in choices (in which case string value is used).
class WXDLLIMPEXP_PROPGRID wxEditEnumProperty : public wxEnumProperty
{
WX_PG_DECLARE_PROPERTY_CLASS(wxEditEnumProperty)
@@ -581,16 +482,13 @@ protected:
// -----------------------------------------------------------------------
/** @class wxFlagsProperty
@ingroup classes
Represents a bit set that fits in a long integer. wxBoolProperty
sub-properties are created for editing individual bits. Textctrl is created
to manually edit the flags as a text; a continuous sequence of spaces,
commas and semicolons is considered as a flag id separator.
<b>Note:</b> When changing "choices" (ie. flag labels) of wxFlagsProperty,
you will need to use SetPropertyChoices - otherwise they will not get
updated properly.
*/
// Represents a bit set that fits in a long integer. wxBoolProperty
// sub-properties are created for editing individual bits. Textctrl is created
// to manually edit the flags as a text; a continuous sequence of spaces,
// commas and semicolons is considered as a flag id separator.
// Note: When changing "choices" (ie. flag labels) of wxFlagsProperty,
// you will need to use SetPropertyChoices - otherwise they will not get
// updated properly.
class WXDLLIMPEXP_PROPGRID wxFlagsProperty : public wxPGProperty
{
WX_PG_DECLARE_PROPERTY_CLASS(wxFlagsProperty)
@@ -650,9 +548,6 @@ protected:
// -----------------------------------------------------------------------
/** @class wxPGFileDialogAdapter
@ingroup classes
*/
class WXDLLIMPEXP_PROPGRID
wxPGFileDialogAdapter : public wxPGEditorDialogAdapter
{
@@ -666,20 +561,7 @@ public:
// Indicates first bit useable by derived properties.
#define wxPG_PROP_SHOW_FULL_FILENAME wxPG_PROP_CLASS_SPECIFIC_1
/** @class wxFileProperty
@ingroup classes
Like wxLongStringProperty, but the button triggers file selector instead.
<b>Supported special attributes:</b>
- "Wildcard": Sets wildcard (see wxFileDialog for format details), "All
files..." is default.
- "ShowFullPath": Default 1. When 0, only the file name is shown (i.e. drive
and directory are hidden).
- "ShowRelativePath": If set, then the filename is shown relative to the
given path string.
- "InitialPath": Sets the initial path of where to look for files.
- "DialogTitle": Sets a specific title for the dir dialog.
*/
// Like wxLongStringProperty, but the button triggers file selector instead.
class WXDLLIMPEXP_PROPGRID wxFileProperty : public wxPGProperty
{
friend class wxPGFileDialogAdapter;
@@ -702,9 +584,7 @@ public:
static wxValidator* GetClassValidator();
virtual wxValidator* DoGetValidator() const wxOVERRIDE;
/**
Returns filename to file represented by current value.
*/
// Returns filename to file represented by current value.
wxFileName GetFileName() const;
protected:
@@ -723,9 +603,6 @@ protected:
#define wxPG_PROP_ACTIVE_BTN wxPG_PROP_CLASS_SPECIFIC_3
/** @class wxPGLongStringDialogAdapter
@ingroup classes
*/
class WXDLLIMPEXP_PROPGRID
wxPGLongStringDialogAdapter : public wxPGEditorDialogAdapter
{
@@ -735,11 +612,8 @@ public:
};
/** @class wxLongStringProperty
@ingroup classes
Like wxStringProperty, but has a button that triggers a small text
editor dialog.
*/
// Like wxStringProperty, but has a button that triggers a small text
// editor dialog.
class WXDLLIMPEXP_PROPGRID wxLongStringProperty : public wxPGProperty
{
WX_PG_DECLARE_PROPERTY_CLASS(wxLongStringProperty)
@@ -772,13 +646,7 @@ protected:
// -----------------------------------------------------------------------
/** @class wxDirProperty
@ingroup classes
Like wxLongStringProperty, but the button triggers dir selector instead.
<b>Supported special attributes:</b>
- "DialogMessage": Sets specific message in the dir selector.
*/
// Like wxLongStringProperty, but the button triggers dir selector instead.
class WXDLLIMPEXP_PROPGRID wxDirProperty : public wxLongStringProperty
{
wxDECLARE_DYNAMIC_CLASS(wxDirProperty);
@@ -807,10 +675,7 @@ protected:
// -----------------------------------------------------------------------
/** @class wxArrayStringProperty
@ingroup classes
Property that manages a list of strings.
*/
// Property that manages a list of strings.
class WXDLLIMPEXP_PROPGRID wxArrayStringProperty : public wxPGProperty
{
WX_PG_DECLARE_PROPERTY_CLASS(wxArrayStringProperty)
@@ -853,10 +718,8 @@ public:
QuoteStrings = 0x02
};
/**
Generates contents for string dst based on the contents of
wxArrayString src.
*/
// Generates contents for string dst based on the contents of
// wxArrayString src.
static void ArrayStringToString( wxString& dst, const wxArrayString& src,
wxUniChar delimiter, int flags );
@@ -966,29 +829,24 @@ public:
m_hasCustomNewAction = true;
}
/** Set value modified by dialog.
*/
// Set value modified by dialog.
virtual void SetDialogValue( const wxVariant& WXUNUSED(value) )
{
wxFAIL_MSG(wxS("re-implement this member function in derived class"));
}
/** Return value modified by dialog.
*/
// Return value modified by dialog.
virtual wxVariant GetDialogValue() const
{
wxFAIL_MSG(wxS("re-implement this member function in derived class"));
return wxVariant();
}
/** Override to return wxValidator to be used with the wxTextCtrl
in dialog. Note that the validator is used in the standard
wx way, i.e. it immediately prevents user from entering invalid
input.
@remarks
Dialog frees the validator.
*/
// Override to return wxValidator to be used with the wxTextCtrl
// in dialog. Note that the validator is used in the standard
// wx way, i.e. it immediately prevents user from entering invalid
// input.
// Note: Dialog frees the validator.
virtual wxValidator* GetTextCtrlValidator() const
{
return NULL;