vtkSlicerParameterWidget Class Reference

#include <vtkSlicerParameterWidget.h>

Inheritance diagram for vtkSlicerParameterWidget:

List of all members.

Classes
struct	callBackDataStruct
struct	moduleParameterWidgetStruct
struct	ParameterWidgetChangedStruct
Public Types
enum	{ ParameterWidgetChangedEvent = 10000 }
enum	{ PARAMETER_WIDGET_ERR = -1, PARAMETER_WIDGET_FAIL = 0, PARAMETER_WIDGET_SUCC = 1 }
Public Member Functions
int	CreateWidgets ()
int	currentIndex ()
bool	end ()
std::vector< ModuleParameter > *	GetCurrentParameters ()
vtkMRMLNode *	GetMRMLNode ()
vtkKWWidget *	GetNextWidget ()
std::string	GetValueByName (std::string name)
bool	IsCreated ()
void	reset ()
void	SetErrorMap (std::map< std::string, std::string > *errorMap)
void	SetModuleDescription (ModuleDescription *modDescription)
void	SetMRMLNode (vtkMRMLNode *mrmlNode)
void	SetParent (vtkKWWidget *parent)
void	SetSlicerModuleLogic (vtkSlicerModuleLogic *logic)
void	SetWidgetID (std::string ID)
int	size ()
	vtkTypeMacro (vtkSlicerParameterWidget, vtkKWObject)
Static Public Member Functions
static vtkSlicerParameterWidget *	New ()
Protected Member Functions
void	AddGUIObservers ()
void	AddParameterAndEventToWidget (vtkKWCoreWidget *parentWidget, ModuleParameter widgetParameter)
void	copyModuleParameters (const ModuleParameter &from, const ModuleParameter &to)
void	DeleteInputWidget (vtkKWWidget *widg)
void	DeleteInternalLists ()
const char *	GetAttributeName (std::string name)
std::string	GetErrorByParamName (std::string name)
const char *	GetValueFromWidget (vtkKWWidget *widg)
	vtkCallbackCommand *GUIChangedCallbackCommand;
void	Initialize ()
void	SetValueForWidget (vtkKWCoreWidget *widg, const char *value)
void	UpdateMRMLForWidget (vtkKWCoreWidget *parentWidget, ModuleParameter widgetParameter)
	vtkSlicerParameterWidget ()
virtual	~vtkSlicerParameterWidget ()
Static Protected Member Functions
static void	GUIChangedCallback (vtkObject *__caller, unsigned long eid, void *__clientData, void *callData)
Private Attributes
bool	m_Created
int	m_CurrentIndex
std::string	m_curWidgetLabel
	std::map<vtkKWCoreWidget*, ModuleParameter> *m_internalWidgetToParamMap;
bool	m_End
std::vector < moduleParameterWidgetStruct * > ::iterator	m_InternalIterator
std::vector < moduleParameterWidgetStruct * > *	m_InternalWidgetParamList
ModuleDescription *	m_ModuleDescription
vtkSlicerModuleLogic *	m_ModuleLogic
vtkMRMLNode *	m_MRMLNode
std::map< std::string, std::string > *	m_paramToErrorMap
vtkKWWidget *	m_ParentWidget
std::string	m_widgID

---

Member Enumeration Documentation

anonymous enum

Enumerator:

ParameterWidgetChangedEvent

anonymous enum

Enumerator:

PARAMETER_WIDGET_ERR
PARAMETER_WIDGET_FAIL
PARAMETER_WIDGET_SUCC

---

Constructor & Destructor Documentation

vtkSlicerParameterWidget::vtkSlicerParameterWidget

(

)

[protected]

References Initialize(), m_InternalWidgetParamList, m_ModuleDescription, m_ModuleLogic, m_MRMLNode, m_paramToErrorMap, m_ParentWidget, and m_widgID.

vtkSlicerParameterWidget::~vtkSlicerParameterWidget

(

)

[protected, virtual]

References DeleteInternalLists(), m_ModuleDescription, m_ModuleLogic, m_paramToErrorMap, and m_ParentWidget.

---

Member Function Documentation

void vtkSlicerParameterWidget::AddGUIObservers

(

void

)

[protected]

void vtkSlicerParameterWidget::AddParameterAndEventToWidget	(	vtkKWCoreWidget *	parentWidget,
		ModuleParameter	widgetParameter
	)			[protected]

References GUIChangedCallback(), New(), vtkSlicerNodeSelectorWidget::NodeSelectedEvent, vtkSlicerParameterWidget::callBackDataStruct::parentClass, and vtkSlicerParameterWidget::callBackDataStruct::widgetParameter.

Referenced by CreateWidgets().

void vtkSlicerParameterWidget::copyModuleParameters	(	const ModuleParameter &	from,
		const ModuleParameter &	to
	)			[protected]

int vtkSlicerParameterWidget::CreateWidgets

(

)

References AddParameterAndEventToWidget(), NodeSelector::app, DeleteInternalLists(), error(), GetErrorByParamName(), GetMRMLNode(), ModuleDescription::GetParameterGroups(), ModuleDescription::GetTitle(), slicerget::id, Initialize(), m_Created, m_End, m_InternalWidgetParamList, m_ModuleDescription, m_ModuleLogic, m_ParentWidget, max, min, vtkSlicerParameterWidget::moduleParameterWidgetStruct::modParams, New(), PARAMETER_WIDGET_ERR, PARAMETER_WIDGET_FAIL, PARAMETER_WIDGET_SUCC, vtkSlicerParameterWidget::moduleParameterWidgetStruct::paramWidget, vtkSlicerNodeSelectorWidget::SetMRMLScene(), vtkSlicerNodeSelectorWidget::SetNodeClass(), vtkSlicerNodeSelectorWidget::UpdateMenu(), and UpdateMRMLForWidget().

int vtkSlicerParameterWidget::currentIndex

(

)

References m_CurrentIndex.

void vtkSlicerParameterWidget::DeleteInputWidget

(

vtkKWWidget *

widg

)

[protected]

Referenced by DeleteInternalLists().

void vtkSlicerParameterWidget::DeleteInternalLists

(

)

[protected]

References DeleteInputWidget(), m_InternalWidgetParamList, vtkSlicerParameterWidget::moduleParameterWidgetStruct::modParams, and vtkSlicerParameterWidget::moduleParameterWidgetStruct::paramWidget.

Referenced by CreateWidgets(), and ~vtkSlicerParameterWidget().

bool vtkSlicerParameterWidget::end

(

)

References m_End.

Referenced by GetCurrentParameters().

const char * vtkSlicerParameterWidget::GetAttributeName

(

std::string

name

)

[protected]

References m_widgID.

Referenced by GetValueByName(), and UpdateMRMLForWidget().

std::vector< ModuleParameter > * vtkSlicerParameterWidget::GetCurrentParameters

(

)

References end(), and m_InternalIterator.

std::string vtkSlicerParameterWidget::GetErrorByParamName

(

std::string

name

)

[protected]

References m_paramToErrorMap.

Referenced by CreateWidgets().

vtkMRMLNode * vtkSlicerParameterWidget::GetMRMLNode

(

)

References m_MRMLNode.

Referenced by CreateWidgets(), GetValueByName(), SetValueForWidget(), and UpdateMRMLForWidget().

vtkKWWidget * vtkSlicerParameterWidget::GetNextWidget

(

)

References IsCreated(), m_CurrentIndex, m_End, m_InternalIterator, and m_InternalWidgetParamList.

std::string vtkSlicerParameterWidget::GetValueByName

(

std::string

name

)

References vtkMRMLNode::GetAttribute(), GetAttributeName(), and GetMRMLNode().

const char * vtkSlicerParameterWidget::GetValueFromWidget

(

vtkKWWidget *

widg

)

[protected]

vtkCallbackCommand *GUIChangedCallbackCommand;

References vtkSlicerNodeSelectorWidget::GetSelected().

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

Callback routine that is used for creating a new node. This method is needed to avoid recursive calls to GUICallback()

Referenced by AddParameterAndEventToWidget().

void vtkSlicerParameterWidget::Initialize

(

void

)

[protected]

References m_Created, m_CurrentIndex, and m_End.

Referenced by CreateWidgets(), and vtkSlicerParameterWidget().

bool vtkSlicerParameterWidget::IsCreated

(

)

References m_Created.

Referenced by GetNextWidget(), and size().

static vtkSlicerParameterWidget* vtkSlicerParameterWidget::New

(

)

[static]

Referenced by AddParameterAndEventToWidget(), and CreateWidgets().

void vtkSlicerParameterWidget::reset

(

)

References m_CurrentIndex, and m_End.

void vtkSlicerParameterWidget::SetErrorMap

