The menu manager can be used to lookup registered QMenu and QAction objects based on their menu paths. The QMenu and QAction objects for the menu paths defined in the application's menu configuration are automatically registered with the menu manager by the menu assembler.

See Also: DtMenuAssembler

Inheritance diagram for makVrv::DtMenuManager:

[legend]

Public Member Functions
virtual	~DtMenuManager ()

virtual void	registerMenu (const DtMenuPath &path, QMenu *menu)

virtual void	registerMenuItem (const DtMenuPath &path, QAction *action)

virtual QMenu *	findMenu (const DtMenuPath &path) const

virtual QAction *	findMenuItem (const DtMenuPath &path) const

virtual void	sortMenuConfiguration (const DtMenuConfiguration &configuration) const

virtual bool	showMenu (const DtMenuPath &path)

virtual bool	hideMenu (const DtMenuPath &path)

virtual bool	setMenuVisible (const DtMenuPath &path, bool visible)

virtual bool	showMenuItem (const DtMenuPath &path)

virtual bool	hideMenuItem (const DtMenuPath &path)

virtual bool	setMenuItemVisible (const DtMenuPath &path, bool visible)

const std::map< DtMenuPath, QMenu * > &	menus () const

const std::map< DtMenuPath, QAction * >	menuItems () const

Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()

virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtMenuManager &	instance (DtDe &de)

Public Attributes
boost::signalslib::signal < void(const DtMenuPath &)>	signal_menuDeleted

boost::signalslib::signal < void(const DtMenuPath &)>	signal_menuItemDeleted

Protected Slots
virtual void	onMenuDestroyed (QObject *obj)

virtual void	onActionDestroyed (QObject *obj)

Protected Member Functions
	DtMenuManager ()

virtual void	addSortedNamesToMenu (QStringList sortedByName, std::map< QString, std::vector< QAction * > > sorted, QMenu *menu) const

virtual void	sortMenu (QMenu *, const DtMenuConfiguration::MenuSortFlags &flags, const DtMenuConfiguration &configuration) const

Protected Attributes
std::map< QPointer< QMenu > , DtMenuPath >	myMenuPaths

std::map< DtMenuPath, QMenu * >	myMenus

std::map< DtMenuPath, QAction * >	myMenuItems

Constructor & Destructor Documentation

virtual makVrv::DtMenuManager::~DtMenuManager ( )

virtual

DTOR.

makVrv::DtMenuManager::DtMenuManager ( )

protected

Protected CTOR, use the instance function.

Member Function Documentation

static DtMenuManager& makVrv::DtMenuManager::instance ( DtDe & de )

static

Get an instance of the Menu manager.

Referenced by makVrf::DtConfigurableMenuAssembler::menuManager().

virtual void makVrv::DtMenuManager::registerMenu	(	const DtMenuPath &	path,
		QMenu *	menu
	)

virtual

Register a menu, this is done automatically by the DtMenuAssembler.

virtual void makVrv::DtMenuManager::registerMenuItem	(	const DtMenuPath &	path,
		QAction *	action
	)

virtual

Register a menu item, this is done automatically by the DtMenuAssembler.

virtual QMenu* makVrv::DtMenuManager::findMenu ( const DtMenuPath & path ) const

virtual

Find a menu by its path.

virtual QAction* makVrv::DtMenuManager::findMenuItem ( const DtMenuPath & path ) const

virtual

Find a menu item by its path.

virtual void makVrv::DtMenuManager::sortMenuConfiguration ( const DtMenuConfiguration & configuration ) const

virtual

Sort all menus based on the menu configuration provided. This function assumes the individual menu path configurations within the menu configuration have already been assembled into QMenu and QAction objects that have been registered with this manager.

virtual bool makVrv::DtMenuManager::showMenu ( const DtMenuPath & path )

virtual

Show a menu by its path. Akin to calling setMenuVisible(path, true). Returns true if successful, false otherwise.

virtual bool makVrv::DtMenuManager::hideMenu ( const DtMenuPath & path )

virtual

Hide a menu by its path. Akin to calling setMenuVisible(path, false). Returns true if successful, false otherwise.

virtual bool makVrv::DtMenuManager::setMenuVisible	(	const DtMenuPath &	path,
		bool	visible
	)

virtual

Show/Hide a menu by its path. Returns true if successful, false otherwise.

virtual bool makVrv::DtMenuManager::showMenuItem ( const DtMenuPath & path )

virtual

Show a menu item by its path. Akin to calling setMenuItemVisible(path, true). Returns true if successful, false otherwise.

virtual bool makVrv::DtMenuManager::hideMenuItem ( const DtMenuPath & path )

virtual

Hide a menu item by its path. Akin to calling setMenuItemVisible(path, false). Returns true if successful, false otherwise.

virtual bool makVrv::DtMenuManager::setMenuItemVisible	(	const DtMenuPath &	path,
		bool	visible
	)

virtual

Show/Hide a menu by its path. Returns true if successful, false otherwise.

const std::map<DtMenuPath,QMenu*>& makVrv::DtMenuManager::menus ( ) const

Returns the list of known menus and menu items. Key is the path to the menu or menu item.

const std::map<DtMenuPath,QAction*> makVrv::DtMenuManager::menuItems ( ) const

virtual void makVrv::DtMenuManager::onMenuDestroyed ( QObject * obj )

protectedvirtualslot

When a menu is destroyed.

virtual void makVrv::DtMenuManager::onActionDestroyed ( QObject * obj )

protectedvirtualslot

When an action is destroyed.

virtual void makVrv::DtMenuManager::addSortedNamesToMenu	(	QStringList	sortedByName,
		std::map< QString, std::vector< QAction * > >	sorted,
		QMenu *	menu
	)		const

protectedvirtual

Helper function for sorting menus.

virtual void makVrv::DtMenuManager::sortMenu	(	QMenu *	,
		const DtMenuConfiguration::MenuSortFlags &	flags,
		const DtMenuConfiguration &	configuration
	)		const

protectedvirtual

Helper function for sorting menus. Recursively sort the provided QMenu based on its sort flags and the sort flags of its children menus, menu items, and/or actions.

Member Data Documentation

boost::signalslib::signal<void (const DtMenuPath&)> makVrv::DtMenuManager::signal_menuDeleted

boost::signalslib::signal<void (const DtMenuPath&)> makVrv::DtMenuManager::signal_menuItemDeleted

std::map<QPointer<QMenu>, DtMenuPath> makVrv::DtMenuManager::myMenuPaths

protected

std::map<DtMenuPath,QMenu*> makVrv::DtMenuManager::myMenus

protected

std::map<DtMenuPath,QAction*> makVrv::DtMenuManager::myMenuItems

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCoreQt/DtMenuManager.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Slots

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation