Utility Class for describe the parameters of a ParameterSettable. More...
Public Member Functions | |
| Descriptor (QString type, QString shortHelp, QString longHelp) | |
| Add an entry for the type into the descriptions of all available types. | |
| BoolDescriptor | describeBool (QString parameter) |
| Add/Modify the description of a boolean parameter 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 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 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 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 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 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. | |
Detailed Description
Utility Class for describe the parameters of a ParameterSettable.
Definition at line 583 of file parametersettable.h.
Constructor & Destructor Documentation
| Descriptor | ( | QString | type, |
| QString | shortHelp, | ||
| QString | longHelp | ||
| ) |
Add an entry for the type into the descriptions of all available types.
- Parameters
-
type is the name of the type 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
- Warning
- Don't call it directly; use addTypeDescription instead
Definition at line 107 of file parametersettable.cpp.
References ConfigurationParameters::createGroup(), ConfigurationParameters::createParameter(), and Factory::getTypeDescriptions().
Member Function Documentation
| ParameterSettable::BoolDescriptor describeBool | ( | QString | parameter | ) |
Add/Modify the description of a boolean parameter 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 parentGroup is the complete path of the parents if the parameter is a nested subgroup. To specify a subgroup of a subgroup, the complete path is needed; i.e: "subgroup1/subgroup2"
- Returns
- an instance of BoolDescriptor for setting all others fields of the description
Definition at line 129 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 parentGroup is the complete path of the parents if the parameter is a nested subgroup. To specify a subgroup of a subgroup, the complete path is needed; i.e: "subgroup1/subgroup2"
- Returns
- an instance of EnumDescriptor for setting all others fields of the description
Definition at line 133 of file parametersettable.cpp.
| ParameterSettable::IntDescriptor describeInt | ( | QString | parameter | ) |
Add/Modify the description of a int parameter 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 parentGroup is the complete path of the parents if the parameter is a nested subgroup. To specify a subgroup of a subgroup, the complete path is needed; i.e: "subgroup1/subgroup2"
- Returns
- an instance of IntDescriptor for setting all others fields of the description
Definition at line 121 of file parametersettable.cpp.
| ParameterSettable::ObjectDescriptor describeObject | ( | QString | parameter | ) |
Add/Modify the description of a object parameter 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 parentGroup is the complete path of the parents if the parameter is a nested subgroup. To specify a subgroup of a subgroup, the complete path is needed; i.e: "subgroup1/subgroup2"
- Returns
- an instance of ObjectDescriptor for setting all others fields of the description
Definition at line 137 of file parametersettable.cpp.
| ParameterSettable::RealDescriptor describeReal | ( | QString | parameter | ) |
Add/Modify the description of a real value parameter 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 parentGroup is the complete path of the parents if the parameter is a nested subgroup. To specify a subgroup of a subgroup, the complete path is needed; i.e: "subgroup1/subgroup2"
- Returns
- an instance of RealDescriptor for setting all others fields of the description
Definition at line 125 of file parametersettable.cpp.
| ParameterSettable::StringDescriptor describeString | ( | QString | parameter | ) |
Add/Modify the description of a string parameter 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 parentGroup is the complete path of the parents if the parameter is a nested subgroup. To specify a subgroup of a subgroup, the complete path is needed; i.e: "subgroup1/subgroup2"
- Returns
- an instance of StringDescriptor for setting all others fields of the description
Definition at line 117 of file parametersettable.cpp.
| ParameterSettable::SubgroupDescriptor describeSubgroup | ( | QString | subgroup | ) |
Add/Modify the description of a 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 parentGroup is the complete path of the parents if the subgroup is a nested in another subgroup. To specify a subgroup of a subgroup, the complete path is needed; i.e: "subgroup1/subgroup2"
- Returns
- an instance of SubGroupDescriptor for setting all others fields of the description
Definition at line 141 of file parametersettable.cpp.
The documentation for this class was generated from the following files:
- configuration/include/parametersettable.h
- configuration/src/parametersettable.cpp