makVrf::DtScriptedTaskConfigurableMenu Class Reference

Container class that will create instances of scripted task configurable menu.

Examples

• menuManipulation

Inheritance diagram for makVrf::DtScriptedTaskConfigurableMenu:

Classes
struct	ScriptedTaskData

Public Types
enum	RecreateFlags {   RecreateNone = 0, RecreateOnScenarioLoad = 0x00000001, RecreateOnScriptedTaskChange = 0x00000002, RecreateToolbars = 0x00000004,   UseGlobalMenuManager = 0x00000008, RecreateMenuOnSelectionChange = 0x00000010, SkipInitialMenuSetup = 0x00000020, AllowPassThru = 0x00000040 }
typedef std::map< std::string, ScriptedTaskData >	ScriptedTasks

Public Member Functions
	DtScriptedTaskConfigurableMenu (makVrv::DtDe &, const std::string &menuIdName)
virtual	~DtScriptedTaskConfigurableMenu () override
virtual void	setEditMode (bool)
virtual bool	editMode () const
virtual void	setRecreateFlags (RecreateFlags)
virtual void	addScriptedTask (const DtScriptedTaskMetaData &, bool signal=true)
virtual void	addScriptedTasks (DtSubMenuConfiguration &, makVrv::DtToolbarConfiguration &, DtConfigurableMenuAssembler &, bool addToolbarMenuItems=true, bool useGlobalMenuManager=false)
virtual void	setScriptedTasks (const ScriptedTasks &, bool signal=true)
virtual const ScriptedTasks &	scriptedTasks () const
virtual void	setMenuConfiguration (const DtSubMenuConfiguration &)
virtual int	supportedScriptType (int type) const =0
virtual const char *	supportsToolbarType () const =0
DtVrfTaskSetMenu *	menu ()
Public Member Functions inherited from makVrf::DtConfigurableMenu
	DtConfigurableMenu (makVrv::DtDe &, const std::string &className)
virtual	~DtConfigurableMenu () override
virtual DtSubMenuConfiguration &	menuConfiguration ()
virtual DtConfigurableMenuAssembler &	menuAssembler ()
virtual void	registerMenu (makVrv::DtMenu *customMenu)
virtual void	registerMenuItem (makVrv::DtMenuItem *customMenuItem)
virtual void	createSimpleMenu (std::string menuText, makVrv::DtMenuPath menuIdPath, const makVrv::DtMenuConfiguration::MenuSortFlags &sortFlagsIfMenu=(makVrv::DtMenuConfiguration::MenuSortFlags)(makVrv::DtMenuConfiguration::SortAllAlphabetically|makVrv::DtMenuConfiguration::SortWithinSubmenus|makVrv::DtMenuConfiguration::SortBetweenSeparators))
virtual void	createSimpleMenuAfter (std::string menuText, makVrv::DtMenuPath menuIdPath, makVrv::DtMenuPath afterIdPath)
virtual void	createSimpleMenuBefore (std::string menuText, makVrv::DtMenuPath menuIdPath, makVrv::DtMenuPath beforeIdPath)
virtual void	createSimpleMenuItem (std::string itemText, makVrv::DtMenuPath itemIdPath, DtSimpleMenuItemAction *action, void *usr=NULL, const makVrv::DtMenuConfiguration::MenuSortFlags &sortFlagsIfMenu=(makVrv::DtMenuConfiguration::MenuSortFlags)(makVrv::DtMenuConfiguration::SortAllAlphabetically|makVrv::DtMenuConfiguration::SortWithinSubmenus|makVrv::DtMenuConfiguration::SortBetweenSeparators))
virtual void	createSimpleMenuItemAfter (std::string itemText, makVrv::DtMenuPath itemIdPath, makVrv::DtMenuPath afterIdPath, DtSimpleMenuItemAction *action, void *usr=NULL)
virtual void	createSimpleMenuItemBefore (std::string itemText, makVrv::DtMenuPath itemIdPath, makVrv::DtMenuPath beforeIdPath, DtSimpleMenuItemAction *action, void *usr=NULL)
virtual void	mergeMenu (makVrv::DtQtMenuAssembler &assembler, makVrv::DtMenuConfiguration &configuration)
virtual void	mergeMenu (makVrv::DtQtMenuAssembler &assembler)
virtual void	mergeMenu (makVrv::DtMenuConfiguration &configuration)
Public Member Functions inherited from makVrv::DtMenu
	DtMenu (DtDe &de, const std::string &menuIdName)
virtual	~DtMenu ()
virtual const std::string &	menuIdName () const
virtual QMenu *	createMenu (DtDe &, QWidget *parent)=0
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Public Attributes
boost::signals2::signal< void(DtSubMenuConfiguration &)>	signal_preCreateConfiguration
boost::signals2::signal< void()>	signal_recreateMenu
Public Attributes inherited from makVrf::DtConfigurableMenu
boost::signals2::signal< void(DtConfigurableMenu *)>	signal_menuRecreated
boost::signals2::signal< void(QAction *)>	signal_validateMenuItem

