makVrf::DtScriptedTaskDialog Class Reference

This class will created a dialog from scripted task meta data and send that information to the back-end for the scripted task. More...

Inheritance diagram for makVrf::DtScriptedTaskDialog:

Classes
struct	WidgetInfo

Public Slots
virtual void	updateValidity ()
	Enables or disables the OK button based on the validity of the user's current selections.

Public Member Functions
	DtScriptedTaskDialog (makVrv::DtDe &de, QWidget *parent, const Qt::WindowFlags &flags=0)
virtual	~DtScriptedTaskDialog ()
virtual bool	editStatement (const std::vector< makVrv::DtSimEntry * > &data, const DtSimStatement *s)
	Edits the current statement. Return true if the statement can be edited.
virtual void	initializeFromVariables (const QString &description, const std::vector< DtScriptedTaskVariable > &vars)
	Initializes dialog from variables without running.
virtual void	setDescription (const QString &)
	Sets the description for this task.
virtual std::vector < DtScriptedTaskVariable >	convertToVariables () const
	Converts the dialog settings back to scripted task variables.
virtual DtRwVariableBindings *	convertToVariableBindings () const
	Converts the dialog settings to variable bindings. The return pointer must be freed.
virtual void	setLocationValid (bool)
virtual void	validate ()
virtual QSize	visibleSize ()
virtual void	setupFromBoundVariables (const DtRwVariableBindings &)
	Sets up gui elements from bound variables it can find.
virtual DtRwVariableBindings *	variableBindings () const
	Returns the variable bindings for the widgets in this dialog. Delete the returned pointer to prevent memory leak.
template<typename T >
void	getWidgetsOfType (std::vector< T > &widgets) const
virtual bool	insertMapFocusHandler (DtMapFocusHandler *h, int index)
	If a dialog has manages map focus handlers, inserts this map focus handler into the chain.
Public Member Functions inherited from makVrf::DtBaseTaskSetDialogInterface
	DtBaseTaskSetDialogInterface (makVrv::DtDe &de, QWidget *parent, const Qt::WindowFlags &flags=0)
virtual	~DtBaseTaskSetDialogInterface ()
virtual void	setOKEnabled (bool)
	Enables/disables OK button.
virtual bool	valid () const
	Override to return whether or not extension is valid.
int	accepted () const
	0 - Closed without pressing cancel or ok 1 - Closed by ok 2 - Closed by cancel
Public Member Functions inherited from makVrf::DtTaskSetDialogInterface
	DtTaskSetDialogInterface (makVrv::DtDe &de, QWidget *parent, const Qt::WindowFlags &flags=0)
virtual	~DtTaskSetDialogInterface ()
virtual void	connectSignals (const std::vector< makVrv::DtSimEntry * > &)
	Setup signals to cancel dialog if all objects deleted that this dialog is representing.
virtual void	setSendToRemoteController (bool b)
	Set to true to send the message immediately to the remote controller given the currently selected entities when the dialog was created.
virtual bool	sendToRemoteController () const
virtual void	selectionChanged (const QString &selection)
	Notify dialog of selection changes from attached dialogs.
virtual void	sendSetRequest (std::vector< std::string > names, const DtSetDataRequest &)
	Sends signal to send out set.
virtual void	sendTaskRequest (std::vector< std::string > names, const DtSimTask &)
	Sends signal to send out task.
virtual std::vector< std::string >	names () const
virtual void	setPartOfPlan (int b)
	0 - Not part of plan dialog 1 - Part of plan dialog 2 - Part of command widget 3 - Part of embedded entity menu
int	partOfPlan () const
virtual void	cancel ()
	Sends out cancel signal.
virtual QWidget *	widget ()
	Returns the widget.
const std::vector < makVrv::DtSimEntry * > &	connectedTo () const
Public Member Functions inherited from makVrf::DtCommandDialogExtensionInterface
virtual	~DtCommandDialogExtensionInterface ()
virtual bool	initiallyBroadcast () const
	Whether or not to initially set to broadcast. Default is false.
virtual void	onCancel ()=0
virtual makVrv::DtUnicode	broadcastTitle () const

Public Attributes
boost::signal< void(DtVrfFilteredListView *)>	signal_filteredListViewSelectionChanged
boost::signal< void(bool, DtTaskSetVariableWidget *)>	signal_topLevelCheckStateChanged
QWidget *	myCanvas
QVBoxLayout *	myContentLayout
QLabel *	myDescription
QScrollArea *	myScrollArea
QWidget *	myInsideWidget
QFrame *	myDescriptionSeparator
Public Attributes inherited from makVrf::DtBaseTaskSetDialogInterface
QVBoxLayout *	myMasterLayout
QHBoxLayout *	myButtonLayout
QPushButton *	myOKButton
QPushButton *	myCancelButton
char	myAccepted

Protected Types
typedef std::map < DtLocationEntryWidget *, bool >	LocationValid

Protected Member Functions
virtual void	slot_topLevelCheckStateChanged (bool, DtTaskSetVariableWidget *)
virtual void	slot_filteredListViewChanged (DtVrfFilteredListView *)
virtual void	initializeFromAction (DtVrfTaskSetAction *)
	Action contains script_id, so, build dialog from that.
virtual void	initializeFromScriptId (const std::string &scriptId)
virtual bool	wantsSelectionOfObjectInCommandMode () const
	Override to return false if, when this task is used as part of a simulation command, it does not want to allow to choose an object to apply the command to.
virtual void	sendRequest ()
	Override to send the set or task request.
virtual QWidget *	contents (const std::vector< makVrv::DtSimEntry * > &data)
	Creates set dialog contents. Called from setupGui.
virtual void	run (const std::vector< makVrv::DtSimEntry * > &)
	If no variables acts as immediate task.
virtual void	setupFrom (const std::vector< makVrv::DtSimEntry * > &s)
	Sets up variables from data.
virtual void	setupStatement (const DtSimStatement *stmt)
	Sets up the dialog from the scripted task and the variables within.
virtual void	postGuiSetup (const std::vector< makVrv::DtSimEntry * > &data)
	For dialog sizing.
virtual void	setLocationValid (DtLocationEntryWidget *loca, bool)
Protected Member Functions inherited from makVrf::DtBaseTaskSetDialogInterface
virtual void	setupGui (const std::vector< makVrv::DtSimEntry * > &)
	Sets up the ok/cancel buttons.
virtual void	initializeItems (const std::vector< makVrv::DtSimEntry * > &data)
	Override for dialogs that need item initialization.
virtual void	closeEvent (QCloseEvent *)
	Figure out if a cancelled signal needs to be sent.
virtual void	sendSetRequest (const DtSetDataRequest &)
virtual void	sendTaskRequest (const DtSimTask &)
virtual void	sendCommandRequest (const DtSimCommandObjectWrapper &)
	Sends signal to send out command.
Protected Member Functions inherited from makVrf::DtTaskSetDialogInterface
virtual void	slot_objectAboutToBeRemoved (makVrv::DtSimObjectEntry &)
virtual std::vector< std::string >	commandDialogFiltersFor (const std::vector< makVrv::DtSimEntry * > &data, const DtSimStatement *stmt, int &initialSelection) const
	If part of a command dialog the filters to use for the command dialog selection.

Protected Attributes
DtMapFocusHandlerManager	myMapFocusHandlerManager
std::map< std::string, WidgetInfo >	myWidgetVariables
DtScriptedTaskMetaData	myScriptedTaskMetaData
std::vector < DtScriptedTaskVariable >	myScriptedTaskVariables
QString	myDescriptionText
LocationValid	myLocationsValid

Additional Inherited Members
Protected Slots inherited from makVrf::DtBaseTaskSetDialogInterface
virtual void	onOk ()
virtual void	onCancel ()

Detailed Description

This class will created a dialog from scripted task meta data and send that information to the back-end for the scripted task.

Member Typedef Documentation

typedef std::map<DtLocationEntryWidget*, bool> makVrf::DtScriptedTaskDialog::LocationValid

protected

Constructor & Destructor Documentation

makVrf::DtScriptedTaskDialog::DtScriptedTaskDialog	(	makVrv::DtDe &	de,
		QWidget *	parent,
		const Qt::WindowFlags &	flags = 0
	)

virtual makVrf::DtScriptedTaskDialog::~DtScriptedTaskDialog ( )

virtual

Member Function Documentation

virtual bool makVrf::DtScriptedTaskDialog::editStatement ( const std::vector< makVrv::DtSimEntry * > &  , const DtSimStatement *    )

virtual

Edits the current statement. Return true if the statement can be edited.

Reimplemented from makVrf::DtBaseTaskSetDialogInterface.

virtual void makVrf::DtScriptedTaskDialog::initializeFromVariables ( const QString &  description, const std::vector< DtScriptedTaskVariable > &  vars  )

virtual

Initializes dialog from variables without running.

virtual void makVrf::DtScriptedTaskDialog::setDescription ( const QString &  )

virtual

Sets the description for this task.

virtual std::vector<DtScriptedTaskVariable> makVrf::DtScriptedTaskDialog::convertToVariables ( ) const

virtual

Converts the dialog settings back to scripted task variables.

virtual DtRwVariableBindings* makVrf::DtScriptedTaskDialog::convertToVariableBindings ( ) const

virtual

Converts the dialog settings to variable bindings. The return pointer must be freed.

virtual void makVrf::DtScriptedTaskDialog::setLocationValid ( bool  )

virtual

virtual void makVrf::DtScriptedTaskDialog::validate ( )

virtual

virtual QSize makVrf::DtScriptedTaskDialog::visibleSize ( )

virtual

