makVrf::DtVrfTaskSetAction Class Reference

Contains makVrf::DtTaskSetMenu, makVrf::DtVrfTaskSetAction, and makVrf::DtTaskSetMenuItem class. More...

Inheritance diagram for makVrf::DtVrfTaskSetAction:

Public Member Functions
	DtVrfTaskSetAction (QWidget *parent, makVrv::DtDe &)
	Constructor specifies the parent which should be a pointer to the makVrf::DtTaskSetMenuItem object.
virtual	~DtVrfTaskSetAction ()
	Destructor.
void	setParentMenu (DtVrfTaskSetMenu *p)
	Sets the parent menu which is of type makVrf::DtVrfTaskSetMenu.
DtVrfTaskSetMenu *	parentMenu ()
	Gets the parent menu which is of type makVrf::DtVrfTaskSetMenu.
virtual void	slot_onSendSetRequest (std::vector< DtUUID > names, const DtSetDataRequest &)
	Slot to receive a sendSetRequest.
virtual void	slot_onSendTaskRequest (std::vector< DtUUID > names, const DtSimTask &)
	Slot to receive a sendTaskRequest.
virtual void	on_triggered ()
	Function is called by the makVrf::DtVrfTaskSetMenuItem::on_triggered() function.

Public Attributes
boost::signal< void(std::vector < DtUUID > names, const DtSetDataRequest &)>	signal_sendSetRequest
	Boost signal emitted when sending a set request.
boost::signal< void(std::vector < DtUUID > names, const DtSimTask &)>	signal_sendTaskRequest
	Boost signal emitted when sending a task request.
boost::signal< void(int menuItemType, QWidget *, DtVrfTaskSetAction *, const std::vector < makVrv::DtSimEntry * > &, bool)>	signal_createTaskSetDialog
	Signal emitted when the dialog is created if the parent menu was signaled to create the action.

Protected Attributes
makVrv::DtDe &	myDe
DtVrfTaskSetMenu *	myParentMenu

Detailed Description

Contains makVrf::DtTaskSetMenu, makVrf::DtVrfTaskSetAction, and makVrf::DtTaskSetMenuItem class.

The action that gets invoked when a menu item is selected. The menu item and action are separated.

To get information about this action you can inspect two properties: 1) VrfActionType - This will return the internal id that is used to reference this action (see menuItems.h for hard coded task/set menu items) 2) script_id - If this is a scripted task this will be the string of the scripted task

Constructor & Destructor Documentation

makVrf::DtVrfTaskSetAction::DtVrfTaskSetAction	(	QWidget *	parent,
		makVrv::DtDe &
	)

Constructor specifies the parent which should be a pointer to the makVrf::DtTaskSetMenuItem object.

DtDe is required by most GUI components.

virtual makVrf::DtVrfTaskSetAction::~DtVrfTaskSetAction ( )

virtual

Destructor.

Member Function Documentation

void makVrf::DtVrfTaskSetAction::setParentMenu ( DtVrfTaskSetMenu *  p )

inline

Sets the parent menu which is of type makVrf::DtVrfTaskSetMenu.

Inline function.

Parameters

p	the parent menu

DtVrfTaskSetMenu* makVrf::DtVrfTaskSetAction::parentMenu ( )

inline

Gets the parent menu which is of type makVrf::DtVrfTaskSetMenu.

Inline function.

Returns

parent menu pointer

virtual void makVrf::DtVrfTaskSetAction::slot_onSendSetRequest ( std::vector< DtUUID >  names, const DtSetDataRequest &    )

virtual

Slot to receive a sendSetRequest.

This slot is not hooked up by default.

Parameters

names	vector of names of entities
request	the set data request

virtual void makVrf::DtVrfTaskSetAction::slot_onSendTaskRequest ( std::vector< DtUUID >  names, const DtSimTask &    )

virtual

Slot to receive a sendTaskRequest.

This slot is not hooked up by default.

Parameters

names	vector of names of entities
request	the task request

virtual void makVrf::DtVrfTaskSetAction::on_triggered ( )

virtual

Function is called by the makVrf::DtVrfTaskSetMenuItem::on_triggered() function.

Meant to perform the action of this class.

Reimplemented in makVrf::DtVrfRadioAction.

Member Data Documentation

boost::signal<void (std::vector<DtUUID> names, const DtSetDataRequest&)> makVrf::DtVrfTaskSetAction::signal_sendSetRequest

Boost signal emitted when sending a set request.

Other objects can connected to this signal to be notified when slot_onSendSetRequest() is called. Otherwise this isn't emitted by default.

Parameters

names	vector of names of entities
request	the set data request

boost::signal<void (std::vector<DtUUID> names, const DtSimTask&)> makVrf::DtVrfTaskSetAction::signal_sendTaskRequest

Boost signal emitted when sending a task request.

Other objects can connected to this signal to be notified when slot_onSendTaskRequest() is called. Otherwise this isn't emitted by default.

Parameters

names	vector of names of entities
request	the task request

boost::signal<void (int menuItemType, QWidget*, DtVrfTaskSetAction*, const std::vector<makVrv::DtSimEntry*>&, bool)> makVrf::DtVrfTaskSetAction::signal_createTaskSetDialog

Signal emitted when the dialog is created if the parent menu was signaled to create the action.

Called by on_triggered() in the condition previously mentioned.

Parameters

menuItemType	the integer menu type value
parent	the parent widget pointer, likely the menu
action	the action, generally this object
entries	the selected entities in this dialog
plan	whether or not this action is part of a plan dialog or not, true if so, false otherwise.

makVrv::DtDe& makVrf::DtVrfTaskSetAction::myDe

protected

DtVrfTaskSetMenu* makVrf::DtVrfTaskSetAction::myParentMenu

protected

---

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

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