vtkCommandLineModuleGUI Class Reference

#include <vtkCommandLineModuleGUI.h>

Inheritance diagram for vtkCommandLineModuleGUI:

List of all members.

Public Member Functions
virtual void	AddGUIObservers ()
virtual void	BuildGUI (vtkKWFrame *f, double *bgColor)
virtual void	BuildGUI (vtkKWFrame *f)
virtual void	BuildGUI ()
virtual void	CreateModuleEventBindings ()
virtual void	Enter (vtkMRMLNode *node)
virtual void	Enter ()
virtual void	Exit ()
virtual unsigned short	GetIndex () const
const ModuleDescription &	GetModuleDescription () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	ProcessGUIEvents (vtkObject *caller, unsigned long event, void *callData)
virtual void	ProcessLogicEvents (vtkObject *vtkNotUsed(caller), unsigned long vtkNotUsed(event), void *vtkNotUsed(callData))
virtual void	ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData)
virtual void	ReleaseModuleEventBindings ()
virtual void	RemoveGUIObservers ()
virtual void	RemoveLogicObservers ()
virtual void	RemoveMRMLNodeObservers ()
virtual void	SetCommandLineModuleNode (vtkMRMLCommandLineModuleNode *)
void	SetInMRMLCallbackFlag (int flag)
void	SetModuleDescription (const ModuleDescription &description)
virtual void	TearDownGUI ()
	vtkGetMacro (InMRMLCallbackFlag, int)
	vtkGetObjectMacro (CommandLineModuleNode, vtkMRMLCommandLineModuleNode)
	vtkGetObjectMacro (Logic, vtkCommandLineModuleLogic)
	vtkSetObjectMacro (Logic, vtkCommandLineModuleLogic)
	vtkTypeMacro (vtkCommandLineModuleGUI, vtkSlicerModuleGUI)
Static Public Member Functions
static vtkCommandLineModuleGUI *	New ()
	The usual vtk class functions.
Static Protected Member Functions
static void	NewNodeCallback (vtkObject *__caller, unsigned long eid, void *__clientData, void *callData)
Protected Attributes
int	InMRMLCallbackFlag
vtkCallbackCommand *	NewNodeCallbackCommand
Private Member Functions
void	operator= (const vtkCommandLineModuleGUI &)
	Not implemented.
void	UpdateGUI ()
void	UpdateMRML ()
	vtkCommandLineModuleGUI (const vtkCommandLineModuleGUI &)
	vtkCommandLineModuleGUI ()
virtual	~vtkCommandLineModuleGUI ()
Private Attributes
vtkMRMLCommandLineModuleNode *	CommandLineModuleNode
bool	CreatingNewNode
ModuleWidgetMap *	InternalWidgetMap
bool	InUpdateGUI
bool	InUpdateMRML
vtkCommandLineModuleLogic *	Logic
ModuleDescription	ModuleDescriptionObject

---

Constructor & Destructor Documentation

vtkCommandLineModuleGUI::vtkCommandLineModuleGUI

(

)

[private]

References CommandLineModuleNode, CreatingNewNode, InMRMLCallbackFlag, InternalWidgetMap, InUpdateGUI, InUpdateMRML, Logic, New(), NewNodeCallback(), and NewNodeCallbackCommand.

vtkCommandLineModuleGUI::~vtkCommandLineModuleGUI

(

)

[private, virtual]

References CommandLineModuleNode, InternalWidgetMap, NewNodeCallbackCommand, RemoveGUIObservers(), RemoveLogicObservers(), RemoveMRMLNodeObservers(), SetCommandLineModuleNode(), vtkSlicerComponentGUI::SetLogic(), and vtkSetAndObserveMRMLNodeMacro.

vtkCommandLineModuleGUI::vtkCommandLineModuleGUI

(

const vtkCommandLineModuleGUI &

)

[private]

---

Member Function Documentation

void vtkCommandLineModuleGUI::AddGUIObservers

(

void

)

[virtual]

Add/Remove observers on a GUI.

Reimplemented from vtkSlicerComponentGUI.

References vtkSlicerComponentGUI::GUICallbackCommand, InternalWidgetMap, NewNodeCallbackCommand, vtkSlicerNodeSelectorWidget::NewNodeEvent, and vtkSlicerNodeSelectorWidget::NodeSelectedEvent.

Referenced by Enter().

virtual void vtkCommandLineModuleGUI::BuildGUI	(	vtkKWFrame *	f,
		double *	bgColor
	)			[inline, virtual]

virtual void vtkCommandLineModuleGUI::BuildGUI

(

vtkKWFrame *

f

)

[inline, virtual]

void vtkCommandLineModuleGUI::BuildGUI

(

void

)

[virtual]

Specifies all widgets for this GUI Define function in subclasses.

Reimplemented from vtkSlicerComponentGUI.

References vtkSlicerNodeSelectorWidget::AddNodeClass(), NodeSelector::app, vtkSlicerModuleGUI::BuildHelpAndAboutFrame(), vtkSlicerModuleCollapsibleFrame::CollapseFrame(), vtkSlicerModuleCollapsibleFrame::ExpandFrame(), ModuleDescription::GetAcknowledgements(), ModuleDescription::GetContributor(), ModuleDescription::GetDescription(), ModuleDescription::GetDocumentationURL(), vtkSlicerModuleGUI::GetLogo(), ModuleDescription::GetParameterGroups(), ModuleDescription::GetTitle(), slicerget::id, InternalWidgetMap, Logic, max, min, ModuleDescriptionObject, New(), vtkSlicerModuleCollapsibleFrame::SetLabelText(), vtkSlicerNodeSelectorWidget::SetMRMLScene(), vtkSlicerNodeSelectorWidget::SetNodeClass(), vtkSlicerNodeSelectorWidget::SetSelected(), splitFilenames(), vtkSlicerModuleGUI::UIPanel, and vtkSlicerNodeSelectorWidget::UpdateMenu().

Referenced by Enter().

void vtkCommandLineModuleGUI::CreateModuleEventBindings

(

void

)

[virtual]

Reimplemented from vtkSlicerModuleGUI.

Referenced by Enter().

virtual void vtkCommandLineModuleGUI::Enter

(

vtkMRMLNode *

node

)

[inline, virtual]

void vtkCommandLineModuleGUI::Enter

(

void

)

[virtual]

functions that define and undefine module-specific behaviors.

• a module can define either Enter() or Enter(node), where the latter version selects the node on entry. See vtkSlicerApplicationGUI::SelectModuleForNode for the (currently hard-coded) mapping of node types to module names.

Reimplemented from vtkSlicerComponentGUI.

References AddGUIObservers(), BuildGUI(), vtkSlicerModuleGUI::Built, CreateModuleEventBindings(), Logic, and vtkCommandLineModuleLogic::SetTemporaryDirectory().

Referenced by vtkSlicerDiffusionTestingWidget::RunDWI().

void vtkCommandLineModuleGUI::Exit

(

void

)

[virtual]

Reimplemented from vtkSlicerComponentGUI.

References ReleaseModuleEventBindings().

Referenced by TearDownGUI().

virtual unsigned short vtkCommandLineModuleGUI::GetIndex

(

)

const [inline, virtual]

Get/Set the index of the module. The index is used for sorting the modules within a menu. Modules are sorted first by index, then alphabetical

Reimplemented from vtkSlicerModuleGUI.

const ModuleDescription& vtkCommandLineModuleGUI::GetModuleDescription

(

)

const [inline]

Referenced by PrintSelf().

vtkCommandLineModuleGUI * vtkCommandLineModuleGUI::New

(

)

[static]

The usual vtk class functions.

Reimplemented from vtkSlicerModuleGUI.

References autoSlicerTracto2regions::ret.

Referenced by BuildGUI(), SetModuleDescription(), Slicer3_main(), UpdateGUI(), and vtkCommandLineModuleGUI().

void vtkCommandLineModuleGUI::NewNodeCallback	(	vtkObject *	__caller,
		unsigned long	eid,
		void *	__clientData,
		void *	callData
	)			[static, protected]

Referenced by vtkCommandLineModuleGUI().

void vtkCommandLineModuleGUI::operator=

(

const vtkCommandLineModuleGUI &

)

[private]

Not implemented.

Reimplemented from vtkSlicerModuleGUI.

void vtkCommandLineModuleGUI::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

Reimplemented from vtkSlicerModuleGUI.

References GetModuleDescription().

void vtkCommandLineModuleGUI::ProcessGUIEvents	(	vtkObject *	,
		unsigned long	,
		void *
	)			[virtual]

alternative method to propagate events generated in GUI to logic / mrml

Reimplemented from vtkSlicerModuleGUI.

