Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
qSlicerDataModule Class Reference

#include <Modules/Loadable/Data/qSlicerDataModule.h>

Inheritance diagram for qSlicerDataModule:
Inheritance graph
Collaboration diagram for qSlicerDataModule:
Collaboration graph

Public Types

typedef qSlicerLoadableModule Superclass
- Public Types inherited from qSlicerLoadableModule
typedef qSlicerLoadableModule Self
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 categories () const override
QStringList contributors () const override
 Return the contributors of the module. More...
QStringList dependencies () const override
QString helpText () const override
 Return help/acknowledgement text. More...
QIcon icon () const override
 qSlicerDataModule (QObject *parent=nullptr)
 qSlicerGetTitleMacro (QTMODULE_TITLE)
void setup () override
 All initialization code should be done in the setup. More...
 ~qSlicerDataModule () override
- Public Member Functions inherited from qSlicerLoadableModule
 qSlicerLoadableModule (QObject *parent=nullptr)
 ~qSlicerLoadableModule () override
- Public Member Functions inherited from qSlicerAbstractModule
Q_INVOKABLE QAction * action ()
virtual QImage logo () const
 The logo of the module, the credits given by the grants or instution. More...
 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 QString title () const =0
virtual int index () const
 Return the category index of the module. More...
virtual bool isHidden () const
bool isWidgetRepresentationCreationEnabled () const
void setWidgetRepresentationCreationEnabled (bool value)
qSlicerAbstractModuleRepresentationwidgetRepresentation ()
qSlicerAbstractModuleRepresentationcreateNewWidgetRepresentation ()
void setAppLogic (vtkSlicerApplicationLogic *appLogic)
vtkSlicerApplicationLogicappLogic () const
Q_INVOKABLE vtkMRMLAbstractLogiclogic ()
Q_INVOKABLE vtkMRMLScenemrmlScene () const
 Return a pointer on the MRML scene. More...
QString path () const
void setPath (const QString &newPath)
bool isInstalled () const
void setInstalled (bool value)
bool isBuiltIn () const
void setBuiltIn (bool value)
virtual QStringList associatedNodeTypes () const
 Return node types associated with this module (e.g., node types this module can edit) More...

Protected Member Functions

vtkMRMLAbstractLogiccreateLogic () override
 Create and return the logic associated to this module. More...
qSlicerAbstractModuleRepresentationcreateWidgetRepresentation () override
 Create and return the widget representation associated to this module. More...
- Protected Member Functions inherited from qSlicerAbstractCoreModule

Protected Attributes

QScopedPointer< qSlicerDataModulePrivate > d_ptr
- Protected Attributes inherited from qSlicerLoadableModule
QScopedPointer< qSlicerLoadableModulePrivate > 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 *)
- Static Public Member Functions inherited from qSlicerLoadableModule
static bool addModuleNameToSlicerModuleNames (qSlicerCorePythonManager *pythonManager, const QString &moduleName)
static bool addModuleToSlicerModules (qSlicerCorePythonManager *pythonManager, qSlicerAbstractModule *module, const QString &moduleName)
static bool importModulePythonExtensions (qSlicerCorePythonManager *pythonManager, const QString &intDir, const QString &modulePath, bool isEmbedded=false)
 Import python extensions associated with modulePath. More...

Detailed Description

Definition at line 33 of file qSlicerDataModule.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file qSlicerDataModule.h.

Constructor & Destructor Documentation

◆ qSlicerDataModule()

qSlicerDataModule::qSlicerDataModule ( QObject *  parent = nullptr)

◆ ~qSlicerDataModule()

qSlicerDataModule::~qSlicerDataModule ( )

Member Function Documentation

◆ acknowledgementText()

QString qSlicerDataModule::acknowledgementText ( ) const

Return acknowledgement text for the module Must be reimplemented in the derived classes

Reimplemented from qSlicerLoadableModule.

◆ categories()

QStringList qSlicerDataModule::categories ( ) const

Categories the module belongs to. Categories support subcategories. Use the '.' separator to specify a subcategory (no depth limit), e.g.: "Filtering.Arithmetic". The function must be reimplemented in derived classes. Note: If a category doesn't exist, it will be created.

Reimplemented from qSlicerAbstractCoreModule.

◆ contributors()

QStringList qSlicerDataModule::contributors ( ) const

Return the contributors of the module.

Reimplemented from qSlicerAbstractCoreModule.

◆ createLogic()

vtkMRMLAbstractLogic* qSlicerDataModule::createLogic ( )

Create and return the logic associated to this module.

Implements qSlicerAbstractCoreModule.

◆ createWidgetRepresentation()

qSlicerAbstractModuleRepresentation* qSlicerDataModule::createWidgetRepresentation ( )

Create and return the widget representation associated to this module.

Implements qSlicerAbstractCoreModule.

◆ dependencies()

QStringList qSlicerDataModule::dependencies ( ) const

Reimplemented from qSlicerAbstractCoreModule.

◆ helpText()

QString qSlicerDataModule::helpText ( ) const

Return help/acknowledgement text.

Reimplemented from qSlicerLoadableModule.

◆ icon()

QIcon qSlicerDataModule::icon ( ) const

Icon of the module. Anytime a graphical representation of the module is needed, the icon is used. It's the icon shown in the module selector as well as in the frequently used module toolbar (if any).

Reimplemented from qSlicerAbstractModule.

◆ qSlicerGetTitleMacro()

qSlicerDataModule::qSlicerGetTitleMacro ( QTMODULE_TITLE  )

◆ setup()

void qSlicerDataModule::setup ( )

All initialization code should be done in the setup.

Reimplemented from qSlicerLoadableModule.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerDataModulePrivate> qSlicerDataModule::d_ptr

Definition at line 65 of file qSlicerDataModule.h.

The documentation for this class was generated from the following file: