MPtiKeyMappings Class Reference

API published in: S60 3rd Ed

Link against: ptiengine.lib

Capability Information

Required Capabilities

None

#include <ptikeymappings.h>


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
virtual TPtiKey	CurrentKey ()=0
virtual TInt	ReplaceKeyMapL (TPtiKey aKey, TDesC &aMap, TPtiTextCase aCase)=0
virtual TPtiKey	KeyForCharacter (TUint16 aChar)=0
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).

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

virtual TPtiKey MPtiKeyMappings::CurrentKey ( ) [pure virtual]

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

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

virtual TUint16 MPtiKeyMappings::NextKey	(	TPtiKey	aKey,
		TBool &	aAppend,
		TPtiTextCase	aCase
	)	`[pure virtual]`

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

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