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 Attributes
qSlicerAbstractModule Class Reference

#include <Base/QTGUI/qSlicerAbstractModule.h>

Inheritance diagram for qSlicerAbstractModule:
Inheritance graph
Collaboration diagram for qSlicerAbstractModule:
Collaboration graph

Public Types

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


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

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...
virtual QString helpText () const
virtual QString acknowledgementText () const
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...
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...

Protected Attributes

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 *)
- Protected Member Functions inherited from qSlicerAbstractCoreModule
virtual void setup ()=0
 All initialization code should be done in the setup. More...
virtual qSlicerAbstractModuleRepresentationcreateWidgetRepresentation ()=0
 Create and return a widget representation for the module. More...
virtual vtkMRMLAbstractLogiccreateLogic ()=0

Detailed Description

Overrides qSlicerAbstractCoreModule and adds an icon property to the module and associates a QAction to it.

Definition at line 40 of file qSlicerAbstractModule.h.

Member Typedef Documentation

◆ Superclass

Definition at line 50 of file qSlicerAbstractModule.h.

Property Documentation

◆ icon

QIcon qSlicerAbstractModule::icon

This property holds the module's icon. It is also the icon of the module QAction (see action()).

Definition at line 46 of file qSlicerAbstractModule.h.

◆ logo

QImage qSlicerAbstractModule::logo

Definition at line 47 of file qSlicerAbstractModule.h.

Constructor & Destructor Documentation

◆ qSlicerAbstractModule()

qSlicerAbstractModule::qSlicerAbstractModule ( QObject *  parent = nullptr)

◆ ~qSlicerAbstractModule()

qSlicerAbstractModule::~qSlicerAbstractModule ( )

Member Function Documentation

◆ action()

Q_INVOKABLE QAction* qSlicerAbstractModule::action ( )

Returns then associated QAction of the module. It contains all the information relative to the module. The text (QAction::text()) and icon (QAction::icon()) are the module title and icon; the name of the module is saved in the QAction's data (QAction::data().toString()) and the module index is the QAction property "index" (QAction::property("index").toInt()). It is typically used in the module selector menu; triggering the QAction will make the module current.

◆ icon()

virtual QIcon qSlicerAbstractModule::icon ( ) const

◆ logo()

virtual QImage qSlicerAbstractModule::logo ( ) const

The logo of the module, the credits given by the grants or instution.

Reimplemented in qSlicerCLIModule.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerAbstractModulePrivate> qSlicerAbstractModule::d_ptr

Definition at line 72 of file qSlicerAbstractModule.h.

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