Description of the parameters of a command line module.The parameters can be used for automated GUI generation or execution of the module, and are directly related to the XML description used to describe the command line module parameters.
More...
#include <Libs/CommandLineModules/Core/ctkCmdLineModuleDescription.h>
|
QString | acknowledgements () const |
| Returns the title, derived from the. More...
|
|
QString | category () const |
| Returns the category, derived from the. More...
|
|
QString | categoryDotTitle () const |
| Helper method that returns the category followed by a dot followed by the title. More...
|
|
QString | contributor () const |
| Returns the title, derived from the. More...
|
|
| ctkCmdLineModuleDescription (const ctkCmdLineModuleDescription &description) |
|
QString | description () const |
| Returns the title, derived from the. More...
|
|
QString | documentationURL () const |
| Returns the title, derived from the. More...
|
|
bool | hasParameter (const QString &name) const |
| Searches the list of parameters, checking if a parameter has the given name. More...
|
|
bool | hasReturnParameters () const |
| Does the module have any simple (primitive) return types? More...
|
|
QString | license () const |
| Returns the title, derived from the. More...
|
|
QIcon | logo () const |
| Should return a QIcon, but does not appear to be supported yet. More...
|
|
ctkCmdLineModuleDescription & | operator= (const ctkCmdLineModuleDescription &other) |
|
ctkCmdLineModuleParameter | parameter (const QString &name) const |
| Returns the parameter specified by name. More...
|
|
QList< ctkCmdLineModuleParameterGroup > | parameterGroups () const |
| The XML can define groups of parameters, so this method returns a QList of ctkCmdLineModuleParameterGroup to handle groups. More...
|
|
QString | title () const |
| Returns the title, derived from the. More...
|
|
QString | version () const |
| Returns the title, derived from the. More...
|
|
| ~ctkCmdLineModuleDescription () |
|
Description of the parameters of a command line module.
The parameters can be used for automated GUI generation or execution of the module, and are directly related to the XML description used to describe the command line module parameters.
Definition at line 46 of file ctkCmdLineModuleDescription.h.
ctkCmdLineModuleDescription::~ctkCmdLineModuleDescription |
( |
| ) |
|
QString ctkCmdLineModuleDescription::acknowledgements |
( |
| ) |
const |
Returns the title, derived from the.
tag.
QString ctkCmdLineModuleDescription::category |
( |
| ) |
const |
Returns the category, derived from the.
tag.
QString ctkCmdLineModuleDescription::categoryDotTitle |
( |
| ) |
const |
Helper method that returns the category followed by a dot followed by the title.
QString ctkCmdLineModuleDescription::contributor |
( |
| ) |
const |
Returns the title, derived from the.
tag.
QString ctkCmdLineModuleDescription::description |
( |
| ) |
const |
Returns the title, derived from the.
tag.
QString ctkCmdLineModuleDescription::documentationURL |
( |
| ) |
const |
Returns the title, derived from the.
tag.
bool ctkCmdLineModuleDescription::hasParameter |
( |
const QString & |
name | ) |
const |
Searches the list of parameters, checking if a parameter has the given name.
- Parameters
-
name | the name of the parameter, derived from the tag. |
- Returns
- true if this module has a parameter called name and false otherwise
bool ctkCmdLineModuleDescription::hasReturnParameters |
( |
| ) |
const |
Does the module have any simple (primitive) return types?
QString ctkCmdLineModuleDescription::license |
( |
| ) |
const |
Returns the title, derived from the.
tag.
QIcon ctkCmdLineModuleDescription::logo |
( |
| ) |
const |
Should return a QIcon, but does not appear to be supported yet.
Returns the parameter specified by name.
- Parameters
-
name | the name of the parameter, derived from the tag. |
- Returns
- the parameter
- Exceptions
-
QString ctkCmdLineModuleDescription::title |
( |
| ) |
const |
Returns the title, derived from the.
tag.
QString ctkCmdLineModuleDescription::version |
( |
| ) |
const |
Returns the title, derived from the.
tag.
friend struct ctkCmdLineModuleReferencePrivate |
|
friend |
friend class ctkCmdLineModuleXmlParser |
|
friend |
The documentation for this class was generated from the following file: