Utility Class for customize the description of a subgroup. More...
Public Member Functions | |
| SubgroupDescriptor (QString paramPath) | |
| Add (if not exists) the description of a subgroup parameter. | |
| BoolDescriptor | describeBool (QString parameter) |
| Add/Modify the description of a boolean parameter to this subgroup This method add (if there was no previous description of the parameter) or modify (changing the previous description) a description of a boolean parameter. | |
| EnumDescriptor | describeEnum (QString parameter) |
| Add/Modify the description of a parameter which can take value from a fixed set of values This method add (if there was no previous description of the parameter) or modify (changing the previous description) a description of a enum-like parameter. | |
| IntDescriptor | describeInt (QString parameter) |
| Add/Modify the description of a int parameter to this subgroup This method add (if there was no previous description of the parameter) or modify (changing the previous description) a description of a integer parameter. | |
| ObjectDescriptor | describeObject (QString parameter) |
| Add/Modify the description of a object parameter to this subgroup This method add (if there was no previous description of the parameter) or modify (changing the previous description) a description of a object parameter. | |
| RealDescriptor | describeReal (QString parameter) |
| Add/Modify the description of a real value parameter to this subgroup This method add (if there was no previous description of the parameter) or modify (changing the previous description) a description of a real value parameter. | |
| StringDescriptor | describeString (QString parameter) |
| Add/Modify the description of a string parameter to this subgroup This method add (if there was no previous description of the parameter) or modify (changing the previous description) a description of a string parameter. | |
| SubgroupDescriptor | describeSubgroup (QString subgroup) |
| Add/Modify the description of a subgroup to this subgroup This method add (if there was no previous description of the parameter) or modify (changing the previous description) a description of a subgroup of the type specified. | |
| SubgroupDescriptor & | help (QString shortHelp, QString longHelp=QString("")) |
| Add a short help comment and a complete help comment. | |
| SubgroupDescriptor & | props (Properties properties) |
| set the Properties of this parameter (see Property documentation) | |
| SubgroupDescriptor & | type (QString className) |
| the name of the class of the object corresponding to the subgroup (it includes also all subclasses) | |
Detailed Description
Utility Class for customize the description of a subgroup.
Definition at line 487 of file parametersettable.h.
Constructor & Destructor Documentation
| SubgroupDescriptor | ( | QString | paramPath | ) |
Add (if not exists) the description of a subgroup parameter.
- Warning
- Don't call it directly; use Descriptor::describeSubgroup instead
Definition at line 328 of file parametersettable.cpp.
References ConfigurationParameters::createGroup(), and Factory::getTypeDescriptions().
Member Function Documentation
| ParameterSettable::BoolDescriptor describeBool | ( | QString | parameter | ) |
Add/Modify the description of a boolean parameter to this subgroup This method add (if there was no previous description of the parameter) or modify (changing the previous description) a description of a boolean parameter.
- Note
- There are several similar method on the basis of the type of the parameter to describe.
- Parameters
-
parameter is the name of the parameter to describe
- Returns
- an instance of BoolDescriptor for setting all others fields of the description
Definition at line 365 of file parametersettable.cpp.
| ParameterSettable::EnumDescriptor describeEnum | ( | QString | parameter | ) |
Add/Modify the description of a parameter which can take value from a fixed set of values This method add (if there was no previous description of the parameter) or modify (changing the previous description) a description of a enum-like parameter.
- Note
- There are several similar method on the basis of the type of the parameter to describe.
- Parameters
-
parameter is the name of the parameter to describe
- Returns
- an instance of EnumDescriptor for setting all others fields of the description
Definition at line 369 of file parametersettable.cpp.
| ParameterSettable::IntDescriptor describeInt | ( | QString | parameter | ) |
Add/Modify the description of a int parameter to this subgroup This method add (if there was no previous description of the parameter) or modify (changing the previous description) a description of a integer parameter.
- Note
- There are several similar method on the basis of the type of the parameter to describe.
- Parameters
-
parameter is the name of the parameter to describe
- Returns
- an instance of IntDescriptor for setting all others fields of the description
Definition at line 357 of file parametersettable.cpp.
| ParameterSettable::ObjectDescriptor describeObject | ( | QString | parameter | ) |
Add/Modify the description of a object parameter to this subgroup This method add (if there was no previous description of the parameter) or modify (changing the previous description) a description of a object parameter.
- Note
- There are several similar method on the basis of the type of the parameter to describe.
- Parameters
-
parameter is the name of the parameter to describe
- Returns
- an instance of ObjectDescriptor for setting all others fields of the description
Definition at line 373 of file parametersettable.cpp.
| ParameterSettable::RealDescriptor describeReal | ( | QString | parameter | ) |
Add/Modify the description of a real value parameter to this subgroup This method add (if there was no previous description of the parameter) or modify (changing the previous description) a description of a real value parameter.
- Note
- There are several similar method on the basis of the type of the parameter to describe.
- Parameters
-
parameter is the name of the parameter to describe
- Returns
- an instance of RealDescriptor for setting all others fields of the description
Definition at line 361 of file parametersettable.cpp.
| ParameterSettable::StringDescriptor describeString | ( | QString | parameter | ) |
Add/Modify the description of a string parameter to this subgroup This method add (if there was no previous description of the parameter) or modify (changing the previous description) a description of a string parameter.
- Note
- There are several similar method on the basis of the type of the parameter to describe.
- Parameters
-
parameter is the name of the parameter to describe
- Returns
- an instance of StringDescriptor for setting all others fields of the description
Definition at line 353 of file parametersettable.cpp.
| ParameterSettable::SubgroupDescriptor describeSubgroup | ( | QString | subgroup | ) |
Add/Modify the description of a subgroup to this subgroup This method add (if there was no previous description of the parameter) or modify (changing the previous description) a description of a subgroup of the type specified.
- Note
- There are several similar method on the basis of the type of the parameter to describe.
- Parameters
-
parameter is the name of the parameter to describe
- Returns
- an instance of SubGroupDescriptor for setting all others fields of the description
Definition at line 377 of file parametersettable.cpp.
| ParameterSettable::SubgroupDescriptor & 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 344 of file parametersettable.cpp.
References ConfigurationParameters::createParameter(), and Factory::getTypeDescriptions().
| ParameterSettable::SubgroupDescriptor & props | ( | Properties | properties | ) |
set the Properties of this parameter (see Property documentation)
Definition at line 333 of file parametersettable.cpp.
References Factory::getTypeDescriptions().
| ParameterSettable::SubgroupDescriptor & type | ( | QString | className | ) |
the name of the class of the object corresponding to the subgroup (it includes also all subclasses)
Definition at line 338 of file parametersettable.cpp.
References ConfigurationParameters::createParameter(), and Factory::getTypeDescriptions().
The documentation for this class was generated from the following files:
- configuration/include/parametersettable.h
- configuration/src/parametersettable.cpp