Collapse all Symbian^3 Product Developer Library

CPtiCoreLanguage Class Reference

class CPtiCoreLanguage : public CBase

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.

Inherits from

CPtiCoreLanguage
- CBase

Public Member Functions
	~CPtiCoreLanguage()
IMPORT_C void	ClearHalfQwerty()
IMPORT_C void	ClearMultitapping()
IMPORT_C void	ClearQwerty()
IMPORT_C CPtiKeyMapDataFactory *	DataFactory()
IMPORT_C void	GetAvailableInputModesL(CArrayFix< TInt > *)
IMPORT_C void	GetAvailableInputModesL(RArray< TInt > &)
IMPORT_C MPtiCore *	GetCore(TPtiEngineInputMode)
IMPORT_C MPtiKeyMappings *	GetHalfQwertyKeymappings()
IMPORT_C MPtiKeyMappings *	GetKeymappings()
IMPORT_C MPtiKeyMappings *	GetQwertyKeymappings()
IMPORT_C TBool	HasCore(MPtiCore *)
IMPORT_C TBool	HasInputMode(TPtiEngineInputMode)
TInt	LanguageCode()
TPtrC	LocalizedName()
IMPORT_C TDes &	LocalizedNameDes()
IMPORT_C CPtiCoreLanguage *	NewL()
IMPORT_C CPtiKeyMapData *	RawKeyMapData()
IMPORT_C void	RemoveCore(MPtiCore *)
IMPORT_C void	SetCore(MPtiCore *, TPtiEngineInputMode)
IMPORT_C void	SetHalfQwertyKeyMappings(MPtiKeyMappings *)
void	SetKeyMapDataFactory(CPtiKeyMapDataFactory *)
IMPORT_C void	SetKeyMappings(MPtiKeyMappings *)
IMPORT_C void	SetLanguageCode(TInt)
IMPORT_C void	SetLocalizedName(const TDesC &)
IMPORT_C void	SetQwertyKeyMappings(MPtiKeyMappings *)

Private Member Functions
	CPtiCoreLanguage()
void	Clear()
void	ConstructL()
CPtiCore *	GetCoreForNumericMode()
void	LoadKeymappingsL()
void	SetCoreLocal(MPtiCore *, TPtiEngineInputMode)

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()

Private Attributes
RArray< TPtiCoreBinding >	iCores
CPtiKeyMapDataFactory *	iDataFactory
TPtiKeyMappingsHolder *	iHolder
CPtiKeyMapData *	iKeyMapData
TInt	iLanguageCode
TBuf< KMaxLanguageNameLength >	iLocalizedName

Constructor & Destructor Documentation

CPtiCoreLanguage()

CPtiCoreLanguage

(

)

[private]

~CPtiCoreLanguage()

IMPORT_C

~CPtiCoreLanguage

(

)

Member Functions Documentation

Clear()

void

Clear

(

)

[private]

ClearHalfQwerty()

IMPORT_C void

ClearHalfQwerty

(

)

Resets current half qwerty keymappings.

ClearMultitapping()

IMPORT_C void

ClearMultitapping

(

)

Resets current multitapping keymappings.

ClearQwerty()

IMPORT_C void

ClearQwerty

(

)

Resets current qwerty keymappings.

ConstructL()

void

ConstructL

(

)

[private]

DataFactory()

IMPORT_C CPtiKeyMapDataFactory *

DataFactory

(

)

const

Returns active data factory.

Since: S60 5.0

GetAvailableInputModesL(CArrayFix< TInt > *)

IMPORT_C void

GetAvailableInputModesL

(

CArrayFix< TInt > *

aResult

)

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

Parameters

CArrayFix< TInt > * aResult

Resulting input mode list.

GetAvailableInputModesL(RArray< TInt > &)

IMPORT_C void

GetAvailableInputModesL

(

RArray< TInt > &

aResult

)

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

Since: 3.0

Parameters

RArray< TInt > & aResult

Resulting input mode list.

GetCore(TPtiEngineInputMode)

IMPORT_C MPtiCore *

GetCore

(

TPtiEngineInputMode

aMode

)

Returns core object for given input mode.

Input mode to be queried.

Parameters

TPtiEngineInputMode aMode

GetCoreForNumericMode()

CPtiCore *

GetCoreForNumericMode

(

)

const [private]

GetHalfQwertyKeymappings()

IMPORT_C MPtiKeyMappings *

GetHalfQwertyKeymappings

