CPtiKeyMappings Class Reference

API published in: S60 3rd Ed

Link against: ptiengine.lib

Capability Information

Required Capabilities

None

#include <ptikeymappings.h>

Inherits CPtiMappings, and MPtiKeyMappings.


Public Member Functions

IMPORT_C ~CPtiKeyMappings ()
IMPORT_C TUint16 StartMapping (TPtiKey aKey, TPtiTextCase aCase, TPtiEngineInputMode aMode=EPtiEngineInputModeNone)
 Start mapping for given key.
IMPORT_C TUint16 NextKey (TPtiKey aKey, TBool &aAppend, TPtiTextCase aCase)
TPtiKey CurrentKey ()
 Returns key code for key currently being mapped (relates to StartMapping and NextKey).
IMPORT_C TInt ReplaceKeyMapL (TPtiKey aKey, TDesC &aMap, TPtiTextCase aCase)
 Replaces keymapping data for given key.
IMPORT_C TPtiKey KeyForCharacter (TUint16 aChar)
 Scans through keymapping data and returns key code for given character.
IMPORT_C void GetDataForKey (TPtiKey aKey, TDes &aResult, TPtiTextCase aCase)
 Returns keymapping data for given key.
TPtrC GetAll (TPtiTextCase aCase)
 Returns all keymapping data for current key, excluding first character (which is expected to be "get all"-control character).

Static Public Member Functions

static IMPORT_C CPtiKeyMappings * NewL (TDesC &aData)
static IMPORT_C CPtiKeyMappings * NewL (TInt16 *aData)

Constructor & Destructor Documentation

IMPORT_C CPtiKeyMappings::~CPtiKeyMappings (   ) 
 

Member Function Documentation

TPtiKey CPtiKeyMappings::CurrentKey (   )  [inline, virtual]
 

Returns key code for key currently being mapped (relates to StartMapping and NextKey).

Returns:
Key code for key currently being mapped.

Implements MPtiKeyMappings.

TPtrC CPtiKeyMappings::GetAll ( TPtiTextCase  aCase  )  [virtual]
 

Returns all keymapping data for current key, excluding first character (which is expected to be "get all"-control character).

Parameters:
aCase Text case for which data will be returned.
Returns:
Constant descriptor pointing to keymap data.

Implements MPtiKeyMappings.

IMPORT_C void CPtiKeyMappings::GetDataForKey ( TPtiKey  aKey,
TDes &  aResult,
TPtiTextCase  aCase
) 
 

Returns keymapping data for given key.

Parameters:
aKey A key to be queried.
aResult Descritor where resulting data is stored.
aCase Text case
IMPORT_C TPtiKey CPtiKeyMappings::KeyForCharacter ( TUint16  aChar  )  [virtual]
 

Scans through keymapping data and returns key code for given character.

Parameters:
aChar A character to be queried.
Returns:
Key code for mtaching key. EPtiKeyNone if no matching keys found.

Implements MPtiKeyMappings.

static IMPORT_C CPtiKeyMappings* CPtiKeyMappings::NewL ( TInt16 *  aData  )  [static]
 
static IMPORT_C CPtiKeyMappings* CPtiKeyMappings::NewL ( TDesC &  aData  )  [static]
 
IMPORT_C TUint16 CPtiKeyMappings::NextKey ( TPtiKey  aKey,
TBool &  aAppend,
TPtiTextCase  aCase
)  [virtual]
 

Implements MPtiKeyMappings.

IMPORT_C TInt CPtiKeyMappings::ReplaceKeyMapL ( TPtiKey  aKey,
TDesC &  aMap,
TPtiTextCase  aCase
)  [virtual]
 

Replaces keymapping data for given key.

Parameters:
aKey Key code for key to be replaced.
aMap New keymapping data for aKey.
aCase Text case.
Returns:
KErrNone if succesfull Otherwise system wide error code.

Implements MPtiKeyMappings.

IMPORT_C TUint16 CPtiKeyMappings::StartMapping ( TPtiKey  aKey,
TPtiTextCase  aCase,
TPtiEngineInputMode  aMode = EPtiEngineInputModeNone
)  [virtual]
 

Start mapping for given key.

Parameters:
aKey Key code for key.
aCase Cuurrent text case.
aMode Current input mode. Default value works for most cases.
Returns:
First character for given key.

Implements MPtiKeyMappings.

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