qSlicerCLIModuleWidgetPrivate Class Reference

#include <qSlicerCLIModuleWidget_p.h>

Inheritance diagram for qSlicerCLIModuleWidgetPrivate:
QObject qCTKPrivate< qSlicerCLIModuleWidget > Ui_qSlicerCLIModule

List of all members.

Public Types

typedef std::vector
< std::string >
::const_iterator 		ElementConstIterator
typedef std::vector
< std::string >::iterator 		ElementIterator
typedef std::vector
< ModuleParameter >
::const_iterator 		ParameterConstIterator
typedef std::vector
< ModuleParameterGroup >
::const_iterator 		ParameterGroupConstIterator
typedef std::vector
< ModuleParameterGroup >
::iterator 		ParameterGroupIterator
typedef std::vector
< ModuleParameter >::iterator 		ParameterIterator
typedef
qSlicerCLIModuleWidgetPrivate 		Self

Public Slots

void enableCommandButtonState (bool enable)
void onApplyButtonPressed ()
void onCancelButtonPressed ()
void onDefaultButtonPressed ()

Public Member Functions

void addParameter (QFormLayout *layout, const ModuleParameter &moduleParameter)
void addParameterGroup (QBoxLayout *layout, const ModuleParameterGroup &parameterGroup)
void addParameterGroups ()
void addParameters (QFormLayout *layout, const ModuleParameterGroup &parameterGroup)
vtkMRMLCommandLineModuleNode * commandLineModuleNode () const
QWidget * createBooleanTagWidget (const ModuleParameter &moduleParameter)
QWidget * createDirectoryTagWidget (const ModuleParameter &moduleParameter)
QWidget * createDoubleTagWidget (const ModuleParameter &moduleParameter)
QWidget * createEnumerationTagWidget (const ModuleParameter &moduleParameter)
QWidget * createFileTagWidget (const ModuleParameter &moduleParameter)
QWidget * createFloatTagWidget (const ModuleParameter &moduleParameter)
QWidget * createGeometryTagWidget (const ModuleParameter &moduleParameter)
QWidget * createImageTagWidget (const ModuleParameter &moduleParameter)
QWidget * createIntegerTagWidget (const ModuleParameter &moduleParameter)
QWidget * createPointTagWidget (const ModuleParameter &moduleParameter)
QWidget * createRegionTagWidget (const ModuleParameter &moduleParameter)
QWidget * createStringTagWidget (const ModuleParameter &moduleParameter)
QWidget * createTableTagWidget (const ModuleParameter &moduleParameter)
QWidget * createTransformTagWidget (const ModuleParameter &moduleParameter)
vtkSlicerCLIModuleLogic * logic () const
 qSlicerCLIModuleWidgetPrivate ()
void setupUi (qSlicerWidget *widget)
void updateMRMLCommandLineModuleNode ()

Static Public Member Functions

static void initializeMaps ()
static QString nodeTypeFromMap (const QString &defaultValue, const QHash< QString, QString > &map, const QString &attribute)

Public Attributes

QString Category
vtkMRMLCommandLineModuleNode * CommandLineModuleNode
QString Contributor
QString ModuleEntryPoint
QString Name
std::vector< ModuleParameterGroup > ParameterGroups
ModuleProcessInformation * ProcessInformation
QString Title
QList< WidgetValueWrapper * > WidgetValueWrappers

Static Public Attributes

static QHash< QString, QString > GeometryTypeAttributeToNodeType
static QHash< QString, QString > ImageTypeAttributeToNodeType
static bool MapInitialized = false
static QHash< QString, QString > TableTypeAttributeToNodeType
static QHash< QString, QString > TransformTypeAttributeToNodeType

Private Member Functions

 QCTK_DECLARE_PUBLIC (qSlicerCLIModuleWidget)

Member Typedef Documentation

typedef std::vector<std::string>::const_iterator qSlicerCLIModuleWidgetPrivate::ElementConstIterator
typedef std::vector<std::string>::iterator qSlicerCLIModuleWidgetPrivate::ElementIterator
typedef std::vector<ModuleParameter>::const_iterator qSlicerCLIModuleWidgetPrivate::ParameterConstIterator
typedef std::vector<ModuleParameterGroup>::const_iterator qSlicerCLIModuleWidgetPrivate::ParameterGroupConstIterator
typedef std::vector<ModuleParameterGroup>::iterator qSlicerCLIModuleWidgetPrivate::ParameterGroupIterator
typedef std::vector<ModuleParameter>::iterator qSlicerCLIModuleWidgetPrivate::ParameterIterator
typedef qSlicerCLIModuleWidgetPrivate qSlicerCLIModuleWidgetPrivate::Self

