qSlicerAnnotationsModule Class Reference

#include <Modules/Loadable/Annotations/qSlicerAnnotationsModule.h>

Inheritance diagram for qSlicerAnnotationsModule:

Collaboration diagram for qSlicerAnnotationsModule:

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 Slots
void	showScreenshotDialog ()
Public Slots inherited from qSlicerAbstractCoreModule
virtual void	setMRMLScene (vtkMRMLScene *)

Public Member Functions
QString	acknowledgementText () const override
QStringList	associatedNodeTypes () const override
	Specify editable node types. More...
QStringList	categories () const override
QStringList	contributors () const override
	Return the contributors of the module. More...
QStringList	dependencies () const override
QString	helpText () const override
	Return the help and acknowledgement text for the Annotation module. More...
QIcon	icon () const override
	Return the icon of the Annotation module. More...
	qSlicerAnnotationsModule (QObject *parent=nullptr)
	qSlicerGetTitleMacro (QTMODULE_TITLE)
	~qSlicerAnnotationsModule () 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)
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...
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
vtkMRMLAbstractLogic *	createLogic () override
qSlicerAbstractModuleRepresentation *	createWidgetRepresentation () override
	Create and return a widget representation for the module. More...
void	setup () override
	All initialization code should be done in the setup. More...
Protected Member Functions inherited from qSlicerAbstractCoreModule

Protected Attributes
QScopedPointer< qSlicerAnnotationsModulePrivate >	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
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 16 of file qSlicerAnnotationsModule.h.

Member Typedef Documentation

Superclass

typedef qSlicerLoadableModule qSlicerAnnotationsModule::Superclass

Definition at line 24 of file qSlicerAnnotationsModule.h.

Constructor & Destructor Documentation

qSlicerAnnotationsModule()

qSlicerAnnotationsModule::qSlicerAnnotationsModule

(

QObject *

parent = nullptr

)

~qSlicerAnnotationsModule()

qSlicerAnnotationsModule::~qSlicerAnnotationsModule ( )

override

Member Function Documentation

acknowledgementText()

QString qSlicerAnnotationsModule::acknowledgementText ( ) const

overridevirtual

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

Reimplemented from qSlicerLoadableModule.

associatedNodeTypes()

QStringList qSlicerAnnotationsModule::associatedNodeTypes ( ) const

overridevirtual

Specify editable node types.

Reimplemented from qSlicerAbstractCoreModule.

categories()

QStringList qSlicerAnnotationsModule::categories ( ) const

overridevirtual

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

overridevirtual

Return the contributors of the module.

Reimplemented from qSlicerAbstractCoreModule.

createLogic()

vtkMRMLAbstractLogic* qSlicerAnnotationsModule::createLogic ( )

overrideprotectedvirtual

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

Implements qSlicerAbstractCoreModule.

createWidgetRepresentation()

qSlicerAbstractModuleRepresentation* qSlicerAnnotationsModule::createWidgetRepresentation ( )

overrideprotectedvirtual

Create and return a widget representation for the module.

Implements qSlicerAbstractCoreModule.

dependencies()

QStringList qSlicerAnnotationsModule::dependencies ( ) const

overridevirtual

Reimplemented from qSlicerAbstractCoreModule.

helpText()

QString qSlicerAnnotationsModule::helpText ( ) const

overridevirtual

Return the help and acknowledgement text for the Annotation module.

Reimplemented from qSlicerLoadableModule.

icon()

QIcon qSlicerAnnotationsModule::icon ( ) const

overridevirtual

Return the icon of the Annotation module.

Reimplemented from qSlicerAbstractModule.

qSlicerGetTitleMacro()

qSlicerAnnotationsModule::qSlicerGetTitleMacro

(

QTMODULE_TITLE

)

setup()

void qSlicerAnnotationsModule::setup ( )

overrideprotectedvirtual

All initialization code should be done in the setup.

Reimplemented from qSlicerLoadableModule.

showScreenshotDialog

void qSlicerAnnotationsModule::showScreenshotDialog ( )

slot

a public slot to open up the screen capture dialog (get the module manager, get the module annotation, get the widget representation, then invoke this method

See also

qSlicerIOManager::openScreenshotDialog

Member Data Documentation

d_ptr

QScopedPointer<qSlicerAnnotationsModulePrivate> qSlicerAnnotationsModule::d_ptr

protected

Definition at line 65 of file qSlicerAnnotationsModule.h.

---

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

• Modules/Loadable/Annotations/qSlicerAnnotationsModule.h