Symbian^3 Application Developer Library >

CPtiCore Class Reference

class CPtiCore : public CBase

This class is a base class implementation for MPtiCore . It contains empty base implemenations for core API methods and static methods for creating and listing PtiEngine core objects.

Inherits from

Public Member Functions
~CPtiCore ()
IMPORT_C TInt AddUserDictionaryEntry ( MPtiUserDictionaryEntry &, CPtiUserDictionary *)
IMPORT_C TInt AttachUserDictionary ( CPtiUserDictionary *)
IMPORT_C TInt CommitCurrentWord ()
IMPORT_C MPtiEngineCompositionDataInterface * CompositionData ()
IMPORT_C TInt Convert ( TPtiCharConversion , TAny *, TInt , TAny *)
IMPORT_C CPtiCore * CreateCoreL ( TUid )
IMPORT_C CPtiUserDictionary * CreateEmptyUserDictionaryL ( TInt )
IMPORT_C TBool DetachUserDictionary ( CPtiUserDictionary *)
IMPORT_C TInt GetCandidateListL ( CDesCArray &)
IMPORT_C TPtrC GetCandidatePage ()
IMPORT_C HBufC * GetCandidatesByInputString (const TDesC &, RPointerArray < HBufC > &, const TBool )
IMPORT_C TPtrC GetCurrentWord ()
IMPORT_C TInt GetFirstCandidate ( TDes &)
IMPORT_C TInt GetNextCandidate ( TDes &)
IMPORT_C TInt GetNextWordCandidateListL ( CDesCArray &)
IMPORT_C TPtrC GetPhoneticSpelling ( TInt )
IMPORT_C TInt GetPreviousCandidate ( TDes &)
IMPORT_C TInt GetSpelling ( TUint16 , TDes &, TPtiSpelling )
IMPORT_C TInt GetUserDictionaryEntry ( TInt , MPtiUserDictionaryEntry &, CPtiUserDictionary *)
IMPORT_C TBool IsToneMarkValidForSpelling ()
IMPORT_C CArrayFix < TInt > * ListCoresLC ()
IMPORT_C TBool MoreCandidatePages ()
IMPORT_C TBool NextCandidatePage ()
IMPORT_C TInt NumberOfCandidates ()
IMPORT_C TInt NumberOfEntriesInUserDictionary ( CPtiUserDictionary *)
IMPORT_C TInt PhoneticSpellingCount ()
IMPORT_C TBool PreviousCandidatePage ()
IMPORT_C TPtrC ReadingTextL ()
IMPORT_C TInt RemoveUserDictionaryEntry ( MPtiUserDictionaryEntry &, CPtiUserDictionary *)
IMPORT_C TBool SelectPhoneticSpelling ( TInt )
IMPORT_C TInt SelectedPhoneticSpelling ()
IMPORT_C void SetCandidatePageLength ( TInt )
IMPORT_C TInt SetCurrentInputSequence ( TPtrC8 )
IMPORT_C TInt SetExternalKeyMapL ( TPtiEngineInputMode , TPtiKey , TDesC &, TPtiTextCase )
IMPORT_C TBool SetPredictiveChineseChar (const TDesC &)
IMPORT_C TBool SetToneMark ( TInt )
IMPORT_C TBool ToneMark ( TText &)
Private Member Functions
void SetDestructorKeyId ( TInt )
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
TInt Reserved_1
TInt iDtorKeyId

Constructor & Destructor Documentation

~CPtiCore()

IMPORT_C ~CPtiCore ( )

Member Functions Documentation

AddUserDictionaryEntry(MPtiUserDictionaryEntry &, CPtiUserDictionary *)

IMPORT_C TInt AddUserDictionaryEntry ( MPtiUserDictionaryEntry & aEntry,
CPtiUserDictionary * aDict
)

Parameters

MPtiUserDictionaryEntry & aEntry
CPtiUserDictionary * aDict

AttachUserDictionary(CPtiUserDictionary *)

IMPORT_C TInt AttachUserDictionary ( CPtiUserDictionary * aDict )

Parameters

CPtiUserDictionary * aDict

CommitCurrentWord()

IMPORT_C TInt CommitCurrentWord ( )

CompositionData()

IMPORT_C MPtiEngineCompositionDataInterface * CompositionData ( )

Convert(TPtiCharConversion, TAny *, TInt, TAny *)

IMPORT_C TInt Convert ( TPtiCharConversion aType,
TAny * aInput,
TInt aInputLength,
TAny * aOutput
)

Parameters

TPtiCharConversion aType
TAny * aInput
TInt aInputLength
TAny * aOutput

CreateCoreL(TUid)

IMPORT_C CPtiCore * CreateCoreL ( TUid aCoreUid ) [static]

Creates in instance of core object for given implemenation uid.

Parameters

TUid aCoreUid An ecom implementation uid for core object to be created.

CreateEmptyUserDictionaryL(TInt)

IMPORT_C CPtiUserDictionary * CreateEmptyUserDictionaryL ( TInt aMaxSize )

Parameters

TInt aMaxSize

DetachUserDictionary(CPtiUserDictionary *)

IMPORT_C TBool DetachUserDictionary ( CPtiUserDictionary * aDict )

Parameters

CPtiUserDictionary * aDict

GetCandidateListL(CDesCArray &)

