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

#include <Base/QTGUI/qSlicerScriptedLoadableModule.h>

Inheritance diagram for qSlicerScriptedLoadableModule:
Inheritance graph
Collaboration diagram for qSlicerScriptedLoadableModule:
Collaboration graph

Public Types

typedef qSlicerScriptedLoadableModulePrivate Pimpl
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


QString acknowledgementText
QStringList associatedNodeTypes
QStringList categories
 Reimplemented to expose the setter setCategories. More...
QStringList contributors
QStringList dependencies
QVariantMap extensions
QString helpText
bool hidden
QIcon icon
int index
QString title
- 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 Member Functions

QString acknowledgementText () const override
QStringList associatedNodeTypes () const override
 Return node types associated with this module (e.g., node types this module can edit) More...
QStringList categories () const override
QStringList contributors () const override
 Return the contributors of the module. More...
QStringList dependencies () const override
virtual QVariantMap extensions () const
QString helpText () const override
 Return help/acknowledgement text. More...
QIcon icon () const override
int index () const override
 Return the category index of the module. More...
bool isHidden () const override
QString pythonSource () const
 qSlicerScriptedLoadableModule (QObject *parent=nullptr)
void setAcknowledgementText (const QString &newAcknowledgementText)
void setAssociatedNodeTypes (const QStringList &newAssociatedNodeTypes)
void setCategories (const QStringList &newCategories)
void setContributors (const QStringList &newContributors)
void setDependencies (const QStringList &dependencies)
void setExtensions (const QVariantMap &extensions)
void setHelpText (const QString &newHelpText)
void setHidden (bool hidden)
void setIcon (const QIcon &newIcon)
void setIndex (const int index)
bool setPythonSource (const QString &newPythonSource)
void setTitle (const QString &newTitle)
QString title () const override
 ~qSlicerScriptedLoadableModule () 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)
bool isWidgetRepresentationCreationEnabled () const
void setWidgetRepresentationCreationEnabled (bool value)
qSlicerAbstractModuleRepresentationwidgetRepresentation ()
qSlicerAbstractModuleRepresentationcreateNewWidgetRepresentation ()
void setAppLogic (vtkSlicerApplicationLogic *appLogic)
vtkSlicerApplicationLogicappLogic () const
vtkMRMLAbstractLogicmoduleLogic (const QString &moduleName) const
 Convenience method for getting another module's logic from appLogic. More...
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)

Protected Member Functions

vtkMRMLAbstractLogiccreateLogic () override
qSlicerAbstractModuleRepresentationcreateWidgetRepresentation () override
 Create and return a widget representation for the module. More...
void registerFileDialog ()
void registerIO ()
void setup () override
 All initialization code should be done in the setup. More...
- Protected Member Functions inherited from qSlicerAbstractCoreModule

Protected Attributes

QScopedPointer< qSlicerScriptedLoadableModulePrivate > 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

- 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 34 of file qSlicerScriptedLoadableModule.h.

Member Typedef Documentation

◆ Pimpl

typedef qSlicerScriptedLoadableModulePrivate qSlicerScriptedLoadableModule::Pimpl

Definition at line 53 of file qSlicerScriptedLoadableModule.h.

◆ Superclass

Definition at line 52 of file qSlicerScriptedLoadableModule.h.

Property Documentation

◆ acknowledgementText

QString qSlicerScriptedLoadableModule::acknowledgementText

Definition at line 43 of file qSlicerScriptedLoadableModule.h.

◆ associatedNodeTypes

QStringList qSlicerScriptedLoadableModule::associatedNodeTypes

Definition at line 41 of file qSlicerScriptedLoadableModule.h.

◆ categories

QStringList qSlicerScriptedLoadableModule::categories

Reimplemented to expose the setter setCategories.

Definition at line 39 of file qSlicerScriptedLoadableModule.h.

◆ contributors

QStringList qSlicerScriptedLoadableModule::contributors

Definition at line 40 of file qSlicerScriptedLoadableModule.h.

◆ dependencies

QStringList qSlicerScriptedLoadableModule::dependencies

Definition at line 47 of file qSlicerScriptedLoadableModule.h.

◆ extensions

QVariantMap qSlicerScriptedLoadableModule::extensions

Definition at line 44 of file qSlicerScriptedLoadableModule.h.

◆ helpText

QString qSlicerScriptedLoadableModule::helpText

Definition at line 42 of file qSlicerScriptedLoadableModule.h.

◆ hidden

bool qSlicerScriptedLoadableModule::hidden

Definition at line 46 of file qSlicerScriptedLoadableModule.h.

◆ icon

QIcon qSlicerScriptedLoadableModule::icon

Definition at line 45 of file qSlicerScriptedLoadableModule.h.

◆ index

int qSlicerScriptedLoadableModule::index

