qSlicerCoreModule Class Reference

#include <Modules/Core/qSlicerCoreModule.h>

Inheritance diagram for qSlicerCoreModule:

Collaboration diagram for qSlicerCoreModule:

Public Types
typedef qSlicerAbstractModule	Superclass
Public Types inherited from qSlicerAbstractModule
typedef qSlicerAbstractCoreModule	Superclass
typedef QObject	Superclass

Public Member Functions
	qSlicerCoreModule (QObject *parent=nullptr)
	~qSlicerCoreModule () 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 institution.
	qSlicerAbstractModule (QObject *parent=nullptr)
	~qSlicerAbstractModule () override
	qSlicerAbstractCoreModule (QObject *parent=nullptr)
	~qSlicerAbstractCoreModule () override
virtual void	printAdditionalInfo ()
QString	slicerWikiUrl () const
	Convenience method to return slicer wiki URL.
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.
virtual bool	isHidden () const
virtual QStringList	contributors () const
	Return the contributors of the module.
virtual QString	helpText () const
virtual QString	acknowledgementText () 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.
Q_INVOKABLE vtkMRMLAbstractLogic *	logic ()
Q_INVOKABLE vtkMRMLScene *	mrmlScene () const
	Return a pointer on the MRML scene.
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)

Protected Member Functions
void	setup () override
	All initialization code should be done in the setup.
virtual qSlicerAbstractModuleRepresentation *	createWidgetRepresentation ()=0
	Create and return a widget representation for the module.
virtual vtkMRMLAbstractLogic *	createLogic ()=0

Protected Attributes
QScopedPointer< qSlicerCoreModulePrivate >	d_ptr
Protected Attributes inherited from qSlicerAbstractModule
QScopedPointer< qSlicerAbstractModulePrivate >	d_ptr
QScopedPointer< qSlicerAbstractCoreModulePrivate >	d_ptr

Additional Inherited Members
Properties inherited from qSlicerAbstractModule
QIcon	icon
QImage	logo
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
virtual void	setMRMLScene (vtkMRMLScene *)

Detailed Description

Definition at line 34 of file qSlicerCoreModule.h.

Member Typedef Documentation

Superclass

typedef qSlicerAbstractModule qSlicerCoreModule::Superclass

Definition at line 40 of file qSlicerCoreModule.h.

Constructor & Destructor Documentation

qSlicerCoreModule()

qSlicerCoreModule::qSlicerCoreModule

(

QObject *

parent = nullptr

)

~qSlicerCoreModule()

qSlicerCoreModule::~qSlicerCoreModule ( )

override

Member Function Documentation

setup()

void qSlicerCoreModule::setup ( )

overrideprotectedvirtual

All initialization code should be done in the setup.

Implements qSlicerAbstractCoreModule.

Member Data Documentation

d_ptr

QScopedPointer<qSlicerCoreModulePrivate> qSlicerCoreModule::d_ptr

protected

Definition at line 48 of file qSlicerCoreModule.h.

---

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

• Modules/Core/qSlicerCoreModule.h