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 | Public Member Functions | Protected Member Functions | Protected Attributes
qSlicerColorsModule Class Reference

#include <Modules/Loadable/Colors/qSlicerColorsModule.h>

Inheritance diagram for qSlicerColorsModule:
Inheritance graph
Collaboration diagram for qSlicerColorsModule:
Collaboration graph

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 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...
QString helpText () const override
 Return help/acknowledgement text. More...
QIcon icon () const override
bool isHidden () const override
 qSlicerColorsModule (QObject *parent=nullptr)
 qSlicerGetTitleMacro (QTMODULE_TITLE)
void setMRMLScene (vtkMRMLScene *newMRMLScene) override
 ~qSlicerColorsModule () 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...
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)

Protected Member Functions

vtkMRMLAbstractLogiccreateLogic () override
 Create and return the logic associated to this module. More...
qSlicerAbstractModuleRepresentationcreateWidgetRepresentation () override
 Create and return the widget representation associated to this module. More...
void setup () override
 Reimplemented to initialize the color logic. More...
- Protected Member Functions inherited from qSlicerAbstractCoreModule

Protected Attributes

QScopedPointer< qSlicerColorsModulePrivate > 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
- Public Slots inherited from qSlicerAbstractCoreModule
- 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 33 of file qSlicerColorsModule.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file qSlicerColorsModule.h.

Constructor & Destructor Documentation

◆ qSlicerColorsModule()

qSlicerColorsModule::qSlicerColorsModule ( QObject *  parent = nullptr)

◆ ~qSlicerColorsModule()

qSlicerColorsModule::~qSlicerColorsModule ( )

Member Function Documentation

◆ acknowledgementText()

QString qSlicerColorsModule::acknowledgementText ( ) const

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

Reimplemented from qSlicerLoadableModule.

◆ associatedNodeTypes()

QStringList qSlicerColorsModule::associatedNodeTypes ( ) const

Specify editable node types.

Reimplemented from qSlicerAbstractCoreModule.

◆ categories()

QStringList qSlicerColorsModule::categories ( ) const

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

Return the contributors of the module.

Reimplemented from qSlicerAbstractCoreModule.

◆ createLogic()

vtkMRMLAbstractLogic* qSlicerColorsModule::createLogic ( )

Create and return the logic associated to this module.

Implements qSlicerAbstractCoreModule.

◆ createWidgetRepresentation()

qSlicerAbstractModuleRepresentation* qSlicerColorsModule::createWidgetRepresentation ( )

Create and return the widget representation associated to this module.

Implements qSlicerAbstractCoreModule.

◆ helpText()

QString qSlicerColorsModule::helpText ( ) const

Return help/acknowledgement text.

Reimplemented from qSlicerLoadableModule.

◆ icon()

QIcon qSlicerColorsModule::icon ( ) const

Icon of the module. Anytime a graphical representation of the module is needed, the icon is used. It's the icon shown in the module selector as well as in the frequently used module toolbar (if any).

Reimplemented from qSlicerAbstractModule.

◆ isHidden()

bool qSlicerColorsModule::isHidden ( ) const

Returns true if the module should be hidden to the user. By default, interactive modules are visible and non-interactive modules are hidden.

See also
hidden, isWidgetRepresentationCreationEnabled

Reimplemented from qSlicerAbstractCoreModule.

◆ qSlicerGetTitleMacro()

qSlicerColorsModule::qSlicerGetTitleMacro ( QTMODULE_TITLE  )

◆ setMRMLScene()

void qSlicerColorsModule::setMRMLScene ( vtkMRMLScene )

Set the current MRML scene to the module, it is propagated to the logic and representations if any

Reimplemented from qSlicerAbstractCoreModule.

◆ setup()

void qSlicerColorsModule::setup ( )

Reimplemented to initialize the color logic.

Reimplemented from qSlicerLoadableModule.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerColorsModulePrivate> qSlicerColorsModule::d_ptr

Definition at line 72 of file qSlicerColorsModule.h.

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