Slicer  4.13
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
qSlicerSequencesModule Class Reference

#include <Modules/Loadable/Sequences/qSlicerSequencesModule.h>

Inheritance diagram for qSlicerSequencesModule:
Inheritance graph
[legend]
Collaboration diagram for qSlicerSequencesModule:
Collaboration graph
[legend]

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
 

Properties

bool autoShowToolBar
 
bool toolBarVisible
 Visibility of the sequence browser 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 onNodeAddedEvent (vtkObject *, vtkObject *)
 
void onNodeRemovedEvent (vtkObject *, vtkObject *)
 
void setAutoShowToolBar (bool autoShow)
 Enables automatic showing sequence browser toolbar when a new sequence is loaded. More...
 
void setMRMLScene (vtkMRMLScene *) override
 
void setToolBarActiveBrowserNode (vtkMRMLSequenceBrowserNode *browserNode)
 
void setToolBarVisible (bool visible)
 
void updateAllVirtualOutputNodes ()
 
- 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...
 
Q_INVOKABLE bool autoShowToolBar ()
 
QStringList categories () const override
 
QStringList contributors () const override
 Return the contributors of the module. More...
 
QStringList dependencies () const override
 
QString helpText () const override
 Return help/acknowledgement text. More...
 
QIcon icon () const override
 
Q_INVOKABLE bool isToolBarVisible ()
 
 qSlicerGetTitleMacro (QTMODULE_TITLE)
 
 qSlicerSequencesModule (QObject *parent=0)
 
Q_INVOKABLE qMRMLSequenceBrowserToolBartoolBar ()
 
 ~qSlicerSequencesModule () 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...
 
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 Q_INVOKABLE bool showSequenceBrowser (vtkMRMLSequenceBrowserNode *browserNode)
 
- 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< qSlicerSequencesModulePrivate > 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 40 of file qSlicerSequencesModule.h.

Member Typedef Documentation

◆ Superclass

Definition at line 57 of file qSlicerSequencesModule.h.

Property Documentation

◆ autoShowToolBar

bool qSlicerSequencesModule::autoShowToolBar
readwrite

Definition at line 53 of file qSlicerSequencesModule.h.

◆ toolBarVisible

bool qSlicerSequencesModule::toolBarVisible
readwrite

Visibility of the sequence browser toolbar.

Definition at line 52 of file qSlicerSequencesModule.h.

Constructor & Destructor Documentation

◆ qSlicerSequencesModule()

qSlicerSequencesModule::qSlicerSequencesModule ( QObject *  parent = 0)
explicit

◆ ~qSlicerSequencesModule()

qSlicerSequencesModule::~qSlicerSequencesModule ( )
override

Member Function Documentation

◆ acknowledgementText()

QString qSlicerSequencesModule::acknowledgementText ( ) const
overridevirtual

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

Reimplemented from qSlicerLoadableModule.

◆ associatedNodeTypes()

QStringList qSlicerSequencesModule::associatedNodeTypes ( ) const
overridevirtual

Specify editable node types.

Reimplemented from qSlicerAbstractCoreModule.

◆ autoShowToolBar()

Q_INVOKABLE bool qSlicerSequencesModule::autoShowToolBar ( )

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

◆ categories()

QStringList qSlicerSequencesModule::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 qSlicerSequencesModule::contributors ( ) const
overridevirtual

Return the contributors of the module.

Reimplemented from qSlicerAbstractCoreModule.

◆ createLogic()

vtkMRMLAbstractLogic* qSlicerSequencesModule::createLogic ( )
overrideprotectedvirtual

Create and return the logic associated to this module.

Implements qSlicerAbstractCoreModule.

◆ createWidgetRepresentation()

qSlicerAbstractModuleRepresentation* qSlicerSequencesModule::createWidgetRepresentation ( )
overrideprotectedvirtual

Create and return the widget representation associated to this module.

Implements qSlicerAbstractCoreModule.

◆ dependencies()

QStringList qSlicerSequencesModule::dependencies ( ) const
overridevirtual

Reimplemented from qSlicerAbstractCoreModule.

◆ helpText()

QString qSlicerSequencesModule::helpText ( ) const
overridevirtual

Return help/acknowledgement text.

Reimplemented from qSlicerLoadableModule.

◆ icon()

QIcon qSlicerSequencesModule::icon ( ) const
overridevirtual

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.

◆ isToolBarVisible()

Q_INVOKABLE bool qSlicerSequencesModule::isToolBarVisible ( )

◆ onNodeAddedEvent

void qSlicerSequencesModule::onNodeAddedEvent ( vtkObject *  ,
vtkObject *   
)
slot

◆ onNodeRemovedEvent

void qSlicerSequencesModule::onNodeRemovedEvent ( vtkObject *  ,
vtkObject *   
)
slot

◆ qSlicerGetTitleMacro()

qSlicerSequencesModule::qSlicerGetTitleMacro ( QTMODULE_TITLE  )

◆ setAutoShowToolBar

void qSlicerSequencesModule::setAutoShowToolBar ( bool  autoShow)
slot

Enables automatic showing sequence browser toolbar when a new sequence is loaded.

◆ setMRMLScene

void qSlicerSequencesModule::setMRMLScene ( vtkMRMLScene )
overrideslot

◆ setToolBarActiveBrowserNode

void qSlicerSequencesModule::setToolBarActiveBrowserNode ( vtkMRMLSequenceBrowserNode browserNode)
slot

◆ setToolBarVisible

void qSlicerSequencesModule::setToolBarVisible ( bool  visible)
slot

◆ setup()

void qSlicerSequencesModule::setup ( )
overrideprotectedvirtual

Initialize the module. Register the volumes reader/writer.

Reimplemented from qSlicerLoadableModule.

◆ showSequenceBrowser()

static Q_INVOKABLE bool qSlicerSequencesModule::showSequenceBrowser ( vtkMRMLSequenceBrowserNode browserNode)
static

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

◆ toolBar()

Q_INVOKABLE qMRMLSequenceBrowserToolBar* qSlicerSequencesModule::toolBar ( )

◆ updateAllVirtualOutputNodes

void qSlicerSequencesModule::updateAllVirtualOutputNodes ( )
slot

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerSequencesModulePrivate> qSlicerSequencesModule::d_ptr
protected

Definition at line 109 of file qSlicerSequencesModule.h.


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