CAgnSimpleEntry Class Reference

class CAgnSimpleEntry : public CBase

Base class for agenda entry types.

It provides an interface to the following entry attributes:

  • type

  • repeat information

  • entry id

  • last changed date

  • alarm time

  • priority

  • status

  • start and end time

CAgnSimpleEntry is the base class for the full entry CAgnEntry.

On the client side, CAgnSimpleEntry is used as the 'light entry' which is stored in an instance. Calling FindInstanceL will return CCalInstances. Each of these CCalInstances will reference a 'light entry', which is a CAgnSimpleEntry. If a function is called on the instance which cannot be handled by CAgnSimpleEntry, the full CAgnEntry will be loaded.

On the server side, CAgnSimpleEntry is used in the entry index - CAgnIndex. There is one main index of CAgnSimpleEntrys, other indexes contain pointers to simple entries in that index.

Inherits from

Public Member Functions
IMPORT_C voidAdjustStartUntilTimeForRepEntryL()
IMPORT_C TTimeIntervalMinutesAlarmOffset()
IMPORT_C voidClearRepeat()
IMPORT_C TCalCollectionIdCollectionId()
IMPORT_C const TTime &CompletedDateUtc()
voidCopySimpleEntryL(const CAgnSimpleEntry &, CCalEntry::TCopyType)
IMPORT_C TTimeDurationMinusL(const TTime &)
IMPORT_C TTimeDurationPlusL(const TTime &)
IMPORT_C const TAgnCalendarTime &EndTime()
IMPORT_C const TAgnEntryId &EntryId()
IMPORT_C const TAgnCalendarTime &EntryTime()
IMPORT_C voidExternalizeGuidHashL(RWriteStream &)
IMPORT_C voidExternalizeL(RWriteStream &, TBool)
IMPORT_C TUint32GuidHash()
IMPORT_C TBoolHasAlarm()
IMPORT_C voidInternalizeGuidHashL(RReadStream &)
IMPORT_C voidInternalizeL(RReadStream &, TBool)
IMPORT_C const TTime &LastModifiedDateUtc()
IMPORT_C TCalLocalUidLocalUid()
IMPORT_C TBoolMoveStartTimeLocalL(const TTime &)
IMPORT_C TUint8Priority()
IMPORT_C CAgnRptDef *RptDef()
IMPORT_C const CAgnRptDef *RptDef()
IMPORT_C voidSetAlarmOffset(const TTimeIntervalMinutes &)
IMPORT_C voidSetCollectionId(TCalCollectionId)
IMPORT_C voidSetCompletedDateUtcL(const TTime &)
IMPORT_C voidSetEntryId(const TAgnEntryId &)
IMPORT_C voidSetGuidHash(TUint32)
IMPORT_C voidSetIncomplete()
IMPORT_C voidSetLastModifiedDate()
IMPORT_C voidSetLastModifiedDateUtc(const TTime &)
IMPORT_C voidSetLocalUid(TCalLocalUid)
IMPORT_C voidSetPriority(TUint8)
IMPORT_C voidSetRptDefL(const CAgnRptDef &)
IMPORT_C voidSetStartAndEndTimeL(const TAgnCalendarTime &, const TAgnCalendarTime &)
IMPORT_C voidSetStatus(CCalEntry::TStatus)
IMPORT_C voidSetUserInt(TUint32)
IMPORT_C const TAgnCalendarTime &StartTime()
IMPORT_C CCalEntry::TStatusStatus()
IMPORT_C MAgnCalendarTimeMode::TTimeModeTimeMode()
IMPORT_C CCalEntry::TTypeType()
IMPORT_C TUint32UserInt()
IMPORT_C TTimeValidFromTimeLocalL()
IMPORT_C TTimeValidToTimeLocalL()
voiddoExternalizeL(RWriteStream &, TBool)
voiddoInternalizeL(RReadStream &, TBool)
TBool operator==(const CAgnSimpleEntry &)
Protected Member Functions
CAgnSimpleEntry(CCalEntry::TType)
~CAgnSimpleEntry()
voidStartTimeChanged()
TAny *operator new(TUint, TLeave, CAgnSimpleEntryAllocator *)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
TInt32 iAlarmOffset
TCalCollectionId iCollectionId
TTime iCompletedDateUtc
TAgnCalendarTime iEndTime
TAgnEntryId iEntryId
TUint32 iGuidHash
TTime iLastModifiedDateUtc
TCalLocalUid iLocalUid
TUint8 iPriority
TUint8 iReserved
CAgnRptDef *iRptDef
TAgnCalendarTime iStartTime
TUint8 iStatus
TUint8 iType
TUint32 iUserInt

