CEikHotKeyTable Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib

Capability Information

Required Capabilities

None

#include <eikhkeyt.h>

Detailed Description

An array for hotkey commands and their associated key codes and modifiers.

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.

Constructor & Destructor Documentation

IMPORT_C CEikHotKeyTable::CEikHotKeyTable (   ) 
 

Default C++ constructor.

IMPORT_C CEikHotKeyTable::~CEikHotKeyTable (   ) 
 

Destructor.

Member Function Documentation

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.
Leave:
KErrNotSupported If the specified modifier is not supported
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.
Returns:
The command ID for the specified key code and modifier.
IMPORT_C void CEikHotKeyTable::ConstructFromResourceL (  TInt  aResourceId  ) 
 

Constructs an empty array from resource.

Parameters:
aResourceId  The ID if the resource reader to use to construct the array.
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.
Returns:
ETrue if the hotkey exists, EFalse otherwise
IMPORT_C void CEikHotKeyTable::RemoveItem (  TInt  aCommandId  ) 
 

Removes the item specified by command ID from the array.

Parameters:
aCommandId  The ID of the item to remove.
Panic:
EIKCOCTL-7 If the array contains no hotkeys.
IMPORT_C void CEikHotKeyTable::Reset (   ) 
 

Resets the hotkey array.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top