Constructor & Destructor Documentation

qSlicerCLIModuleWidgetPrivate::qSlicerCLIModuleWidgetPrivate (  )  [inline]

References CommandLineModuleNode, Name, and ProcessInformation.

Member Function Documentation

void qSlicerCLIModuleWidgetPrivate::addParameter ( QFormLayout *  layout,
const ModuleParameter &  moduleParameter 
)

References createBooleanTagWidget(), createDirectoryTagWidget(), createDoubleTagWidget(), createEnumerationTagWidget(), createFileTagWidget(), createFloatTagWidget(), createGeometryTagWidget(), createImageTagWidget(), createIntegerTagWidget(), createPointTagWidget(), createRegionTagWidget(), createStringTagWidget(), createTableTagWidget(), createTransformTagWidget(), ModuleParameter::GetDescription(), ModuleParameter::GetFlag(), ModuleParameter::GetHidden(), ModuleParameter::GetLabel(), ModuleParameter::GetLongFlag(), and ModuleParameter::GetTag().

Referenced by addParameters().

void qSlicerCLIModuleWidgetPrivate::addParameterGroup ( QBoxLayout *  layout,
const ModuleParameterGroup &  parameterGroup 
)

References addParameters(), ModuleParameterGroup::GetAdvanced(), ModuleParameterGroup::GetLabel(), and qCTKCollapsibleButton::setCollapsed().

Referenced by addParameterGroups().

void qSlicerCLIModuleWidgetPrivate::addParameterGroups (  ) 

References addParameterGroup(), and ParameterGroups.

Referenced by setupUi().

void qSlicerCLIModuleWidgetPrivate::addParameters ( QFormLayout *  layout,
const ModuleParameterGroup &  parameterGroup 
)

References addParameter(), and ModuleParameterGroup::GetParameters().

Referenced by addParameterGroup().

vtkMRMLCommandLineModuleNode * qSlicerCLIModuleWidgetPrivate::commandLineModuleNode (  )  const

Convenient function to cast vtkMRMLNode into vtkMRMLCommandLineModuleNode

Referenced by onApplyButtonPressed(), and updateMRMLCommandLineModuleNode().

QWidget * qSlicerCLIModuleWidgetPrivate::createBooleanTagWidget ( const ModuleParameter &  moduleParameter  ) 

References ModuleParameter::GetDefault(), ModuleParameter::GetLabel(), and INSTANCIATE_WIDGET_VALUE_WRAPPER.

Referenced by addParameter().

QWidget * qSlicerCLIModuleWidgetPrivate::createDirectoryTagWidget ( const ModuleParameter &  moduleParameter  ) 

Referenced by addParameter().

QWidget * qSlicerCLIModuleWidgetPrivate::createDoubleTagWidget ( const ModuleParameter &  moduleParameter  ) 

References ModuleParameter::GetConstraints(), ModuleParameter::GetDefault(), ModuleParameter::GetLabel(), INSTANCIATE_WIDGET_VALUE_WRAPPER, max, min, qCTKDoubleSlider::setOrientation(), qCTKDoubleSlider::setRange(), qCTKDoubleSlider::setSingleStep(), qCTKDoubleSlider::setTickInterval(), and qCTKDoubleSlider::setValue().

Referenced by addParameter().

QWidget * qSlicerCLIModuleWidgetPrivate::createEnumerationTagWidget ( const ModuleParameter &  moduleParameter  ) 

References ModuleParameter::GetDefault(), ModuleParameter::GetElements(), ModuleParameter::GetLabel(), and INSTANCIATE_WIDGET_VALUE_WRAPPER.

Referenced by addParameter().

QWidget * qSlicerCLIModuleWidgetPrivate::createFileTagWidget ( const ModuleParameter &  moduleParameter  ) 

Referenced by addParameter().

QWidget * qSlicerCLIModuleWidgetPrivate::createFloatTagWidget ( const ModuleParameter &  moduleParameter  ) 

