CPtiQwertyKeyMappings Class Reference

API published in: S60 3rd Ed

Link against: ptiengine.lib

#include <ptikeymappings.h>

Inherits CPtiMappings, and MPtiKeyMappings.


Public Types
enum �	{ EDeadKeyRootFlag = 0x01, EVowelSeqFlag = 0x02, EPrevKeyInUpperCase = 0x04, ETrackVietnameseToneMarksAndVowels = 0x08 }
�	Public Since 3rd Ed FP1. More...
Public Member Functions
IMPORT_C�	~CPtiQwertyKeyMappings ()
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.
TBool�	DeadKeyRootFlag () const
TUint16�	DeadKeyRootChar () const
TInt�	WriteData (TInt16 *aDest)
TInt�	ChunkDataSize () const
TBool�	VowelSequenceFlag () const
TUint16�	VowelSequenceResult () const
void�	ClearVowelSequence ()
TInt16�	DeadKey () const
void�	ClearDeadKey ()
void�	ClearLastChar ()
�	Public Since 3rd Ed FP1.
void�	SetLastChar (TInt aLastChar)
�	Public Since 3rd Ed FP1.
TInt�	GetLastChar () const
�	Public Since 3rd Ed FP1.
TUint16�	ReplacedCharacter ()
�	Public Since 3rd Ed FP1.
void�	SetLastKey (TPtiKey aKey)
�	Public Since 3rd Ed FP1.
TPtiTextCase�	VowelCase () const
�	Public Since 3rd Ed FP1.
void�	ResetVietnameseVowelSequenceAndToneMarks ()
�	Public Since 3rd Ed FP1.
TPtiKey�	LastKey () const
�	Public Since 3rd Ed FP1.
TPtrC�	GetAll (TPtiTextCase aCase)
�	Returns all keymapping data for current key, excluding first character (which is expected to be "get all"-control character).
void�	SetFlag (TInt aFlag)
�	Public Since 3rd Ed FP1.
void�	ResetFlag (TInt aFlag)
�	Public Since 3rd Ed FP1.
Static Public Member Functions
static IMPORT_C CPtiQwertyKeyMappings *�	NewL (TDesC &aData)
static IMPORT_C CPtiQwertyKeyMappings *�	NewL (TInt16 *aData)

Member Enumeration Documentation

anonymous enum

�

Public Since 3rd Ed FP1.

Enumerator:

EDeadKeyRootFlag�
EVowelSeqFlag�
EPrevKeyInUpperCase�
ETrackVietnameseToneMarksAndVowels�

Constructor & Destructor Documentation

IMPORT_C CPtiQwertyKeyMappings::~CPtiQwertyKeyMappings

(�

�)�

�

Member Function Documentation

TInt CPtiQwertyKeyMappings::ChunkDataSize (� �)� const [virtual]

�	Reimplemented from CPtiMappings.

void CPtiQwertyKeyMappings::ClearDeadKey (� �)� [inline]

�

void CPtiQwertyKeyMappings::ClearLastChar (� �)� [inline]

�	Public Since 3rd Ed FP1.

void CPtiQwertyKeyMappings::ClearVowelSequence (� �)� [inline]

�

TPtiKey CPtiQwertyKeyMappings::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.

TInt16 CPtiQwertyKeyMappings::DeadKey (� �)� const [inline]

�

TUint16 CPtiQwertyKeyMappings::DeadKeyRootChar (� �)� const [inline]

�

TBool CPtiQwertyKeyMappings::DeadKeyRootFlag (� �)� const [inline]

�

TPtrC CPtiQwertyKeyMappings::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 CPtiQwertyKeyMappings::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

TInt CPtiQwertyKeyMappings::GetLastChar (� �)� const [inline]

�	Public Since 3rd Ed FP1.

IMPORT_C TPtiKey CPtiQwertyKeyMappings::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.

TPtiKey CPtiQwertyKeyMappings::LastKey (� �)� const [inline]

�	Public Since 3rd Ed FP1.

static IMPORT_C CPtiQwertyKeyMappings* CPtiQwertyKeyMappings::NewL (� TInt16 *� aData �)� [static]

�

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

�

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

�	Implements MPtiKeyMappings.

TUint16 CPtiQwertyKeyMappings::ReplacedCharacter (� �)� [inline]

�	Public Since 3rd Ed FP1.

IMPORT_C TInt CPtiQwertyKeyMappings::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.

void CPtiQwertyKeyMappings::ResetFlag (� TInt� aFlag �)� [inline]

�	Public Since 3rd Ed FP1.

void CPtiQwertyKeyMappings::ResetVietnameseVowelSequenceAndToneMarks (� �)� [inline]

�	Public Since 3rd Ed FP1.

void CPtiQwertyKeyMappings::SetFlag (� TInt� aFlag �)� [inline]

�	Public Since 3rd Ed FP1.

void CPtiQwertyKeyMappings::SetLastChar (� TInt� aLastChar �)� [inline]

�	Public Since 3rd Ed FP1.

void CPtiQwertyKeyMappings::SetLastKey (� TPtiKey� aKey �)� [inline]

�	Public Since 3rd Ed FP1.

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