Slicer  5.1
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Signals | Public Member Functions | Static Public Member Functions | Protected Attributes | Friends
qMRMLMarkupsOptionsWidgetsFactory Class Reference

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

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

Inheritance diagram for qMRMLMarkupsOptionsWidgetsFactory:
Inheritance graph
Collaboration diagram for qMRMLMarkupsOptionsWidgetsFactory:
Collaboration graph


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. More...
Q_INVOKABLE bool registerOptionsWidget (qMRMLMarkupsAbstractOptionsWidget *widget)
Q_INVOKABLE void unregisterAll ()
 Unregister all widgets. More...
Q_INVOKABLE bool unregisterOptionsWidget (const QString &className)
 Unregisters an additional options widget. More...
Q_INVOKABLE bool unregisterOptionsWidget (qMRMLMarkupsAbstractOptionsWidget *widget)
 Unregisters an additional options widget. More...

Static Public Member Functions

static Q_INVOKABLE qMRMLMarkupsOptionsWidgetsFactoryinstance ()

Protected Attributes

QMap< QString, QPointer< qMRMLMarkupsAbstractOptionsWidget > > RegisteredWidgets


class PythonQtWrapper_qMRMLMarkupsOptionsWidgetsFactory
class qMRMLMarkupsOptionsWidgetsFactoryCleanup

Detailed Description

Singleton class managing segment editor effect plugins.

Definition at line 42 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 ( )

Instance getter for the singleton class

Instance object

◆ optionsWidgetRegistered

void qMRMLMarkupsOptionsWidgetsFactory::optionsWidgetRegistered ( )

◆ optionsWidgetUnregistered

void qMRMLMarkupsOptionsWidgetsFactory::optionsWidgetUnregistered ( )

◆ registeredOptionsWidgetsClassNames()

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

Returns the list of additional options widgets registered.

Definition at line 68 of file qMRMLMarkupsOptionsWidgetsFactory.h.

◆ registerOptionsWidget()

Q_INVOKABLE bool qMRMLMarkupsOptionsWidgetsFactory::registerOptionsWidget ( qMRMLMarkupsAbstractOptionsWidget widget)

Registers 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)

Unregisters an additional options widget.

◆ unregisterOptionsWidget() [2/2]

Q_INVOKABLE bool qMRMLMarkupsOptionsWidgetsFactory::unregisterOptionsWidget ( qMRMLMarkupsAbstractOptionsWidget widget)

Unregisters an additional options widget.

Friends And Related Function Documentation

◆ PythonQtWrapper_qMRMLMarkupsOptionsWidgetsFactory

friend class PythonQtWrapper_qMRMLMarkupsOptionsWidgetsFactory

Definition at line 92 of file qMRMLMarkupsOptionsWidgetsFactory.h.

◆ qMRMLMarkupsOptionsWidgetsFactoryCleanup

friend class qMRMLMarkupsOptionsWidgetsFactoryCleanup

Definition at line 91 of file qMRMLMarkupsOptionsWidgetsFactory.h.

Member Data Documentation

◆ RegisteredWidgets

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

Definition at line 80 of file qMRMLMarkupsOptionsWidgetsFactory.h.

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