Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
Loading...
Searching...
No Matches
qMRMLMarkupsOptionsWidgetsFactory Class Reference

Singleton class managing segment editor effect plugins. More...

#include <Modules/Loadable/Markups/Widgets/qMRMLMarkupsOptionsWidgetsFactory.h>

Inheritance diagram for qMRMLMarkupsOptionsWidgetsFactory:
Collaboration diagram for qMRMLMarkupsOptionsWidgetsFactory:

Signals

void optionsWidgetRegistered ()
 
void optionsWidgetUnregistered ()
 

Public Member Functions

Q_INVOKABLE qMRMLMarkupsAbstractOptionsWidgetcreateWidget (const QString &widgetClassName)
 
Q_INVOKABLE const QList< QString > registeredOptionsWidgetsClassNames () const
 Returns the list of additional options widgets registered.
 
Q_INVOKABLE bool registerOptionsWidget (qMRMLMarkupsAbstractOptionsWidget *widget)
 
Q_INVOKABLE void unregisterAll ()
 Unregister all widgets.
 
Q_INVOKABLE bool unregisterOptionsWidget (const QString &className)
 Unregister an additional options widget.
 
Q_INVOKABLE bool unregisterOptionsWidget (qMRMLMarkupsAbstractOptionsWidget *widget)
 Unregister an additional options widget.
 

Static Public Member Functions

static Q_INVOKABLE qMRMLMarkupsOptionsWidgetsFactoryinstance ()
 

Protected Attributes

QMap< QString, QPointer< qMRMLMarkupsAbstractOptionsWidget > > RegisteredWidgets
 

Friends

class PythonQtWrapper_qMRMLMarkupsOptionsWidgetsFactory
 
class qMRMLMarkupsOptionsWidgetsFactoryCleanup
 

Detailed Description

Singleton class managing segment editor effect plugins.

Definition at line 41 of file qMRMLMarkupsOptionsWidgetsFactory.h.

Member Function Documentation

◆ createWidget()

Q_INVOKABLE qMRMLMarkupsAbstractOptionsWidget * qMRMLMarkupsOptionsWidgetsFactory::createWidget ( const QString & widgetClassName)

Creates a markups option widget of a given class name. The markups option widget must have been registered previously (nullptr will return if not).

◆ instance()

static Q_INVOKABLE qMRMLMarkupsOptionsWidgetsFactory * qMRMLMarkupsOptionsWidgetsFactory::instance ( )
static

Instance getter for the singleton class

Returns
Instance object

◆ optionsWidgetRegistered

void qMRMLMarkupsOptionsWidgetsFactory::optionsWidgetRegistered ( )
signal

◆ optionsWidgetUnregistered

void qMRMLMarkupsOptionsWidgetsFactory::optionsWidgetUnregistered ( )
signal

◆ registeredOptionsWidgetsClassNames()

Q_INVOKABLE const QList< QString > qMRMLMarkupsOptionsWidgetsFactory::registeredOptionsWidgetsClassNames ( ) const
inline

Returns the list of additional options widgets registered.

Definition at line 67 of file qMRMLMarkupsOptionsWidgetsFactory.h.

◆ registerOptionsWidget()

Q_INVOKABLE bool qMRMLMarkupsOptionsWidgetsFactory::registerOptionsWidget ( qMRMLMarkupsAbstractOptionsWidget * widget)

Register an additional options widget. This factory object takes ownership of the widget (even if it fails to register it due to for example a widget already existing for that markup type), therefore the caller must NOT delete the widget.

◆ unregisterAll()

Q_INVOKABLE void qMRMLMarkupsOptionsWidgetsFactory::unregisterAll ( )

Unregister all widgets.

◆ unregisterOptionsWidget() [1/2]

Q_INVOKABLE bool qMRMLMarkupsOptionsWidgetsFactory::unregisterOptionsWidget ( const QString & className)

Unregister an additional options widget.

◆ unregisterOptionsWidget() [2/2]

Q_INVOKABLE bool qMRMLMarkupsOptionsWidgetsFactory::unregisterOptionsWidget ( qMRMLMarkupsAbstractOptionsWidget * widget)

Unregister an additional options widget.

Friends And Related Symbol Documentation

◆ PythonQtWrapper_qMRMLMarkupsOptionsWidgetsFactory

friend class PythonQtWrapper_qMRMLMarkupsOptionsWidgetsFactory
friend

Definition at line 90 of file qMRMLMarkupsOptionsWidgetsFactory.h.

◆ qMRMLMarkupsOptionsWidgetsFactoryCleanup

friend class qMRMLMarkupsOptionsWidgetsFactoryCleanup
friend

Definition at line 89 of file qMRMLMarkupsOptionsWidgetsFactory.h.

Member Data Documentation

◆ RegisteredWidgets

QMap<QString, QPointer<qMRMLMarkupsAbstractOptionsWidget> > qMRMLMarkupsOptionsWidgetsFactory::RegisteredWidgets
protected

Definition at line 78 of file qMRMLMarkupsOptionsWidgetsFactory.h.


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