makVrf::DtTaskMenu Class Reference

Container class that will create instances of the task menu which will configure itself for tasks. More...

Inheritance diagram for makVrf::DtTaskMenu:

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

Public Member Functions
	DtTaskMenu (makVrv::DtDe &, const std::string &menuIdName=DtTaskMenuId)
	CTOR.
virtual	~DtTaskMenu ()
	DTOR.
virtual QMenu *	createMenu (makVrv::DtDe &, QWidget *parent)
	Build a menu.
virtual DtTaskMenu *	newInstance ()
virtual void	setEditMode (bool)
	If in edit mode shows all scripted task items regardless of show in menu status. Default is false.
virtual bool	editMode () const
virtual void	setRecreateFlags (RecreateFlags)
	If true will respond to recreate message. Default is false.
virtual void	addScriptedTask (const DtScriptedTaskMetaData &, bool signal=true)
virtual void	addScriptedTasks (DtSubMenuConfiguration &, makVrv::DtToolbarConfiguration &, DtConfigurableMenuAssembler &, bool addToolbarMenuItems=true)
	Adds the scripted tasks into the supplied configuration.
virtual void	setScriptedTasks (const ScriptedTasks &, bool signal=true)
	Sets/gets the scripted tasks to use with this task menu.
virtual const ScriptedTasks &	scriptedTasks () const
virtual void	setTaskMenuConfiguration (const DtSubMenuConfiguration &)
	If set use this instead of the default task menu configuration.
DtVrfTaskSetMenu *	menu ()
Public Member Functions inherited from makVrf::DtConfigurableMenu
	DtConfigurableMenu (makVrv::DtDe &, const std::string &className)
	CTOR.
virtual	~DtConfigurableMenu ()
	DTOR.
virtual DtSubMenuConfiguration &	menuConfiguration ()
	Returns the configuration for the menu to be used. May be effected directly.
virtual DtConfigurableMenuAssembler &	menuAssembler ()
	Returns the assembler for the menu to be used. May be effected directly.
virtual void	registerMenu (makVrv::DtMenu *customMenu)
	Use to register your own complex menu object.
virtual void	registerMenuItem (makVrv::DtMenuItem *customMenuItem)
	Use to register your own complex menu item object.
virtual void	createSimpleMenu (std::string menuText, makVrv::DtMenuPath menuIdPath, int weight=-1)
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, int weight=-1)
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)
	Merges in the assembler and configuration into the supplied assembler and configuration.
virtual void	mergeMenu (makVrv::DtQtMenuAssembler &assembler)
	Merges in the assembler into the supplied assembler.
virtual void	mergeMenu (makVrv::DtMenuConfiguration &configuration)
	Merges in the configuration into the supplied configuration. This merges all the menu paths together.
Public Member Functions inherited from makVrv::DtMenu
	DtMenu (DtDe &de, const std::string &menuIdName)
	CTOR.
virtual	~DtMenu ()
	DTOR.
virtual const std::string &	menuIdName () const
	Get the menu id name, the menu id name is not the same thing as the visible menu text.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtTaskMenu &	instance (makVrv::DtDe &)
static DtTaskMenu *	menuInstance (makVrv::DtDe &)
	Return a new copy, not the registered copy.

Public Attributes
boost::signal< void(DtSubMenuConfiguration &)>	signal_preCreateConfiguration
	Signal sent right before menu is configured.
boost::signal< void()>	signal_recreateMenu
	Sent when the task menus need to be recreated because menu configuration has changed.
Public Attributes inherited from makVrf::DtConfigurableMenu
boost::signal< void(DtConfigurableMenu *)>	signal_menuRecreated
	Signal sent when this menu is recreated from it's original creation.
boost::signal< void(QAction *)>	signal_validateMenuItem

Protected Member Functions
virtual void	menuRecreated ()
virtual void	clearScriptedTasks ()
virtual void	scriptedTaskAboutToBeRemoved (std::string id)
virtual void	scriptedTaskAdded (std::string id)
virtual void	receivedScriptedTasks ()
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)
	This could get added if it is not shown in the menu if it is show in the toolbar.
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 &)
	Creates the menu configuration by creating the assembler and adding menu items.

