TAgnFilter Class Reference

class TAgnFilter

Identifies which model entry types should be involved when tidying, searching or populating an instance or symbol list.

It is usually used in combination with a date or date range.

Constructor & Destructor Documentation

TAgnFilter()

IMPORT_CTAgnFilter()

TAgnFilter(const CalCommon::TCalViewFilter &, const CalCommon::TCalSearchBehaviour &)

IMPORT_CTAgnFilter(const CalCommon::TCalViewFilter &aFilter,
const CalCommon::TCalSearchBehaviour &aBehaviour
)

Parameters

const CalCommon::TCalViewFilter & aFilter
const CalCommon::TCalSearchBehaviour & aBehaviour

Member Functions Documentation

AreAlarmedOnlyIncluded()

TBool AreAlarmedOnlyIncluded()const [inline]

Tests whether the filter only includes alarmed entries.

True=Only include alarmed entries, False=include all entries.

AreAnnivsIncluded()

TBool AreAnnivsIncluded()const [inline]

Tests whether the filter includes or excludes anniversaries.

True=included, False=excluded.

AreCompletedTodosIncluded()

TBool AreCompletedTodosIncluded()const [inline]

AreEventsIncluded()

TBool AreEventsIncluded()const [inline]

Tests whether the filter includes or excludes events.

True=included, False=excluded.

AreIncompletedTodosIncluded()

TBool AreIncompletedTodosIncluded()const [inline]

AreNonTodosIncluded()

TBool AreNonTodosIncluded()const [inline]

Tests whether the filter includes any entry type other than to-dos True=included, False=excluded.

AreRemindersIncluded()

TBool AreRemindersIncluded()const [inline]

Tests whether the filter includes or excludes reminders

True=included, False=excluded.

AreTimedApptsIncluded()

TBool AreTimedApptsIncluded()const [inline]

Tests whether the filter includes or excludes timed appointments.

True=included, False=excluded.

EndTimeOverlapOnly()

TBool EndTimeOverlapOnly()const [inline]

ExcludeInstanceAdjoiningRange()

TBool ExcludeInstanceAdjoiningRange()const [inline]

ExternalizeL(RWriteStream &)

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Parameters

RWriteStream & aStream

InternalizeL(RReadStream &)

IMPORT_C voidInternalizeL(RReadStream &aStream)

Parameters

RReadStream & aStream

IsAttendeeAddressSearched()

TBool IsAttendeeAddressSearched()const [inline]

IsAttendeeCommonNameSearched()

TBool IsAttendeeCommonNameSearched()const [inline]

IsAttendeeSentByAddressSearched()

TBool IsAttendeeSentByAddressSearched()const [inline]

IsEntryDescriptionSearched()

TBool IsEntryDescriptionSearched()const [inline]

IsEntryLocationSearched()

TBool IsEntryLocationSearched()const [inline]

IsExactTextOnlySearch()

TBool IsExactTextOnlySearch()const [inline]

IsFoldedOnlySearch()

TBool IsFoldedOnlySearch()const [inline]

IsOrganizerAddressSearched()

TBool IsOrganizerAddressSearched()const [inline]

IsOrganizerCommonNameSearched()

TBool IsOrganizerCommonNameSearched()const [inline]

IsOrganizerSentByAddressSearched()

TBool IsOrganizerSentByAddressSearched()const [inline]

IsValid(const CAgnSimpleEntry &)

IMPORT_C TBoolIsValid(const CAgnSimpleEntry &aElement)const

Parameters

const CAgnSimpleEntry & aElement

RptNextInstanceOnly()

TBool RptNextInstanceOnly()const [inline]

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

True=only include the next instance of a repeating entry, False=include all instances.

StartTimeOverlapOnly()

TBool StartTimeOverlapOnly()const [inline]

Member Data Documentation

CalCommon::TCalViewFilter iFilter

CalCommon::TCalViewFilter iFilter[private]

TUint iHighPriority

TUint iHighPriority

TUint iLowPriority

TUint iLowPriority

The search range of priority.

CalCommon::TCalSearchBehaviour iSearchBehaviour

CalCommon::TCalSearchBehaviour iSearchBehaviour[private]

TUint32 iUserIntFilterMask

TUint32 iUserIntFilterMask

TUint32 iUserIntFilterValue

TUint32 iUserIntFilterValue

The search criteria for UserInt(32 bits integer).