Class TAgnFilter

TAgnFilter

Support

Supported from 5.0

Description

Identifies which model entry types should be involved when tidying, finding or populating an instance or symbol list. It is usually used in combination with a date or date range.

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

TAgnFilter();

Description

The default C++ constructor constructs the filter and sets it to include all entry types.

void SetIncludeAlarmedOnly(TBool aIncludeAlarmed);

Description

Sets whether the filter should only include alarmed entries.

Parameters

TBool aIncludeAlarmed True=only include alarmed entries, False=do not only include alarmed entries.

void SetIncludeAnnivs(TBool aIncludeAnnivs);

Description

Sets the filter to include / exclude anniversary entries.

Parameters

TBool aIncludeAnnivs True=Include, False=Exclude.

void SetIncludeCrossedOut(TBool aIncludeCrossedOut);

Description

Sets the filter to include / exclude crossed-out entries.

Parameters

TBool aIncludeCrossedOut True=Include, False=Exclude.

void SetIncludeCrossedOutOnly(TBool aIncludeCrossedOutOnly);

Support

Supported from 6.0

Description

Sets whether the filter should only include crossed-out entries.

Parameters

TBool aIncludeCrossedOutOnly True=only include crossed-out entries, False=do not only include crossed-out entries.

void SetIncludeEvents(TBool aIncludeEvents);

Description

Sets the filter to include / exclude event entries.

Parameters

TBool aIncludeEvents True=Include, False=Exclude.

void SetIncludeNonRpts(TBool aIncludeNonRpts);

Description

Sets the filter to include / exclude non-repeated entries.

Parameters

TBool aIncludeNonRpts True=Include, False=Exclude.

void SetIncludeRpts(TBool aIncludeRpts);

Description

Sets the filter to include / exclude repeated entries.

Parameters

TBool aIncludeRpts True=Include, False=Exclude.

void SetIncludeRptsNextInstanceOnly(TBool aIncludeRptsNextInstanceOnly);

Description

Sets the filter to include / exclude the next instance only of repeated entries.

Parameters

TBool aIncludeRptsNextInstanceOnly True=Include only the next instance of a repeat, False=Do not include only the next instance of a repeat.

void SetIncludeTimedAppts(TBool aIncludeTimedAppts);

Description

Sets the filter to include / exclude timed appointments.

Parameters

TBool aIncludeTimedAppts True=Include, False=Exclude.

void SetIncludeTodos(TBool aIncludeTodos);

Description

Sets the filter to include / exclude to-do entries.

Parameters

TBool aIncludeTodos True=Include, False=Exclude.

void SetIncludeUnTimedAppts(TBool aIncludeUntimedAppts);

Description

Sets the filter to include / exclude untimed appointments, i.e. day notes.

Parameters

TBool aIncludeUntimedAppts True=Include, False=Exclude.

virtual TType Type();

Description

This is overridden by the derived classes TAgnSymbolFilter, TAgnDayFilter, TAgnSrvFindFilter and TAgnSrvTidyFilter to return the type of filter. This implementation returns EAgnFilter.

Return value

TType EAgnFilter.

TBool AreAlarmedOnlyIncluded() const;

Description

Returns whether the filter only includes alarmed entries.

Return value

TBool True=Only alarmed entries included, False=Does not only include alarmed entries.

TBool AreAnnivsIncluded() const;

Description

Returns whether the filter includes / excludes anniversaries.

Return value

TBool True=Included, False=Excluded.

TBool AreCrossedOutIncluded() const;

Description

Returns whether the filter includes / excludes crossed-out entries.

Return value

TBool True=Included, False=Excluded.

TBool AreCrossedOutOnlyIncluded() const;

Support

Supported from 6.0

Description

Returns whether the filter only includes crossed-out entries.

Return value

TBool True=Only crossed-out entries included, False=Does not only include crossed-out entries.

TBool AreEventsIncluded() const;

Description

Returns whether the filter includes / excludes events.

Return value

TBool True=Included, False=Excluded.

TBool AreNonRptsIncluded() const;

Description

Returns whether the filter includes / excludes non-repeating entries.

Return value

TBool True=Included, False=Excluded.

TBool AreRptsIncluded() const;

Description

Returns whether the filter includes / excludes repeating entries.

Return value

TBool True=Included, False=Excluded.

TBool AreTimedApptsIncluded() const;

Description

Returns whether the filter includes / excludes timed appointments.

Return value

TBool True=Included, False=Excluded.

TBool AreTodosIncluded() const;

Description

Returns whether the filter includes / excludes to-do entries.

Return value

TBool True=Included, False=Excluded.

TBool AreUnTimedApptsIncluded() const;

Description

Returns whether the filter includes / excludes untimed appointments, i.e. day notes.

Return value

TBool True=Included, False=Excluded.

TBool RptNextInstanceOnly() const;

Description

Returns whether the filter only includes the next instance of a repeating entry.

Return value

TBool True=Only includes the next instance of a repeating entry, False=Does not only include the next instance of a repeating entry.

virtual TBool IsValid(const CAgnSortEntry* aElement) const;

Description

Returns whether the type of the specified entry is included in or excluded from the filter.

Parameters

const CAgnSortEntry* aElement The entry.

Return value

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

TBool IsValid(const TAgnLiteEntry& aLiteEntry) const;

Description

Returns whether the type of the specified entry is included in or excluded from the filter.

Parameters

const TAgnLiteEntry& aLiteEntry The entry.

Return value

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

TType

Description

Filter type

EAgnFilter Default filter type. EDayFilter Indicates the filter is a TAgnDayFilter. ESymbolFilter Indicates the filter is a TAgnSymbolFilter. EFindFilter Indicates the filter is a TAgnsrvFindFilter. ETidyFilter Indicates the filter is a TAgnsrvTidyFilter.