ParameterSettable::BoolDescriptor Class Reference
Utility Class for customize the description of Boolean parameter. More...
Public Member Functions | |
| BoolDescriptor (QString paramPath) | |
| Add (if not exists) the description of a Boolean parameter. | |
| BoolDescriptor & | def (bool defaultValue) |
| set the default value when the parameter is not present into the configuration | |
| BoolDescriptor & | help (QString shortHelp, QString longHelp=QString("")) |
| Add a short help comment and a complete help comment. | |
| BoolDescriptor & | props (Properties properties) |
| set the Properties of this parameter (see Property documentation) | |
Detailed Description
Utility Class for customize the description of Boolean parameter.
Definition at line 387 of file parametersettable.h.
Constructor & Destructor Documentation
| BoolDescriptor | ( | QString | paramPath | ) |
Add (if not exists) the description of a Boolean parameter.
- Warning:
- Don't call it directly; use Descriptor::describeBool instead
Definition at line 285 of file parametersettable.cpp.
References ConfigurationParameters::createGroup(), ConfigurationParameters::createParameter(), and Factory::getTypeDescriptions().
Member Function Documentation
| ParameterSettable::BoolDescriptor & def | ( | bool | defaultValue | ) |
set the default value when the parameter is not present into the configuration
Definition at line 292 of file parametersettable.cpp.
References ConfigurationParameters::createParameter(), and Factory::getTypeDescriptions().
| ParameterSettable::BoolDescriptor & 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 302 of file parametersettable.cpp.
References ConfigurationParameters::createParameter(), and Factory::getTypeDescriptions().
| ParameterSettable::BoolDescriptor & props | ( | Properties | properties | ) |
set the Properties of this parameter (see Property documentation)
Definition at line 297 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