Class TAgnSymbolFilter

TAgnSymbolFilter

Support

Supported from 5.0

Description

A day filter which additionally may store an entry symbol. If it does, only instances with a matching entry symbol are valid. A flag is used to indicate whether or not the filter has an entry symbol. This class is used when populating year views.

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 TAgnSymbolFilter A day filter which additionally may store an entry symbol

Defined in TAgnSymbolFilter:
EntrySymbol(), ExternalizeL(), HasEntrySymbol(), InternalizeL(), IsValid(), SetEntrySymbol(), SetHasEntrySymbol(), TAgnSymbolFilter(), 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

TAgnSymbolFilter(CAgnEntryModel* aEntryModel);

Description

C++ constructor with an agenda entry model. The filter is initialised to have no entry symbol.

Parameters

CAgnEntryModel* aEntryModel Pointer to the agenda model.

void SetHasEntrySymbol(TBool aHasEntrySymbol);

Description

Sets the ‘has entry symbol’ flag.

Parameters

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

void SetEntrySymbol(TText aEntrySymbol);

Description

Sets the entry symbol and sets the ‘has entry symbol’ flag to True.

Parameters

TText aEntrySymbol The entry symbol.

TBool HasEntrySymbol() const;

Description

Tests whether the filter has an entry symbol.

Return value

TBool True if the filter has an entry symbol, otherwise False.

TText16 EntrySymbol() const;

Description

Gets the entry symbol, as set by SetEntrySymbol().

Return value

TText16 The entry symbol.

virtual TAgnFilter::TType Type();

Description

Gets the filter type.

Return value

TAgnFilter::TType The type, (ESymbolFilter).

virtual TBool IsValid(const CAgnSortEntry* aElement) const;

Description

Tests whether the entry is valid. Calls TAgnDayFilter::IsValid(). Then additionally, filters out the following:

• all entries with no entry symbol

• if the filter has an entry symbol, entries which have an entry symbol if the two symbols do not match.

Parameters

const CAgnSortEntry* aElement Pointer to the entry.

Return value

TBool True if valid, otherwise False.

void ExternalizeL(RWriteStream& aStream) const;

Description

Externalises the filter object to a write stream.

Parameters

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

void InternalizeL(RReadStream& aStream);

Description

Internalises the filter object from a read stream.

Parameters

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