CPtiKeyMappings Class Reference

Link against: ptiengine.lib

#include <PtiKeyMappings.h>

Inherits CPtiMappings, and MPtiKeyMappings.

Inherited by CPtiHalfQwertyKeyMappings.

Detailed Description

CPtiKeyMappings.

Keymappings implementation class for itu-t keyboard


Public Member Functions

IMPORT_C ~CPtiKeyMappings ()
virtual 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)
 Continues keymapping sequence.
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)
 DEPRECATED.
static IMPORT_C CPtiKeyMappings * NewL (TInt16 *aData)
 DEPRECATED.
static IMPORT_C CPtiKeyMappings * NewL (CPtiKeyMapData *aData)
 Constructor.

Protected Member Functions

 CPtiKeyMappings ()
 CPtiKeyMappings (CPtiKeyMapData *aData)
TUint16 NextChar (TPtiTextCase aCase)
void KeyCodeToInternal (TPtiKey aKey)
void DeQwertyfyCaseValue (TPtiTextCase &aCase)

Constructor & Destructor Documentation

IMPORT_C CPtiKeyMappings::~CPtiKeyMappings (   ) 
 
CPtiKeyMappings::CPtiKeyMappings (   )  [protected]
 
CPtiKeyMappings::CPtiKeyMappings ( CPtiKeyMapData *  aData  )  [protected]
 

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.

void CPtiKeyMappings::DeQwertyfyCaseValue ( TPtiTextCase &  aCase  )  [inline, protected]
 
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.
Since:
S60 V3.0

Implements MPtiKeyMappings.

Reimplemented in CPtiHalfQwertyKeyMappings.

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

Reimplemented in CPtiHalfQwertyKeyMappings.

void CPtiKeyMappings::KeyCodeToInternal ( TPtiKey  aKey  )  [inline, protected]
 
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.

Reimplemented in CPtiHalfQwertyKeyMappings.

static IMPORT_C CPtiKeyMappings* CPtiKeyMappings::NewL ( CPtiKeyMapData *  aData  )  [static]
 

Constructor.

Reimplemented in CPtiHalfQwertyKeyMappings.

static IMPORT_C CPtiKeyMappings* CPtiKeyMappings::NewL ( TInt16 *  aData  )  [static]
 

DEPRECATED.

Leaves with KErrNotSupported.

static IMPORT_C CPtiKeyMappings* CPtiKeyMappings::NewL ( TDesC &  aData  )  [static]
 

DEPRECATED.

Leaves with KErrNotSupported.

TUint16 CPtiKeyMappings::NextChar ( TPtiTextCase  aCase  )  [protected]
 

Reimplemented in CPtiHalfQwertyKeyMappings.

IMPORT_C TUint16 CPtiKeyMappings::NextKey ( TPtiKey  aKey,
TBool &  aAppend,
TPtiTextCase  aCase
)  [virtual]
 

Continues keymapping sequence.

This method should be called when key event comes in while multitapping timer is active. Takes care of cycling through multitapping candidates associated for given key.

Since:
S60 V2.6
Parameters:
aKey A key to be mapped.
Refernce to boolen variable. This will be set to ETrue if current character in editor should be replaced (new multitapping candidate was found) and to EFalse if new character should inserted instead.
aCase Text case for mapping operation.
Returns:
Next character assosiated to given key or the first character if aKey was different key than previous key press.

Implements MPtiKeyMappings.

Reimplemented in CPtiHalfQwertyKeyMappings.

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.

Reimplemented in CPtiHalfQwertyKeyMappings.

virtual 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.

Reimplemented in CPtiHalfQwertyKeyMappings.

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