Protected Member Functions
virtual void	scriptIdChanged (const std::string &oldId, const std::string &newId, int action)
virtual bool	eventFilter (QObject *o, QEvent *e) override
virtual void	slot_sendTaskRequest (std::vector< DtUUID > names, const DtSimTask &s)
virtual void	slot_sendSetRequest (std::vector< DtUUID > names, const DtSetDataRequest &s)
virtual void	menuRecreated ()
virtual void	clearScriptedTasks ()
virtual void	scriptedTaskAboutToBeRemoved (std::string id)
virtual void	scriptedTaskAdded (std::string id)
virtual void	receivedScriptedTasks ()
virtual void	clearRegisteredMenuAssemblers ()
virtual void	clearRegisteredMenuAssembler (const std::string &)
virtual void	removeAllScriptedTasks (bool signal=true)
virtual void	removeScriptedTask (const std::string &id, bool signal=true)
virtual std::string	addScriptedTaskMenuLocation (const std::string &scriptedTaskId, const std::string &potentialPath, const QString &menuName, const QString &extMenuName, const QString &toolTip, DtSubMenuConfiguration &configuration, DtConfigurableMenuAssembler &, bool showInMenu=true, bool addToolbarMenuItems=true, bool useGlobalMenuManager=false)
virtual std::string	addScriptedTaskToolbarLocation (const std::string &scriptedTaskId, makVrv::DtToolbarConfiguration &configuration)
Protected Member Functions inherited from makVrf::DtConfigurableMenu
virtual void	initMenuItems (makVrv::DtDe &de)
DtConfigurableMenuAssembler &	assembler ()
DtSubMenuConfiguration &	configuration ()
virtual void	createMenuConfiguration (makVrv::DtDe &)

Protected Attributes
RecreateFlags	myRecreateFlags
ScriptedTasks	myScriptedTasks
bool	myEditMode
makVrv::DtSignalConnectionManager	myConnectionManager
DtSubMenuConfiguration	myConfiguration
DtVrfTaskSetMenu *	myMenu
std::set< std::string >	myScriptedTasksAddedToMenuAssember
std::map< std::string, std::string >	myScriptedTaskMenuItems
Protected Attributes inherited from makVrf::DtConfigurableMenu
DtConfigurableMenuAssembler	myAssembler
DtSubMenuConfiguration	myConfiguration
bool	myInitialized
makVrv::DtSignalConnectionManager	myConnections
Protected Attributes inherited from makVrv::DtMenu
DtDe &	myDe
std::string	myMenuIdName

Additional Inherited Members
Static Public Member Functions inherited from makVrf::DtConfigurableMenu
static bool	hasMenuPath (const makVrv::DtMenuConfiguration &menus, const makVrv::DtMenuPath &sourcePath, const std::string &item, makVrv::DtMenuPath &foundPath)

Member Typedef Documentation

typedef std::map<std::string, ScriptedTaskData> makVrf::DtScriptedTaskConfigurableMenu::ScriptedTasks

Member Enumeration Documentation

enum makVrf::DtScriptedTaskConfigurableMenu::RecreateFlags

Enumerator
RecreateNone
RecreateOnScenarioLoad
RecreateOnScriptedTaskChange
RecreateToolbars
UseGlobalMenuManager
RecreateMenuOnSelectionChange
SkipInitialMenuSetup
AllowPassThru	Do not create entire menu on first assemble – wait until entity set is set.

Constructor & Destructor Documentation

makVrf::DtScriptedTaskConfigurableMenu::DtScriptedTaskConfigurableMenu	(	makVrv::DtDe &	,
		const std::string &	menuIdName
	)

CTOR.

virtual makVrf::DtScriptedTaskConfigurableMenu::~DtScriptedTaskConfigurableMenu ( )

overridevirtual

DTOR.

Member Function Documentation

virtual void makVrf::DtScriptedTaskConfigurableMenu::setEditMode ( bool  )

virtual

If in edit mode shows all scripted task items regardless of show in menu status. Default is false.

virtual bool makVrf::DtScriptedTaskConfigurableMenu::editMode ( ) const

virtual

virtual void makVrf::DtScriptedTaskConfigurableMenu::setRecreateFlags ( RecreateFlags  )

virtual

If true will respond to recreate message. Default is false.

virtual void makVrf::DtScriptedTaskConfigurableMenu::addScriptedTask ( const DtScriptedTaskMetaData &  , bool  signal = true  )

virtual

virtual void makVrf::DtScriptedTaskConfigurableMenu::addScriptedTasks ( DtSubMenuConfiguration &  , makVrv::DtToolbarConfiguration &  , DtConfigurableMenuAssembler &  , bool  addToolbarMenuItems = true, bool  useGlobalMenuManager = false  )

virtual

Adds the scripted tasks into the supplied configuration.

virtual void makVrf::DtScriptedTaskConfigurableMenu::setScriptedTasks ( const ScriptedTasks &  , bool  signal = true  )

virtual

Sets/gets the scripted tasks to use with this task menu. If signal is true signal to recreate menu.

