CNcdSearchFilter Class Reference

class CNcdSearchFilter : public CBase

A default implementation for the MNcdSearchFilter interface.

ncdutils_20019119.dll

MNcdSearchFilter

Inherits from

Constructor & Destructor Documentation

CNcdSearchFilter()

CNcdSearchFilter ( ) [protected]

First phase constructor.

~CNcdSearchFilter()

~CNcdSearchFilter ( ) [virtual]

Destructor.

Member Functions Documentation

AddKeywordL(const TDesC &)

IMPORT_C void AddKeywordL ( const TDesC & aKeyword )

Adds a search keyword. By default, no keywords are set

Parameters

const TDesC & aKeyword Search keyword to add.

ConstructL()

void ConstructL ( ) [protected]

Second phase constructor.

ContentPurposes()

TUint ContentPurposes ( ) const [virtual]

ExternalizeL(RWriteStream &)

void ExternalizeL ( RWriteStream & aStream ) [virtual]

Externalize member data.

Parameters

RWriteStream & aStream Destination stream.

InternalizeL(RReadStream &)

void InternalizeL ( RReadStream & aStream ) [virtual]

Internalize member data.

Parameters

RReadStream & aStream Source stream.

Keywords()

const MDesCArray & Keywords ( ) const [virtual]

NewL()

IMPORT_C CNcdSearchFilter * NewL ( ) [static]

Default factory method for CNcdSearchFilter objects. Leaves contents uninitialized.

NewL(const CNcdSearchFilter &)

IMPORT_C CNcdSearchFilter * NewL ( const CNcdSearchFilter & aFilter ) [static]

Factory method for CNcdSearchFilter objects. Initializes as a copy of another filter.

Parameters

const CNcdSearchFilter & aFilter Initialization copy source.

NewL(RReadStream &)

IMPORT_C CNcdSearchFilter * NewL ( RReadStream & aStream ) [static]

Factory method for CNcdSearchFilter objects. Initializes from a stream externalized with CNcdSearchFilter::ExternalizeL() .

Parameters

RReadStream & aStream Initialization source stream.

NewLC()

IMPORT_C CNcdSearchFilter * NewLC ( ) [static]

Default factory method for CNcdSearchFilter objects. Leaves contents uninitialized. Leaves object pointer on cleanup stack.

NewLC(const CNcdSearchFilter &)

IMPORT_C CNcdSearchFilter * NewLC ( const CNcdSearchFilter & aFilter ) [static]

Factory method for CNcdSearchFilter objects. Initializes as a copy of another filter. Leaves object pointer on cleanup stack.

Parameters

const CNcdSearchFilter & aFilter Initialization copy source.

NewLC(RReadStream &)

IMPORT_C CNcdSearchFilter * NewLC ( RReadStream & aStream ) [static]

Factory method for CNcdSearchFilter objects. Initializes from a stream externalized with CNcdSearchFilter::ExternalizeL() . Leaves object pointer on cleanup stack.

Parameters

RReadStream & aStream Initialization source stream.

RecursionDepth()

TUint RecursionDepth ( ) const [virtual]

SearchMode()

MNcdSearchFilter::TSearchMode SearchMode ( ) const [virtual]

SetContentPurposes(TUint)

IMPORT_C void SetContentPurposes ( TUint aFlags )

Set flags for filtering by content purpose. By default, no content flags are set

TNcdItemPurpose

Parameters

TUint aFlags Content flags for filtering. A combination of TNcdItemPurpose flags.

SetRecursionDepthL(TUint)

IMPORT_C void SetRecursionDepthL ( TUint aRecursionDepth )

Set recursion depth

By default, recursion depth is 2. Depth of 0 disabled recursion

leave
KErrArgument if aRecursionDepth is greater than 5

Parameters

TUint aRecursionDepth Depth of recursion

SetSearchMode(MNcdSearchFilter::TSearchMode)

IMPORT_C void SetSearchMode ( MNcdSearchFilter::TSearchMode aMode )

Set search mode

By default, mode is ENormal

Parameters

MNcdSearchFilter::TSearchMode aMode Search mode

Member Data Documentation

CDesCArray * iKeywords

CDesCArray * iKeywords [private]

Keywords to filter the search based on

TUint iPurposes

TUint iPurposes [private]

Purposes to filter the search based on

TUint iRecursionDepth

TUint iRecursionDepth [private]

Recursion depth

MNcdSearchFilter::TSearchMode iSearchMode

MNcdSearchFilter::TSearchMode iSearchMode [private]

Search mode