Class RIncrMatcherBase

class RIncrMatcherBase;

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"

Members

Defined in RIncrMatcherBase:
AppendChar(), Clear(), DeleteLastChar(), FirstMatchingIndex(), FirstMatchingIndexC(), FirstMatchingIndexF(), IsMatch(), IsMatchC(), IsMatchF(), MatchDes(), MatchDes(), MatchLength(), MatchText(), MaxLength(), RIncrMatcherBase(), SetBestMatch(), SetBestMatchC(), SetBestMatchF(), SetMatchText(), ~RIncrMatcherBase()

virtual IMPORT_C ~RIncrMatcherBase();

Description

Virtual destructor, for reimplementation by derived classes.

protected: inline RIncrMatcherBase();

Description

Default constructor.

protected: virtual TDes &MatchDes()=0;

Description

Gets the match text.

Return value

TDes & Match text

protected: virtual const TDes &MatchDes() const=0;

Description

Gets the match text.

Return value

const TDes & Match text

inline TInt MaxLength() const;

Description

Gets the maximum length of the match text buffer.

Return value

TInt

inline TInt MatchLength() const;

Description

Gets the current length of the match text buffer.

Return value

TInt

inline TPtrC MatchText() const;

Description

Gets the match text as a TPtrC.

Return value

TPtrC

inline void Clear();

Description

Clears the match text.

IMPORT_C void DeleteLastChar();

Description

Deletes the final character in the match text.

IMPORT_C void AppendChar(TChar aLetter);

Description

Appends a character to the end of the match text.

Parameters

TChar aLetter Character to append

inline void SetMatchText(const TDesC &aText);

Description

Sets the match text.

Parameters

const TDesC &aText String to which to set the match text.

IMPORT_C void SetBestMatch(const TDesC &aBuf);

Description

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".

Parameters

const TDesC &aBuf Text to match

IMPORT_C void SetBestMatchC(const TDesC &aBuf);

Description

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

Parameters

const TDesC &aBuf Text to match

IMPORT_C void SetBestMatchF(const TDesC &aBuf);

Description

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

Parameters

const TDesC &aBuf Text to match

IMPORT_C TBool IsMatch(const TDesC &aBuf) const;

Description

Tests for match, using a binary comparison.

Parameters

const TDesC &aBuf Text to match

Return value

TBool ETrue if match found, else EFalse

IMPORT_C TBool IsMatchC(const TDesC &aBuf) const;

Description

Tests for match, using locale collation rules.

Parameters

const TDesC &aBuf Text to match

Return value

TBool ETrue if match found, else EFalse

IMPORT_C TBool IsMatchF(const TDesC &aBuf) const;

Description

Tests for match, using locale folding rules.

Parameters

const TDesC &aBuf Text to match

Return value

TBool ETrue if match found, else EFalse

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

Description

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

Parameters

TInt &aResult On return, index of the first match in aDesArray const MDesC16Array &aDesArray Array of descriptors to search TInt aStartIndex Index of aDesArray at which to begin search

Return value

TInt KErrNone if success or KErrNotFound if no match is found

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

Description

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

Parameters

TInt &aResult On return, index of the first match in aDesArray const MDesC16Array &aDesArray Array of descriptors to search TInt aStartIndex Index of aDesArray at which to begin search

Return value

TInt KErrNone if success or KErrNotFound if no match is found

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

Description

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

Parameters

TInt &aResult On return, index of the first match in aDesArray const MDesC16Array &aDesArray Array of descriptors to search TInt aStartIndex Index of aDesArray at which to begin search

Return value

TInt KErrNone if success or KErrNotFound if no match is found