Collapse all Symbian^3 Application Developer Library

MPtiKeyMappings Class Reference

class MPtiKeyMappings

Interface class for PtiEngine keymapping functionality.

Public Member Functions
	~MPtiKeyMappings ()
TPtiKey	CurrentKey ()
TPtrC	GetAll ( TPtiTextCase )
TPtiKey	KeyForCharacter ( TUint16 )
TUint16	NextKey ( TPtiKey , TBool &, TPtiTextCase )
TInt	ReplaceKeyMapL ( TPtiKey , TDesC &, TPtiTextCase )
TUint16	StartMapping ( TPtiKey , TPtiTextCase , TPtiEngineInputMode )

Constructor & Destructor Documentation

~MPtiKeyMappings()

~MPtiKeyMappings

(

)

[inline, virtual]

Member Functions Documentation

CurrentKey()

TPtiKey

CurrentKey

(

)

[pure virtual]

Returns PtiEngine key code for last StartMapping() call.

Since: 2.6

GetAll(TPtiTextCase)

TPtrC

GetAll

(

TPtiTextCase

aCase

)

[pure virtual]

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

Since: 3.0

Parameters

TPtiTextCase aCase

Text case for which data will be returned.

KeyForCharacter(TUint16)

TPtiKey

KeyForCharacter

(

TUint16

aChar

)

[pure virtual]

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

Since: 2.6

Parameters

TUint16 aChar

A character to be queried.

NextKey(TPtiKey, TBool &, TPtiTextCase)

TUint16	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

TPtiKey aKey	A key to be mapped.
TBool & 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.
TPtiTextCase aCase	Text case for mapping operation.

ReplaceKeyMapL(TPtiKey, TDesC &, TPtiTextCase)

TInt	ReplaceKeyMapL	(	TPtiKey	aKey,
			TDesC &	aMap,
			TPtiTextCase	aCase
		)	[pure virtual]

Replaces keymapping data for given key and case.

Since: 2.6

Parameters

TPtiKey aKey	A key to be replaced.
TDesC & aMap	New keymapping data for aKey,
TPtiTextCase aCase	Text case for replaced data.

StartMapping(TPtiKey, TPtiTextCase, TPtiEngineInputMode)

TUint16	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

TPtiKey aKey	A key to be mapped.
TPtiTextCase aCase	Text case for mapping operation.
TPtiEngineInputMode aMode = EPtiEngineInputModeNone	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.