CPtiCoreLanguage Class Reference

#include <mw/PtiLanguage.h>

Link against: PtiEngine.lib

class CPtiCoreLanguage : public CBase

Inherits from

  • CPtiCoreLanguage
    Public Member Functions
    ~CPtiCoreLanguage()
    IMPORT_C voidClearHalfQwerty()
    IMPORT_C voidClearMultitapping()
    IMPORT_C voidClearQwerty()
    IMPORT_C CPtiKeyMapDataFactory *DataFactory()
    IMPORT_C voidGetAvailableInputModesL(CArrayFix< TInt > *)
    IMPORT_C voidGetAvailableInputModesL(RArray< TInt > &)
    IMPORT_C MPtiCore *GetCore(TPtiEngineInputMode)
    IMPORT_C MPtiKeyMappings *GetHalfQwertyKeymappings()
    IMPORT_C MPtiKeyMappings *GetKeymappings()
    IMPORT_C MPtiKeyMappings *GetQwertyKeymappings()
    IMPORT_C TBoolHasCore(MPtiCore *)
    IMPORT_C TBoolHasInputMode(TPtiEngineInputMode)
    TInt LanguageCode()
    TPtrC LocalizedName()
    IMPORT_C TDes &LocalizedNameDes()
    IMPORT_C CPtiCoreLanguage *NewL()
    IMPORT_C CPtiKeyMapData *RawKeyMapData()
    IMPORT_C voidRemoveCore(MPtiCore *)
    IMPORT_C voidSetCore(MPtiCore *, TPtiEngineInputMode)
    IMPORT_C voidSetHalfQwertyKeyMappings(MPtiKeyMappings *)
    voidSetKeyMapDataFactory(CPtiKeyMapDataFactory *)
    IMPORT_C voidSetKeyMappings(MPtiKeyMappings *)
    IMPORT_C voidSetLanguageCode(TInt)
    IMPORT_C voidSetLocalizedName(const TDesC &)
    IMPORT_C voidSetQwertyKeyMappings(MPtiKeyMappings *)
    Inherited Functions
    CBase::CBase()
    CBase::Delete(CBase *)
    CBase::Extension_(TUint,TAny *&,TAny *)
    CBase::operator new(TUint)
    CBase::operator new(TUint,TAny *)
    CBase::operator new(TUint,TLeave)
    CBase::operator new(TUint,TLeave,TUint)
    CBase::operator new(TUint,TUint)
    CBase::~CBase()

    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.

    Constructor & Destructor Documentation

    ~CPtiCoreLanguage ( )

    IMPORT_C~CPtiCoreLanguage()

    Member Function Documentation

    ClearHalfQwerty ( )

    IMPORT_C voidClearHalfQwerty()

    Resets current half qwerty keymappings.

    ClearMultitapping ( )

    IMPORT_C voidClearMultitapping()

    Resets current multitapping keymappings.

    ClearQwerty ( )

    IMPORT_C voidClearQwerty()

    Resets current qwerty keymappings.

    DataFactory ( )

    IMPORT_C CPtiKeyMapDataFactory *DataFactory()const

    Returns active data factory.

    Since
    S60 5.0

    Returns: A pointer to active data factory.

    GetAvailableInputModesL ( CArrayFix< TInt > * )

    IMPORT_C voidGetAvailableInputModesL(CArrayFix< TInt > *aResult)

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

    ParameterDescription
    aResultResulting input mode list.

    GetAvailableInputModesL ( RArray< TInt > & )

    IMPORT_C voidGetAvailableInputModesL(RArray< TInt > &aResult)

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

    Since
    3.0
    ParameterDescription
    aResultResulting input mode list.

    GetCore ( TPtiEngineInputMode )

    IMPORT_C MPtiCore *GetCore(TPtiEngineInputModeaMode)

    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.

    GetHalfQwertyKeymappings ( )

    IMPORT_C MPtiKeyMappings *GetHalfQwertyKeymappings()const

    Returns pointer to half qwerty keymappings object.

    Returns: Pointer to half qwerty keymappings. NULL if no half qwerty keymappings available.

    GetKeymappings ( )

    IMPORT_C MPtiKeyMappings *GetKeymappings()const

    Returns pointer to multitapping keymappings object.

    Returns: Pointer to current multitapping keymappings. NULL if no multitapping keymappings available.

    GetQwertyKeymappings ( )

    IMPORT_C MPtiKeyMappings *GetQwertyKeymappings()const

    Returns pointer to qwerty keymappings object.

    Returns: Pointer to current qwerty keymappings. NULL if no qwerty keymappings available.

    HasCore ( MPtiCore * )

    IMPORT_C TBoolHasCore(MPtiCore *aCore)const

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

    ParameterDescription
    aCoreA core object to be queried.

    Returns: ETrue if given core object is asigned to any input mode. EFalse otherwise.

    HasInputMode ( TPtiEngineInputMode )

    IMPORT_C TBoolHasInputMode(TPtiEngineInputModeaMode)const

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

    ParameterDescription
    aModeInput mode to be queried.

    Returns: ETrue if input mode is supported. EFalse otherwise.

    LanguageCode ( )

    TInt LanguageCode()const [inline]

    Returns Symbian OS language code for this language object.

    Returns: Language code

    LocalizedName ( )

    TPtrC LocalizedName()const [inline]

    Returns constant descriptor pointing to localized name for this language.

    Returns: Localized language name.

    LocalizedNameDes ( )

    IMPORT_C TDes &LocalizedNameDes()

    Returns descriptor pointing to localized language name.

    Returns: Localoized language name descriptor.

    NewL ( )

    IMPORT_C CPtiCoreLanguage *NewL()[static]

    RawKeyMapData ( )

    IMPORT_C CPtiKeyMapData *RawKeyMapData()const

    Returns raw keymap data object.

    Since
    S60 5.0

    Returns: A pointer to raw keymap data object.

    RemoveCore ( MPtiCore * )

    IMPORT_C voidRemoveCore(MPtiCore *aCore)

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

    ParameterDescription
    aCoreA core object to be detached.

    SetCore ( MPtiCore *, TPtiEngineInputMode )

    IMPORT_C voidSetCore(MPtiCore *aCore,
    TPtiEngineInputModeaMode
    )

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

    ParameterDescription
    aCorePointer to core object
    aModeInput mode for core object.

    SetHalfQwertyKeyMappings ( MPtiKeyMappings * )

    IMPORT_C voidSetHalfQwertyKeyMappings(MPtiKeyMappings *aMappings)

    Sets half qwerty keymappings.

    ParameterDescription
    aMappingsPointer to keymappings object to be set.

    SetKeyMapDataFactory ( CPtiKeyMapDataFactory * )

    voidSetKeyMapDataFactory(CPtiKeyMapDataFactory *aFactory)

    Sets keymap data factory class.

    Since
    S60 5.0
    ParameterDescription
    aFactoryA keymap data factory to be used.

    SetKeyMappings ( MPtiKeyMappings * )

    IMPORT_C voidSetKeyMappings(MPtiKeyMappings *aMappings)

    Sets multitapping keymappings.

    ParameterDescription
    aMappingsPointer to keymappings object to be set.

    SetLanguageCode ( TInt )

    IMPORT_C voidSetLanguageCode(TIntaCode)

    Sets Symbian OS language code for this language.

    ParameterDescription
    aCodeLanguage code to be set.

    SetLocalizedName ( const TDesC & )

    IMPORT_C voidSetLocalizedName(const TDesC &aName)

    Sets localized language name.

    ParameterDescription
    aNameLanguage name to be set.

    SetQwertyKeyMappings ( MPtiKeyMappings * )

    IMPORT_C voidSetQwertyKeyMappings(MPtiKeyMappings *aMappings)

    Sets qwerty keymappings.

    ParameterDescription
    aMappingsPointer to keymappings object to be set.
    © Nokia 2011.