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 Slots | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
qSlicerMarkupsModule Class Reference

#include <Modules/Loadable/Markups/qSlicerMarkupsModule.h>

Inheritance diagram for qSlicerMarkupsModule:
Inheritance graph
Collaboration diagram for qSlicerMarkupsModule:
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


bool autoShowToolBar
bool toolBarVisible
 Visibility of the markups toolbar. More...
- 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

void setAutoShowToolBar (bool autoShow)
 Enables automatic showing markups toolbar when a new markups node is loaded. More...
void setToolBarVisible (bool visible)
- Public Slots inherited from qSlicerAbstractCoreModule

Public Member Functions

QString acknowledgementText () const override
 Return acknowledgements. More...
QStringList associatedNodeTypes () const override
 Specify editable node types. More...
Q_INVOKABLE bool autoShowToolBar ()
QStringList categories () const override
 Return the categories for the module. More...
QStringList contributors () const override
 Return the authors of the module. More...
QString helpText () const override
 Help to use the module. More...
QIcon icon () const override
 Return a custom icon for the module. More...
Q_INVOKABLE bool isToolBarVisible ()
 qSlicerGetTitleMacro (QTMODULE_TITLE)
 qSlicerMarkupsModule (QObject *parent=nullptr)
void setMRMLScene (vtkMRMLScene *scene) override
Q_INVOKABLE qMRMLMarkupsToolBartoolBar ()
 ~qSlicerMarkupsModule () 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)
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)

Static Public Member Functions

static void readDefaultMarkupsDisplaySettings (vtkMRMLMarkupsDisplayNode *markupsDisplayNode)
static Q_INVOKABLE bool showMarkups (vtkMRMLMarkupsNode *markupsNode)
static void writeDefaultMarkupsDisplaySettings (vtkMRMLMarkupsDisplayNode *markupsDisplayNode)
- 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...

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
 Initialize the module. Register the volumes reader/writer. More...
- Protected Member Functions inherited from qSlicerAbstractCoreModule

Protected Attributes

QScopedPointer< qSlicerMarkupsModulePrivate > 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

Detailed Description

Definition at line 39 of file qSlicerMarkupsModule.h.

Member Typedef Documentation

◆ Superclass

Definition at line 52 of file qSlicerMarkupsModule.h.

Property Documentation

◆ autoShowToolBar

bool qSlicerMarkupsModule::autoShowToolBar

Definition at line 48 of file qSlicerMarkupsModule.h.

◆ toolBarVisible

bool qSlicerMarkupsModule::toolBarVisible

Visibility of the markups toolbar.

Definition at line 47 of file qSlicerMarkupsModule.h.

Constructor & Destructor Documentation

◆ qSlicerMarkupsModule()

qSlicerMarkupsModule::qSlicerMarkupsModule ( QObject *  parent = nullptr)

◆ ~qSlicerMarkupsModule()

qSlicerMarkupsModule::~qSlicerMarkupsModule ( )

Member Function Documentation

◆ acknowledgementText()

QString qSlicerMarkupsModule::acknowledgementText ( ) const

Return acknowledgements.

Reimplemented from qSlicerLoadableModule.

◆ associatedNodeTypes()

QStringList qSlicerMarkupsModule::associatedNodeTypes ( ) const

Specify editable node types.

Reimplemented from qSlicerAbstractCoreModule.

◆ autoShowToolBar()

Q_INVOKABLE bool qSlicerMarkupsModule::autoShowToolBar ( )

Indicates that markups toolbar should be showed when a new sequence is loaded. Adding a new markups node to the scene does not show the toolbar automatically but the importer must call showMarkups method.

◆ categories()

QStringList qSlicerMarkupsModule::categories ( ) const

Return the categories for the module.

Reimplemented from qSlicerAbstractCoreModule.

◆ contributors()

QStringList qSlicerMarkupsModule::contributors ( ) const

Return the authors of the module.

Reimplemented from qSlicerAbstractCoreModule.

◆ createLogic()

vtkMRMLAbstractLogic* qSlicerMarkupsModule::createLogic ( )

Create and return the logic associated to this module.

Implements qSlicerAbstractCoreModule.

◆ createWidgetRepresentation()

qSlicerAbstractModuleRepresentation* qSlicerMarkupsModule::createWidgetRepresentation ( )

Create and return the widget representation associated to this module.

Implements qSlicerAbstractCoreModule.

◆ helpText()

QString qSlicerMarkupsModule::helpText ( ) const

Help to use the module.

Reimplemented from qSlicerLoadableModule.

◆ icon()

QIcon qSlicerMarkupsModule::icon ( ) const

Return a custom icon for the module.

Reimplemented from qSlicerAbstractModule.

◆ isToolBarVisible()

Q_INVOKABLE bool qSlicerMarkupsModule::isToolBarVisible ( )

◆ qSlicerGetTitleMacro()

qSlicerMarkupsModule::qSlicerGetTitleMacro ( QTMODULE_TITLE  )

◆ readDefaultMarkupsDisplaySettings()

static void qSlicerMarkupsModule::readDefaultMarkupsDisplaySettings ( vtkMRMLMarkupsDisplayNode markupsDisplayNode)

◆ setAutoShowToolBar

void qSlicerMarkupsModule::setAutoShowToolBar ( bool  autoShow)

Enables automatic showing markups toolbar when a new markups node is loaded.

◆ setMRMLScene()

void qSlicerMarkupsModule::setMRMLScene ( vtkMRMLScene )

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

Reimplemented from qSlicerAbstractCoreModule.

◆ setToolBarVisible

void qSlicerMarkupsModule::setToolBarVisible ( bool  visible)

◆ setup()

void qSlicerMarkupsModule::setup ( )

Initialize the module. Register the volumes reader/writer.

Reimplemented from qSlicerLoadableModule.

◆ showMarkups()

static Q_INVOKABLE bool qSlicerMarkupsModule::showMarkups ( vtkMRMLMarkupsNode markupsNode)

Utility function for showing the markupsNode in the application user interface (toolbar) if autoShowToolBar is enabled.

◆ toolBar()

Q_INVOKABLE qMRMLMarkupsToolBar* qSlicerMarkupsModule::toolBar ( )

◆ writeDefaultMarkupsDisplaySettings()

static void qSlicerMarkupsModule::writeDefaultMarkupsDisplaySettings ( vtkMRMLMarkupsDisplayNode markupsDisplayNode)

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerMarkupsModulePrivate> qSlicerMarkupsModule::d_ptr

Definition at line 110 of file qSlicerMarkupsModule.h.

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