References vtkCommandLineModuleLogic::Apply(), vtkMRMLCommandLineModuleNode::Cancelled, CommandLineModuleNode, CreatingNewNode, vtkSlicerNodeSelectorWidget::GetSelected(), ModuleDescription::GetTarget(), InternalWidgetMap, vtkCommandLineModuleLogic::LazyEvaluateModuleTarget(), Logic, ModuleDescriptionObject, mathExample::n, vtkSlicerNodeSelectorWidget::NewNodeEvent, vtkSlicerNodeSelectorWidget::NodeSelectedEvent, NodeSelector::selector, vtkMRMLCommandLineModuleNode::SetModuleDescription(), vtkCommandLineModuleLogic::SetTemporaryDirectory(), UpdateGUI(), UpdateMRML(), and vtkSetAndObserveMRMLNodeMacro.

virtual void vtkCommandLineModuleGUI::ProcessLogicEvents	(	vtkObject *	vtkNotUsedcaller,
		unsigned long	vtkNotUsedevent,
		void *	vtkNotUsedcallData
	)			[inline, virtual]

virtual void vtkCommandLineModuleGUI::ProcessMRMLEvents	(	vtkObject *	,
		unsigned long	,
		void *
	)			[virtual]

alternative method to propagate events generated in GUI to logic / mrml

Reimplemented from vtkSlicerModuleGUI.

void vtkCommandLineModuleGUI::ReleaseModuleEventBindings

(

void

)

[virtual]

Reimplemented from vtkSlicerModuleGUI.

Referenced by Exit().

void vtkCommandLineModuleGUI::RemoveGUIObservers

(

void

)

[virtual]

Reimplemented from vtkSlicerComponentGUI.

References vtkSlicerComponentGUI::GUICallbackCommand, InternalWidgetMap, NewNodeCallbackCommand, vtkSlicerNodeSelectorWidget::NewNodeEvent, and vtkSlicerNodeSelectorWidget::NodeSelectedEvent.

Referenced by TearDownGUI(), and ~vtkCommandLineModuleGUI().

void vtkCommandLineModuleGUI::RemoveLogicObservers

(

)

[virtual]

Referenced by ~vtkCommandLineModuleGUI().

void vtkCommandLineModuleGUI::RemoveMRMLNodeObservers

(

)

[virtual]

Referenced by ~vtkCommandLineModuleGUI().

void vtkCommandLineModuleGUI::SetCommandLineModuleNode

(

vtkMRMLCommandLineModuleNode *

node

)

[virtual]

References CommandLineModuleNode, and vtkSetAndObserveMRMLNodeMacro.

Referenced by vtkSlicerDiffusionTestingWidget::RunDWI(), and ~vtkCommandLineModuleGUI().

void vtkCommandLineModuleGUI::SetInMRMLCallbackFlag

(

int

flag

)

[inline]

Reimplemented from vtkSlicerComponentGUI.

void vtkCommandLineModuleGUI::SetModuleDescription

(

const ModuleDescription &

description

)

References ModuleLogo::GetBufferLength(), ModuleDescription::GetCategory(), ModuleLogo::GetHeight(), ModuleLogo::GetLogo(), ModuleDescription::GetLogo(), ModuleLogo::GetOptions(), ModuleLogo::GetPixelSize(), ModuleLogo::GetWidth(), vtkSlicerModuleGUI::Logo, FW::Actions::Modified, ModuleDescriptionObject, and New().

Referenced by Slicer3_main().

void vtkCommandLineModuleGUI::TearDownGUI

(

void

)

[virtual]

Method in which references are released, called before Delete().

Reimplemented from vtkSlicerComponentGUI.

References vtkSlicerModuleGUI::Built, Exit(), and RemoveGUIObservers().

void vtkCommandLineModuleGUI::UpdateGUI

(

)

[private]

References vtkMRMLCommandLineModuleNode::Cancelled, vtkMRMLCommandLineModuleNode::Completed, vtkMRMLCommandLineModuleNode::CompletedWithErrors, ModuleProcessInformation::ElapsedTime, vtkMRMLCommandLineModuleNode::GetModuleDescription(), vtkMRMLCommandLineModuleNode::GetParameterAsString(), ModuleDescription::GetParameterGroups(), ModuleDescription::GetProcessInformation(), vtkMRMLCommandLineModuleNode::GetStatus(), vtkMRMLCommandLineModuleNode::Idle, InternalWidgetMap, InUpdateGUI, InUpdateMRML, Logic, ModuleDescriptionObject, mathExample::n, New(), ModuleProcessInformation::Progress, ModuleProcessInformation::ProgressMessage, vtkMRMLCommandLineModuleNode::Running, vtkMRMLCommandLineModuleNode::Scheduled, vtkSlicerNodeSelectorWidget::SetSelected(), splitFilenames(), and ModuleProcessInformation::StageProgress.