Constructor & Destructor Documentation

CAgnSimpleEntry(CCalEntry::TType)

CAgnSimpleEntry(CCalEntry::TTypeaType)[protected]

Parameters

CCalEntry::TType aType

~CAgnSimpleEntry()

~CAgnSimpleEntry()[protected, virtual]

Member Functions Documentation

AdjustStartUntilTimeForRepEntryL()

IMPORT_C voidAdjustStartUntilTimeForRepEntryL()

AlarmOffset()

IMPORT_C TTimeIntervalMinutesAlarmOffset()const

ClearRepeat()

IMPORT_C voidClearRepeat()

CollectionId()

IMPORT_C TCalCollectionIdCollectionId()const

CompletedDateUtc()

IMPORT_C const TTime &CompletedDateUtc()const

CopySimpleEntryL(const CAgnSimpleEntry &, CCalEntry::TCopyType)

voidCopySimpleEntryL(const CAgnSimpleEntry &aSimpleEntry,
CCalEntry::TCopyTypeaCopyType
)

Parameters

const CAgnSimpleEntry & aSimpleEntry
CCalEntry::TCopyType aCopyType

DurationMinusL(const TTime &)

IMPORT_C TTimeDurationMinusL(const TTime &aTime)const

Parameters

const TTime & aTime

DurationPlusL(const TTime &)

IMPORT_C TTimeDurationPlusL(const TTime &aTime)const

Parameters

const TTime & aTime

EndTime()

IMPORT_C const TAgnCalendarTime &EndTime()const

EntryId()

IMPORT_C const TAgnEntryId &EntryId()const

EntryTime()

IMPORT_C const TAgnCalendarTime &EntryTime()const

ExternalizeGuidHashL(RWriteStream &)

IMPORT_C voidExternalizeGuidHashL(RWriteStream &aWriteStream)const

Parameters

RWriteStream & aWriteStream

ExternalizeL(RWriteStream &, TBool)

IMPORT_C voidExternalizeL(RWriteStream &aStream,
TBoolaToBuffer = EFalse
)const [virtual]

Parameters

RWriteStream & aStream
TBool aToBuffer = EFalse

GuidHash()

IMPORT_C TUint32GuidHash()const

HasAlarm()

IMPORT_C TBoolHasAlarm()const

InternalizeGuidHashL(RReadStream &)

IMPORT_C voidInternalizeGuidHashL(RReadStream &aReadStream)

Parameters

RReadStream & aReadStream

InternalizeL(RReadStream &, TBool)

IMPORT_C voidInternalizeL(RReadStream &aStream,
TBoolaFromBuffer = EFalse
)[virtual]

Parameters

RReadStream & aStream
TBool aFromBuffer = EFalse

LastModifiedDateUtc()

IMPORT_C const TTime &LastModifiedDateUtc()const

LocalUid()

IMPORT_C TCalLocalUidLocalUid()const

MoveStartTimeLocalL(const TTime &)

IMPORT_C TBoolMoveStartTimeLocalL(const TTime &aNewStartTimeLocal)

Parameters

const TTime & aNewStartTimeLocal

Priority()

IMPORT_C TUint8Priority()const

RptDef()

IMPORT_C CAgnRptDef *RptDef()

RptDef()

IMPORT_C const CAgnRptDef *RptDef()const

SetAlarmOffset(const TTimeIntervalMinutes &)

IMPORT_C voidSetAlarmOffset(const TTimeIntervalMinutes &aStartTimeOffset)

Parameters

const TTimeIntervalMinutes & aStartTimeOffset

SetCollectionId(TCalCollectionId)

IMPORT_C voidSetCollectionId(TCalCollectionIdaFileId)

Parameters

TCalCollectionId aFileId

SetCompletedDateUtcL(const TTime &)

IMPORT_C voidSetCompletedDateUtcL(const TTime &aDateUtc)

Parameters

const TTime & aDateUtc

SetEntryId(const TAgnEntryId &)

IMPORT_C voidSetEntryId(const TAgnEntryId &aId)

Parameters

const TAgnEntryId & aId