References ModuleParameter::GetConstraints(), ModuleParameter::GetDefault(), ModuleParameter::GetLabel(), INSTANCIATE_WIDGET_VALUE_WRAPPER, max, min, qCTKDoubleSlider::setOrientation(), qCTKDoubleSlider::setRange(), qCTKDoubleSlider::setSingleStep(), qCTKDoubleSlider::setTickInterval(), and qCTKDoubleSlider::setValue().

Referenced by addParameter().

QWidget * qSlicerCLIModuleWidgetPrivate::createGeometryTagWidget ( const ModuleParameter &  moduleParameter  ) 

References connect(), GeometryTypeAttributeToNodeType, ModuleParameter::GetAggregate(), ModuleParameter::GetChannel(), ModuleParameter::GetLabel(), ModuleParameter::GetMultiple(), ModuleParameter::GetType(), INSTANCIATE_WIDGET_VALUE_WRAPPER, nodeTypeFromMap(), p, QCTK_P, and type.

Referenced by addParameter().

QWidget * qSlicerCLIModuleWidgetPrivate::createImageTagWidget ( const ModuleParameter &  moduleParameter  ) 

References connect(), GeometryTypeAttributeToNodeType, ModuleParameter::GetChannel(), ModuleParameter::GetLabel(), ModuleParameter::GetType(), INSTANCIATE_WIDGET_VALUE_WRAPPER, nodeTypeFromMap(), p, QCTK_P, and type.

Referenced by addParameter().

QWidget * qSlicerCLIModuleWidgetPrivate::createIntegerTagWidget ( const ModuleParameter &  moduleParameter  ) 

Create widget corresponding to the different parameters

References ModuleParameter::GetConstraints(), ModuleParameter::GetDefault(), ModuleParameter::GetLabel(), ModuleParameter::GetMaximum(), ModuleParameter::GetMinimum(), ModuleParameter::GetStep(), INSTANCIATE_WIDGET_VALUE_WRAPPER, max, and min.

Referenced by addParameter().

QWidget * qSlicerCLIModuleWidgetPrivate::createPointTagWidget ( const ModuleParameter &  moduleParameter  ) 

References connect(), ModuleParameter::GetLabel(), INSTANCIATE_WIDGET_VALUE_WRAPPER, p, and QCTK_P.

Referenced by addParameter().

QWidget * qSlicerCLIModuleWidgetPrivate::createRegionTagWidget ( const ModuleParameter &  moduleParameter  ) 

References connect(), ModuleParameter::GetLabel(), INSTANCIATE_WIDGET_VALUE_WRAPPER, p, and QCTK_P.

Referenced by addParameter().

QWidget * qSlicerCLIModuleWidgetPrivate::createStringTagWidget ( const ModuleParameter &  moduleParameter  ) 

References ModuleParameter::GetDefault(), ModuleParameter::GetLabel(), and INSTANCIATE_WIDGET_VALUE_WRAPPER.

Referenced by addParameter().

QWidget * qSlicerCLIModuleWidgetPrivate::createTableTagWidget ( const ModuleParameter &  moduleParameter  ) 

References connect(), ModuleParameter::GetChannel(), ModuleParameter::GetLabel(), ModuleParameter::GetType(), INSTANCIATE_WIDGET_VALUE_WRAPPER, nodeTypeFromMap(), p, QCTK_P, TableTypeAttributeToNodeType, and type.

Referenced by addParameter().

QWidget * qSlicerCLIModuleWidgetPrivate::createTransformTagWidget ( const ModuleParameter &  moduleParameter  ) 

References connect(), ModuleParameter::GetChannel(), ModuleParameter::GetLabel(), ModuleParameter::GetType(), INSTANCIATE_WIDGET_VALUE_WRAPPER, nodeTypeFromMap(), p, QCTK_P, TransformTypeAttributeToNodeType, and type.

Referenced by addParameter().

void qSlicerCLIModuleWidgetPrivate::enableCommandButtonState ( bool  enable  )  [slot]

Referenced by setupUi().

void qSlicerCLIModuleWidgetPrivate::initializeMaps (  )  [static]

Initiliaze the maps containing the mapping parameter type -> MRML node type (classname)

References GeometryTypeAttributeToNodeType, ImageTypeAttributeToNodeType, MapInitialized, TableTypeAttributeToNodeType, and TransformTypeAttributeToNodeType.