virtual const ScriptedTasks& makVrf::DtScriptedTaskConfigurableMenu::scriptedTasks ( ) const

virtual

virtual void makVrf::DtScriptedTaskConfigurableMenu::setMenuConfiguration ( const DtSubMenuConfiguration &  )

virtual

If set use this instead of the default task menu configuration.

virtual int makVrf::DtScriptedTaskConfigurableMenu::supportedScriptType ( int  type ) const

pure virtual

Implemented in makVrf::DtSetMenu, and makVrf::DtTaskMenu.

virtual const char* makVrf::DtScriptedTaskConfigurableMenu::supportsToolbarType ( ) const

pure virtual

Implemented in makVrf::DtSetMenu, and makVrf::DtTaskMenu.

DtVrfTaskSetMenu* makVrf::DtScriptedTaskConfigurableMenu::menu ( )

inline

virtual void makVrf::DtScriptedTaskConfigurableMenu::scriptIdChanged ( const std::string &  oldId, const std::string &  newId, int  action  )

protectedvirtual

virtual bool makVrf::DtScriptedTaskConfigurableMenu::eventFilter ( QObject *  o, QEvent *  e  )

overrideprotectedvirtual

virtual void makVrf::DtScriptedTaskConfigurableMenu::slot_sendTaskRequest ( std::vector< DtUUID >  names, const DtSimTask &  s  )

protectedvirtual

virtual void makVrf::DtScriptedTaskConfigurableMenu::slot_sendSetRequest ( std::vector< DtUUID >  names, const DtSetDataRequest &  s  )

protectedvirtual

virtual void makVrf::DtScriptedTaskConfigurableMenu::menuRecreated ( )

protectedvirtual

virtual void makVrf::DtScriptedTaskConfigurableMenu::clearScriptedTasks ( )

protectedvirtual

virtual void makVrf::DtScriptedTaskConfigurableMenu::scriptedTaskAboutToBeRemoved ( std::string  id )

protectedvirtual

virtual void makVrf::DtScriptedTaskConfigurableMenu::scriptedTaskAdded ( std::string  id )

protectedvirtual

virtual void makVrf::DtScriptedTaskConfigurableMenu::receivedScriptedTasks ( )

protectedvirtual

virtual void makVrf::DtScriptedTaskConfigurableMenu::clearRegisteredMenuAssemblers ( )

protectedvirtual

virtual void makVrf::DtScriptedTaskConfigurableMenu::clearRegisteredMenuAssembler ( const std::string &  )

protectedvirtual

virtual void makVrf::DtScriptedTaskConfigurableMenu::removeAllScriptedTasks ( bool  signal = true )

protectedvirtual

virtual void makVrf::DtScriptedTaskConfigurableMenu::removeScriptedTask ( const std::string &  id, bool  signal = true  )

protectedvirtual

virtual std::string makVrf::DtScriptedTaskConfigurableMenu::addScriptedTaskMenuLocation ( const std::string &  scriptedTaskId, const std::string &  potentialPath, const QString &  menuName, const QString &  extMenuName, const QString &  toolTip, DtSubMenuConfiguration &  configuration, DtConfigurableMenuAssembler &  , bool  showInMenu = true, bool  addToolbarMenuItems = true, bool  useGlobalMenuManager = false  )

protectedvirtual

This could get added if it is not shown in the menu if it is show in the toolbar. If the last variable is false do not register toolbar items to be created. This should only be set to true for the main task menu.

virtual std::string makVrf::DtScriptedTaskConfigurableMenu::addScriptedTaskToolbarLocation ( const std::string &  scriptedTaskId, makVrv::DtToolbarConfiguration &  configuration  )

protectedvirtual

Member Data Documentation

boost::signals2::signal<void (DtSubMenuConfiguration&)> makVrf::DtScriptedTaskConfigurableMenu::signal_preCreateConfiguration

Signal sent right before menu is configured.

boost::signals2::signal<void ()> makVrf::DtScriptedTaskConfigurableMenu::signal_recreateMenu

Sent when the task menus need to be recreated because menu configuration has changed.

RecreateFlags makVrf::DtScriptedTaskConfigurableMenu::myRecreateFlags

protected

ScriptedTasks makVrf::DtScriptedTaskConfigurableMenu::myScriptedTasks

protected

bool makVrf::DtScriptedTaskConfigurableMenu::myEditMode

protected

makVrv::DtSignalConnectionManager makVrf::DtScriptedTaskConfigurableMenu::myConnectionManager

protected

DtSubMenuConfiguration makVrf::DtScriptedTaskConfigurableMenu::myConfiguration

protected

DtVrfTaskSetMenu* makVrf::DtScriptedTaskConfigurableMenu::myMenu

protected

std::set<std::string> makVrf::DtScriptedTaskConfigurableMenu::myScriptedTasksAddedToMenuAssember

protected

std::map<std::string, std::string> makVrf::DtScriptedTaskConfigurableMenu::myScriptedTaskMenuItems

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfGuiTaskSetQt/scriptedTaskConfigurableMenu.h