(

)

const

Returns pointer to half qwerty keymappings object.

GetKeymappings()

IMPORT_C MPtiKeyMappings *

GetKeymappings

(

)

const

Returns pointer to multitapping keymappings object.

GetQwertyKeymappings()

IMPORT_C MPtiKeyMappings *

GetQwertyKeymappings

(

)

const

Returns pointer to qwerty keymappings object.

HasCore(MPtiCore *)

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.

Parameters

MPtiCore * aCore

A core object to be queried.

HasInputMode(TPtiEngineInputMode)

IMPORT_C TBool

HasInputMode

(

TPtiEngineInputMode

aMode

)

const

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

Parameters

TPtiEngineInputMode aMode

Input mode to be queried.

LanguageCode()

TInt

LanguageCode

(

)

const [inline]

Returns Symbian OS language code for this language object.

LoadKeymappingsL()

void

LoadKeymappingsL

(

)

const [private]

LocalizedName()

TPtrC

LocalizedName

(

)

const [inline]

Returns constant descriptor pointing to localized name for this language.

LocalizedNameDes()

IMPORT_C TDes &

LocalizedNameDes

(

)

Returns descriptor pointing to localized language name.

NewL()

IMPORT_C CPtiCoreLanguage *

NewL

(

)

[static]

RawKeyMapData()

IMPORT_C CPtiKeyMapData *

RawKeyMapData

(

)

const

Returns raw keymap data object.

Since: S60 5.0

RemoveCore(MPtiCore *)

IMPORT_C void

RemoveCore

(

MPtiCore *

aCore

)

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

Parameters

MPtiCore * aCore

A core object to be detached.

SetCore(MPtiCore *, TPtiEngineInputMode)

IMPORT_C void	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

MPtiCore * aCore	Pointer to core object
TPtiEngineInputMode aMode	Input mode for core object.

SetCoreLocal(MPtiCore *, TPtiEngineInputMode)

void	SetCoreLocal	(	MPtiCore *	aCore,
			TPtiEngineInputMode	aMode
		)	const [private]

Parameters

MPtiCore * aCore
TPtiEngineInputMode aMode

SetHalfQwertyKeyMappings(MPtiKeyMappings *)

IMPORT_C void

SetHalfQwertyKeyMappings

(

MPtiKeyMappings *

aMappings

)

Sets half qwerty keymappings.

Parameters

MPtiKeyMappings * aMappings

Pointer to keymappings object to be set.

SetKeyMapDataFactory(CPtiKeyMapDataFactory *)

void

SetKeyMapDataFactory

(

CPtiKeyMapDataFactory *

aFactory

)

Sets keymap data factory class.

Since: S60 5.0

Parameters

CPtiKeyMapDataFactory * aFactory

A keymap data factory to be used.

SetKeyMappings(MPtiKeyMappings *)

IMPORT_C void

SetKeyMappings

(

MPtiKeyMappings *

aMappings

)

Sets multitapping keymappings.

Parameters

MPtiKeyMappings * aMappings

Pointer to keymappings object to be set.

SetLanguageCode(TInt)

IMPORT_C void

SetLanguageCode

(

TInt

aCode

)

Sets Symbian OS language code for this language.

Parameters

TInt aCode

Language code to be set.

SetLocalizedName(const TDesC &)

IMPORT_C void

SetLocalizedName

(

const TDesC &

aName

)

Sets localized language name.

Parameters

const TDesC & aName

Language name to be set.

SetQwertyKeyMappings(MPtiKeyMappings *)

IMPORT_C void

SetQwertyKeyMappings

(

MPtiKeyMappings *

aMappings

)

Sets qwerty keymappings.

Parameters

MPtiKeyMappings * aMappings

Pointer to keymappings object to be set.

Member Data Documentation

RArray< TPtiCoreBinding > iCores

RArray< TPtiCoreBinding >

iCores

[private]

CPtiKeyMapDataFactory * iDataFactory

CPtiKeyMapDataFactory *

iDataFactory

[private]

TPtiKeyMappingsHolder * iHolder

TPtiKeyMappingsHolder *

iHolder

[private]

CPtiKeyMapData * iKeyMapData

CPtiKeyMapData *

iKeyMapData

[private]

TInt iLanguageCode

TInt

iLanguageCode

[private]

TBuf< KMaxLanguageNameLength > iLocalizedName

TBuf< KMaxLanguageNameLength >

iLocalizedName

[private]