SetGuidHash(TUint32)

IMPORT_C voidSetGuidHash(TUint32aGuidHash)

Parameters

TUint32 aGuidHash

SetIncomplete()

IMPORT_C voidSetIncomplete()

SetLastModifiedDate()

IMPORT_C voidSetLastModifiedDate()

SetLastModifiedDateUtc(const TTime &)

IMPORT_C voidSetLastModifiedDateUtc(const TTime &aLastChangedDateUtc)

Parameters

const TTime & aLastChangedDateUtc

SetLocalUid(TCalLocalUid)

IMPORT_C voidSetLocalUid(TCalLocalUidaUId)

Parameters

TCalLocalUid aUId

SetPriority(TUint8)

IMPORT_C voidSetPriority(TUint8aPriority)

Parameters

TUint8 aPriority

SetRptDefL(const CAgnRptDef &)

IMPORT_C voidSetRptDefL(const CAgnRptDef &aRptDef)

Parameters

const CAgnRptDef & aRptDef

SetStartAndEndTimeL(const TAgnCalendarTime &, const TAgnCalendarTime &)

IMPORT_C voidSetStartAndEndTimeL(const TAgnCalendarTime &aStartTime,
const TAgnCalendarTime &aEndTime
)

Parameters

const TAgnCalendarTime & aStartTime
const TAgnCalendarTime & aEndTime

SetStatus(CCalEntry::TStatus)

IMPORT_C voidSetStatus(CCalEntry::TStatusaStatus)

Parameters

CCalEntry::TStatus aStatus

SetUserInt(TUint32)

IMPORT_C voidSetUserInt(TUint32aUserInt)

Parameters

TUint32 aUserInt

StartTime()

IMPORT_C const TAgnCalendarTime &StartTime()const

StartTimeChanged()

voidStartTimeChanged()[protected]

Status()

IMPORT_C CCalEntry::TStatusStatus()const

TimeMode()

IMPORT_C MAgnCalendarTimeMode::TTimeModeTimeMode()const

Type()

IMPORT_C CCalEntry::TTypeType()const

UserInt()

IMPORT_C TUint32UserInt()const

ValidFromTimeLocalL()

IMPORT_C TTimeValidFromTimeLocalL()const

ValidToTimeLocalL()

IMPORT_C TTimeValidToTimeLocalL()const

doExternalizeL(RWriteStream &, TBool)

voiddoExternalizeL(RWriteStream &aStream,
TBoolaToBuffer
)const

Parameters

RWriteStream & aStream
TBool aToBuffer

doInternalizeL(RReadStream &, TBool)

voiddoInternalizeL(RReadStream &aStream,
TBoolaFromBuffer
)

Parameters

RReadStream & aStream
TBool aFromBuffer

operator new(TUint, TLeave, CAgnSimpleEntryAllocator *)

TAny *operator new(TUintaSize,
TLeaveaType,
CAgnSimpleEntryAllocator *aAllocator
)[protected]

Parameters

TUint aSize
TLeave aType
CAgnSimpleEntryAllocator * aAllocator

operator==(const CAgnSimpleEntry &)

TBool operator==(const CAgnSimpleEntry &aSimpleEntry)const

Parameters

const CAgnSimpleEntry & aSimpleEntry

Member Data Documentation

TInt32 iAlarmOffset

TInt32 iAlarmOffset[private]

TCalCollectionId iCollectionId

TCalCollectionId iCollectionId[private]

TTime iCompletedDateUtc

TTime iCompletedDateUtc[private]

TAgnCalendarTime iEndTime

TAgnCalendarTime iEndTime[private]

TAgnEntryId iEntryId

TAgnEntryId iEntryId[private]

TUint32 iGuidHash

TUint32 iGuidHash[private]

TTime iLastModifiedDateUtc

TTime iLastModifiedDateUtc[private]

TCalLocalUid iLocalUid

TCalLocalUid iLocalUid[private]

TUint8 iPriority

TUint8 iPriority[private]

TUint8 iReserved

TUint8 iReserved[private]

CAgnRptDef * iRptDef

CAgnRptDef *iRptDef[private]

TAgnCalendarTime iStartTime

TAgnCalendarTime iStartTime[private]

TUint8 iStatus

TUint8 iStatus[private]

TUint8 iType

TUint8 iType[private]

TUint32 iUserInt

TUint32 iUserInt[private]
© Nokia 2010.