This class will traverse the created actions in the menu system and add a potential key mapping for them. The mechanism will replace the Qt shortcut mechanism in that it will handle the triggering of the actions.

Inheritance diagram for makVrf::DtVrfMenuKeyMapManager:

[legend]

Public Member Functions
	DtVrfMenuKeyMapManager (makVrv::DtDe &)

virtual	~DtVrfMenuKeyMapManager ()

virtual void	setup ()

virtual void	addKeyboardMenuMapping (const makVrv::DtMenuPath &path)

virtual void	removeKeyboardMenuMapping (const makVrv::DtMenuPath &path)

virtual void	setApplyChangesToAllKeymaps (bool)

virtual bool	applyChangesToAllKeymaps () const

virtual bool	isMenuFunction (const std::string &func) const

virtual QString	reverseTranslate (const QString &) const

virtual void	copyKeyFunction (const makVrv::DtMenuPath &from, const makVrv::DtMenuPath &to)

virtual bool	setSaveManagersOnChange (bool)

virtual bool	saveManagersOnChange () const

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

virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtVrfMenuKeyMapManager &	instance (makVrv::DtDe &de)

static void	registerInstance (makVrv::DtDe &, DtVrfMenuKeyMapManager *)

Protected Types
typedef std::map< std::string, std::string >	FunctionToPathMap

typedef std::map< std::string, std::string >	PathToFunctionMap

typedef std::map< std::string, int >	FunctionCategoryMap

Protected Member Functions
virtual bool	eventFilter (QObject , QEvent )

virtual std::string	menuPathToFunctionName (const makVrv::DtMenuPath &) const

virtual void	slot_triggerShortcut (makVrv::DtMenuPath)

virtual void	setKeyMap (makVrv::DtKeyMapManager *, std::string currentMap)

virtual void	manageChangeableMenu (const std::string &menuId)

virtual void	setupChangeableMenus ()

virtual void	preAssembleConfigurableMenu (DtAssembledMenu *)

virtual void	postAssembleConfigurableMenu (DtAssembledMenu *)

virtual int	mapPathToKeymapFunctionCategory (const std::string &path)

virtual void	keyMappingRemoved (makVrv::DtKeyMap *, std::string, makVrv::DtKeyState::KeyType, makVrv::DtKeyEvent::KeyEventType, makVrv::DtKeyState::KeyModifier)

virtual void	keyMappingModified (makVrv::DtKeyMap *, std::string, makVrv::DtKeyState::KeyType, makVrv::DtKeyEvent::KeyEventType, makVrv::DtKeyState::KeyModifier)

virtual void	setupKeyMappingFor (const std::string &path, QAction action, makVrv::DtKeyMap map)

virtual void	resetShortcut (makVrv::DtKeyMap *, std::string)

void	parseTSFile (const QString &file)

virtual void	zoomToExtents ()

Protected Attributes
makVrv::DtDe &	myDe

makVrv::DtSignalConnectionManager	myConnectionManager

FunctionToPathMap	myFunctionToPathMap

PathToFunctionMap	myPathToFunctionMap

FunctionCategoryMap	myFunctionCategories

bool	myApplyChangesToAllKeymaps

std::map< QString, QString >	myReverseMap

bool	mySaveManagersOnChange

std::string	myCurrentKeyMap

Member Typedef Documentation

typedef std::map<std::string, std::string> makVrf::DtVrfMenuKeyMapManager::FunctionToPathMap

protected

typedef std::map<std::string, std::string> makVrf::DtVrfMenuKeyMapManager::PathToFunctionMap

protected

typedef std::map<std::string, int> makVrf::DtVrfMenuKeyMapManager::FunctionCategoryMap

protected

Constructor & Destructor Documentation

makVrf::DtVrfMenuKeyMapManager::DtVrfMenuKeyMapManager ( makVrv::DtDe & )

virtual makVrf::DtVrfMenuKeyMapManager::~DtVrfMenuKeyMapManager ( )

virtual

Member Function Documentation

static DtVrfMenuKeyMapManager& makVrf::DtVrfMenuKeyMapManager::instance ( makVrv::DtDe & de )

static

Returns instance of the manager.

static void makVrf::DtVrfMenuKeyMapManager::registerInstance	(	makVrv::DtDe &	,
		DtVrfMenuKeyMapManager *
	)

static

virtual void makVrf::DtVrfMenuKeyMapManager::setup ( )

virtual

Will setup the key mappings by iterating over the menu configuration and then calling addKeyboardMenuMapping with that path.

virtual void makVrf::DtVrfMenuKeyMapManager::addKeyboardMenuMapping ( const makVrv::DtMenuPath & path )

virtual

Adds a new keyboard mapping for the particular path.

virtual void makVrf::DtVrfMenuKeyMapManager::removeKeyboardMenuMapping ( const makVrv::DtMenuPath & path )

virtual

Removes a keyboard menu map with a particular path.

virtual void makVrf::DtVrfMenuKeyMapManager::setApplyChangesToAllKeymaps ( bool )

virtual

Sets whether or not to apply changes made here to all keymaps. Default is true.

virtual bool makVrf::DtVrfMenuKeyMapManager::applyChangesToAllKeymaps ( ) const

virtual

virtual bool makVrf::DtVrfMenuKeyMapManager::isMenuFunction ( const std::string & func ) const

virtual

Returns true if this keyboard function is a menu function.

virtual QString makVrf::DtVrfMenuKeyMapManager::reverseTranslate ( const QString & ) const

virtual

Reverse the translation to the original english text.

virtual void makVrf::DtVrfMenuKeyMapManager::copyKeyFunction	(	const makVrv::DtMenuPath &	from,
		const makVrv::DtMenuPath &	to
	)

virtual

Copied the keyboard functions from the specied to the specified path.

virtual bool makVrf::DtVrfMenuKeyMapManager::setSaveManagersOnChange ( bool )

virtual

If there are any changes to the key map manager, save them or not. Default is true.

virtual bool makVrf::DtVrfMenuKeyMapManager::saveManagersOnChange ( ) const

virtual

virtual bool makVrf::DtVrfMenuKeyMapManager::eventFilter	(	QObject *	,
		QEvent *
	)

protectedvirtual

This event filter will accept all shortcut events to prevent the Qt system from handling them.

virtual std::string makVrf::DtVrfMenuKeyMapManager::menuPathToFunctionName ( const makVrv::DtMenuPath & ) const

protectedvirtual

Given a menu path returns a function name for that path. If the path is not an item or not found returns empty string.

virtual void makVrf::DtVrfMenuKeyMapManager::slot_triggerShortcut ( makVrv::DtMenuPath )

protectedvirtual

Called when a shortcut is triggered, finds the associated action and triggers it.

virtual void makVrf::DtVrfMenuKeyMapManager::setKeyMap	(	makVrv::DtKeyMapManager *	,
		std::string	currentMap
	)

protectedvirtual

Sets the current key map and looks for function name mappings to map from function to actions to set shortcuts.

virtual void makVrf::DtVrfMenuKeyMapManager::manageChangeableMenu ( const std::string & menuId )

protectedvirtual

Will add a new menu to manage keyboard mappings for. This menu is a menu that is of type DtConfigurableMenu and is expected to change it's menu contents over the lifetime of the application. Once managed it cannot be unmanaged.

virtual void makVrf::DtVrfMenuKeyMapManager::setupChangeableMenus ( )

protectedvirtual

The following menu items are different in that they are created/destroyed via the changing or loading of th scenario, so, they need to be handled differently.

virtual void makVrf::DtVrfMenuKeyMapManager::preAssembleConfigurableMenu ( DtAssembledMenu * )

protectedvirtual

Sent before a configurable menu is assembled. This will remove all old key mapping functions.

virtual void makVrf::DtVrfMenuKeyMapManager::postAssembleConfigurableMenu ( DtAssembledMenu * )

protectedvirtual

Sent after a configurable menu is assembled. This will add all key mapping functions.

virtual int makVrf::DtVrfMenuKeyMapManager::mapPathToKeymapFunctionCategory ( const std::string & path )

protectedvirtual

Maps a path by finding the root menu to a function category. If category does not exist a new map is created.

virtual void makVrf::DtVrfMenuKeyMapManager::keyMappingRemoved	(	makVrv::DtKeyMap *	,
		std::string	,
		makVrv::DtKeyState::KeyType	,
		makVrv::DtKeyEvent::KeyEventType	,
		makVrv::DtKeyState::KeyModifier
	)

protectedvirtual

Received when a key mapping is removed. If action that represents the keymap has a shortcut for that, then set that shortcut to empty.

virtual void makVrf::DtVrfMenuKeyMapManager::keyMappingModified	(	makVrv::DtKeyMap *	,
		std::string	,
		makVrv::DtKeyState::KeyType	,
		makVrv::DtKeyEvent::KeyEventType	,
		makVrv::DtKeyState::KeyModifier
	)

protectedvirtual

Received when a key mapping is modified. If action that represents that function does not have a shortcut already assigned to it, set it to be the shortcut.

virtual void makVrf::DtVrfMenuKeyMapManager::setupKeyMappingFor	(	const std::string &	path,
		QAction *	action,
		makVrv::DtKeyMap *	map
	)

protectedvirtual

Sets up a shortcut for the given action, key map and menu path.

virtual void makVrf::DtVrfMenuKeyMapManager::resetShortcut	(	makVrv::DtKeyMap *	,
		std::string
	)

protectedvirtual

Resets the shortcut for the particular function string changed in the supplied keymap. Will only reset if the key map supplied is the current selected one.

void makVrf::DtVrfMenuKeyMapManager::parseTSFile ( const QString & file )

protected

virtual void makVrf::DtVrfMenuKeyMapManager::zoomToExtents ( )

protectedvirtual

Member Data Documentation

makVrv::DtDe& makVrf::DtVrfMenuKeyMapManager::myDe

protected

makVrv::DtSignalConnectionManager makVrf::DtVrfMenuKeyMapManager::myConnectionManager

protected

FunctionToPathMap makVrf::DtVrfMenuKeyMapManager::myFunctionToPathMap

protected

PathToFunctionMap makVrf::DtVrfMenuKeyMapManager::myPathToFunctionMap

protected

FunctionCategoryMap makVrf::DtVrfMenuKeyMapManager::myFunctionCategories

protected

bool makVrf::DtVrfMenuKeyMapManager::myApplyChangesToAllKeymaps

protected

std::map<QString, QString> makVrf::DtVrfMenuKeyMapManager::myReverseMap

protected

bool makVrf::DtVrfMenuKeyMapManager::mySaveManagersOnChange

protected

std::string makVrf::DtVrfMenuKeyMapManager::myCurrentKeyMap

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfGuiCommonQt/vrfMenuKeyMapManager.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation