This class will define the interface needed for being a task set variable that can be used in task dialogs and scripted task dialogs. More...

Inheritance diagram for makVrf::DtTaskSetVariableWidgetInterface:

[legend]

Public Types
enum	CreationFlags { NormalMode = 0x00000000, QtDesignerMode = 0x00000001 }

Public Member Functions
	DtTaskSetVariableWidgetInterface ()
virtual	~DtTaskSetVariableWidgetInterface ()
virtual void	setLabel (const std::string &)=0
	Display label.
virtual void	setLabel (const QString &)=0
virtual void	setToolTip (const QString &)=0
	Sets the tool tip for the widget.
virtual void	setTopLineVisible (bool)
	Hides top line.
virtual bool	topLineVisible () const
virtual bool	isValid () const =0
	Indicates the current selection is valid.
virtual void	widgetInitializedForDialog (DtScriptedTaskDialog *)
	Called when the widget is initialized from a scripted task dialog. Default implementation is to do nothing.
virtual void	setRange (double bottom, double top)=0
virtual void	setDefaultValue (const std::string &)=0
	Default value to set in control.
virtual void	setVariableData (const std::string &)=0
	Variable data that can be used by this control to initialize values (i.e.
virtual void	setupFrom (const std::vector< makVrv::DtSimEntry * > &data)=0
	Sets up widget with currently selected item.
virtual DtReaderWriter *	createBoundVariable (const std::string &variableName)=0
	Creates the reader/writer variable that will be used as part of the task statement.
virtual void	setupFromBoundVariable (const DtReaderWriter *variableName)=0
	Sets up the widget from the given reader/writer variables.
virtual DtTaskSetVariableWidgetExtensionInterface *	parameterContents (QWidget *parent, const Qt::WindowFlags &flags=0) const
	If there are any, returns contents for this variable for variable extension. Default is no extension.
virtual bool	guiElementOnly () const
	Returns true if this is a GUI element only. Default is false.
virtual void	setIndent (int)=0
	Sets the indent level for the contents of this widget.
virtual std::string	variableDataFromUiDesigner (const QDomElement &, const DtScriptedTaskVariableLayoutConverter &) const =0
	Given the Ui designer properties create a string that will represent the variable data for those properties.
virtual std::string	scriptedTaskVariableName () const =0
	In most cases this is the objectName of the object, however, in some cases (as in radio button) this could be a name that is shared amongst like objects, so, that is returned instead.
static void	initializeForQtDesignerExtension (makVrv::DtDe &de, QDesignerFormEditorInterface *core)
	Implement at class level to perform Qt Designer custom widget initialization. Please refer to Qt documentation for designer modifications.
static bool	includeInQtDesigner ()

Detailed Description

This class will define the interface needed for being a task set variable that can be used in task dialogs and scripted task dialogs.

Subclass of QGroupBox to be able to implement label creation. If a label is set, then the group box will be used, else it will be no frame and no title.

Member Enumeration Documentation

enum makVrf::DtTaskSetVariableWidgetInterface::CreationFlags

Enumerator:

NormalMode
QtDesignerMode

Constructor & Destructor Documentation

makVrf::DtTaskSetVariableWidgetInterface::DtTaskSetVariableWidgetInterface ( )

inline

virtual makVrf::DtTaskSetVariableWidgetInterface::~DtTaskSetVariableWidgetInterface ( )

inlinevirtual

Member Function Documentation

virtual void makVrf::DtTaskSetVariableWidgetInterface::setLabel ( const std::string & )

pure virtual

Display label.

This will create the top label line if not overriden by a default.

Implemented in makVrf::DtSimpleSingleRadioButtonVariableWidget, makVrf::DtTaskSetVariableWidget, makVrf::DtSimpleVariableWidget, makVrf::DtForceSelectionEntryWidget, makVrf::DtOverlayParentEntryWidget, makVrf::DtEmitterModesSelectionEntryWidget, makVrf::DtOffsetLocationEntryWidget, and makVrf::DtOrientationEntryWidget.

virtual void makVrf::DtTaskSetVariableWidgetInterface::setLabel ( const QString & )

pure virtual

virtual void makVrf::DtTaskSetVariableWidgetInterface::setToolTip ( const QString & )

pure virtual

Sets the tool tip for the widget.

Implemented in makVrf::DtSimpleEntityTypesVariableWidget, makVrf::DtTaskSetVariableWidget, makVrf::DtForceSelectionEntryWidget, makVrf::DtOverlayParentEntryWidget, and makVrf::DtEmitterModesSelectionEntryWidget.

virtual void makVrf::DtTaskSetVariableWidgetInterface::setTopLineVisible ( bool )

inlinevirtual

Hides top line.

Reimplemented in makVrf::DtTaskSetVariableWidget.

virtual bool makVrf::DtTaskSetVariableWidgetInterface::topLineVisible ( ) const

inlinevirtual

Reimplemented in makVrf::DtTaskSetVariableWidget.

virtual bool makVrf::DtTaskSetVariableWidgetInterface::isValid ( ) const

pure virtual

Indicates the current selection is valid.

Implemented in makVrf::DtTaskSetVariableWidget, makVrf::DtVrfFilteredListView, makVrf::DtSimpleSeparatorWidget, makVrf::DtOverlayParentEntryWidget, makVrf::DtEmitterModesSelectionEntryWidget, makVrf::DtForceSelectionEntryWidget, makVrf::DtNewTacticalGraphicEntryWidget, and makVrf::DtSimpleLabelWidget.

virtual void makVrf::DtTaskSetVariableWidgetInterface::setRange	(	double	bottom,
		double	top
	)

pure virtual

These methods must be implemented in order to be considered a DtTaskSetVariable that can be used as part of a scripted task Validation range. Might not be applicable to all items

virtual void makVrf::DtTaskSetVariableWidgetInterface::setDefaultValue ( const std::string & )

pure virtual

Default value to set in control.

virtual void makVrf::DtTaskSetVariableWidgetInterface::setVariableData ( const std::string & )

pure virtual

Variable data that can be used by this control to initialize values (i.e.

filtered list box, combo box). Items should be separated by a semi-colon

Implemented in makVrf::DtSimpleImageComboVariableWidget, makVrf::DtTaskSetVariableWidget, makVrf::DtSimpleSeparatorWidget, makVrf::DtEmitterModesSelectionEntryWidget, makVrf::DtForceSelectionEntryWidget, makVrf::DtOverlayParentEntryWidget, DtIntegerListEntryWidget, and makVrf::DtSimpleLabelWidget.

virtual void makVrf::DtTaskSetVariableWidgetInterface::setupFrom ( const std::vector< makVrv::DtSimEntry * > & data )

pure virtual

Sets up widget with currently selected item.

virtual DtReaderWriter* makVrf::DtTaskSetVariableWidgetInterface::createBoundVariable ( const std::string & variableName )

pure virtual

Creates the reader/writer variable that will be used as part of the task statement.

virtual void makVrf::DtTaskSetVariableWidgetInterface::setupFromBoundVariable ( const DtReaderWriter * variableName )

pure virtual

Sets up the widget from the given reader/writer variables.

virtual DtTaskSetVariableWidgetExtensionInterface* makVrf::DtTaskSetVariableWidgetInterface::parameterContents	(	QWidget *	parent,
		const Qt::WindowFlags &	flags = `0`
	)		const

inlinevirtual

If there are any, returns contents for this variable for variable extension. Default is no extension.

virtual bool makVrf::DtTaskSetVariableWidgetInterface::guiElementOnly ( ) const

inlinevirtual

Returns true if this is a GUI element only. Default is false.

Reimplemented in makVrf::DtSimpleSeparatorWidget, and makVrf::DtSimpleLabelWidget.

virtual void makVrf::DtTaskSetVariableWidgetInterface::setIndent ( int )

pure virtual

Sets the indent level for the contents of this widget.

Implemented in makVrf::DtTaskSetVariableWidget, makVrf::DtOverlayParentEntryWidget, makVrf::DtEmitterModesSelectionEntryWidget, and makVrf::DtForceSelectionEntryWidget.

virtual std::string makVrf::DtTaskSetVariableWidgetInterface::variableDataFromUiDesigner	(	const QDomElement &	,
		const DtScriptedTaskVariableLayoutConverter &
	)		const

pure virtual

Given the Ui designer properties create a string that will represent the variable data for those properties.

Implemented in makVrf::DtSimpleSingleRadioButtonVariableWidget, makVrf::DtSimpleRadioButtonVariableWidget, makVrf::DtSimpleImageComboVariableWidget, makVrf::DtSimpleComboVariableWidget, makVrf::DtVrfFilteredListView, makVrf::DtTaskSetVariableWidget, makVrf::DtOverlayParentEntryWidget, makVrf::DtTimeEntryWidget, makVrf::DtForceSelectionEntryWidget, makVrf::DtNewTacticalGraphicEntryWidget, makVrf::DtSphereEntryWidget, makVrf::DtOffsetLocationEntryWidget, makVrf::DtWeaponSelectionWidget, makVrf::DtOrientationEntryWidget, makVrf::DtColorEntryWidget, makVrf::DtEmitterModesSelectionEntryWidget, and makVrf::DtPrecisionMovementEntryWidget.

static void makVrf::DtTaskSetVariableWidgetInterface::initializeForQtDesignerExtension	(	makVrv::DtDe &	de,
		QDesignerFormEditorInterface *	core
	)

inlinestatic

Implement at class level to perform Qt Designer custom widget initialization. Please refer to Qt documentation for designer modifications.

Reimplemented in makVrf::DtSimpleImageComboVariableWidget, makVrf::DtSimpleEntityTypeVariableWidget, makVrf::DtVrfFilteredListView, makVrf::DtNewTacticalGraphicEntryWidget, makVrf::DtResourceSelectionEntryWidget, and DtIntegerListEntryWidget.

static bool makVrf::DtTaskSetVariableWidgetInterface::includeInQtDesigner ( )

inlinestatic

Reimplemented in makVrf::DtTaskSetVariableWidget, makVrf::DtOverlayParentEntryWidget, and makVrf::DtForceSelectionEntryWidget.

virtual std::string makVrf::DtTaskSetVariableWidgetInterface::scriptedTaskVariableName ( ) const

pure virtual

In most cases this is the objectName of the object, however, in some cases (as in radio button) this could be a name that is shared amongst like objects, so, that is returned instead.

If the blank name is returned then just use the variable name

Implemented in makVrf::DtSimpleSingleRadioButtonVariableWidget, makVrf::DtTaskSetVariableWidget, makVrf::DtOverlayParentEntryWidget, makVrf::DtForceSelectionEntryWidget, and makVrf::DtEmitterModesSelectionEntryWidget.

virtual void makVrf::DtTaskSetVariableWidgetInterface::widgetInitializedForDialog ( DtScriptedTaskDialog * )

inlinevirtual

Called when the widget is initialized from a scripted task dialog. Default implementation is to do nothing.

Reimplemented in makVrf::DtSimpleSingleRadioButtonVariableWidget, makVrf::DtSimpleRadioButtonVariableWidget, makVrf::DtSimpleCheckBoxVariableWidget, and makVrf::DtVrfFilteredListView.

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCoreQt/taskSetVariableWidget.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation