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
virtual QString	acknowledgementText () const
virtual QStringList	associatedNodeTypes () const
	Specify editable node types. More...
virtual QStringList	categories () const
virtual QStringList	contributors () const
	Return the contributors of the module. More...
virtual QStringList	dependencies () const
virtual QString	helpText () const
	Return the help and acknowledgement text for the Annotation module. More...
virtual QIcon	icon () const
	Return the icon of the Annotation module. More...
	qSlicerAnnotationsModule (QObject *parent=0)
	qSlicerGetTitleMacro (QTMODULE_TITLE)
virtual	~qSlicerAnnotationsModule ()
Public Member Functions inherited from qSlicerLoadableModule
	qSlicerLoadableModule (QObject *parent=0)
virtual	~qSlicerLoadableModule ()
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=0)
virtual	~qSlicerAbstractModule ()
Public Member Functions inherited from qSlicerAbstractCoreModule
	qSlicerAbstractCoreModule (QObject *parent=0)
virtual	~qSlicerAbstractCoreModule ()
virtual void	printAdditionalInfo ()
QString	slicerWikiUrl () const
	Convenient method to return slicer wiki URL. More...
void	initialize (vtkSlicerApplicationLogic *appLogic)
bool	initialized ()
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
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
virtual vtkMRMLAbstractLogic *	createLogic ()
virtual qSlicerAbstractModuleRepresentation *	createWidgetRepresentation ()
	Create and return a widget representation for the module. More...
virtual void	setup ()
	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
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 26 of file qSlicerAnnotationsModule.h.

Constructor & Destructor Documentation

qSlicerAnnotationsModule()

qSlicerAnnotationsModule::qSlicerAnnotationsModule

(

QObject *

parent = 0

)

~qSlicerAnnotationsModule()

virtual qSlicerAnnotationsModule::~qSlicerAnnotationsModule ( )

virtual

Member Function Documentation

acknowledgementText()

virtual QString qSlicerAnnotationsModule::acknowledgementText ( ) const

virtual

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

Reimplemented from qSlicerLoadableModule.

associatedNodeTypes()

virtual QStringList qSlicerAnnotationsModule::associatedNodeTypes ( ) const

virtual

Specify editable node types.

Reimplemented from qSlicerAbstractCoreModule.

categories()

virtual QStringList qSlicerAnnotationsModule::categories ( ) const

virtual

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()

virtual QStringList qSlicerAnnotationsModule::contributors ( ) const

virtual

Return the contributors of the module.

Reimplemented from qSlicerAbstractCoreModule.

createLogic()

virtual vtkMRMLAbstractLogic* qSlicerAnnotationsModule::createLogic ( )

protectedvirtual

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

Implements qSlicerAbstractCoreModule.

createWidgetRepresentation()

virtual qSlicerAbstractModuleRepresentation* qSlicerAnnotationsModule::createWidgetRepresentation ( )

protectedvirtual

Create and return a widget representation for the module.

Implements qSlicerAbstractCoreModule.

dependencies()

virtual QStringList qSlicerAnnotationsModule::dependencies ( ) const

virtual

Reimplemented from qSlicerAbstractCoreModule.

helpText()

virtual QString qSlicerAnnotationsModule::helpText ( ) const

virtual

Return the help and acknowledgement text for the Annotation module.

Reimplemented from qSlicerLoadableModule.

icon()

virtual QIcon qSlicerAnnotationsModule::icon ( ) const

virtual

Return the icon of the Annotation module.

Reimplemented from qSlicerAbstractModule.

qSlicerGetTitleMacro()

qSlicerAnnotationsModule::qSlicerGetTitleMacro

(

QTMODULE_TITLE

)

setup()

virtual void qSlicerAnnotationsModule::setup ( )

protectedvirtual

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 67 of file qSlicerAnnotationsModule.h.

---

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

• Modules/Loadable/Annotations/qSlicerAnnotationsModule.h