RIncrMatcherBase Class Reference

#include <bamatch.h>

Link against: bafl.lib

class RIncrMatcherBase

Public Member Functions
virtual	~RIncrMatcherBase()
IMPORT_C void	AppendChar(TChar)
void	Clear()
IMPORT_C void	DeleteLastChar()
IMPORT_C TInt	FirstMatchingIndex(TInt &, const MDesCArray &, TInt)
IMPORT_C TInt	FirstMatchingIndexC(TInt &, const MDesCArray &, TInt)
IMPORT_C TInt	FirstMatchingIndexF(TInt &, const MDesCArray &, TInt)
IMPORT_C TBool	IsMatch(const TDesC &)
IMPORT_C TBool	IsMatchC(const TDesC &)
IMPORT_C TBool	IsMatchF(const TDesC &)
TInt	MatchLength()
TPtrC	MatchText()
TInt	MaxLength()
IMPORT_C void	SetBestMatch(const TDesC &)
IMPORT_C void	SetBestMatchC(const TDesC &)
IMPORT_C void	SetBestMatchF(const TDesC &)
void	SetMatchText(const TDesC &)

Protected Member Functions
	RIncrMatcherBase()
pure virtual TDes &	MatchDes()
pure virtual const TDes &	MatchDes()

Detailed Description

Base class for incremental matcher classes.

An incremental matcher compares two text buffers from left-to-right. For example, the match between "garage" and "gander" is "ga".

The class provides the interface for getting and setting the text to be matched against, and for performing match tests. Each type of match test is available in three versions, one using binary comparison, one using locale collation rules (comparison of strings to produce a dictionary-like ('lexicographic') ordering, e.g. ignoring punctuation), and one using locale folding rules (e.g. ignoring case).

"bafl.lib"

Since: 5.0

Constructor & Destructor Documentation

RIncrMatcherBase ( )

RIncrMatcherBase

(

)

[protected, inline]

Default constructor.

~RIncrMatcherBase ( )

IMPORT_C

~RIncrMatcherBase

(

)

[virtual]

Virtual destructor, for reimplementation by derived classes.

Member Function Documentation

AppendChar ( TChar )

IMPORT_C void

AppendChar

(

TChar

aLetter

)

Appends a character to the end of the match text.

Parameter	Description
aLetter	Character to append

Clear ( )

void

Clear

(

)

[inline]

Clears the match text.

DeleteLastChar ( )

IMPORT_C void

DeleteLastChar

(

)

Deletes the final character in the match text.

FirstMatchingIndex ( TInt &, const MDesCArray &, TInt )

IMPORT_C TInt	FirstMatchingIndex	(	TInt &	aResult,
			const MDesCArray &	aDesArray,
			TInt	aStartIndex = 0
		)	const

Finds the first match in an array, using a binary comparison.

Parameter	Description
aResult	On return, index of the first match in aDesArray
aDesArray	Array of descriptors to search
aStartIndex	Index of aDesArray at which to begin search

Returns: KErrNone if success or KErrNotFound if no match is found

FirstMatchingIndexC ( TInt &, const MDesCArray &, TInt )

IMPORT_C TInt	FirstMatchingIndexC	(	TInt &	aResult,
			const MDesCArray &	aDesArray,
			TInt	aStartIndex = 0
		)	const

Finds the first match in an array, using locale collation rules.

Parameter	Description
aResult	On return, index of the first match in aDesArray
aDesArray	Array of descriptors to search
aStartIndex	Index of aDesArray at which to begin search

Returns: KErrNone if success or KErrNotFound if no match is found

FirstMatchingIndexF ( TInt &, const MDesCArray &, TInt )

IMPORT_C TInt	FirstMatchingIndexF	(	TInt &	aResult,
			const MDesCArray &	aDesArray,
			TInt	aStartIndex = 0
		)	const

Finds the first match in an array, using locale folding rules.

Parameter	Description
aResult	On return, index of the first match in aDesArray
aDesArray	Array of descriptors to search
aStartIndex	Index of aDesArray at which to begin search

Returns: KErrNone if success or KErrNotFound if no match is found

IsMatch ( const TDesC & )

IMPORT_C TBool

IsMatch

(

const TDesC &

aBuf

)

const

Tests for match, using a binary comparison.

Parameter	Description
aBuf	Text to match

Returns: ETrue if match found, else EFalse

IsMatchC ( const TDesC & )

IMPORT_C TBool

IsMatchC

(

const TDesC &

aBuf

)

const

Tests for match, using locale collation rules.

Parameter	Description
aBuf	Text to match

Returns: ETrue if match found, else EFalse

IsMatchF ( const TDesC & )

IMPORT_C TBool

IsMatchF

(

const TDesC &

aBuf

)

const

Tests for match, using locale folding rules.

Parameter	Description
aBuf	Text to match

Returns: ETrue if match found, else EFalse

MatchDes ( )

TDes &

MatchDes

(

)

[protected, pure virtual]

Gets the match text.

Returns: Match text

MatchDes ( )

const TDes &

MatchDes

(

)

const [protected, pure virtual]

Gets the match text.

Returns: Match text

MatchLength ( )

TInt

MatchLength

(

)

const [inline]

Gets the current length of the match text buffer.

MatchText ( )

TPtrC

MatchText

(

)

const [inline]

Gets the match text as a TPtrC.

MaxLength ( )

TInt

MaxLength

(

)

const [inline]

Gets the maximum length of the match text buffer.

SetBestMatch ( const TDesC & )

IMPORT_C void

SetBestMatch

(

const TDesC &

aBuf

)

Sets the match text to the best match between the match text and the passed buffer, using a binary comparision.

For example, if the original match text is "goose" and the passed buffer is "gooSE", the match text would be changed to "goo".

Parameter	Description
aBuf	Text to match

SetBestMatchC ( const TDesC & )

IMPORT_C void

SetBestMatchC

(

const TDesC &

aBuf

)

Sets the match text to the best match between the match text and the passed buffer, using locale collation rules.

Parameter	Description
aBuf	Text to match

SetBestMatchF ( const TDesC & )

IMPORT_C void

SetBestMatchF

(

const TDesC &

aBuf

)

Sets the match text to the best match between the match text and the passed buffer, using locale folding rules.

Parameter	Description
aBuf	Text to match

SetMatchText ( const TDesC & )

void

SetMatchText

(

const TDesC &

aText

)

[inline]

Sets the match text.

Parameter	Description
aText	String to which to set the match text.