CMsvFindText Class Reference

#include <mw/msvftext.h>

class CMsvFindText : public CMsgActive, public CMsgActive

Inherits from

CMsvFindText
- CMsgActive
  - CActive
    - CBase
  - CActive
    - CBase
- CMsgActive
  - CActive
    - CBase
  - CActive
    - CBase

Public Member Functions
	~CMsvFindText()
IMPORT_C void	FindRichTextL(const TDesC &, const CRichText &, TMsvPartList, TRequestStatus &)
IMPORT_C TBool	FindRichTextL(const TDesC &, const CRichText &, TMsvPartList)
IMPORT_C void	FindTextL(const TDesC &, const TDesC &, TMsvPartList, TRequestStatus &)
IMPORT_C TBool	FindTextL(const TDesC &, const TDesC &, TMsvPartList)
TBool	FoundText()
IMPORT_C CMsvFindText *	NewL(TInt)
IMPORT_C CMsvFindText *	NewLC(TInt)

Inherited Attributes
	CActive::iStatus

Inherited Enumerations
	CActive:TPriority

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::RunError(TInt)
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	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()
	CMsgActive::CMsgActive(TInt)
	CMsgActive::Complete(TInt)
	CMsgActive::DoCancel()
	CMsgActive::Queue(TRequestStatus &)
	CMsgActive::~CMsgActive()

Detailed Description

A utility class which searches through given plain text or rich text for a specified text string.

The class is an active object and searching can be done synchronously or asynchronously. An instance of this class can be re-used to perform multiple searches for text.

Constructor & Destructor Documentation

~CMsvFindText ( )

IMPORT_C

~CMsvFindText

(

)

Destructor.

Any outstanding search is cancelled.

Member Function Documentation

FindRichTextL ( const TDesC &, const CRichText &, TMsvPartList, TRequestStatus & )

IMPORT_C void	FindRichTextL	(	const TDesC &	aFind,
			const CRichText &	aSource,
			TMsvPartList	aFlags,
			TRequestStatus &	aStatus
		)

Searches for a specified text string within the given rich text asynchronously.

Parameters
aFind	The text string to search for.
aSource	The rich text to be searched.
aFlags	A set of flags which modify the way the search works: KMsvFindCaseSensitive means the search is successful only if there is an exact case match for the text. KMsvFindWholeWord means the search is successful only if the matching text in aSource is not delimited by alphanumeric characters.
aStatus	The request status object, which is set when the search operation is complete. Use FoundText() to return the result of the search.

FindRichTextL ( const TDesC &, const CRichText &, TMsvPartList )

IMPORT_C TBool	FindRichTextL	(	const TDesC &	aFind,
			const CRichText &	aSource,
			TMsvPartList	aFlags
		)

Searches for a specified text string within the given rich text synchronously.

Parameters
aFind	The text string to search for.
aSource	The rich text to be searched.
aFlags	A set of flags which modify the way the search works: KMsvFindCaseSensitive means the search is successful only if there is an exact case match for the text. KMsvFindWholeWord means the search is successful only if the matching text in aSource is not delimited by alphanumeric characters.

Return Value: ETrue if there is a match, otherwise EFalse.

FindTextL ( const TDesC &, const TDesC &, TMsvPartList, TRequestStatus & )

IMPORT_C void	FindTextL	(	const TDesC &	aFind,
			const TDesC &	aSource,
			TMsvPartList	aFlags,
			TRequestStatus &	aStatus
		)

Performs an asynchronous search for a text string within another text string.

Parameters
aFind	The text string to search for.
aSource	The plain text to be searched.
aFlags	A set of flags which modify the way the search works: KMsvFindCaseSensitive means the search is successful only if there is an exact case match for the text. KMsvFindWholeWord means the search is successful only if the matching text in aSource is not delimited by alphanumeric characters.
aStatus	The request status object, which is set when the search operation is complete. Use FoundText() to return the result of the search.

FindTextL ( const TDesC &, const TDesC &, TMsvPartList )

IMPORT_C TBool	FindTextL	(	const TDesC &	aFind,
			const TDesC &	aSource,
			TMsvPartList	aFlags
		)

Performs a synchronous search for a text string within another text string.

Parameters
aFind	The text string to search for.
aSource	The plain text to be searched.
aFlags	A set of flags which modify the way the search works: KMsvFindCaseSensitive means the search is successful only if there is an exact case match for the text. KMsvFindWholeWord means the search is successful only if the matching text in aSource is not delimited by alphanumeric characters.