MPtiHwrRecognizer Class Reference

class MPtiHwrRecognizer

MHwrRecognizer class. Interface definiton for Hwr.

Member Functions Documentation

AddAuxiliaryRange(const TRecognitionRange &)

TInt AddAuxiliaryRange(const TRecognitionRange &aRange)[pure virtual]

Appends an auxiliary range

Parameters

const TRecognitionRange & aRangeThe auxiliary range to be appended

EnableGuideline(const TBool)

TInt EnableGuideline(const TBoolaFlag)[pure virtual]

Tell the HWR engine whether guideline is on.

Parameters

const TBool aFlagETrue to enable guideline, and EFalse to diable.

EnableRecognitionDictionary(const TBool)

TInt EnableRecognitionDictionary(const TBoolaFlag)[pure virtual]

Tell the engine whether to use dictionary when doing reconition.

Parameters

const TBool aFlagETrue to enable recognition dictionary, and EFalse to diable.

EnableWordRecognition(const TBool)

voidEnableWordRecognition(const TBoolaFlag)[pure virtual]

Enable or disable word recognition

Parameters

const TBool aFlagThe word recognition flag, ETrue if enable word recognition, otherwise EFalse

GetAuxCandidateNum()

TInt GetAuxCandidateNum()const [pure virtual]

Retrieve the current each secondary candidate number need to be returned each time

GetBottomGuideLinePos(TInt &)

voidGetBottomGuideLinePos(TInt &aPos)[pure virtual]

Set position of HWR bottom guideline

Parameters

TInt & aPosPosition to be set

GetCandidateNum()

TInt GetCandidateNum()const [pure virtual]

Retrieve the current primary candidate number need to be returned each time

GetDictVersion(TDes &)

TInt GetDictVersion(TDes &aVersion)[pure virtual]

Retrieve an ASCII string that describes the version information of the basic recognition dictionary

Parameters

TDes & aVersionContains recognition dictionary version string on return

GetEngineVersion(TDes &)

TInt GetEngineVersion(TDes &aVersion)[pure virtual]

Retrieve an ASCII string that describes the version information of the current HWR engine

Parameters

TDes & aVersionContains the engine version string on return

GetRange()

TRecognitionRange GetRange()[pure virtual]

Get current recognition range of hwr engine

GetTopGuideLinePos(TInt &)

voidGetTopGuideLinePos(TInt &aPos)[pure virtual]

Set position of HWR top guideline

Parameters

TInt & aPosPosition to be set

McrAddStrokesL(const RArray< TPoint > &, RPointerArray< HBufC > &)

voidMcrAddStrokesL(const RArray< TPoint > &aTraceData,
RPointerArray< HBufC > &aResult
)[pure virtual]

Get the character candidates from the HWR engine based on the input strokes by MCR

Parameters

const RArray< TPoint > & aTraceDataThe array of pen trace points, each stroke is ended by stroke end mark
RPointerArray< HBufC > & aResultCandidate buffer array

McrBeginSessionL()

voidMcrBeginSessionL()[pure virtual]

Tell the engine that a new MCR session has been started.

McrEndSessionL(RPointerArray< HBufC > &)

voidMcrEndSessionL(RPointerArray< HBufC > &aResult)[pure virtual]

Tell the engine that a new MCR session need to be ended, return the last result.

Parameters

RPointerArray< HBufC > & aResult

QueryUdmInterfaceL()

MTruiEngine *QueryUdmInterfaceL()[pure virtual]

Retrieve MTruiEngine interface pointer if the derived engine support UDM feature.

Recognize(const RArray< TPoint > &, RPointerArray< HBufC > &)

TInt Recognize(const RArray< TPoint > &aTraceData,
RPointerArray< HBufC > &aResult
)[pure virtual]

Get the character candidates from the HWR engine based on the input strokes

Parameters

const RArray< TPoint > & aTraceDataThe array of pen trace points, each stroke is ended by stroke end mark
RPointerArray< HBufC > & aResultCandidate buffer array

RecognizeWithCharSet(const RArray< TPoint > &, RPointerArray< HBufC > &, const TDesC &)

TInt RecognizeWithCharSet(const RArray< TPoint > &aTraceData,
RPointerArray< HBufC > &aResult,
const TDesC &aCharSet
)[pure virtual]

Get the character candidates from the HWR engine based on the input strokes

Parameters

const RArray< TPoint > & aTraceDataThe array of pen trace points, each stroke is ended by stroke end mark
RPointerArray< HBufC > & aResultCandidate buffer array
const TDesC & aCharSetThe small charset that primary range candidate should come from

RemoveAllAuxRange()

voidRemoveAllAuxRange()[pure virtual]

Remove all auxiliary recognition ranges

RemoveAuxiliaryRange(TInt)

TInt RemoveAuxiliaryRange(TIntaIndex)[pure virtual]

Remove an specified auxiliary recognition range.

Parameters

TInt aIndexThe index of auxiliary range to be deleted

SetAuxCandidateNum(TInt)

TInt SetAuxCandidateNum(TIntaNumber)[pure virtual]

Set the number of each secondary candidates the HWR engine should return each time

Parameters

TInt aNumberThe number of each secondary candidates that HWR engine should return each time

SetCandidateNum(TInt)

TInt SetCandidateNum(TIntaNumber)[pure virtual]

Set the number of primary candidate candidates the HWR engine should return each time

Parameters

TInt aNumberThe number of primary candidates that HWR engine should return each time

SetFirstLetterOrder(const TLatinLetterOrder)

voidSetFirstLetterOrder(const TLatinLetterOrderaOrder)[pure virtual]

Specify whether small case or upper case letter will be the first one in candidate list when the first two letters are the same if case is ignored

Parameters

const TLatinLetterOrder aOrderEUpperFirst if user wants upper case letter in the first, otherwise ELowerFirst

SetInputAreaSize(TSize &)

TInt SetInputAreaSize(TSize &aSize)[pure virtual]

Tell the HWR engine about the size of the writing area used to input character

Parameters

TSize & aSizeThe size of writing area

SetNumberMode(const TAknEditorNumericKeymap)

voidSetNumberMode(const TAknEditorNumericKeymapaNumberMode)[pure virtual]

Set number mode

Parameters

const TAknEditorNumericKeymap aNumberModeGiven number mode

SetPermittedSymbolSet(const TDesC &)

voidSetPermittedSymbolSet(const TDesC &aSymbolSet)[pure virtual]

Set permitted recognized character set

Parameters

const TDesC & aSymbolSetPermitted recognized character set

SetRange(const TRecognitionRange &)

TInt SetRange(const TRecognitionRange &aRange)[pure virtual]

Set Hwr to given recognition range

Parameters

const TRecognitionRange & aRangeGiven recognition range

SetScreenSize(TSize &)

TInt SetScreenSize(TSize &aSize)[pure virtual]

Tell the HWR engine about the size of the touch screen

Parameters

TSize & aSizeThe size of touch screen

StrokeEndMark()

TPoint StrokeEndMark()const [pure virtual]

Get the stroke end mark