Protected Attributes
RecreateFlags	myRecreateFlags
ScriptedTasks	myScriptedTasks
bool	myEditMode
makVrv::DtSignalConnectionManager	myConnectionManager
DtSubMenuConfiguration	myConfiguration
DtVrfTaskSetMenu *	myMenu
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

Detailed Description

Container class that will create instances of the task menu which will configure itself for tasks.

Examples

• menuManipulation

Member Typedef Documentation

typedef std::map<std::string, DtScriptedTaskMetaData> makVrf::DtTaskMenu::ScriptedTasks

Member Enumeration Documentation

enum makVrf::DtTaskMenu::RecreateFlags

Enumerator:

RecreateNone
RecreateOnScenarioLoad
RecreateOnScriptedTaskChange
RecreateToolbars
UseGlobalMenuManager
RecreateMenuOnSelectionChange

Constructor & Destructor Documentation

makVrf::DtTaskMenu::DtTaskMenu	(	makVrv::DtDe &	,
		const std::string &	menuIdName = DtTaskMenuId
	)

CTOR.

virtual makVrf::DtTaskMenu::~DtTaskMenu ( )

virtual

DTOR.

Member Function Documentation

virtual QMenu* makVrf::DtTaskMenu::createMenu ( makVrv::DtDe &  , QWidget *  parent  )

virtual

Build a menu.

Implements makVrv::DtMenu.

Reimplemented in makVrf::DtRightClickTaskMenu, and makVrf::DtEmbeddedEntityTaskMenu.

static DtTaskMenu& makVrf::DtTaskMenu::instance ( makVrv::DtDe &  )

static

static DtTaskMenu* makVrf::DtTaskMenu::menuInstance ( makVrv::DtDe &  )

static

Return a new copy, not the registered copy.

It will do this by calling the newInstance method on the currently registered version. newInstance needs to be overridden by subclasses to return their own new instance

virtual DtTaskMenu* makVrf::DtTaskMenu::newInstance ( )

virtual

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

virtual

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

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

virtual

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

virtual

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

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

virtual

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

virtual

Adds the scripted tasks into the supplied configuration.

virtual void makVrf::DtTaskMenu::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::DtTaskMenu::scriptedTasks ( ) const

virtual

virtual void makVrf::DtTaskMenu::setTaskMenuConfiguration ( const DtSubMenuConfiguration &  )

virtual

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

DtVrfTaskSetMenu* makVrf::DtTaskMenu::menu ( )

inline

virtual void makVrf::DtTaskMenu::menuRecreated ( )

protectedvirtual

virtual void makVrf::DtTaskMenu::clearScriptedTasks ( )

protectedvirtual

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

protectedvirtual

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

protectedvirtual

virtual void makVrf::DtTaskMenu::receivedScriptedTasks ( )

protectedvirtual

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

protectedvirtual

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

protectedvirtual

virtual std::string makVrf::DtTaskMenu::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  )

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::DtTaskMenu::addScriptedTaskToolbarLocation ( const std::string &  scriptedTaskId, makVrv::DtToolbarConfiguration &  configuration  )

protectedvirtual

Member Data Documentation

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

Signal sent right before menu is configured.

boost::signal<void ()> makVrf::DtTaskMenu::signal_recreateMenu

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

RecreateFlags makVrf::DtTaskMenu::myRecreateFlags

protected

ScriptedTasks makVrf::DtTaskMenu::myScriptedTasks

protected

bool makVrf::DtTaskMenu::myEditMode

protected

makVrv::DtSignalConnectionManager makVrf::DtTaskMenu::myConnectionManager

protected

DtSubMenuConfiguration makVrf::DtTaskMenu::myConfiguration

protected

DtVrfTaskSetMenu* makVrf::DtTaskMenu::myMenu

protected

---

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

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