Symbian^3 Product Developer Library >

CalenAgendaUtils Class Reference

class CalenAgendaUtils
Public Member Functions
IMPORT_C voidCreateEntryIdListForDayL(RPointerArray< CCalInstance > &, CCalInstanceView *, const TTime &, const TBool, const TBool)
IMPORT_C TTimeIntervalMinutesDurationL(const CCalEntry &)
IMPORT_C TBoolEndsAtStartOfDayL(CCalInstance *, const TTime &)
IMPORT_C TTimeEntryTimeL(const CCalEntry &)
IMPORT_C voidFindEventsForDayRangeL(CCalInstanceView *, RPointerArray< CCalInstance > &, const CalCommon::TCalViewFilter &, const TTime &, const TTime &)
IMPORT_C voidFindTodosForDayRangeL(CCalInstanceView *, RPointerArray< CCalInstance > &, const TTime &, const TTime &)
IMPORT_C TBoolIsEmptyText(const TDesC &)
IMPORT_C TBoolIsRepeatingL(const CCalEntry &)
IMPORT_C TBoolIsTimedEntryL(CCalEntry::TType)
IMPORT_C voidRemoveEntriesEndingAtMidnightL(RPointerArray< CCalInstance > &, const TTime &)
IMPORT_C voidSortInstanceList(RPointerArray< CCalInstance > &)
IMPORT_C voidSortPopupInstanceList(RPointerArray< CCalInstance > &)
Private Member Functions
TInt CompareNonTimedNotesL(const CCalInstance &, const CCalInstance &)
TInt CompareTimedNotesL(const CCalInstance &, const CCalInstance &)
TInt CompareToDosL(const CCalEntry &, const CCalEntry &)
TInt DoEntryCompareL(const CCalInstance &, const CCalInstance &)
TInt DoPopupEntryCompareL(const CCalInstance &, const CCalInstance &)
TInt EntryCompare(const CCalInstance &, const CCalInstance &)
TInt PopupEntryCompare(const CCalInstance &, const CCalInstance &)
Private Member Enumerations
enumTCompareResult { EEqual = 0, ELessThan = -1, EGreaterThan = 1 }

Member Functions Documentation

CompareNonTimedNotesL(const CCalInstance &, const CCalInstance &)

TInt CompareNonTimedNotesL(const CCalInstance &aInstance1,
const CCalInstance &aInstance2
)[private, static]

Parameters

const CCalInstance & aInstance1
const CCalInstance & aInstance2

CompareTimedNotesL(const CCalInstance &, const CCalInstance &)

TInt CompareTimedNotesL(const CCalInstance &aInstance1,
const CCalInstance &aInstance2
)[private, static]

Parameters

const CCalInstance & aInstance1
const CCalInstance & aInstance2

CompareToDosL(const CCalEntry &, const CCalEntry &)

TInt CompareToDosL(const CCalEntry &aEntry1,
const CCalEntry &aEntry2
)[private, static]

Parameters

const CCalEntry & aEntry1
const CCalEntry & aEntry2

CreateEntryIdListForDayL(RPointerArray< CCalInstance > &, CCalInstanceView *, const TTime &, const TBool, const TBool)

IMPORT_C voidCreateEntryIdListForDayL(RPointerArray< CCalInstance > &aList,
CCalInstanceView *aInstanceView,
const TTime &aDay,
const TBoolaSortForPopup = EFalse,
const TBoolaIncludeToDos = ETrue
)[static]

Parameters

RPointerArray< CCalInstance > & aListThe list will contain all the entries for the specified day once the function completes
CCalInstanceView * aInstanceViewThe instance view from which all the instances of the entries will be fetched
const TTime & aDayThe day for which the instances of the entries have to be fetched
const TBool aSortForPopup = EFalseEFalse by default, does not sort the list. Must be ETrue if the entries need to be sorted by start time
const TBool aIncludeToDos = ETrueETrue by default, includes To-do's also in the list. Must be EFalse if To-do's must be excluded from the list

DoEntryCompareL(const CCalInstance &, const CCalInstance &)

TInt DoEntryCompareL(const CCalInstance &aInstance1,
const CCalInstance &aInstance2
)[private, static]

Parameters

const CCalInstance & aInstance1
const CCalInstance & aInstance2

DoPopupEntryCompareL(const CCalInstance &, const CCalInstance &)

TInt DoPopupEntryCompareL(const CCalInstance &aInstance1,
const CCalInstance &aInstance2
)[private, static]

Parameters

const CCalInstance & aInstance1
const CCalInstance & aInstance2

