21 #ifndef __ctkCmdLineModuleDescription_h
22 #define __ctkCmdLineModuleDescription_h
24 #include <ctkCommandLineModulesCoreExport.h>
27 #include <QSharedDataPointer>
33 struct ctkCmdLineModuleDescriptionPrivate;
136 friend class ctkCmdLineModuleXmlParser;
137 friend struct ctkCmdLineModuleReferencePrivate;
141 QSharedDataPointer<ctkCmdLineModuleDescriptionPrivate> d;
Description of the parameters of a command line module.
QString contributor() const
Returns the title, derived from the.
ctkCmdLineModuleDescription & operator=(const ctkCmdLineModuleDescription &other)
QString categoryDotTitle() const
Helper method that returns the category followed by a dot followed by the title.
bool hasReturnParameters() const
Does the module have any simple (primitive) return types?
QString version() const
Returns the title, derived from the.
~ctkCmdLineModuleDescription()
QString category() const
Returns the category, derived from the.
ctkCmdLineModuleParameter parameter(const QString &name) const
Returns the parameter specified by name.
QString acknowledgements() const
Returns the title, derived from the.
static ctkCmdLineModuleDescription parse(QIODevice *input)
bool hasParameter(const QString &name) const
Searches the list of parameters, checking if a parameter has the given name.
QString title() const
Returns the title, derived from the.
ctkCmdLineModuleDescription(const ctkCmdLineModuleDescription &description)
QList< ctkCmdLineModuleParameterGroup > parameterGroups() const
The XML can define groups of parameters, so this method returns a QList of ctkCmdLineModuleParameterG...
QString license() const
Returns the title, derived from the.
QIcon logo() const
Should return a QIcon, but does not appear to be supported yet.
QString description() const
Returns the title, derived from the.
QString documentationURL() const
Returns the title, derived from the.
Single parameter to a module, like a threshold of a filter.
CTK_CMDLINEMODULECORE_EXPORT QTextStream & operator<<(QTextStream &os, const ctkCmdLineModuleDescription &module)