CPtiCoreLanguage Class Reference

API published in: S60 3rd Ed

Link against: ptiengine.lib

Capability Information

Required Capabilities

None

#include <ptilanguage.h>

Inherits MPtiLanguage.

Detailed Description

Implementation class for a PtiEngine language.

This class is used mainly in PtiEngine and core objects code and it implements clients side language interface class. PtiEngine maintains language list containing instances of this class. CPtiCoreLanguage class also maintains list of <core <-> input mode> bindings.


Public Member Functions
IMPORT_C  ~CPtiCoreLanguage ()
IMPORT_C void  SetKeyMappings (MPtiKeyMappings *aMappings)
  Sets multitapping keymappings.
IMPORT_C void  SetQwertyKeyMappings (MPtiKeyMappings *aMappings)
  Sets qwerty keymappings.
IMPORT_C void  SetLanguageCode (TInt aCode)
  Sets Symbian OS language code for this language.
IMPORT_C MPtiKeyMappings *  GetKeymappings () const
  Returns pointer to multitapping keymappings object.
IMPORT_C MPtiKeyMappings *  GetQwertyKeymappings () const
  Returns pointer to qwerty keymappings object.
IMPORT_C void  ClearMultitapping ()
  Resets current multitapping keymappings.
IMPORT_C void  ClearQwerty ()
  Resets current qwerty keymappings.
IMPORT_C void  SetLocalizedName (const TDesC &aName)
  Sets localized language name.
IMPORT_C TDes &  LocalizedNameDes ()
  Returns descriptor pointing to localized language name.
IMPORT_C MPtiCore *  GetCore (TPtiEngineInputMode aMode)
  Returns core object for given input mode.
IMPORT_C void  SetCore (MPtiCore *aCore, TPtiEngineInputMode aMode)
  Sets core object for given input mode.
IMPORT_C void  GetAvailableInputModesL (CArrayFix< TInt > *aResult)
  Returns an array of available input modes for this language object.
IMPORT_C void  GetAvailableInputModesL (RArray< TInt > &aResult)
  Returns an array of available input modes for this language object.
IMPORT_C TBool  HasInputMode (TPtiEngineInputMode aMode) const
  Returns a boolean value indicating whether this language supports given input mode.
TInt  LanguageCode () const
  Returns Symbian OS language code for this language object.
TPtrC  LocalizedName () const
  Returns constant descriptor pointing to localized name for this language.
IMPORT_C TBool  HasCore (MPtiCore *aCore) const
  Returns a boolean value indicating whether given core object is already asigned to some input mode for this language.
IMPORT_C void  RemoveCore (MPtiCore *aCore)
  Removes detachs given core object from all input modes it is attached to.
void  SetKeymappingFileIndex (TUint16 aIndex)
void  SetQwertyKeymappingFileIndex (TUint16 aIndex)

Static Public Member Functions
static IMPORT_C CPtiCoreLanguage *  NewL ()

Constructor & Destructor Documentation

IMPORT_C CPtiCoreLanguage::~CPtiCoreLanguage (   ) 
 

Member Function Documentation

IMPORT_C void CPtiCoreLanguage::ClearMultitapping (   ) 
 

Resets current multitapping keymappings.

IMPORT_C void CPtiCoreLanguage::ClearQwerty (   ) 
 

Resets current qwerty keymappings.

IMPORT_C void CPtiCoreLanguage::GetAvailableInputModesL (  RArray< TInt > &  aResult  ) 
 

Returns an array of available input modes for this language object.

Parameters:
aResult  Resulting input mode list.
IMPORT_C void CPtiCoreLanguage::GetAvailableInputModesL (  CArrayFix< TInt > *  aResult  )  [virtual]
 

Returns an array of available input modes for this language object.

Parameters:
aResult  Resulting input mode list.

Implements MPtiLanguage.

IMPORT_C MPtiCore* CPtiCoreLanguage::GetCore (  TPtiEngineInputMode  aMode  ) 
 

Returns core object for given input mode.

Input mode to be queried.

Returns:
Pointer to core object. NULL if no core object is asigned to given input mode.
IMPORT_C MPtiKeyMappings* CPtiCoreLanguage::GetKeymappings (   )  const
 

Returns pointer to multitapping keymappings object.

Returns:
Pointer to current multitapping keymappings. NULL if no multitapping keymappings available.
IMPORT_C MPtiKeyMappings* CPtiCoreLanguage::GetQwertyKeymappings (   )  const
 

Returns pointer to qwerty keymappings object.

Returns:
Pointer to current qwerty keymappings. NULL if no qwerty keymappings available.
IMPORT_C TBool CPtiCoreLanguage::HasCore (  MPtiCore *  aCore  )  const
 

Returns a boolean value indicating whether given core object is already asigned to some input mode for this language.

Parameters:
aCore  A core object to be queried.
Returns:
ETrue if given core object is asigned to any input mode. EFalse otherwise.
IMPORT_C TBool CPtiCoreLanguage::HasInputMode (  TPtiEngineInputMode  aMode  )  const [virtual]
 

Returns a boolean value indicating whether this language supports given input mode.

Parameters:
aMode  Input mode to be queried.
Returns:
ETrue if input mode is supported. EFalse otherwise.

Implements MPtiLanguage.

TInt CPtiCoreLanguage::LanguageCode (   )  const [inline, virtual]
 

Returns Symbian OS language code for this language object.

Returns:
Language code

Implements MPtiLanguage.

TPtrC CPtiCoreLanguage::LocalizedName (   )  const [inline, virtual]
 

Returns constant descriptor pointing to localized name for this language.

Returns:
Localized language name.

Implements MPtiLanguage.

IMPORT_C TDes& CPtiCoreLanguage::LocalizedNameDes (   ) 
 

Returns descriptor pointing to localized language name.

Returns:
Localoized language name descriptor.
static IMPORT_C CPtiCoreLanguage* CPtiCoreLanguage::NewL (   )  [static]
 
IMPORT_C void CPtiCoreLanguage::RemoveCore (  MPtiCore *  aCore  ) 
 

Removes detachs given core object from all input modes it is attached to.

Parameters:
aCore  A core object to be detached.
IMPORT_C void CPtiCoreLanguage::SetCore (  MPtiCore *  aCore,
TPtiEngineInputMode  aMode
) 
 

Sets core object for given input mode.

If input mode already has a core object asigned to it, it will be replaced.

Parameters:
aCore  Pointer to core object
aMode  Input mode for core object.
void CPtiCoreLanguage::SetKeymappingFileIndex (  TUint16  aIndex  ) 
 
IMPORT_C void CPtiCoreLanguage::SetKeyMappings (  MPtiKeyMappings *  aMappings  ) 
 

Sets multitapping keymappings.

Parameters:
aMappings  Pointer to keymappings object to be set.
IMPORT_C void CPtiCoreLanguage::SetLanguageCode (  TInt  aCode  ) 
 

Sets Symbian OS language code for this language.

Parameters:
aCode  Language code to be set.
IMPORT_C void CPtiCoreLanguage::SetLocalizedName (  const TDesC &  aName  ) 
 

Sets localized language name.

Parameters:
aName  Language name to be set.
void CPtiCoreLanguage::SetQwertyKeymappingFileIndex (  TUint16  aIndex  ) 
 
IMPORT_C void CPtiCoreLanguage::SetQwertyKeyMappings (  MPtiKeyMappings *  aMappings  ) 
 

Sets qwerty keymappings.

Parameters:
aMappings  Pointer to keymappings object to be set.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top