Class TAgnsrvTidyFilter

TAgnsrvTidyFilter

Support

Supported from 5.0

Description

An agenda model filter which additionally allows all entries except crossed-out to be filtered out. This class is used when tidying an agenda file.

Derivation

TAgnFilter Identifies which model entry types should be involved when tidying, finding or populating an instance or symbol list TAgnsrvTidyFilter An agenda model filter which additionally allows all entries except crossed-out to be filtered out

Defined in TAgnsrvTidyFilter:
ExternalizeL(), IncludeCrossedOutOnly(), InternalizeL(), IsValid(), SetIncludeCrossedOutOnly(), TAgnsrvTidyFilter(), Type()

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

TAgnsrvTidyFilter();

Description

Constructs a tidy filter object. The ‘include crossed out only’ flag is initialised to False.

void SetIncludeCrossedOutOnly(TBool aIncludeCrossedOutOnly);

Description

Sets the ‘include crossed out only’ flag. When this flag is set True, the filter is also set to include crossed out entries (see TAgnFilter::SetIncludeCrossedOut()).

Parameters

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

TBool IncludeCrossedOutOnly() const;

Description

Tests whether the ‘include crossed out 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 ETidyFilter.

virtual TBool IsValid(const CAgnSortEntry* aElement) const;

Description

Tests whether the entry is valid with respect to the filter by calling TAgnFilter::IsValid(). In addition, if the filter is set to include crossed out entries only, non-crossed out entries 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 tidy filter object to a write stream.

Parameters

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

void InternalizeL(RReadStream& aStream);

Description

Internalises the tidy filter object from a read stream.

Parameters

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