ParameterSettable::StringDescriptor Class Reference
Utility Class for customize the description of String parameter. More...
Public Member Functions | |
| StringDescriptor (QString paramPath) | |
| Add (if not exists) the description of a String parameter. | |
| StringDescriptor & | def (QString defaultValue) |
| set the default value when the parameter is not present into the configuration | |
| StringDescriptor & | help (QString shortHelp, QString longHelp=QString("")) |
| Add a short help comment and a complete help comment. | |
| StringDescriptor & | props (Properties properties) |
| set the Properties of this parameter (see Property documentation) | |
Detailed Description
Utility Class for customize the description of String parameter.
Definition at line 295 of file parametersettable.h.
Constructor & Destructor Documentation
| StringDescriptor | ( | QString | paramPath | ) |
Add (if not exists) the description of a String parameter.
- Warning:
- Don't call it directly; use Descriptor::describeString instead
Definition at line 185 of file parametersettable.cpp.
References ConfigurationParameters::createGroup(), ConfigurationParameters::createParameter(), and Factory::getTypeDescriptions().
Member Function Documentation
| ParameterSettable::StringDescriptor & def | ( | QString | defaultValue | ) |
set the default value when the parameter is not present into the configuration
Definition at line 192 of file parametersettable.cpp.
References ConfigurationParameters::createParameter(), and Factory::getTypeDescriptions().
| ParameterSettable::StringDescriptor & help | ( | QString | shortHelp, |
| QString | longHelp = QString("") |
||
| ) |
Add a short help comment and a complete help comment.
The short help comment is typically used as a tooltip help, while the complete help comment will be shown in the help section for the type
- Parameters:
-
shortHelp is the short comment (rich text here is not allowed) longHelp is the long help (rich text here is allowed); if not specified the longHelp will be the same of the shortHelp
Definition at line 202 of file parametersettable.cpp.
References ConfigurationParameters::createParameter(), and Factory::getTypeDescriptions().
| ParameterSettable::StringDescriptor & props | ( | Properties | properties | ) |
set the Properties of this parameter (see Property documentation)
Definition at line 197 of file parametersettable.cpp.
References Factory::getTypeDescriptions().
The documentation for this class was generated from the following files:
- configuration/include/parametersettable.h
- configuration/src/parametersettable.cpp