qSlicerScriptedLoadableModuleWidget Class Reference

#include <Base/QTGUI/qSlicerScriptedLoadableModuleWidget.h>

Inheritance diagram for qSlicerScriptedLoadableModuleWidget:

Collaboration diagram for qSlicerScriptedLoadableModuleWidget:

Public Types
typedef qSlicerScriptedLoadableModuleWidgetPrivate	Pimpl
typedef qSlicerAbstractModuleWidget	Superclass
Public Types inherited from qSlicerAbstractModuleRepresentation
typedef qSlicerObject	Superclass

Properties
QString	moduleName
Properties inherited from qSlicerAbstractModuleWidget
bool	isEntered

Public Member Functions
void	enter () override
void	exit () override
double	nodeEditable (vtkMRMLNode *node) override
QString	pythonSource () const
	qSlicerScriptedLoadableModuleWidget (QWidget *parentWidget=nullptr)
Q_INVOKABLE PyObject *	self () const
	Convenience method allowing to retrieve the associated scripted instance. More...
bool	setEditedNode (vtkMRMLNode *node, QString role=QString(), QString context=QString()) override
	Node editing. More...
bool	setPythonSource (const QString &newPythonSource, const QString &className=QLatin1String(""))
	~qSlicerScriptedLoadableModuleWidget () override
Public Member Functions inherited from qSlicerAbstractModuleWidget
bool	isEntered () const
	qSlicerAbstractModuleWidget (QWidget *parent=nullptr)
	~qSlicerAbstractModuleWidget () override
Public Member Functions inherited from qSlicerWidget
vtkSlicerApplicationLogic *	appLogic () const
vtkMRMLAbstractLogic *	moduleLogic (const QString &moduleName) const
	qSlicerWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
	~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< qSlicerScriptedLoadableModuleWidgetPrivate >	d_ptr
Protected Attributes inherited from qSlicerAbstractModuleWidget
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 Slots inherited from qSlicerWidget
void	setMRMLScene (vtkMRMLScene *scene) override
Signals inherited from qSlicerWidget
void	mrmlSceneChanged (vtkMRMLScene *)

Detailed Description

Definition at line 36 of file qSlicerScriptedLoadableModuleWidget.h.

Member Typedef Documentation

Pimpl

typedef qSlicerScriptedLoadableModuleWidgetPrivate qSlicerScriptedLoadableModuleWidget::Pimpl

Definition at line 43 of file qSlicerScriptedLoadableModuleWidget.h.

Superclass

typedef qSlicerAbstractModuleWidget qSlicerScriptedLoadableModuleWidget::Superclass

Definition at line 42 of file qSlicerScriptedLoadableModuleWidget.h.

Property Documentation

moduleName

QString qSlicerScriptedLoadableModuleWidget::moduleName

read

Definition at line 40 of file qSlicerScriptedLoadableModuleWidget.h.

Constructor & Destructor Documentation

qSlicerScriptedLoadableModuleWidget()

qSlicerScriptedLoadableModuleWidget::qSlicerScriptedLoadableModuleWidget

(

QWidget *

parentWidget = nullptr

)

~qSlicerScriptedLoadableModuleWidget()

qSlicerScriptedLoadableModuleWidget::~qSlicerScriptedLoadableModuleWidget ( )

override

Member Function Documentation

enter()

void qSlicerScriptedLoadableModuleWidget::enter ( )

overridevirtual

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 from qSlicerAbstractModuleWidget.

exit()

void qSlicerScriptedLoadableModuleWidget::exit ( )

overridevirtual

Reimplemented from qSlicerAbstractModuleWidget.

nodeEditable()

double qSlicerScriptedLoadableModuleWidget::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 qSlicerAbstractModuleWidget.

pythonSource()

QString qSlicerScriptedLoadableModuleWidget::pythonSource

(

)

const

self()

Q_INVOKABLE PyObject* qSlicerScriptedLoadableModuleWidget::self

(

)

const

Convenience method allowing to retrieve the associated scripted instance.

setEditedNode()

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

overridevirtual

Node editing.

Reimplemented from qSlicerAbstractModuleWidget.

setPythonSource()

bool qSlicerScriptedLoadableModuleWidget::setPythonSource	(	const QString &	newPythonSource,
		const QString &	className = QLatin1String("")
	)

setup()

void qSlicerScriptedLoadableModuleWidget::setup ( )

overrideprotectedvirtual

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

Reimplemented from qSlicerAbstractModuleWidget.

Member Data Documentation

d_ptr

QScopedPointer<qSlicerScriptedLoadableModuleWidgetPrivate> qSlicerScriptedLoadableModuleWidget::d_ptr

protected

Definition at line 63 of file qSlicerScriptedLoadableModuleWidget.h.

---

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

• Base/QTGUI/qSlicerScriptedLoadableModuleWidget.h