Definition at line 48 of file qSlicerScriptedLoadableModule.h.

◆ title

QString qSlicerScriptedLoadableModule::title

Definition at line 37 of file qSlicerScriptedLoadableModule.h.

Constructor & Destructor Documentation

◆ qSlicerScriptedLoadableModule()

qSlicerScriptedLoadableModule::qSlicerScriptedLoadableModule ( QObject *  parent = nullptr)

◆ ~qSlicerScriptedLoadableModule()

qSlicerScriptedLoadableModule::~qSlicerScriptedLoadableModule ( )

Member Function Documentation

◆ acknowledgementText()

QString qSlicerScriptedLoadableModule::acknowledgementText ( ) const

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

Reimplemented from qSlicerLoadableModule.

◆ associatedNodeTypes()

QStringList qSlicerScriptedLoadableModule::associatedNodeTypes ( ) const

Return node types associated with this module (e.g., node types this module can edit)

Reimplemented from qSlicerAbstractCoreModule.

◆ categories()

QStringList qSlicerScriptedLoadableModule::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 qSlicerScriptedLoadableModule::contributors ( ) const

Return the contributors of the module.

Reimplemented from qSlicerAbstractCoreModule.

◆ createLogic()

vtkMRMLAbstractLogic* qSlicerScriptedLoadableModule::createLogic ( )

Create and return the module logic Note: Only one instance of the logic will exist per module

Implements qSlicerAbstractCoreModule.

◆ createWidgetRepresentation()

qSlicerAbstractModuleRepresentation* qSlicerScriptedLoadableModule::createWidgetRepresentation ( )

Create and return a widget representation for the module.

Implements qSlicerAbstractCoreModule.

◆ dependencies()

QStringList qSlicerScriptedLoadableModule::dependencies ( ) const

Reimplemented from qSlicerAbstractCoreModule.

◆ extensions()

virtual QVariantMap qSlicerScriptedLoadableModule::extensions ( ) const

◆ helpText()

QString qSlicerScriptedLoadableModule::helpText ( ) const

Return help/acknowledgement text.

Reimplemented from qSlicerLoadableModule.

◆ icon()

QIcon qSlicerScriptedLoadableModule::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.

◆ index()

int qSlicerScriptedLoadableModule::index ( ) const

Return the category index of the module.

Reimplemented from qSlicerAbstractCoreModule.

◆ isHidden()

bool qSlicerScriptedLoadableModule::isHidden ( ) const

Enable/Disable hide state of the module Needs to be hidden before the module menu is created.

Reimplemented from qSlicerAbstractCoreModule.

◆ pythonSource()

QString qSlicerScriptedLoadableModule::pythonSource ( ) const

◆ registerFileDialog()

void qSlicerScriptedLoadableModule::registerFileDialog ( )

◆ registerIO()

void qSlicerScriptedLoadableModule::registerIO ( )

◆ setAcknowledgementText()

void qSlicerScriptedLoadableModule::setAcknowledgementText ( const QString &  newAcknowledgementText)

◆ setAssociatedNodeTypes()

void qSlicerScriptedLoadableModule::setAssociatedNodeTypes ( const QStringList &  newAssociatedNodeTypes)

◆ setCategories()

void qSlicerScriptedLoadableModule::setCategories ( const QStringList &  newCategories)

◆ setContributors()

void qSlicerScriptedLoadableModule::setContributors ( const QStringList &  newContributors)

◆ setDependencies()

void qSlicerScriptedLoadableModule::setDependencies ( const QStringList &  dependencies)

◆ setExtensions()

void qSlicerScriptedLoadableModule::setExtensions ( const QVariantMap extensions)

◆ setHelpText()

void qSlicerScriptedLoadableModule::setHelpText ( const QString &  newHelpText)

◆ setHidden()

void qSlicerScriptedLoadableModule::setHidden ( bool  hidden)

◆ setIcon()

void qSlicerScriptedLoadableModule::setIcon ( const QIcon &  newIcon)

◆ setIndex()

void qSlicerScriptedLoadableModule::setIndex ( const int  index)

◆ setPythonSource()

bool qSlicerScriptedLoadableModule::setPythonSource ( const QString &  newPythonSource)

◆ setTitle()

void qSlicerScriptedLoadableModule::setTitle ( const QString &  newTitle)

◆ setup()

void qSlicerScriptedLoadableModule::setup ( )

All initialization code should be done in the setup.

Reimplemented from qSlicerLoadableModule.

◆ title()

QString qSlicerScriptedLoadableModule::title ( ) const

Title of the module, (displayed to the user) title() must be reimplemented in derived classes.

Implements qSlicerAbstractCoreModule.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerScriptedLoadableModulePrivate> qSlicerScriptedLoadableModule::d_ptr

Definition at line 108 of file qSlicerScriptedLoadableModule.h.

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