Symbian^3 Application Developer Library >

CalenAgendaUtils Class Reference

class CalenAgendaUtils
Public Member Functions
IMPORT_C void CreateEntryIdListForDayL ( RPointerArray < CCalInstance > &, CCalInstanceView *, const TTime &, const TBool , const TBool )
IMPORT_C TTimeIntervalMinutes DurationL (const CCalEntry &)
IMPORT_C TBool EndsAtStartOfDayL ( CCalInstance *, const TTime &)
IMPORT_C TTime EntryTimeL (const CCalEntry &)
IMPORT_C void FindEventsForDayRangeL ( CCalInstanceView *, RPointerArray < CCalInstance > &, const CalCommon::TCalViewFilter &, const TTime &, const TTime &)
IMPORT_C void FindTodosForDayRangeL ( CCalInstanceView *, RPointerArray < CCalInstance > &, const TTime &, const TTime &)
IMPORT_C TBool IsEmptyText (const TDesC &)
IMPORT_C TBool IsRepeatingL (const CCalEntry &)
IMPORT_C TBool IsTimedEntryL ( CCalEntry::TType )
IMPORT_C void RemoveEntriesEndingAtMidnightL ( RPointerArray < CCalInstance > &, const TTime &)
IMPORT_C void SortInstanceList ( RPointerArray < CCalInstance > &)
IMPORT_C void SortPopupInstanceList ( 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
enum TCompareResult { 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 void CreateEntryIdListForDayL ( RPointerArray < CCalInstance > & aList,
CCalInstanceView * aInstanceView,
const TTime & aDay,
const TBool aSortForPopup = EFalse,
const TBool aIncludeToDos = ETrue
) [static]

Parameters

RPointerArray < CCalInstance > & aList The list will contain all the entries for the specified day once the function completes
CCalInstanceView * aInstanceView The instance view from which all the instances of the entries will be fetched
const TTime & aDay The day for which the instances of the entries have to be fetched
const TBool aSortForPopup = EFalse EFalse by default, does not sort the list. Must be ETrue if the entries need to be sorted by start time
const TBool aIncludeToDos = ETrue ETrue 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 TTimeIntervalMinutes DurationL ( const CCalEntry & aEntry ) [static]

Parameters

const CCalEntry & aEntry The entry for which duration is required

EndsAtStartOfDayL(CCalInstance *, const TTime &)

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

Parameters

CCalInstance * aInstance The instance for which the check needs to be done
const TTime & aDay The 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 TTime EntryTimeL ( const CCalEntry & aEntry ) [static]

Parameters

const CCalEntry & aEntry The entry for which the start time is needed

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

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

Parameters

CCalInstanceView * aInstanceView The instance view from which all the instances of the entries will be fetched
RPointerArray < CCalInstance > & aList The list will contain all the entries for the specified day range once the function completes
const CalCommon::TCalViewFilter & aFilter Mentions the filtering criteria as specified by CalCommon::TCalViewFilter
const TTime & aStartDay The start day
const TTime & aEndDay The end day

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

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

Parameters

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

IsEmptyText(const TDesC &)

IMPORT_C TBool IsEmptyText ( const TDesC & aDes ) [static]

Parameters

const TDesC & aDes The text to check

IsRepeatingL(const CCalEntry &)

IMPORT_C TBool IsRepeatingL ( const CCalEntry & aEntry ) [static]

Parameters

const CCalEntry & aEntry The entry to be checked

IsTimedEntryL(CCalEntry::TType)

IMPORT_C TBool IsTimedEntryL ( CCalEntry::TType aType ) [static]

Parameters

CCalEntry::TType aType The 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 void RemoveEntriesEndingAtMidnightL ( RPointerArray < CCalInstance > & aList,
const TTime & aDay
) [static]

Parameters

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

SortInstanceList(RPointerArray< CCalInstance > &)

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

Parameters

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

SortPopupInstanceList(RPointerArray< CCalInstance > &)

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

Parameters

RPointerArray < CCalInstance > & aInstanceList Will 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.