#include <Base/QTGUI/qSlicerLoadableModule.h>

Inheritance diagram for qSlicerLoadableModule:

[legend]

Collaboration diagram for qSlicerLoadableModule:

Public Types
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

QString	helpText () const override
	Return help/acknowledgement text. More...

	qSlicerLoadableModule (QObject *parent=nullptr)

	~qSlicerLoadableModule () override

Public Member Functions inherited from qSlicerAbstractModule
Q_INVOKABLE QAction *	action ()

virtual QIcon	icon () const

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 QStringList	categories () const

virtual int	index () const
	Return the category index of the module. More...

virtual bool	isHidden () const

virtual QStringList	contributors () const
	Return the contributors of the module. More...

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)

virtual QStringList	associatedNodeTypes () const
	Return node types associated with this module (e.g., node types this module can edit) More...

Static Public Member Functions
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...

Protected Member Functions
void	setup () override
	All initialization code should be done in the setup. More...

Protected Member Functions inherited from qSlicerAbstractCoreModule
virtual qSlicerAbstractModuleRepresentation *	createWidgetRepresentation ()=0
	Create and return a widget representation for the module. More...

virtual vtkMRMLAbstractLogic *	createLogic ()=0

Protected Attributes
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 *)

Detailed Description

Definition at line 35 of file qSlicerLoadableModule.h.

Member Typedef Documentation

◆ Self

typedef qSlicerLoadableModule qSlicerLoadableModule::Self

Definition at line 41 of file qSlicerLoadableModule.h.

◆ Superclass

typedef qSlicerAbstractModule qSlicerLoadableModule::Superclass

Definition at line 42 of file qSlicerLoadableModule.h.

Constructor & Destructor Documentation

◆ qSlicerLoadableModule()

qSlicerLoadableModule::qSlicerLoadableModule ( QObject * parent = nullptr )

◆ ~qSlicerLoadableModule()

qSlicerLoadableModule::~qSlicerLoadableModule ( )

override

Member Function Documentation

◆ acknowledgementText()

QString qSlicerLoadableModule::acknowledgementText ( ) const

overridevirtual

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

Reimplemented from qSlicerAbstractCoreModule.

Reimplemented in qSlicerScriptedLoadableModule, qSlicerSequencesModule, qSlicerTextsModule, qSlicerTransformsModule, qSlicerSubjectHierarchyModule, qSlicerWelcomeModule, qSlicerViewControllersModule, qSlicerDataModule, qSlicerSegmentationsModule, qSlicerTerminologiesModule, qSlicerVolumeRenderingModule, qSlicerCamerasModule, qSlicerColorsModule, qSlicerModelsModule, qSlicerPlotsModule, qSlicerReformatModule, qSlicerTablesModule, qSlicerUnitsModule, qSlicerMarkupsModule, qSlicerVolumesModule, qSlicerDoubleArraysModule, qSlicerCropVolumeModule, qSlicerAnnotationsModule, and qSlicerSceneViewsModule.

◆ addModuleNameToSlicerModuleNames()

static bool qSlicerLoadableModule::addModuleNameToSlicerModuleNames	(	qSlicerCorePythonManager *	pythonManager,
		const QString &	moduleName
	)

static

Set moduleName has an attribute of "slicer.moduleNames" module dictionary. qSlicerCoreApplication::corePythonManager()

◆ addModuleToSlicerModules()

static bool qSlicerLoadableModule::addModuleToSlicerModules	(	qSlicerCorePythonManager *	pythonManager,
		qSlicerAbstractModule *	module,
		const QString &	moduleName
	)

static

Set module identified by moduleName has an attribute of "slicer.modules" module dictionary. qSlicerCoreApplication::corePythonManager()

◆ helpText()

QString qSlicerLoadableModule::helpText ( ) const

overridevirtual

◆ importModulePythonExtensions()

static bool qSlicerLoadableModule::importModulePythonExtensions	(	qSlicerCorePythonManager *	pythonManager,
		const QString &	intDir,
		const QString &	modulePath,
		bool	isEmbedded = `false`
	)

static

Import python extensions associated with modulePath.

modulePath can either be the path to the module library or the directory containing the module library.

Python extensions corresponds to files matching the following wildcard expression:

vtkSlicer*ModuleLogic.py
vtkSlicer*ModuleMRML.py
vtkSlicer*ModuleMRMLDisplayableManager.py
qSlicer*PythonQt.* python

These files are searched within the modulePath directory minus the IntDir if it applies.

See also: qSlicerCoreApplication::intDir(), qSlicerCoreApplication::corePythonManager()

◆ setup()

void qSlicerLoadableModule::setup ( )

overrideprotectedvirtual

All initialization code should be done in the setup.

Implements qSlicerAbstractCoreModule.

Reimplemented in qSlicerScriptedLoadableModule, qSlicerSequencesModule, qSlicerViewControllersModule, qSlicerSegmentationsModule, qSlicerSubjectHierarchyModule, qSlicerMarkupsModule, qSlicerTextsModule, qSlicerTransformsModule, qSlicerReformatModule, qSlicerTerminologiesModule, qSlicerVolumeRenderingModule, qSlicerModelsModule, qSlicerColorsModule, qSlicerUnitsModule, qSlicerPlotsModule, qSlicerTablesModule, qSlicerVolumesModule, qSlicerDoubleArraysModule, qSlicerSceneViewsModule, qSlicerAnnotationsModule, qSlicerDataModule, and qSlicerCropVolumeModule.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerLoadableModulePrivate> qSlicerLoadableModule::d_ptr

protected

Definition at line 87 of file qSlicerLoadableModule.h.

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

Base/QTGUI/qSlicerLoadableModule.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ qSlicerLoadableModule()

◆ ~qSlicerLoadableModule()

Member Function Documentation

◆ acknowledgementText()

◆ addModuleNameToSlicerModuleNames()

◆ addModuleToSlicerModules()

◆ helpText()

◆ importModulePythonExtensions()

◆ setup()

Member Data Documentation

◆ d_ptr