qSlicerAbstractModuleRepresentation Class Reference

#include <Base/QTCore/qSlicerAbstractModuleRepresentation.h>

Inheritance diagram for qSlicerAbstractModuleRepresentation:

Collaboration diagram for qSlicerAbstractModuleRepresentation:

Public Types
typedef qSlicerObject	Superclass

Public Member Functions
qSlicerAbstractCoreModule *	module () const
QString	moduleName () const
	Set/Get module name. More...
virtual double	nodeEditable (vtkMRMLNode *node)
	qSlicerAbstractModuleRepresentation ()
virtual bool	setEditedNode (vtkMRMLNode *node, QString role=QString(), QString context=QString())
virtual	~qSlicerAbstractModuleRepresentation ()
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 ()

Protected Member Functions
vtkMRMLAbstractLogic *	logic () const
virtual void	setup ()=0

Protected Attributes
QScopedPointer< qSlicerAbstractModuleRepresentationPrivate >	d_ptr
Protected Attributes inherited from qSlicerObject
QScopedPointer< qSlicerObjectPrivate >	d_ptr

Friends
class	qSlicerAbstractCoreModule

Detailed Description

Definition at line 42 of file qSlicerAbstractModuleRepresentation.h.

Member Typedef Documentation

Superclass

typedef qSlicerObject qSlicerAbstractModuleRepresentation::Superclass

Definition at line 46 of file qSlicerAbstractModuleRepresentation.h.

Constructor & Destructor Documentation

qSlicerAbstractModuleRepresentation()

qSlicerAbstractModuleRepresentation::qSlicerAbstractModuleRepresentation

(

)

~qSlicerAbstractModuleRepresentation()

virtual qSlicerAbstractModuleRepresentation::~qSlicerAbstractModuleRepresentation ( )

virtual

Member Function Documentation

logic()

vtkMRMLAbstractLogic* qSlicerAbstractModuleRepresentation::logic ( ) const

protected

Return the logic of the module The logic is available (not null) when setup() is called. So you can't access it in the constructor of your module widget.

module()

qSlicerAbstractCoreModule* qSlicerAbstractModuleRepresentation::module

(

)

const

Returns the module the representation belongs to. The module is set right before setup() is called.

moduleName()

QString qSlicerAbstractModuleRepresentation::moduleName

(

)

const

Set/Get module name.

nodeEditable()

virtual double qSlicerAbstractModuleRepresentation::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 in qSlicerMarkupsModuleWidget, qSlicerAbstractModuleWidget, qSlicerVolumeRenderingModuleWidget, qSlicerScriptedLoadableModuleWidget, and qSlicerCLIModuleWidget.

setEditedNode()

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

virtual

Allows other modules to select input and output nodes in the module's GUI. There may be multiple node selectors in a module widget, you can select between them using the role argument. Context can be specified to make a selection within that node (for example, a markup list node may contain multiple markups; context can be used to select a specific item). Returns true if the selection was successful. This node has to be overridden in child classes that support editing certain node types. Preferably each module that defines a new MRML node class should also make sure there is a module widget that can edit that node. If setEditedNode method is overridden then nodeEditable method can be overridden to specify a non-default confidence value that the module can handle a specific node instance.

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

setup()

virtual void qSlicerAbstractModuleRepresentation::setup ( )

protectedpure virtual

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

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

Friends And Related Function Documentation

qSlicerAbstractCoreModule

friend class qSlicerAbstractCoreModule

friend

Give access to qSlicerAbstractModule to the method qSlicerAbstractModuleRepresentation::setModule

Definition at line 97 of file qSlicerAbstractModuleRepresentation.h.

Member Data Documentation

d_ptr

QScopedPointer<qSlicerAbstractModuleRepresentationPrivate> qSlicerAbstractModuleRepresentation::d_ptr

protected

Definition at line 89 of file qSlicerAbstractModuleRepresentation.h.

---

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

• Base/QTCore/qSlicerAbstractModuleRepresentation.h