IMPORT_C TInt GetCandidateListL ( CDesCArray & aList )

Parameters

CDesCArray & aList

GetCandidatePage()

IMPORT_C TPtrC GetCandidatePage ( )

GetCandidatesByInputString(const TDesC &, RPointerArray< HBufC > &, const TBool)

IMPORT_C HBufC * GetCandidatesByInputString ( const TDesC & aInputString,
RPointerArray < HBufC > & aList,
const TBool aIsPredictive
)

Parameters

const TDesC & aInputString
RPointerArray < HBufC > & aList
const TBool aIsPredictive

GetCurrentWord()

IMPORT_C TPtrC GetCurrentWord ( ) const

GetFirstCandidate(TDes &)

IMPORT_C TInt GetFirstCandidate ( TDes & aResult )

Parameters

TDes & aResult

GetNextCandidate(TDes &)

IMPORT_C TInt GetNextCandidate ( TDes & aResult )

Parameters

TDes & aResult

GetNextWordCandidateListL(CDesCArray &)

IMPORT_C TInt GetNextWordCandidateListL ( CDesCArray & aList )

Parameters

CDesCArray & aList

GetPhoneticSpelling(TInt)

IMPORT_C TPtrC GetPhoneticSpelling ( TInt aIndex ) const

Parameters

TInt aIndex

GetPreviousCandidate(TDes &)

IMPORT_C TInt GetPreviousCandidate ( TDes & aResult )

Parameters

TDes & aResult

GetSpelling(TUint16, TDes &, TPtiSpelling)

IMPORT_C TInt GetSpelling ( TUint16 aInput,
TDes & aOutput,
TPtiSpelling aType
)

Parameters

TUint16 aInput
TDes & aOutput
TPtiSpelling aType

GetUserDictionaryEntry(TInt, MPtiUserDictionaryEntry &, CPtiUserDictionary *)

IMPORT_C TInt GetUserDictionaryEntry ( TInt aIndex,
MPtiUserDictionaryEntry & aResult,
CPtiUserDictionary * aDict
)

Parameters

TInt aIndex
MPtiUserDictionaryEntry & aResult
CPtiUserDictionary * aDict

IsToneMarkValidForSpelling()

IMPORT_C TBool IsToneMarkValidForSpelling ( )

ListCoresLC()

IMPORT_C CArrayFix < TInt > * ListCoresLC ( ) [static]

Lists all the available PtiEngine core onject implemenatations.

MoreCandidatePages()

IMPORT_C TBool MoreCandidatePages ( )

NextCandidatePage()

IMPORT_C TBool NextCandidatePage ( )

NumberOfCandidates()

IMPORT_C TInt NumberOfCandidates ( )

NumberOfEntriesInUserDictionary(CPtiUserDictionary *)

IMPORT_C TInt NumberOfEntriesInUserDictionary ( CPtiUserDictionary * aDict )

Parameters

CPtiUserDictionary * aDict

PhoneticSpellingCount()

IMPORT_C TInt PhoneticSpellingCount ( ) const

PreviousCandidatePage()

IMPORT_C TBool PreviousCandidatePage ( )

ReadingTextL()

IMPORT_C TPtrC ReadingTextL ( )

RemoveUserDictionaryEntry(MPtiUserDictionaryEntry &, CPtiUserDictionary *)

IMPORT_C TInt RemoveUserDictionaryEntry ( MPtiUserDictionaryEntry & aEntry,
CPtiUserDictionary * aDict
)

Parameters

MPtiUserDictionaryEntry & aEntry
CPtiUserDictionary * aDict

SelectPhoneticSpelling(TInt)

IMPORT_C TBool SelectPhoneticSpelling ( TInt aIndex )

Parameters

TInt aIndex

SelectedPhoneticSpelling()

IMPORT_C TInt SelectedPhoneticSpelling ( ) const

SetCandidatePageLength(TInt)

IMPORT_C void SetCandidatePageLength ( TInt aLength )

Parameters

TInt aLength

SetCurrentInputSequence(TPtrC8)

IMPORT_C TInt SetCurrentInputSequence ( TPtrC8 aInput )

Parameters

TPtrC8 aInput

SetDestructorKeyId(TInt)

void SetDestructorKeyId ( TInt aDtorKeyId ) [private, inline]

Parameters

TInt aDtorKeyId

SetExternalKeyMapL(TPtiEngineInputMode, TPtiKey, TDesC &, TPtiTextCase)

IMPORT_C TInt SetExternalKeyMapL ( TPtiEngineInputMode aMode,
TPtiKey aKey,
TDesC & aKeyMap,
TPtiTextCase aCase
)

Parameters

TPtiEngineInputMode aMode
TPtiKey aKey
TDesC & aKeyMap
TPtiTextCase aCase

SetPredictiveChineseChar(const TDesC &)

IMPORT_C TBool SetPredictiveChineseChar ( const TDesC & aChar )

Parameters

const TDesC & aChar

SetToneMark(TInt)

IMPORT_C TBool SetToneMark ( TInt aToneMark )

Parameters

TInt aToneMark

ToneMark(TText &)

IMPORT_C TBool ToneMark ( TText & aToneMark ) const

Parameters

TText & aToneMark

Member Data Documentation

TInt Reserved_1

TInt Reserved_1 [private]

TInt iDtorKeyId

TInt iDtorKeyId [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.