virtual void makVrf::DtScriptedTaskDialog::setupFromBoundVariables ( const DtRwVariableBindings &  )

virtual

Sets up gui elements from bound variables it can find.

virtual DtRwVariableBindings* makVrf::DtScriptedTaskDialog::variableBindings ( ) const

virtual

Returns the variable bindings for the widgets in this dialog. Delete the returned pointer to prevent memory leak.

template<typename T >

void makVrf::DtScriptedTaskDialog::getWidgetsOfType ( std::vector< T > &  widgets ) const

inline

virtual bool makVrf::DtScriptedTaskDialog::insertMapFocusHandler ( DtMapFocusHandler *  , int  index  )

virtual

If a dialog has manages map focus handlers, inserts this map focus handler into the chain.

Default is a no-op and will return false (not handled)

Reimplemented from makVrf::DtTaskSetDialogInterface.

virtual void makVrf::DtScriptedTaskDialog::slot_topLevelCheckStateChanged ( bool  , DtTaskSetVariableWidget *    )

protectedvirtual

virtual void makVrf::DtScriptedTaskDialog::slot_filteredListViewChanged ( DtVrfFilteredListView *  )

protectedvirtual

virtual void makVrf::DtScriptedTaskDialog::initializeFromAction ( DtVrfTaskSetAction *  )

protectedvirtual

Action contains script_id, so, build dialog from that.

Reimplemented from makVrf::DtTaskSetDialogInterface.

virtual void makVrf::DtScriptedTaskDialog::initializeFromScriptId ( const std::string &  scriptId )

protectedvirtual

virtual bool makVrf::DtScriptedTaskDialog::wantsSelectionOfObjectInCommandMode ( ) const

protectedvirtual

Override to return false if, when this task is used as part of a simulation command, it does not want to allow to choose an object to apply the command to.

Calls down to logic with method of same name

Reimplemented from makVrf::DtBaseTaskSetDialogInterface.

virtual void makVrf::DtScriptedTaskDialog::sendRequest ( )

protectedvirtual

Override to send the set or task request.

Implements makVrf::DtBaseTaskSetDialogInterface.

virtual QWidget* makVrf::DtScriptedTaskDialog::contents ( const std::vector< makVrv::DtSimEntry * > &  data )

protectedvirtual

Creates set dialog contents. Called from setupGui.

Implements makVrf::DtBaseTaskSetDialogInterface.

virtual void makVrf::DtScriptedTaskDialog::run ( const std::vector< makVrv::DtSimEntry * > &  )

protectedvirtual

If no variables acts as immediate task.

Reimplemented from makVrf::DtBaseTaskSetDialogInterface.

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

protectedvirtual

Sets up variables from data.

Reimplemented from makVrf::DtBaseTaskSetDialogInterface.

virtual void makVrf::DtScriptedTaskDialog::setupStatement ( const DtSimStatement *  stmt )

protectedvirtual

Sets up the dialog from the scripted task and the variables within.

Reimplemented from makVrf::DtBaseTaskSetDialogInterface.

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

protectedvirtual

For dialog sizing.

Reimplemented from makVrf::DtBaseTaskSetDialogInterface.

virtual void makVrf::DtScriptedTaskDialog::setLocationValid ( DtLocationEntryWidget *  loca, bool    )

protectedvirtual

virtual void makVrf::DtScriptedTaskDialog::updateValidity ( )

virtualslot

Enables or disables the OK button based on the validity of the user's current selections.

Member Data Documentation

boost::signal<void (DtVrfFilteredListView*)> makVrf::DtScriptedTaskDialog::signal_filteredListViewSelectionChanged

boost::signal<void (bool, DtTaskSetVariableWidget*)> makVrf::DtScriptedTaskDialog::signal_topLevelCheckStateChanged

QWidget* makVrf::DtScriptedTaskDialog::myCanvas

QVBoxLayout* makVrf::DtScriptedTaskDialog::myContentLayout

QLabel* makVrf::DtScriptedTaskDialog::myDescription

QScrollArea* makVrf::DtScriptedTaskDialog::myScrollArea

QWidget* makVrf::DtScriptedTaskDialog::myInsideWidget

QFrame* makVrf::DtScriptedTaskDialog::myDescriptionSeparator

DtMapFocusHandlerManager makVrf::DtScriptedTaskDialog::myMapFocusHandlerManager

protected

std::map<std::string, WidgetInfo> makVrf::DtScriptedTaskDialog::myWidgetVariables

protected

DtScriptedTaskMetaData makVrf::DtScriptedTaskDialog::myScriptedTaskMetaData

protected

std::vector<DtScriptedTaskVariable> makVrf::DtScriptedTaskDialog::myScriptedTaskVariables

protected

QString makVrf::DtScriptedTaskDialog::myDescriptionText

protected

LocationValid makVrf::DtScriptedTaskDialog::myLocationsValid

protected

---

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

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