vtkSlicerCLIModuleLogic * qSlicerCLIModuleWidgetPrivate::logic (  )  const

Convenient function to cast vtkSlicerLogic into vtkSlicerCLIModuleLogic

References p, and QCTK_P.

Referenced by onApplyButtonPressed().

QString qSlicerCLIModuleWidgetPrivate::nodeTypeFromMap ( const QString &  defaultValue,
const QHash< QString, QString > &  map,
const QString &  attribute 
) [static]

Convenient method allowing to retrieve the node type associated with the parameter type

Referenced by createGeometryTagWidget(), createImageTagWidget(), createTableTagWidget(), and createTransformTagWidget().

void qSlicerCLIModuleWidgetPrivate::onApplyButtonPressed (  )  [slot]

References vtkSlicerCLIModuleLogic::Apply(), commandLineModuleNode(), logic(), and updateMRMLCommandLineModuleNode().

Referenced by setupUi().

void qSlicerCLIModuleWidgetPrivate::onCancelButtonPressed (  )  [slot]

Referenced by setupUi().

void qSlicerCLIModuleWidgetPrivate::onDefaultButtonPressed (  )  [slot]

Referenced by setupUi().

qSlicerCLIModuleWidgetPrivate::QCTK_DECLARE_PUBLIC ( qSlicerCLIModuleWidget   )  [private]
void qSlicerCLIModuleWidgetPrivate::setupUi ( qSlicerWidget *  widget  ) 

Calling this method will loop trough the structure resulting from the XML parsing and generate the corresponding UI.

References addParameterGroups(), connect(), enableCommandButtonState(), onApplyButtonPressed(), onCancelButtonPressed(), onDefaultButtonPressed(), and Title.

void qSlicerCLIModuleWidgetPrivate::updateMRMLCommandLineModuleNode (  ) 

Update MRMLCommandLineModuleNode properties using value entered using the UI

References commandLineModuleNode(), WidgetValueWrapper::label(), ModuleEntryPoint, p, QCTK_P, type, WidgetValueWrapper::value(), and WidgetValueWrappers.

Referenced by onApplyButtonPressed().

Member Data Documentation

QString qSlicerCLIModuleWidgetPrivate::Category
vtkMRMLCommandLineModuleNode* qSlicerCLIModuleWidgetPrivate::CommandLineModuleNode

Referenced by qSlicerCLIModuleWidgetPrivate().

QString qSlicerCLIModuleWidgetPrivate::Contributor
QHash< QString, QString > qSlicerCLIModuleWidgetPrivate::GeometryTypeAttributeToNodeType [static]

Referenced by createGeometryTagWidget(), createImageTagWidget(), and initializeMaps().

QHash< QString, QString > qSlicerCLIModuleWidgetPrivate::ImageTypeAttributeToNodeType [static]

Referenced by initializeMaps().

bool qSlicerCLIModuleWidgetPrivate::MapInitialized = false [static]

Map used to store the different relation parameter type -> MRML node type

Referenced by initializeMaps().

QString qSlicerCLIModuleWidgetPrivate::ModuleEntryPoint

Referenced by updateMRMLCommandLineModuleNode().

QString qSlicerCLIModuleWidgetPrivate::Name

Referenced by qSlicerCLIModuleWidgetPrivate().

std::vector<ModuleParameterGroup> qSlicerCLIModuleWidgetPrivate::ParameterGroups

Referenced by addParameterGroups().

ModuleProcessInformation* qSlicerCLIModuleWidgetPrivate::ProcessInformation

Referenced by qSlicerCLIModuleWidgetPrivate().

QHash< QString, QString > qSlicerCLIModuleWidgetPrivate::TableTypeAttributeToNodeType [static]

Referenced by createTableTagWidget(), and initializeMaps().

QString qSlicerCLIModuleWidgetPrivate::Title

Referenced by setupUi().

QHash< QString, QString > qSlicerCLIModuleWidgetPrivate::TransformTypeAttributeToNodeType [static]

Referenced by createTransformTagWidget(), and initializeMaps().

QList<WidgetValueWrapper*> qSlicerCLIModuleWidgetPrivate::WidgetValueWrappers

Referenced by updateMRMLCommandLineModuleNode().

The documentation for this class was generated from the following files:
Generated on 6 Apr 2011 for Slicer3 by  doxygen 1.6.1