Class TAgnsrvFindFilter

TAgnsrvFindFilter

Support

Supported from 5.0

Description

An agenda model filter which optionally uses a single entry symbol. If it does, instances which do not have an entry symbol, or have a different entry symbol are filtered out. This class is used when searching an agenda file. A flag is used to indicate whether or not the filter uses the entry symbol.

Derivation

TAgnFilter Identifies which model entry types should be involved when tidying, finding or populating an instance or symbol list TAgnsrvFindFilter An agenda model filter which optionally uses a single entry symbol

Defined in TAgnsrvFindFilter:
EntrySymbol(), ExternalizeL(), IncludeOneSymbolOnly(), InternalizeL(), IsValid(), SetEntrySymbol(), SetIncludeOneSymbolOnly(), TAgnsrvFindFilter(), Type()

Inherited from TAgnFilter:
AreAlarmedOnlyIncluded(), AreAnnivsIncluded(), AreCrossedOutIncluded(), AreCrossedOutOnlyIncluded(), AreEventsIncluded(), AreNonRptsIncluded(), AreRptsIncluded(), AreTimedApptsIncluded(), AreTodosIncluded(), AreUnTimedApptsIncluded(), EAgnFilter, EDayFilter, EFindFilter, ESymbolFilter, ETidyFilter, RptNextInstanceOnly(), SetIncludeAlarmedOnly(), SetIncludeAnnivs(), SetIncludeCrossedOut(), SetIncludeCrossedOutOnly(), SetIncludeEvents(), SetIncludeNonRpts(), SetIncludeRpts(), SetIncludeRptsNextInstanceOnly(), SetIncludeTimedAppts(), SetIncludeTodos(), SetIncludeUnTimedAppts(), TType

TAgnsrvFindFilter();

Description

The default C++ constructor constructs the find filter, initialising its entry symbol to ‘E’ and its “use one entry symbol only” flag to EFalse.

void SetEntrySymbol(TChar aSymbol);

Description

Sets the entry symbol. For the filter to use this entry symbol, you should call SetIncludeOneSymbolOnly() with an argument of ETrue.

Parameters

TChar aSymbol The symbol.

void SetIncludeOneSymbolOnly(TBool aOneSymbol);

Description

Sets the ‘include one entry symbol only’ flag.

Parameters

TBool aOneSymbol True to set the flag, False to clear the flag.

TChar EntrySymbol() const;

Description

Gets the entry symbol.

Return value

TChar The symbol.

TBool IncludeOneSymbolOnly() const;

Description

Tests whether the ‘include one entry symbol only’ flag is set.

Return value

TBool True if the flag is set, otherwise False.

TAgnFilter::TType Type();

Description

Gets the filter type.

Return value

TAgnFilter::TType The type (EFindFilter).

virtual TBool IsValid(const CAgnSortEntry* aElement) const;

Description

Tests whether the entry is valid with respect to the filter. Calls TAgnFilter::IsValid(). Additionally, if the filter has been set to use the single entry symbol, entries which do not have an entry symbol, or which have a different entry symbol are filtered out.

Parameters

const CAgnSortEntry* aElement Pointer to the entry.

Return value

TBool True if valid, False if not.

void ExternalizeL(RWriteStream& aStream) const;

Description

Externalises the find filter object to a write stream.

Parameters

RWriteStream& aStream Stream to which the object should be externalised.

void InternalizeL(RReadStream& aStream);

Description

Internalises the find filter object from a read stream.

Parameters

RReadStream& aStream Stream from which the object should be internalised.