(

std::map< std::string, std::string > *

errorMap

)

References m_paramToErrorMap.

void vtkSlicerParameterWidget::SetModuleDescription

(

ModuleDescription *

modDescription

)

References m_ModuleDescription.

void vtkSlicerParameterWidget::SetMRMLNode

(

vtkMRMLNode *

mrmlNode

)

References m_MRMLNode.

void vtkSlicerParameterWidget::SetParent

(

vtkKWWidget *

parent

)

References m_ParentWidget.

void vtkSlicerParameterWidget::SetSlicerModuleLogic

(

vtkSlicerModuleLogic *

logic

)

References m_ModuleLogic.

void vtkSlicerParameterWidget::SetValueForWidget	(	vtkKWCoreWidget *	widg,
		const char *	value
	)			[protected]

References autoSlicerTracto2regions::d, GetMRMLNode(), vtkSlicerNodeSelectorWidget::GetSelected(), and vtkSlicerNodeSelectorWidget::SetSelected().

Referenced by UpdateMRMLForWidget().

void vtkSlicerParameterWidget::SetWidgetID

(

std::string

ID

)

References m_widgID.

int vtkSlicerParameterWidget::size

(

)

References IsCreated(), and m_InternalWidgetParamList.

void vtkSlicerParameterWidget::UpdateMRMLForWidget	(	vtkKWCoreWidget *	parentWidget,
		ModuleParameter	widgetParameter
	)			[protected]

create new attribute for the widget in the mrml node or get the value from the node

References vtkMRMLNode::GetAttribute(), GetAttributeName(), ModuleParameter::GetDefault(), GetMRMLNode(), ModuleParameter::GetName(), vtkMRMLNode::SetAttribute(), and SetValueForWidget().

Referenced by CreateWidgets().

vtkSlicerParameterWidget::vtkTypeMacro	(	vtkSlicerParameterWidget	,
		vtkKWObject
	)

---

Member Data Documentation

bool vtkSlicerParameterWidget::m_Created [private]

Referenced by CreateWidgets(), Initialize(), and IsCreated().

int vtkSlicerParameterWidget::m_CurrentIndex [private]

Referenced by currentIndex(), GetNextWidget(), Initialize(), and reset().

std::string vtkSlicerParameterWidget::m_curWidgetLabel [private]

std::map<vtkKWCoreWidget*, ModuleParameter> *m_internalWidgetToParamMap;

bool vtkSlicerParameterWidget::m_End [private]

Referenced by CreateWidgets(), end(), GetNextWidget(), Initialize(), and reset().

std::vector<moduleParameterWidgetStruct*>::iterator vtkSlicerParameterWidget::m_InternalIterator [private]

Referenced by GetCurrentParameters(), and GetNextWidget().

std::vector<moduleParameterWidgetStruct*>* vtkSlicerParameterWidget::m_InternalWidgetParamList [private]

Referenced by CreateWidgets(), DeleteInternalLists(), GetNextWidget(), size(), and vtkSlicerParameterWidget().

ModuleDescription* vtkSlicerParameterWidget::m_ModuleDescription [private]

Referenced by CreateWidgets(), SetModuleDescription(), vtkSlicerParameterWidget(), and ~vtkSlicerParameterWidget().

vtkSlicerModuleLogic* vtkSlicerParameterWidget::m_ModuleLogic [private]

Referenced by CreateWidgets(), SetSlicerModuleLogic(), vtkSlicerParameterWidget(), and ~vtkSlicerParameterWidget().

vtkMRMLNode* vtkSlicerParameterWidget::m_MRMLNode [private]

Referenced by GetMRMLNode(), SetMRMLNode(), and vtkSlicerParameterWidget().

std::map<std::string, std::string>* vtkSlicerParameterWidget::m_paramToErrorMap [private]

Referenced by GetErrorByParamName(), SetErrorMap(), vtkSlicerParameterWidget(), and ~vtkSlicerParameterWidget().

vtkKWWidget* vtkSlicerParameterWidget::m_ParentWidget [private]

Referenced by CreateWidgets(), SetParent(), vtkSlicerParameterWidget(), and ~vtkSlicerParameterWidget().

std::string vtkSlicerParameterWidget::m_widgID [private]

Referenced by GetAttributeName(), SetWidgetID(), and vtkSlicerParameterWidget().

---

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

• Base/GUI/vtkSlicerParameterWidget.h
• Base/GUI/vtkSlicerParameterWidget.cxx