CPtiQwertyKeyMappings Class Reference

Link against: ptiengine.lib

#include <PtiKeyMappings.h>

Inherits CPtiMappings, and MPtiKeyMappings.

Detailed Description

CPtiQwertyKeyMappings.

Keymappings implementation class for qwerty keyboard.


Public Types
enum   { EDeadKeyRootFlag = 0x01, EVowelSeqFlag = 0x02, EPrevKeyInUpperCase = 0x04, ETrackVietnameseToneMarksAndVowels = 0x08 }

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)
  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.
TInt  WriteData (TInt16 *aDest)
  DEPRECATED.
TInt  ChunkDataSize () const
  DEPRECATED.
TBool  DeadKeyRootFlag () const
  Internal.
TUint16  DeadKeyRootChar () const
  Internal.
TBool  VowelSequenceFlag () const
  Internal.
TUint16  VowelSequenceResult () const
  Internal.
void  ClearVowelSequence ()
  Internal.
TInt16  DeadKey () const
  Internal.
void  ClearDeadKey ()
  Internal.
void  ClearLastChar ()
  Internal.
void  SetLastChar (TInt aLastChar)
  Internal.
TInt  GetLastChar () const
  Internal.
TUint16  ReplacedCharacter ()
  Internal.
void  SetLastKey (TPtiKey aKey)
  Internal.
TPtiTextCase  VowelCase () const
  Internal.
void  ResetVietnameseVowelSequenceAndToneMarks ()
  Internal.
TPtiKey  LastKey () const
  Internal.
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)
  Internal.
void  ResetFlag (TInt aFlag)
  Internal.
void  GetNumericModeKeysFromDataL (RArray< TPtiNumericKeyBinding > &aResult)
  Fills given array with numeric mode mappings defined in keymap data file.
IMPORT_C TInt  SetKeyboardType (TPtiKeyboardType aKeyboardType)
  Set keyboard type to be used with qwerty keymappings.
IMPORT_C TBool  HasDataBlockForKeyboardType (TPtiKeyboardType aKeyboardType) const
  Returns a boolean value indicating whether there is data block available for given keyboard type.

Static Public Member Functions
static IMPORT_C CPtiQwertyKeyMappings *  NewL (TDesC &aData)
  DEPRECATED.
static IMPORT_C CPtiQwertyKeyMappings *  NewL (TInt16 *aData)
  DEPRECATED.
static IMPORT_C CPtiQwertyKeyMappings *  NewL (CPtiKeyMapData *aData)
  Constructor.

Member Enumeration Documentation

anonymous enum
 
Enumerator:
EDeadKeyRootFlag 
EVowelSeqFlag 
EPrevKeyInUpperCase 
ETrackVietnameseToneMarksAndVowels 

Constructor & Destructor Documentation

IMPORT_C CPtiQwertyKeyMappings::~CPtiQwertyKeyMappings (   ) 
 

Member Function Documentation

TInt CPtiQwertyKeyMappings::ChunkDataSize (   )  const [virtual]
 

DEPRECATED.

Reimplemented from CPtiMappings.

void CPtiQwertyKeyMappings::ClearDeadKey (   )  [inline]
 

Internal.

void CPtiQwertyKeyMappings::ClearLastChar (   )  [inline]
 

Internal.

void CPtiQwertyKeyMappings::ClearVowelSequence (   )  [inline]
 

Internal.

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]
 

Internal.

TUint16 CPtiQwertyKeyMappings::DeadKeyRootChar (   )  const [inline]
 

Internal.

TBool CPtiQwertyKeyMappings::DeadKeyRootFlag (   )  const [inline]
 

Internal.

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.
Since:
S60 V3.0

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]
 

Internal.

void CPtiQwertyKeyMappings::GetNumericModeKeysFromDataL (  RArray< TPtiNumericKeyBinding > &  aResult  ) 
 

Fills given array with numeric mode mappings defined in keymap data file.

Resultin array contains those mappings that are given with "numeric_mode_key" tag in keymap data file.

Since:
S60 V3.2
Parameters:
aResult  An array to be filled with numeric mode mappings.
IMPORT_C TBool CPtiQwertyKeyMappings::HasDataBlockForKeyboardType (  TPtiKeyboardType  aKeyboardType  )  const
 

Returns a boolean value indicating whether there is data block available for given keyboard type.

Parameters:
aKeyboardType  Keyboard type.
Returns:
ETrue if there is data block for given keyboard type. EFalse otherwise
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]
 

Internal.

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

Constructor.

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

DEPRECATED.

Will leave with KErrNotSupported.

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

DEPRECATED.

Will leave with KErrNotSupported.

IMPORT_C TUint16 CPtiQwertyKeyMappings::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.
aAppend  Refernce to boolen variable. This will be set to ETrue if current character in editor should be replaced (new chr-case character 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.

TUint16 CPtiQwertyKeyMappings::ReplacedCharacter (   )  [inline]
 

Internal.

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]
 

Internal.

void CPtiQwertyKeyMappings::ResetVietnameseVowelSequenceAndToneMarks (   )  [inline]
 

Internal.

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

Internal.

IMPORT_C TInt CPtiQwertyKeyMappings::SetKeyboardType (  TPtiKeyboardType  aKeyboardType  ) 
 

Set keyboard type to be used with qwerty keymappings.

Default type is EPtiKeyboardStandard4x12 (Nokia E70 style).

Parameters:
aKeyboardType  Keyboard type to be set.
Returns:
KErrNone if keyboard type was set. EErrNotSupported if mapping data does not have block for given keyboard type.
void CPtiQwertyKeyMappings::SetLastChar (  TInt  aLastChar  )  [inline]
 

Internal.

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

Internal.

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

TPtiTextCase CPtiQwertyKeyMappings::VowelCase (   )  const [inline]
 

Internal.

TBool CPtiQwertyKeyMappings::VowelSequenceFlag (   )  const [inline]
 

Internal.

TUint16 CPtiQwertyKeyMappings::VowelSequenceResult (   )  const [inline]
 

Internal.

TInt CPtiQwertyKeyMappings::WriteData (  TInt16 *  aDest  )  [virtual]
 

DEPRECATED.

Reimplemented from CPtiMappings.

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