CPtiCore Class Reference

#include <mw/PtiCore.h>

Link against: PtiEngine.lib

class CPtiCore : public CBase

Inherits from

  • CPtiCore
    Public Member Functions
    ~CPtiCore()
    IMPORT_C TIntAddUserDictionaryEntry(MPtiUserDictionaryEntry &, CPtiUserDictionary *)
    IMPORT_C TIntAttachUserDictionary(CPtiUserDictionary *)
    IMPORT_C TIntCommitCurrentWord()
    IMPORT_C MPtiEngineCompositionDataInterface *CompositionData()
    IMPORT_C TIntConvert(TPtiCharConversion, TAny *, TInt, TAny *)
    IMPORT_C CPtiCore *CreateCoreL(TUid)
    IMPORT_C CPtiUserDictionary *CreateEmptyUserDictionaryL(TInt)
    IMPORT_C TBoolDetachUserDictionary(CPtiUserDictionary *)
    IMPORT_C TIntGetCandidateListL(CDesCArray &)
    IMPORT_C TPtrCGetCandidatePage()
    IMPORT_C HBufC *GetCandidatesByInputString(const TDesC &, RPointerArray< HBufC > &, const TBool)
    IMPORT_C TPtrCGetCurrentWord()
    IMPORT_C TIntGetFirstCandidate(TDes &)
    IMPORT_C TIntGetNextCandidate(TDes &)
    IMPORT_C TIntGetNextWordCandidateListL(CDesCArray &)
    IMPORT_C TPtrCGetPhoneticSpelling(TInt)
    IMPORT_C TIntGetPreviousCandidate(TDes &)
    IMPORT_C TIntGetSpelling(TUint16, TDes &, TPtiSpelling)
    IMPORT_C TIntGetUserDictionaryEntry(TInt, MPtiUserDictionaryEntry &, CPtiUserDictionary *)
    IMPORT_C TBoolIsToneMarkValidForSpelling()
    IMPORT_C CArrayFix< TInt > *ListCoresLC()
    IMPORT_C TBoolMoreCandidatePages()
    IMPORT_C TBoolNextCandidatePage()
    IMPORT_C TIntNumberOfCandidates()
    IMPORT_C TIntNumberOfEntriesInUserDictionary(CPtiUserDictionary *)
    IMPORT_C TIntPhoneticSpellingCount()
    IMPORT_C TBoolPreviousCandidatePage()
    IMPORT_C TPtrCReadingTextL()
    IMPORT_C TIntRemoveUserDictionaryEntry(MPtiUserDictionaryEntry &, CPtiUserDictionary *)
    IMPORT_C TBoolSelectPhoneticSpelling(TInt)
    IMPORT_C TIntSelectedPhoneticSpelling()
    IMPORT_C voidSetCandidatePageLength(TInt)
    IMPORT_C TIntSetCurrentInputSequence(TPtrC8)
    IMPORT_C TIntSetExternalKeyMapL(TPtiEngineInputMode, TPtiKey, TDesC &, TPtiTextCase)
    IMPORT_C TBoolSetPredictiveChineseChar(const TDesC &)
    IMPORT_C TBoolSetToneMark(TInt)
    IMPORT_C TBoolToneMark(TText &)
    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

    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.

    Constructor & Destructor Documentation

    ~CPtiCore ( )

    IMPORT_C~CPtiCore()

    Member Function Documentation

    AddUserDictionaryEntry ( MPtiUserDictionaryEntry &, CPtiUserDictionary * )

    IMPORT_C TIntAddUserDictionaryEntry(MPtiUserDictionaryEntry &aEntry,
    CPtiUserDictionary *aDict
    )

    AttachUserDictionary ( CPtiUserDictionary * )

    IMPORT_C TIntAttachUserDictionary(CPtiUserDictionary *aDict)

    CommitCurrentWord ( )

    IMPORT_C TIntCommitCurrentWord()

    CompositionData ( )

    IMPORT_C MPtiEngineCompositionDataInterface *CompositionData()

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

    IMPORT_C TIntConvert(TPtiCharConversionaType,
    TAny *aInput,
    TIntaInputLength,
    TAny *aOutput
    )

    CreateCoreL ( TUid )

    IMPORT_C CPtiCore *CreateCoreL(TUidaCoreUid)[static]

    Creates in instance of core object for given implemenation uid.

    ParameterDescription
    aCoreUidAn ecom implementation uid for core object to be created.

    Returns: Pointer to new core object instance.

    CreateEmptyUserDictionaryL ( TInt )

    IMPORT_C CPtiUserDictionary *CreateEmptyUserDictionaryL(TIntaMaxSize)

    DetachUserDictionary ( CPtiUserDictionary * )

    IMPORT_C TBoolDetachUserDictionary(CPtiUserDictionary *aDict)

    GetCandidateListL ( CDesCArray & )

    IMPORT_C TIntGetCandidateListL(CDesCArray &aList)

    GetCandidatePage ( )

    IMPORT_C TPtrCGetCandidatePage()

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

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

    GetCurrentWord ( )

    IMPORT_C TPtrCGetCurrentWord()const

    GetFirstCandidate ( TDes & )

    IMPORT_C TIntGetFirstCandidate(TDes &aResult)

    GetNextCandidate ( TDes & )

    IMPORT_C TIntGetNextCandidate(TDes &aResult)

    GetNextWordCandidateListL ( CDesCArray & )

    IMPORT_C TIntGetNextWordCandidateListL(CDesCArray &aList)

    GetPhoneticSpelling ( TInt )

    IMPORT_C TPtrCGetPhoneticSpelling(TIntaIndex)const

    GetPreviousCandidate ( TDes & )

    IMPORT_C TIntGetPreviousCandidate(TDes &aResult)

    GetSpelling ( TUint16, TDes &, TPtiSpelling )

    IMPORT_C TIntGetSpelling(TUint16aInput,
    TDes &aOutput,
    TPtiSpellingaType
    )

    GetUserDictionaryEntry ( TInt, MPtiUserDictionaryEntry &, CPtiUserDictionary * )

    IMPORT_C TIntGetUserDictionaryEntry(TIntaIndex,
    MPtiUserDictionaryEntry &aResult,
    CPtiUserDictionary *aDict
    )

    IsToneMarkValidForSpelling ( )

    IMPORT_C TBoolIsToneMarkValidForSpelling()

    ListCoresLC ( )

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

    Lists all the available PtiEngine core onject implemenatations.

    Returns: Pointer to a list cantaining implementation uids for available core plugins.

    MoreCandidatePages ( )

    IMPORT_C TBoolMoreCandidatePages()

    NextCandidatePage ( )

    IMPORT_C TBoolNextCandidatePage()

    NumberOfCandidates ( )

    IMPORT_C TIntNumberOfCandidates()

    NumberOfEntriesInUserDictionary ( CPtiUserDictionary * )

    IMPORT_C TIntNumberOfEntriesInUserDictionary(CPtiUserDictionary *aDict)

    PhoneticSpellingCount ( )

    IMPORT_C TIntPhoneticSpellingCount()const

    PreviousCandidatePage ( )

    IMPORT_C TBoolPreviousCandidatePage()

    ReadingTextL ( )

    IMPORT_C TPtrCReadingTextL()

    RemoveUserDictionaryEntry ( MPtiUserDictionaryEntry &, CPtiUserDictionary * )

    IMPORT_C TIntRemoveUserDictionaryEntry(MPtiUserDictionaryEntry &aEntry,
    CPtiUserDictionary *aDict
    )

    SelectPhoneticSpelling ( TInt )

    IMPORT_C TBoolSelectPhoneticSpelling(TIntaIndex)

    SelectedPhoneticSpelling ( )

    IMPORT_C TIntSelectedPhoneticSpelling()const

    SetCandidatePageLength ( TInt )

    IMPORT_C voidSetCandidatePageLength(TIntaLength)

    SetCurrentInputSequence ( TPtrC8 )

    IMPORT_C TIntSetCurrentInputSequence(TPtrC8aInput)

    SetExternalKeyMapL ( TPtiEngineInputMode, TPtiKey, TDesC &, TPtiTextCase )

    IMPORT_C TIntSetExternalKeyMapL(TPtiEngineInputModeaMode,
    TPtiKeyaKey,
    TDesC &aKeyMap,
    TPtiTextCaseaCase
    )

    SetPredictiveChineseChar ( const TDesC & )

    IMPORT_C TBoolSetPredictiveChineseChar(const TDesC &aChar)

    SetToneMark ( TInt )

    IMPORT_C TBoolSetToneMark(TIntaToneMark)

    ToneMark ( TText & )

    IMPORT_C TBoolToneMark(TText &aToneMark)const