#include <Base/QTGUI/qSlicerAbstractModuleWidget.h>

Inheritance diagram for qSlicerAbstractModuleWidget:

[legend]

Collaboration diagram for qSlicerAbstractModuleWidget:

Properties
bool	isEntered

Public Member Functions
virtual Q_INVOKABLE void	enter ()

virtual Q_INVOKABLE void	exit ()

bool	isEntered () const

Q_INVOKABLE double	nodeEditable (vtkMRMLNode *node) override

	qSlicerAbstractModuleWidget (QWidget *parent=nullptr)

Q_INVOKABLE bool	setEditedNode (vtkMRMLNode *node, QString role=QString(), QString context=QString()) override
	Node editing. More...

	~qSlicerAbstractModuleWidget () override

Public Member Functions inherited from qSlicerWidget
vtkSlicerApplicationLogic *	appLogic () const

vtkMRMLAbstractLogic *	moduleLogic (const QString &moduleName) const

	qSlicerWidget (QWidget *parent=nullptr, Qt::WindowFlags f=nullptr)

	~qSlicerWidget () override

Public Member Functions inherited from qSlicerObject
vtkMRMLScene *	mrmlScene () const
	Return a pointer on the MRML scene. More...

	qSlicerObject ()

virtual void	setMRMLScene (vtkMRMLScene *)
	Set the current MRML scene to the widget. More...

virtual	~qSlicerObject ()

Public Member Functions inherited from qSlicerAbstractModuleRepresentation
qSlicerAbstractCoreModule *	module () const

QString	moduleName () const
	Set/Get module name. More...

	qSlicerAbstractModuleRepresentation ()

	~qSlicerAbstractModuleRepresentation () override

Protected Member Functions
void	setup () override

Protected Member Functions inherited from qSlicerAbstractModuleRepresentation
vtkMRMLAbstractLogic *	logic () const

Protected Attributes
QScopedPointer< qSlicerAbstractModuleWidgetPrivate >	d_ptr

Protected Attributes inherited from qSlicerWidget
QScopedPointer< qSlicerWidgetPrivate >	d_ptr

Protected Attributes inherited from qSlicerObject
QScopedPointer< qSlicerObjectPrivate >	d_ptr

Protected Attributes inherited from qSlicerAbstractModuleRepresentation
QScopedPointer< qSlicerAbstractModuleRepresentationPrivate >	d_ptr

Additional Inherited Members
Public Types inherited from qSlicerAbstractModuleRepresentation
typedef qSlicerObject	Superclass

Public Slots inherited from qSlicerWidget
void	setMRMLScene (vtkMRMLScene *scene) override

Signals inherited from qSlicerWidget
void	mrmlSceneChanged (vtkMRMLScene *)

Detailed Description

Base class of all the Slicer module widgets. The widget is added in the module panels. Deriving from qSlicerWidget, it inherits the mrmlScene()/setMRMLScene() methods.

Definition at line 39 of file qSlicerAbstractModuleWidget.h.

Property Documentation

◆ isEntered

bool qSlicerAbstractModuleWidget::isEntered

read

Definition at line 43 of file qSlicerAbstractModuleWidget.h.

Constructor & Destructor Documentation

◆ qSlicerAbstractModuleWidget()

qSlicerAbstractModuleWidget::qSlicerAbstractModuleWidget ( QWidget * parent = nullptr )

Constructor

See also: QWidget

◆ ~qSlicerAbstractModuleWidget()

qSlicerAbstractModuleWidget::~qSlicerAbstractModuleWidget ( )

override

Member Function Documentation

◆ enter()

virtual Q_INVOKABLE void qSlicerAbstractModuleWidget::enter ( )

virtual

The enter and exit methods are called when the module panel changes. These give the module a chance to do any setup or shutdown operations as it becomes active and inactive. It is the responsibility of the module's manager to call the methods. enter() and exit() must be called when reimplementing these methods in order to have isEntered() valid.

Reimplemented in qSlicerCLIModuleWidget, qSlicerSegmentationsModuleWidget, qSlicerScriptedLoadableModuleWidget, qSlicerMarkupsModuleWidget, qSlicerModelsModuleWidget, qSlicerSequencesModuleWidget, qSlicerDataModuleWidget, qSlicerCropVolumeModuleWidget, and qSlicerSceneViewsModuleWidget.

◆ exit()

virtual Q_INVOKABLE void qSlicerAbstractModuleWidget::exit ( )

virtual

Reimplemented in qSlicerSegmentationsModuleWidget, qSlicerScriptedLoadableModuleWidget, qSlicerMarkupsModuleWidget, qSlicerModelsModuleWidget, qSlicerSequencesModuleWidget, and qSlicerSceneViewsModuleWidget.

◆ isEntered()

bool qSlicerAbstractModuleWidget::isEntered ( ) const

◆ nodeEditable()

Q_INVOKABLE double qSlicerAbstractModuleWidget::nodeEditable ( vtkMRMLNode * node )

overridevirtual

Returns a confidence value (between 0.0 and 1.0) that defines how much this widget is suitable for editing the provided node. In general value of 0.5 should be used. If the returned value is 0 then it means the node should not be attempted to set as edited node. This node has to be overridden in child classes that want to use a non-default confidence value (for example, they look into the node contents and decide based on that if the node belongs to this module).

Reimplemented from qSlicerAbstractModuleRepresentation.

Reimplemented in qSlicerMarkupsModuleWidget, qSlicerVolumeRenderingModuleWidget, and qSlicerScriptedLoadableModuleWidget.