Collapse all Symbian^3 Application Developer Library

MPtiHwrRecognizer Class Reference

class MPtiHwrRecognizer

MHwrRecognizer class. Interface definiton for Hwr.

Public Member Functions
TInt	AddAuxiliaryRange (const TRecognitionRange &)
TInt	EnableGuideline (const TBool )
TInt	EnableRecognitionDictionary (const TBool )
void	EnableWordRecognition (const TBool )
TInt	GetAuxCandidateNum ()
void	GetBottomGuideLinePos ( TInt &)
TInt	GetCandidateNum ()
TInt	GetDictVersion ( TDes &)
TInt	GetEngineVersion ( TDes &)
TRecognitionRange	GetRange ()
void	GetTopGuideLinePos ( TInt &)
void	McrAddStrokesL (const RArray < TPoint > &, RPointerArray < HBufC > &)
void	McrBeginSessionL ()
void	McrEndSessionL ( RPointerArray < HBufC > &)
MTruiEngine *	QueryUdmInterfaceL ()
TInt	Recognize (const RArray < TPoint > &, RPointerArray < HBufC > &)
TInt	RecognizeWithCharSet (const RArray < TPoint > &, RPointerArray < HBufC > &, const TDesC &)
void	RemoveAllAuxRange ()
TInt	RemoveAuxiliaryRange ( TInt )
TInt	SetAuxCandidateNum ( TInt )
TInt	SetCandidateNum ( TInt )
void	SetFirstLetterOrder (const TLatinLetterOrder )
TInt	SetInputAreaSize ( TSize &)
void	SetNumberMode (const TAknEditorNumericKeymap )
void	SetPermittedSymbolSet (const TDesC &)
TInt	SetRange (const TRecognitionRange &)
TInt	SetScreenSize ( TSize &)
TPoint	StrokeEndMark ()

Member Functions Documentation

AddAuxiliaryRange(const TRecognitionRange &)

TInt

AddAuxiliaryRange

(

const TRecognitionRange &

aRange

)

[pure virtual]

Appends an auxiliary range

Parameters

const TRecognitionRange & aRange

The auxiliary range to be appended

EnableGuideline(const TBool)

TInt

EnableGuideline

(

const TBool

aFlag

)

[pure virtual]

Tell the HWR engine whether guideline is on.

Parameters

const TBool aFlag

ETrue to enable guideline, and EFalse to diable.

EnableRecognitionDictionary(const TBool)

TInt

EnableRecognitionDictionary

(

const TBool

aFlag

)

[pure virtual]

Tell the engine whether to use dictionary when doing reconition.

Parameters

const TBool aFlag

ETrue to enable recognition dictionary, and EFalse to diable.

EnableWordRecognition(const TBool)

void

EnableWordRecognition

(

const TBool

aFlag

)

[pure virtual]

Enable or disable word recognition

Parameters

const TBool aFlag

The 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 &)

void

GetBottomGuideLinePos

(

TInt &

aPos

)

[pure virtual]

Set position of HWR bottom guideline

Parameters

TInt & aPos

Position 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 & aVersion

Contains 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 & aVersion

Contains the engine version string on return

GetRange()

TRecognitionRange

GetRange

(

)

[pure virtual]

Get current recognition range of hwr engine

GetTopGuideLinePos(TInt &)

void

GetTopGuideLinePos

(

TInt &

aPos

)

[pure virtual]

Set position of HWR top guideline

Parameters

TInt & aPos

Position to be set

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

void	McrAddStrokesL	(	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 > & aTraceData	The array of pen trace points, each stroke is ended by stroke end mark
RPointerArray < HBufC > & aResult	Candidate buffer array

McrBeginSessionL()

void

McrBeginSessionL

(

)

[pure virtual]

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

McrEndSessionL(RPointerArray< HBufC > &)

void

McrEndSessionL

(

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 > & aTraceData	The array of pen trace points, each stroke is ended by stroke end mark
RPointerArray < HBufC > & aResult	Candidate 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 > & aTraceData	The array of pen trace points, each stroke is ended by stroke end mark
RPointerArray < HBufC > & aResult	Candidate buffer array
const TDesC & aCharSet	The small charset that primary range candidate should come from

RemoveAllAuxRange()

void

RemoveAllAuxRange

(

)

[pure virtual]

Remove all auxiliary recognition ranges

RemoveAuxiliaryRange(TInt)

TInt

RemoveAuxiliaryRange

(

TInt

aIndex

)

[pure virtual]

Remove an specified auxiliary recognition range.

Parameters

TInt aIndex

The index of auxiliary range to be deleted

SetAuxCandidateNum(TInt)

TInt

SetAuxCandidateNum

(

TInt

aNumber

)

[pure virtual]

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

Parameters

TInt aNumber

The number of each secondary candidates that HWR engine should return each time

SetCandidateNum(TInt)

TInt

SetCandidateNum

(

TInt

aNumber

)

[pure virtual]

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

Parameters

TInt aNumber

The number of primary candidates that HWR engine should return each time

SetFirstLetterOrder(const TLatinLetterOrder)

void

SetFirstLetterOrder

(

const TLatinLetterOrder

aOrder

)

[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 aOrder

EUpperFirst 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 & aSize

The size of writing area

SetNumberMode(const TAknEditorNumericKeymap)

void

SetNumberMode

(

const TAknEditorNumericKeymap

aNumberMode

)

[pure virtual]

Set number mode

Parameters

const TAknEditorNumericKeymap aNumberMode

Given number mode

SetPermittedSymbolSet(const TDesC &)

void

SetPermittedSymbolSet

(

const TDesC &

aSymbolSet

)

[pure virtual]

Set permitted recognized character set

Parameters

const TDesC & aSymbolSet

Permitted recognized character set

SetRange(const TRecognitionRange &)

TInt

SetRange

(

const TRecognitionRange &

aRange

)

[pure virtual]

Set Hwr to given recognition range

Parameters

const TRecognitionRange & aRange

Given recognition range

SetScreenSize(TSize &)

TInt

SetScreenSize

(

TSize &

aSize

)

[pure virtual]

Tell the HWR engine about the size of the touch screen

Parameters

TSize & aSize

The size of touch screen

StrokeEndMark()

TPoint

StrokeEndMark

(

)

const [pure virtual]

Get the stroke end mark