VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Slots | Public Member Functions | Public Attributes | Protected Attributes
makVrf::DtVrfTaskSetAction Class Reference

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

Inheritance diagram for makVrf::DtVrfTaskSetAction:
Inheritance graph
[legend]

Public Slots

virtual void on_aboutToShow ()
 

Public Member Functions

 DtVrfTaskSetAction (QWidget *parent, makVrv::DtDe &)
 
virtual ~DtVrfTaskSetAction ()
 
void setParentMenu (DtVrfTaskSetMenu *p)
 
DtVrfTaskSetMenuparentMenu ()
 
virtual void slot_onSendSetRequest (std::vector< DtUUID > names, const DtSetDataRequest &)
 
virtual void slot_onSendTaskRequest (std::vector< DtUUID > names, const DtSimTask &)
 
virtual void on_triggered ()
 

Public Attributes

boost::signals2::signal< void(std::vector
< DtUUID > names, const
DtSetDataRequest &)> 
signal_sendSetRequest
 
boost::signals2::signal< void(std::vector
< DtUUID > names, const
DtSimTask &)> 
signal_sendTaskRequest
 
boost::signals2::signal< void(int
menuItemType, QWidget
*, DtVrfTaskSetAction *, const
std::vector
< makVrv::DtSimEntry * >
&, bool)> 
signal_createTaskSetDialog
 

Protected Attributes

makVrv::DtDemyDe
 
DtVrfTaskSetMenumyParentMenu
 

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
pthe 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::on_aboutToShow ( )
virtualslot

When this is about to show, if this is on the right click menu only, then show it.

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
namesvector of names of entities
requestthe 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
namesvector of names of entities
requestthe 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::signals2::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
namesvector of names of entities
requestthe set data request
boost::signals2::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
namesvector of names of entities
requestthe task request
boost::signals2::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
menuItemTypethe integer menu type value
parentthe parent widget pointer, likely the menu
actionthe action, generally this object
entriesthe selected entities in this dialog
planwhether 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:

Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)