DurationL(const CCalEntry &)

IMPORT_C TTimeIntervalMinutesDurationL(const CCalEntry &aEntry)[static]

Parameters

const CCalEntry & aEntryThe entry for which duration is required

EndsAtStartOfDayL(CCalInstance *, const TTime &)

IMPORT_C TBoolEndsAtStartOfDayL(CCalInstance *aInstance,
const TTime &aDay
)[static]

Parameters

CCalInstance * aInstanceThe instance for which the check needs to be done
const TTime & aDayThe day in question

EntryCompare(const CCalInstance &, const CCalInstance &)

TInt EntryCompare(const CCalInstance &aInstance1,
const CCalInstance &aInstance2
)[private, static]

Parameters

const CCalInstance & aInstance1
const CCalInstance & aInstance2

EntryTimeL(const CCalEntry &)

IMPORT_C TTimeEntryTimeL(const CCalEntry &aEntry)[static]

Parameters

const CCalEntry & aEntryThe entry for which the start time is needed

FindEventsForDayRangeL(CCalInstanceView *, RPointerArray< CCalInstance > &, const CalCommon::TCalViewFilter &, const TTime &, const TTime &)

IMPORT_C voidFindEventsForDayRangeL(CCalInstanceView *aInstanceView,
RPointerArray< CCalInstance > &aList,
const CalCommon::TCalViewFilter &aFilter,
const TTime &aStartDay,
const TTime &aEndDay
)[static]

Parameters

CCalInstanceView * aInstanceViewThe instance view from which all the instances of the entries will be fetched
RPointerArray< CCalInstance > & aListThe list will contain all the entries for the specified day range once the function completes
const CalCommon::TCalViewFilter & aFilterMentions the filtering criteria as specified by CalCommon::TCalViewFilter
const TTime & aStartDayThe start day
const TTime & aEndDayThe end day

FindTodosForDayRangeL(CCalInstanceView *, RPointerArray< CCalInstance > &, const TTime &, const TTime &)

IMPORT_C voidFindTodosForDayRangeL(CCalInstanceView *aInstanceView,
RPointerArray< CCalInstance > &aList,
const TTime &aStartDay,
const TTime &aEndDay
)[static]

Parameters

CCalInstanceView * aInstanceViewThe instance view from which all the instances of the To-Do's will be fetched
RPointerArray< CCalInstance > & aListThe list will contain all the To-Do's for the specified day range once the function completes
const TTime & aStartDayThe start day
const TTime & aEndDayThe end day

IsEmptyText(const TDesC &)

IMPORT_C TBoolIsEmptyText(const TDesC &aDes)[static]

Parameters

const TDesC & aDesThe text to check

IsRepeatingL(const CCalEntry &)

IMPORT_C TBoolIsRepeatingL(const CCalEntry &aEntry)[static]

Parameters

const CCalEntry & aEntryThe entry to be checked

IsTimedEntryL(CCalEntry::TType)

IMPORT_C TBoolIsTimedEntryL(CCalEntry::TTypeaType)[static]

Parameters

CCalEntry::TType aTypeThe entry type

PopupEntryCompare(const CCalInstance &, const CCalInstance &)

TInt PopupEntryCompare(const CCalInstance &aInstance1,
const CCalInstance &aInstance2
)[private, static]

Parameters

const CCalInstance & aInstance1
const CCalInstance & aInstance2

RemoveEntriesEndingAtMidnightL(RPointerArray< CCalInstance > &, const TTime &)

IMPORT_C voidRemoveEntriesEndingAtMidnightL(RPointerArray< CCalInstance > &aList,
const TTime &aDay
)[static]

Parameters

RPointerArray< CCalInstance > & aListThe list of all the instances from which the entries ending at midnight needs to be removed
const TTime & aDayThe day for which the information is requested

SortInstanceList(RPointerArray< CCalInstance > &)

IMPORT_C voidSortInstanceList(RPointerArray< CCalInstance > &aInstanceList)[static]

Parameters

RPointerArray< CCalInstance > & aInstanceListWill contain the sorted list of entries once the function completes

SortPopupInstanceList(RPointerArray< CCalInstance > &)

IMPORT_C voidSortPopupInstanceList(RPointerArray< CCalInstance > &aInstanceList)[static]

Parameters

RPointerArray< CCalInstance > & aInstanceListWill contain the sorted list of entries once the function completes

Member Enumerations Documentation

Enum TCompareResult

Enumerators

EEqual = 0
ELessThan = -1
EGreaterThan = 1

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.