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.

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

virtual void	setLabel (const QString &)=0

virtual void	setToolTip (const QString &)=0

virtual void	setTopLineVisible (bool)

virtual bool	topLineVisible () const

virtual bool	isValid () const =0

virtual void	widgetInitializedForDialog (DtScriptedTaskDialog , const std::vector< makVrv::DtSimEntry > &data)

virtual void	setSelection (const std::set< makVrv::DtUniqueID > &selection)

virtual void	setSelection (const std::vector< makVrv::DtSimEntry * > &data)

virtual const std::set < makVrv::DtUniqueID > &	selection () const

virtual void	setRange (double bottom, double top)=0

virtual void	setDefaultValue (const std::string &)=0

virtual void	setVariableData (const std::string &)=0

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

virtual DtReaderWriter *	createBoundVariable (const std::string &variableName)=0

virtual void	setupFromBoundVariable (const DtReaderWriter *variableName)=0

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

virtual bool	guiElementOnly () const

virtual void	setIndent (int)=0

virtual std::string	variableDataFromUiDesigner (const QDomElement &, const DtScriptedTaskVariableLayoutConverter &) const =0

virtual std::string	scriptedTaskVariableName () const =0

static bool	canBeUsedAsWidget ()

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

static bool	includeInQtDesigner ()

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::DtForceSelectionEntryWidget, makVrf::DtSimpleVariableWidget, makVrf::DtUnitPatchSelectionEntryWidget, makVrf::DtCountrySelectionEntryWidget, makVrf::DtSimpleMapDataWidget, makVrf::DtRankPatchSelectionEntryWidget, makVrf::DtOverlayParentEntryWidget, makVrf::DtNametagEntryWidget, 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::DtCountrySelectionEntryWidget, makVrf::DtOverlayParentEntryWidget, makVrf::DtUnitPatchSelectionEntryWidget, makVrf::DtRankPatchSelectionEntryWidget, makVrf::DtNametagEntryWidget, 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::DtSimpleComboVariableWidget, makVrf::DtTaskSetVariableWidget, makVrf::DtVrfFilteredListView, makVrf::DtVisualMetaDataSelectionWidget, makVrf::DtSimpleSeparatorWidget, makVrf::DtForceSelectionEntryWidget, makVrf::DtCountrySelectionEntryWidget, makVrf::DtOverlayParentEntryWidget, makVrf::DtEmitterModesSelectionEntryWidget, makVrf::DtNewTacticalGraphicEntryWidget, makVrf::DtSimpleLabelWidget, makVrf::DtLoadoutSelectionWidget, makVrf::DtUnitPatchSelectionEntryWidget, makVrf::DtRankPatchSelectionEntryWidget, makVrf::DtNametagEntryWidget, and makVrf::DtRunwaySelectionWidget.

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::DtForceSelectionEntryWidget, makVrf::DtSimpleSeparatorWidget, makVrf::DtUnitPatchSelectionEntryWidget, makVrf::DtRankPatchSelectionEntryWidget, makVrf::DtNametagEntryWidget, makVrf::DtCountrySelectionEntryWidget, makVrf::DtEmitterModesSelectionEntryWidget, makVrf::DtOverlayParentEntryWidget, DtBooleanListEntryWidget, 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.

static bool makVrf::DtTaskSetVariableWidgetInterface::canBeUsedAsWidget ( )

inlinestatic

Whether or not this shows up as a usable variable widget.

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

pure virtual

Sets the indent level for the contents of this widget.

Implemented in makVrf::DtTaskSetVariableWidget, makVrf::DtForceSelectionEntryWidget, makVrf::DtOverlayParentEntryWidget, makVrf::DtCountrySelectionEntryWidget, makVrf::DtUnitPatchSelectionEntryWidget, makVrf::DtEmitterModesSelectionEntryWidget, makVrf::DtRankPatchSelectionEntryWidget, and makVrf::DtNametagEntryWidget.

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.

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.

static bool makVrf::DtTaskSetVariableWidgetInterface::includeInQtDesigner ( )

inlinestatic

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 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::DtForceSelectionEntryWidget, makVrf::DtCountrySelectionEntryWidget, makVrf::DtOverlayParentEntryWidget, makVrf::DtEmitterModesSelectionEntryWidget, makVrf::DtUnitPatchSelectionEntryWidget, makVrf::DtRankPatchSelectionEntryWidget, and makVrf::DtNametagEntryWidget.

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

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, makVrf::DtVrfFilteredListView, and makVrf::DtEmbarkationSlotEntryWidget.

virtual void makVrf::DtTaskSetVariableWidgetInterface::setSelection ( const std::set< makVrv::DtUniqueID > & selection )

inlinevirtual

The selection set can be used to determine the diplay units to show.

Reimplemented in makVrf::DtTaskSetVariableWidget, makVrf::DtForceSelectionEntryWidget, makVrf::DtCountrySelectionEntryWidget, makVrf::DtOverlayParentEntryWidget, makVrf::DtJammingModeSelectionEntryWidget, makVrf::DtRadarModeSelectionEntryWidget, and makVrf::DtActiveSonarModeSelectionEntryWidget.

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

inlinevirtual

Reimplemented in makVrf::DtTaskSetVariableWidget, makVrf::DtForceSelectionEntryWidget, makVrf::DtCountrySelectionEntryWidget, makVrf::DtOverlayParentEntryWidget, makVrf::DtJammingModeSelectionEntryWidget, makVrf::DtRadarModeSelectionEntryWidget, and makVrf::DtActiveSonarModeSelectionEntryWidget.

virtual const std::set<makVrv::DtUniqueID>& makVrf::DtTaskSetVariableWidgetInterface::selection ( ) const

inlinevirtual

Reimplemented in makVrf::DtTaskSetVariableWidget.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfGuiDataEntryWidgets/taskSetVariableWidget.h

Public Types

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation