CEikHotKeyTable Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib

Capability Information

Required Capabilities

None

#include <eikhkeyt.h>


Public Member Functions
IMPORT_C	CEikHotKeyTable ()
	Default C++ constructor.
IMPORT_C	~CEikHotKeyTable ()
	Destructor.
IMPORT_C TBool	HotKeyFromCommandId (TInt aCommandId, TInt &aKeycode, TInt &aModifiers) const
	Gets the hotkey code and modifier for the specified command ID.
IMPORT_C TInt	CommandIdFromHotKey (TInt aKeycode, TInt aModifiers) const
	Gets the command ID associated with the specified key code and modifier.
IMPORT_C void	AddItemL (TInt aCommandId, TInt aKeycode, TInt aModifiers)
	Adds the specified hotkey to the hotkey array.
IMPORT_C void	RemoveItem (TInt aCommandId)
	Removes the item specified by command ID from the array.
IMPORT_C void	ConstructFromResourceL (TInt aResourceId)
	Constructs an empty array from resource.
IMPORT_C void	Reset ()
	Resets the hotkey array.

Default C++ constructor.

Destructor.

IMPORT_C void CEikHotKeyTable::AddItemL	(	TInt	aCommandId,
		TInt	aKeycode,
		TInt	aModifiers
	)

Adds the specified hotkey to the hotkey array.

Parameters:

	aCommandId	The command associated with the hotkey.
	aKeycode	The key code used to invoke the command.
	aModifiers	Any modifiers used to invoke the command, shift or control for example.

IMPORT_C TInt CEikHotKeyTable::CommandIdFromHotKey	(	TInt	aKeycode,
		TInt	aModifiers
	)	const

Gets the command ID associated with the specified key code and modifier.

Parameters:

	aKeycode	The key code for which the command ID is obtained.
	aModifiers	The key modifier for which the command ID is obtained.

Constructs an empty array from resource.

Parameters:

aResourceId

IMPORT_C TBool CEikHotKeyTable::HotKeyFromCommandId	(	TInt	aCommandId,
		TInt &	aKeycode,
		TInt &	aModifiers
	)	const

Gets the hotkey code and modifier for the specified command ID.

Parameters:

	aCommandId	The ID of the hotkey for which the key code and modifiers are obtained.
`[out]`	aKeycode	On return, the key code for the specified command ID.
`[out]`	aModifiers	On return, the modifier for the specified command ID.