Class TAgnDayFilter

TAgnDayFilter

Support

Supported from 5.0

Description

An agenda model filter which additionally filters out any to-do entries which should not be displayed, either because they do not belong to a to-do list in the model’s list of to-do lists or because to-do entries are not displayed.

Derivation

TAgnDayFilter An agenda model filter which additionally filters out any to-do entries which should not be displayed, either because they do not belong to a to-do list in the model's list of to-do lists or because to-do entries are not displayed TAgnFilter Identifies which model entry types should be involved when tidying, finding or populating an instance or symbol list

Defined in TAgnDayFilter:
IsValid(), TAgnDayFilter(), 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

TAgnDayFilter(CAgnEntryModel* aEntryModel);

Description

The C++ constructor is used to construct the object with an agenda model. The model’s to-do list settings are used by the IsValid() function.

Parameters

CAgnEntryModel* aEntryModel Pointer to the agenda model.

virtual TAgnFilter::TType Type();

Description

Returns a filter type of EDayFilter.

Return value

TAgnFilter::TType The filter type.

virtual TBool IsValid(const CAgnSortEntry* aElement) const;

Description

Tests whether the specified entry is included in or excluded from the filter. Calls TAgnFilter::IsValid(), then additionally, if the entry is a to-do, tests whether it should be displayed (to be displayed, it must belong to one of the model’s to-do lists, and it should not be crossed out if crossed out entries are not displayed).

Parameters

const CAgnSortEntry* aElement The entry.

Return value

TBool ETrue if the entry is valid with respect to the filter, EFalse if invalid.