Slicer  4.10
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Slots | Public Member Functions | Protected Member Functions | Protected Attributes
qSlicerCLIModuleWidget Class Reference

#include <Base/QTCLI/qSlicerCLIModuleWidget.h>

Inheritance diagram for qSlicerCLIModuleWidget:
Inheritance graph
[legend]
Collaboration diagram for qSlicerCLIModuleWidget:
Collaboration graph
[legend]

Public Types

typedef qSlicerAbstractModuleWidget Superclass
 
- Public Types inherited from qSlicerAbstractModuleRepresentation
typedef qSlicerObject Superclass
 

Public Slots

void apply (bool wait=false)
 
void cancel ()
 
void reset ()
 
void setAutoRun (bool enable)
 
void setAutoRunCancelsRunningProcess (bool enable)
 
void setAutoRunOnOtherInputEvents (bool enable)
 
void setAutoRunWhenInputModified (bool enable)
 
void setAutoRunWhenParameterChanged (bool enable)
 
void setCurrentCommandLineModuleNode (vtkMRMLNode *commandLineModuleNode)
 Set the current commandLineModuleNode. More...
 
- Public Slots inherited from qSlicerWidget
virtual void setMRMLScene (vtkMRMLScene *scene)
 

Public Member Functions

Q_INVOKABLE vtkMRMLCommandLineModuleNodecurrentCommandLineModuleNode () const
 Get the current commandLineModuleNode. More...
 
virtual double nodeEditable (vtkMRMLNode *node)
 
 qSlicerCLIModuleWidget (QWidget *parent=0)
 
virtual bool setEditedNode (vtkMRMLNode *node, QString role=QString(), QString context=QString())
 Node editing. More...
 
virtual ~qSlicerCLIModuleWidget ()
 
- Public Member Functions inherited from qSlicerAbstractModuleWidget
virtual Q_INVOKABLE void exit ()
 
bool isEntered () const
 
 qSlicerAbstractModuleWidget (QWidget *parent=0)
 
virtual ~qSlicerAbstractModuleWidget ()
 
- Public Member Functions inherited from qSlicerWidget
 qSlicerWidget (QWidget *parent=0, Qt::WindowFlags f=0)
 
virtual ~qSlicerWidget ()
 
- Public Member Functions inherited from qSlicerObject
vtkMRMLScenemrmlScene () 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
qSlicerAbstractCoreModulemodule () const
 
QString moduleName () const
 Set/Get module name. More...
 
 qSlicerAbstractModuleRepresentation ()
 
virtual ~qSlicerAbstractModuleRepresentation ()
 

Protected Member Functions

void cancel (vtkMRMLCommandLineModuleNode *node)
 Abort the execution of the module associated with node. More...
 
virtual void enter ()
 Set up the GUI from mrml when entering. More...
 
void run (vtkMRMLCommandLineModuleNode *parameterNode, bool waitForCompletion=false)
 
virtual void setup ()
 
- Protected Member Functions inherited from qSlicerAbstractModuleRepresentation
vtkMRMLAbstractLogiclogic () const
 

Protected Attributes

QScopedPointer< qSlicerCLIModuleWidgetPrivate > 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

- Properties inherited from qSlicerAbstractModuleWidget
bool isEntered
 
- Signals inherited from qSlicerWidget
void mrmlSceneChanged (vtkMRMLScene *)
 

Detailed Description

Definition at line 38 of file qSlicerCLIModuleWidget.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file qSlicerCLIModuleWidget.h.

Constructor & Destructor Documentation

◆ qSlicerCLIModuleWidget()

qSlicerCLIModuleWidget::qSlicerCLIModuleWidget ( QWidget *  parent = 0)

◆ ~qSlicerCLIModuleWidget()

virtual qSlicerCLIModuleWidget::~qSlicerCLIModuleWidget ( )
virtual

Member Function Documentation

◆ apply

void qSlicerCLIModuleWidget::apply ( bool  wait = false)
slot

◆ cancel [1/2]

void qSlicerCLIModuleWidget::cancel ( )
slot

◆ cancel() [2/2]

void qSlicerCLIModuleWidget::cancel ( vtkMRMLCommandLineModuleNode node)
protected

Abort the execution of the module associated with node.

◆ currentCommandLineModuleNode()

Q_INVOKABLE vtkMRMLCommandLineModuleNode* qSlicerCLIModuleWidget::currentCommandLineModuleNode ( ) const

Get the current commandLineModuleNode.

◆ enter()

virtual void qSlicerCLIModuleWidget::enter ( )
protectedvirtual

Set up the GUI from mrml when entering.

Reimplemented from qSlicerAbstractModuleWidget.

◆ nodeEditable()

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

◆ reset

void qSlicerCLIModuleWidget::reset ( )
slot

◆ run()

void qSlicerCLIModuleWidget::run ( vtkMRMLCommandLineModuleNode parameterNode,
bool  waitForCompletion = false 
)
protected

Run a command line module given parameterNode If waitForCompletion is True, the call will return only upon completion of the module execution.

◆ setAutoRun

void qSlicerCLIModuleWidget::setAutoRun ( bool  enable)
slot

◆ setAutoRunCancelsRunningProcess

void qSlicerCLIModuleWidget::setAutoRunCancelsRunningProcess ( bool  enable)
slot

◆ setAutoRunOnOtherInputEvents

void qSlicerCLIModuleWidget::setAutoRunOnOtherInputEvents ( bool  enable)
slot

◆ setAutoRunWhenInputModified

void qSlicerCLIModuleWidget::setAutoRunWhenInputModified ( bool  enable)
slot

◆ setAutoRunWhenParameterChanged

void qSlicerCLIModuleWidget::setAutoRunWhenParameterChanged ( bool  enable)
slot

◆ setCurrentCommandLineModuleNode

void qSlicerCLIModuleWidget::setCurrentCommandLineModuleNode ( vtkMRMLNode commandLineModuleNode)
slot

Set the current commandLineModuleNode.

◆ setEditedNode()

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

Node editing.

Reimplemented from qSlicerAbstractModuleWidget.

◆ setup()

virtual void qSlicerCLIModuleWidget::setup ( )
protectedvirtual

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<qSlicerCLIModuleWidgetPrivate> qSlicerCLIModuleWidget::d_ptr
protected

Definition at line 83 of file qSlicerCLIModuleWidget.h.


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