Referenced by ProcessGUIEvents().

void vtkCommandLineModuleGUI::UpdateMRML

(

)

[private]

References CommandLineModuleNode, CreatingNewNode, vtkSlicerNodeSelectorWidget::GetSelected(), ModuleDescription::GetTitle(), InternalWidgetMap, InUpdateGUI, InUpdateMRML, len, Logic, ModuleDescriptionObject, mathExample::n, vtkSlicerNodeSelectorWidget::ProcessNewNodeCommand(), vtkMRMLCommandLineModuleNode::SetModuleDescription(), vtkMRMLCommandLineModuleNode::SetParameterAsBool(), vtkMRMLCommandLineModuleNode::SetParameterAsDouble(), vtkMRMLCommandLineModuleNode::SetParameterAsString(), vtkSlicerNodeSelectorWidget::SetSelectedNew(), and vtkSetAndObserveMRMLNodeMacro.

Referenced by ProcessGUIEvents().

vtkCommandLineModuleGUI::vtkGetMacro	(	InMRMLCallbackFlag	,
		int
	)

Reimplemented from vtkSlicerComponentGUI.

vtkCommandLineModuleGUI::vtkGetObjectMacro	(	CommandLineModuleNode	,
		vtkMRMLCommandLineModuleNode
	)

vtkCommandLineModuleGUI::vtkGetObjectMacro	(	Logic	,
		vtkCommandLineModuleLogic
	)

vtkCommandLineModuleGUI::vtkSetObjectMacro	(	Logic	,
		vtkCommandLineModuleLogic
	)

vtkCommandLineModuleGUI::vtkTypeMacro	(	vtkCommandLineModuleGUI	,
		vtkSlicerModuleGUI
	)

---

Member Data Documentation

vtkMRMLCommandLineModuleNode* vtkCommandLineModuleGUI::CommandLineModuleNode [private]

Referenced by ProcessGUIEvents(), SetCommandLineModuleNode(), UpdateMRML(), vtkCommandLineModuleGUI(), and ~vtkCommandLineModuleGUI().

bool vtkCommandLineModuleGUI::CreatingNewNode [private]

Referenced by ProcessGUIEvents(), UpdateMRML(), and vtkCommandLineModuleGUI().

int vtkCommandLineModuleGUI::InMRMLCallbackFlag [protected]

Reimplemented from vtkSlicerComponentGUI.

Referenced by vtkCommandLineModuleGUI().

ModuleWidgetMap* vtkCommandLineModuleGUI::InternalWidgetMap [private]

Referenced by AddGUIObservers(), BuildGUI(), ProcessGUIEvents(), RemoveGUIObservers(), UpdateGUI(), UpdateMRML(), vtkCommandLineModuleGUI(), and ~vtkCommandLineModuleGUI().

bool vtkCommandLineModuleGUI::InUpdateGUI [private]

Referenced by UpdateGUI(), UpdateMRML(), and vtkCommandLineModuleGUI().

bool vtkCommandLineModuleGUI::InUpdateMRML [private]

Referenced by UpdateGUI(), UpdateMRML(), and vtkCommandLineModuleGUI().

vtkCommandLineModuleLogic* vtkCommandLineModuleGUI::Logic [private]

Referenced by BuildGUI(), Enter(), ProcessGUIEvents(), UpdateGUI(), UpdateMRML(), and vtkCommandLineModuleGUI().

ModuleDescription vtkCommandLineModuleGUI::ModuleDescriptionObject [private]

Referenced by BuildGUI(), ProcessGUIEvents(), SetModuleDescription(), UpdateGUI(), and UpdateMRML().

vtkCallbackCommand* vtkCommandLineModuleGUI::NewNodeCallbackCommand [protected]

Referenced by AddGUIObservers(), RemoveGUIObservers(), vtkCommandLineModuleGUI(), and ~vtkCommandLineModuleGUI().

---

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

• Modules/CommandLineModule/vtkCommandLineModuleGUI.h
• Modules/CommandLineModule/vtkCommandLineModuleGUI.cxx