MPtiKeyMappings Class Reference

Link against: ptiengine.lib


#include <
PtiKeyMappings.h>

Inherited by CPtiKeyMappings, and CPtiQwertyKeyMappings.


Detailed Description

MPtiKeyMappings.

Interface class for PtiEngine keymapping functionality.


Public Member Functions

virtual ~MPtiKeyMappings ()
virtual TUint16 StartMapping (TPtiKey aKey, TPtiTextCase aCase, TPtiEngineInputMode aMode=EPtiEngineInputModeNone)=0
 Starts mapping new key.
virtual TUint16 NextKey (TPtiKey aKey, TBool &aAppend, TPtiTextCase aCase)=0
 Continues keymapping sequence.
virtual TPtiKey CurrentKey ()=0
 Returns PtiEngine key code for last StartMapping() call.
virtual TInt ReplaceKeyMapL (TPtiKey aKey, TDesC &aMap, TPtiTextCase aCase)=0
 Replaces keymapping data for given key and case.
virtual TPtiKey KeyForCharacter (TUint16 aChar)=0
 Returns key code for key which produces given unicode character (if found).
virtual TPtrC GetAll (TPtiTextCase aCase)=0
 Returns all keymapping data for current key, excluding first character (which is expected to be "get all"-control character).

Constructor & Destructor Documentation

virtual MPtiKeyMappings::~MPtiKeyMappings  )  [inline, virtual]
 

Member Function Documentation

virtual TPtiKey MPtiKeyMappings::CurrentKey  )  [pure virtual]
 

Returns PtiEngine key code for last StartMapping() call.

Since:
2.6
Returns:
PtiEngine key code for last StartMapping() call.

Implemented in CPtiKeyMappings, and CPtiQwertyKeyMappings.

virtual TPtrC MPtiKeyMappings::GetAll TPtiTextCase  aCase  )  [pure 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:
3.0

Implemented in CPtiKeyMappings, CPtiQwertyKeyMappings, and CPtiHalfQwertyKeyMappings.

virtual TPtiKey MPtiKeyMappings::KeyForCharacter TUint16  aChar  )  [pure virtual]
 

Returns key code for key which produces given unicode character (if found).

Since:
2.6
Parameters:
aChar A character to be queried.
Returns:
Key code for aChar. EPtiKeyNone, if not found.

Implemented in CPtiKeyMappings, CPtiQwertyKeyMappings, and CPtiHalfQwertyKeyMappings.

virtual TUint16 MPtiKeyMappings::NextKey TPtiKey  aKey,
TBool &  aAppend,
TPtiTextCase  aCase
[pure 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:
2.6
Parameters:
aKey A key to be mapped.
aAppend 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.

Implemented in CPtiKeyMappings, CPtiQwertyKeyMappings, and CPtiHalfQwertyKeyMappings.

virtual TInt MPtiKeyMappings::ReplaceKeyMapL TPtiKey  aKey,
TDesC &  aMap,
TPtiTextCase  aCase
[pure virtual]
 

Replaces keymapping data for given key and case.

Since:
2.6
Parameters:
aKey A key to be replaced.
aMap New keymapping data for aKey,
aCase Text case for replaced data.
Returns:
KErrNone or system wide error code.

Implemented in CPtiKeyMappings, CPtiQwertyKeyMappings, and CPtiHalfQwertyKeyMappings.

virtual TUint16 MPtiKeyMappings::StartMapping TPtiKey  aKey,
TPtiTextCase  aCase,
TPtiEngineInputMode  aMode = EPtiEngineInputModeNone
[pure virtual]
 

Starts mapping new key.

Will return first character bound to given key in given text case.

Parameters:
aKey A key to be mapped.
aCase Text case for mapping operation.
aMode Input mode for mapping. This is needed if keymapping data contains characters for several input modes (used mainly with Chinese modes). This value will be matched to possible input mode control characters in keymapping data.
Returns:
First character bound to requested key.

Implemented in CPtiKeyMappings, CPtiQwertyKeyMappings, and CPtiHalfQwertyKeyMappings.


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

Copyright © Nokia Corporation 2001-2007
Back to top