Slicer
4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
|
#include <Base/QTCLI/qSlicerCLIModule.h>
Public Types | |
typedef qSlicerAbstractModule | Superclass |
Public Types inherited from qSlicerAbstractModule | |
typedef qSlicerAbstractCoreModule | Superclass |
Public Types inherited from qSlicerAbstractCoreModule | |
typedef QObject | Superclass |
Public Member Functions | |
QString | acknowledgementText () const override |
QStringList | associatedNodeTypes () const override |
Specify editable node types. More... | |
QStringList | categories () const override |
Extracted from the "category" field. More... | |
Q_INVOKABLE vtkSlicerCLIModuleLogic * | cliModuleLogic () |
QStringList | contributors () const override |
Extracted from the "contributor" field. More... | |
QString | entryPoint () const |
QString | helpText () const override |
Return help/acknowledgement text More... | |
int | index () const override |
Optionally set in the module XML description. More... | |
QImage | logo () const override |
The logo of the module, the credits given by the grants or instution. More... | |
ModuleDescription & | moduleDescription () |
QString | moduleType () const |
qSlicerCLIModule (QWidget *parent=nullptr) | |
void | setEntryPoint (const QString &entryPoint) |
void | setLogo (const ModuleLogo &logo) |
void | setModuleType (const QString &type) |
void | setTempDirectory (const QString &tempDirectory) |
Set temporary directory associated with the module. More... | |
void | setXmlModuleDescription (const QString &xmlModuleDescription) |
QString | tempDirectory () const |
QString | title () const override |
~qSlicerCLIModule () override | |
Public Member Functions inherited from qSlicerAbstractModule | |
Q_INVOKABLE QAction * | action () |
virtual QIcon | icon () const |
qSlicerAbstractModule (QObject *parent=nullptr) | |
~qSlicerAbstractModule () override | |
Public Member Functions inherited from qSlicerAbstractCoreModule | |
qSlicerAbstractCoreModule (QObject *parent=nullptr) | |
~qSlicerAbstractCoreModule () override | |
virtual void | printAdditionalInfo () |
QString | slicerWikiUrl () const |
Convenience method to return slicer wiki URL. More... | |
QString | defaultDocumentationLink () const |
void | initialize (vtkSlicerApplicationLogic *appLogic) |
virtual QString | name () const |
virtual void | setName (const QString &name) |
virtual bool | isHidden () const |
bool | isWidgetRepresentationCreationEnabled () const |
void | setWidgetRepresentationCreationEnabled (bool value) |
qSlicerAbstractModuleRepresentation * | widgetRepresentation () |
qSlicerAbstractModuleRepresentation * | createNewWidgetRepresentation () |
void | setAppLogic (vtkSlicerApplicationLogic *appLogic) |
vtkSlicerApplicationLogic * | appLogic () const |
vtkMRMLAbstractLogic * | moduleLogic (const QString &moduleName) const |
Convenience method for getting another module's logic from appLogic. More... | |
Q_INVOKABLE vtkMRMLAbstractLogic * | logic () |
Q_INVOKABLE vtkMRMLScene * | mrmlScene () const |
Return a pointer on the MRML scene. More... | |
virtual QStringList | dependencies () const |
QString | path () const |
void | setPath (const QString &newPath) |
bool | isInstalled () const |
void | setInstalled (bool value) |
bool | isBuiltIn () const |
void | setBuiltIn (bool value) |
Static Public Member Functions | |
static QImage | moduleLogoToImage (const ModuleLogo &logo) |
Protected Member Functions | |
vtkMRMLAbstractLogic * | createLogic () override |
Create and return the logic associated to this module More... | |
qSlicerAbstractModuleRepresentation * | createWidgetRepresentation () override |
Create and return the widget representation associated to this module More... | |
void | setup () override |
All initialization code should be done in the setup. More... | |
Protected Member Functions inherited from qSlicerAbstractCoreModule |
Protected Attributes | |
QScopedPointer< qSlicerCLIModulePrivate > | d_ptr |
Protected Attributes inherited from qSlicerAbstractModule | |
QScopedPointer< qSlicerAbstractModulePrivate > | d_ptr |
Protected Attributes inherited from qSlicerAbstractCoreModule | |
QScopedPointer< qSlicerAbstractCoreModulePrivate > | d_ptr |
Additional Inherited Members | |
Properties inherited from qSlicerAbstractModule | |
QIcon | icon |
QImage | logo |
Properties inherited from qSlicerAbstractCoreModule | |
QString | name |
QString | title |
QStringList | categories |
int | index |
bool | hidden |
bool | widgetRepresentationCreationEnabled |
QString | helpText |
QString | acknowledgementText |
QStringList | contributors |
QString | slicerWikiUrl |
QString | defaultDocumentationLink |
QStringList | dependencies |
QString | path |
bool | isInstalled |
bool | isBuiltIn |
QStringList | associatedNodeTypes |
Public Slots inherited from qSlicerAbstractCoreModule | |
virtual void | setMRMLScene (vtkMRMLScene *) |
Definition at line 40 of file qSlicerCLIModule.h.
Definition at line 45 of file qSlicerCLIModule.h.
qSlicerCLIModule::qSlicerCLIModule | ( | QWidget * | parent = nullptr | ) |
|
override |
|
overridevirtual |
Return acknowledgement text for the module Must be reimplemented in the derived classes
Reimplemented from qSlicerAbstractCoreModule.
|
overridevirtual |
Specify editable node types.
Reimplemented from qSlicerAbstractCoreModule.
|
overridevirtual |
Extracted from the "category" field.
Reimplemented from qSlicerAbstractCoreModule.
Q_INVOKABLE vtkSlicerCLIModuleLogic* qSlicerCLIModule::cliModuleLogic | ( | ) |
This method allows to get a pointer to the ModuleLogic. If no moduleLogic already exists, one will be created calling 'createLogic' method.
|
overridevirtual |
Extracted from the "contributor" field.
Reimplemented from qSlicerAbstractCoreModule.
|
overrideprotectedvirtual |
Create and return the logic associated to this module
Implements qSlicerAbstractCoreModule.
|
overrideprotectedvirtual |
Create and return the widget representation associated to this module
Implements qSlicerAbstractCoreModule.
QString qSlicerCLIModule::entryPoint | ( | ) | const |
|
overridevirtual |
Return help/acknowledgement text
Reimplemented from qSlicerAbstractCoreModule.
|
overridevirtual |
Optionally set in the module XML description.
Reimplemented from qSlicerAbstractCoreModule.
|
overridevirtual |
The logo of the module, the credits given by the grants or instution.
Reimplemented from qSlicerAbstractModule.
ModuleDescription& qSlicerCLIModule::moduleDescription | ( | ) |
Return the module description object used to store the module properties.
|
static |
Convert a ModuleLogo into a QIcon
QString qSlicerCLIModule::moduleType | ( | ) | const |
void qSlicerCLIModule::setEntryPoint | ( | const QString & | entryPoint | ) |
Set module entry point. Typically "slicer:0x012345" for loadable CLI or "/home/user/work/Slicer-Superbuild/../mycliexec" for executable CLI
void qSlicerCLIModule::setLogo | ( | const ModuleLogo & | logo | ) |
void qSlicerCLIModule::setModuleType | ( | const QString & | type | ) |
SharedObjectModule for loadable modules or CommandLineModule for executable modules.
void qSlicerCLIModule::setTempDirectory | ( | const QString & | tempDirectory | ) |
Set temporary directory associated with the module.
|
overrideprotectedvirtual |
All initialization code should be done in the setup.
Implements qSlicerAbstractCoreModule.
void qSlicerCLIModule::setXmlModuleDescription | ( | const QString & | xmlModuleDescription | ) |
Assign the module XML description. Note: That will also trigger the parsing of the XML structure
QString qSlicerCLIModule::tempDirectory | ( | ) | const |
|
overridevirtual |
Title of the module, (displayed to the user) title() must be reimplemented in derived classes.
Implements qSlicerAbstractCoreModule.
|
protected |
Definition at line 116 of file qSlicerCLIModule.h.