qSlicerAbstractModuleWidget Class Reference

#include <Base/QTGUI/qSlicerAbstractModuleWidget.h>

Inheritance diagram for qSlicerAbstractModuleWidget:

Collaboration diagram for qSlicerAbstractModuleWidget:

Properties
bool	isEntered

Public Member Functions
virtual Q_INVOKABLE void	enter ()
virtual Q_INVOKABLE void	exit ()
bool	isEntered () const
virtual Q_INVOKABLE double	nodeEditable (vtkMRMLNode *node)
	qSlicerAbstractModuleWidget (QWidget *parent=0)
virtual Q_INVOKABLE bool	setEditedNode (vtkMRMLNode *node, QString role=QString(), QString context=QString())
	Node editing. More...
virtual	~qSlicerAbstractModuleWidget ()
Public Member Functions inherited from qSlicerWidget
	qSlicerWidget (QWidget *parent=0, Qt::WindowFlags f=0)
virtual	~qSlicerWidget ()
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 ()
virtual	~qSlicerAbstractModuleRepresentation ()

Protected Member Functions
virtual void	setup ()
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
virtual void	setMRMLScene (vtkMRMLScene *scene)
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 = 0

)

Constructor

See also

QWidget

~qSlicerAbstractModuleWidget()

virtual qSlicerAbstractModuleWidget::~qSlicerAbstractModuleWidget ( )

virtual

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, qSlicerDataModuleWidget, qSlicerCropVolumeModuleWidget, and qSlicerSceneViewsModuleWidget.

exit()

virtual Q_INVOKABLE void qSlicerAbstractModuleWidget::exit ( )

virtual

Reimplemented in qSlicerSegmentationsModuleWidget, qSlicerScriptedLoadableModuleWidget, qSlicerMarkupsModuleWidget, and qSlicerSceneViewsModuleWidget.

isEntered()

bool qSlicerAbstractModuleWidget::isEntered

(

)

const

nodeEditable()

virtual Q_INVOKABLE double qSlicerAbstractModuleWidget::nodeEditable ( vtkMRMLNode *  node )

virtual

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, qSlicerScriptedLoadableModuleWidget, and qSlicerCLIModuleWidget.

setEditedNode()

virtual Q_INVOKABLE bool qSlicerAbstractModuleWidget::setEditedNode ( vtkMRMLNode *  node, QString  role = QString(), QString  context = QString()  )

virtual

Node editing.

Reimplemented from qSlicerAbstractModuleRepresentation.

Reimplemented in qSlicerMarkupsModuleWidget, qSlicerSegmentationsModuleWidget, qSlicerVolumeRenderingModuleWidget, qSlicerScriptedLoadableModuleWidget, qSlicerCLIModuleWidget, qSlicerReformatModuleWidget, qSlicerModelsModuleWidget, qSlicerTransformsModuleWidget, qSlicerAnnotationModuleWidget, qSlicerTablesModuleWidget, qSlicerVolumesModuleWidget, qSlicerColorsModuleWidget, qSlicerCamerasModuleWidget, qSlicerSceneViewsModuleWidget, and qSlicerCropVolumeModuleWidget.

setup()

virtual void qSlicerAbstractModuleWidget::setup ( )

protectedvirtual

All initialization code (typically setupUi()) must be done in setup() The module and the logic are accessible.

Implements qSlicerAbstractModuleRepresentation.

Reimplemented in qSlicerMarkupsModuleWidget, qSlicerVolumeRenderingModuleWidget, qSlicerDataModuleWidget, qSlicerSceneViewsModuleWidget, qSlicerSegmentationsModuleWidget, qSlicerCLIModuleWidget, qSlicerModelsModuleWidget, qSlicerMultiVolumeRenderingModuleWidget, qSlicerTransformsModuleWidget, qSlicerScriptedLoadableModuleWidget, qSlicerViewControllersModuleWidget, qSlicerColorsModuleWidget, qSlicerWelcomeModuleWidget, qSlicerTablesModuleWidget, qSlicerSubjectHierarchyModuleWidget, qSlicerReformatModuleWidget, qSlicerEventBrokerModuleWidget, qSlicerCamerasModuleWidget, qSlicerTerminologiesModuleWidget, qSlicerVolumesModuleWidget, qSlicerMeasurementsModuleWidget, and qSlicerCropVolumeModuleWidget.

Member Data Documentation

d_ptr

QScopedPointer<qSlicerAbstractModuleWidgetPrivate> qSlicerAbstractModuleWidget::d_ptr

protected

Definition at line 65 of file qSlicerAbstractModuleWidget.h.

---

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

• Base/QTGUI/qSlicerAbstractModuleWidget.h