Symbian^3 Application Developer Library >

CCalEntry Class Reference

class CCalEntry : public CBase

Class representing a calendar entry. This can be an appointment, to-do item, reminder, event or anniversary.

CCalEntry contains information about a calendar entry, including a repeat definition, synchronisation information, and group scheduling data.

A repeating calendar entry has more than one occurrence. Instances are represented by the CCalInstance class.

Synchronisation information includes a record of the date/time the entry was last modified. This can be found by calling the LastModifiedDateL() function.

Inherits from

Public Member Functions
~CCalEntry ()
IMPORT_C void AddAttachmentL (CCalAttachment &)
IMPORT_C void AddAttendeeL (CCalAttendee *)
IMPORT_C void AddCategoryL (CCalCategory *)
IMPORT_C CCalAlarm * AlarmL ()
IMPORT_C TInt AttachmentCountL ()
IMPORT_C CCalAttachment * AttachmentL ( TInt )
IMPORT_C RPointerArray < CCalAttendee > & AttendeesL ()
IMPORT_C const RPointerArray < CCalCategory > & CategoryListL ()
IMPORT_C void ClearGeoValueL ()
IMPORT_C void ClearRepeatingPropertiesL ()
IMPORT_C TBool CompareL (const CCalEntry &)
IMPORT_C TCalTime CompletedTimeL ()
IMPORT_C void CopyFromL (const CCalEntry &)
IMPORT_C void CopyFromL (const CCalEntry &, TCopyType )
IMPORT_C TCalTime DTStampL ()
IMPORT_C void DeleteAttachmentL (const CCalAttachment &)
IMPORT_C void DeleteAttendeeL ( TInt )
IMPORT_C void DeleteCategoryL ( TInt )
IMPORT_C const TDesC & DescriptionL ()
IMPORT_C TCalTime EndTimeL ()
IMPORT_C TType EntryTypeL ()
IMPORT_C TCalTime FindRptUntilTimeL ( TInt )
IMPORT_C CCalGeoValue * GeoValueL ()
IMPORT_C void GetExceptionDatesL ( RArray < TCalTime > &)
IMPORT_C void GetRDatesL ( RArray < TCalTime > &)
IMPORT_C TBool GetRRuleL (TCalRRule &)
CCalEntryImpl * Impl ()
IMPORT_C TCalTime LastModifiedDateL ()
IMPORT_C TCalLocalUid LocalUidL ()
IMPORT_C const TDesC & LocationL ()
IMPORT_C TMethod MethodL ()
IMPORT_C CCalEntry * NewL ( TType , HBufC8 *, TMethod , TUint )
IMPORT_C CCalEntry * NewL ( TType , HBufC8 *, TMethod , TUint , const TCalTime &, CalCommon::TRecurrenceRange )
CCalEntry * NewL (CCalEntryImpl *)
IMPORT_C TCalTime NextInstanceForLocalUIDL (const TCalTime &)
IMPORT_C CCalUser * OrganizerL ()
IMPORT_C CCalUser * PhoneOwnerL ()
IMPORT_C TCalTime PreviousInstanceForLocalUIDL (const TCalTime &)
IMPORT_C TUint PriorityL ()
IMPORT_C TCalTime RecurrenceIdL ()
IMPORT_C CalCommon::TRecurrenceRange RecurrenceRangeL ()
IMPORT_C TReplicationStatus ReplicationStatusL ()
IMPORT_C TInt SequenceNumberL ()
IMPORT_C void SetAlarmL (CCalAlarm *)
IMPORT_C void SetCompletedL ( TBool , const TCalTime &)
IMPORT_C void SetDTStampL (const TCalTime &)
IMPORT_C void SetDescriptionL (const TDesC &)
IMPORT_C void SetExceptionDatesL (const RArray < TCalTime > &)
IMPORT_C void SetGeoValueL (const CCalGeoValue &)
IMPORT_C void SetLastModifiedDateL ()
IMPORT_C void SetLastModifiedDateL (const TCalTime &)
IMPORT_C void SetLocalUidL ( TCalLocalUid )
IMPORT_C void SetLocationL (const TDesC &)
IMPORT_C void SetMethodL ( TMethod )
IMPORT_C void SetOrganizerL (CCalUser *)
IMPORT_C void SetPhoneOwnerL (const CCalUser *)
IMPORT_C void SetPriorityL ( TUint )
IMPORT_C void SetRDatesL (const RArray < TCalTime > &)
IMPORT_C void SetRRuleL (const TCalRRule &)
IMPORT_C void SetReplicationStatusL ( TReplicationStatus )
IMPORT_C void SetSequenceNumberL ( TInt )
IMPORT_C void SetStartAndEndTimeL (const TCalTime &, const TCalTime &)
IMPORT_C void SetStatusL ( TStatus )
IMPORT_C void SetSummaryL (const TDesC &)
IMPORT_C void SetTimeTransparencyL ( TTransp )
IMPORT_C void SetTzRulesL (const CTzRules &)
IMPORT_C void SetTzRulesL ()
TUint8 ShortFileIdL ()
IMPORT_C TCalTime StartTimeL ()
IMPORT_C TStatus StatusL ()
IMPORT_C const TDesC & SummaryL ()
IMPORT_C TTransp TimeTransparencyL ()
IMPORT_C CTzRules * TzRulesL ()
IMPORT_C const TDesC8 & UidL ()
Private Member Functions
void ConstructL ( TType , HBufC8 *, TMethod , TUint , const TCalTime &, CalCommon::TRecurrenceRange )
void ConstructL ( TType , HBufC8 *, TMethod , TUint )
void ConstructL (CCalEntryImpl *)
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()
Public Member Enumerations
enum TCopyType { ECopyAll , EDontCopyId }
enum TMethod {
EMethodNone , EMethodPublish , EMethodRequest , EMethodReply , EMethodAdd , EMethodCancel , EMethodRefresh , EMethodCounter , EMethodDeclineCounter
}
enum TReplicationStatus { EOpen , EPrivate , ERestricted }
enum TStatus {
ETentative , EConfirmed , ECancelled , ETodoNeedsAction , ETodoCompleted , ETodoInProcess , ENullStatus , EVCalAccepted , EVCalNeedsAction , EVCalSent , EVCalDeclined , EVCalDelegated
}
enum TTransp { ETranspBusy , ETranspFree , ETranspTentative , ETranspOutOfOffice }
enum TType { EAppt , ETodo , EEvent , EReminder , EAnniv }
Private Attributes
CCalEntryImpl * iImpl

Constructor & Destructor Documentation

~CCalEntry()

IMPORT_C ~CCalEntry ( )

Member Functions Documentation

AddAttachmentL(CCalAttachment &)

IMPORT_C void AddAttachmentL ( CCalAttachment & aAttachment )

Parameters

CCalAttachment & aAttachment

AddAttendeeL(CCalAttendee *)

IMPORT_C void AddAttendeeL ( CCalAttendee * aAttendee )

Parameters

CCalAttendee * aAttendee

AddCategoryL(CCalCategory *)

IMPORT_C void AddCategoryL ( CCalCategory * aCategory )

Parameters

CCalCategory * aCategory

AlarmL()

IMPORT_C CCalAlarm * AlarmL ( ) const

AttachmentCountL()

IMPORT_C TInt AttachmentCountL ( ) const

AttachmentL(TInt)

IMPORT_C CCalAttachment * AttachmentL ( TInt aIndex ) const

Parameters

TInt aIndex

AttendeesL()

IMPORT_C RPointerArray < CCalAttendee > & AttendeesL ( ) const

CategoryListL()

IMPORT_C const RPointerArray < CCalCategory > & CategoryListL ( )

ClearGeoValueL()

IMPORT_C void ClearGeoValueL ( )

ClearRepeatingPropertiesL()

IMPORT_C void ClearRepeatingPropertiesL ( )

CompareL(const CCalEntry &)

IMPORT_C TBool CompareL ( const CCalEntry & aEntry ) const

Parameters

const CCalEntry & aEntry

CompletedTimeL()

IMPORT_C TCalTime CompletedTimeL ( ) const

ConstructL(TType, HBufC8 *, TMethod, TUint, const TCalTime &, CalCommon::TRecurrenceRange)

void ConstructL ( TType aType,
HBufC8 * aUid,
TMethod aMethod,
TUint aSeqNum,
const TCalTime & aRecurrenceId,
CalCommon::TRecurrenceRange aRange
) [private]

Parameters

TType aType
HBufC8 * aUid
TMethod aMethod
TUint aSeqNum
const TCalTime & aRecurrenceId
CalCommon::TRecurrenceRange aRange

ConstructL(TType, HBufC8 *, TMethod, TUint)

void ConstructL ( TType aType,
HBufC8 * aUid,
TMethod aMethod,
TUint aSeqNum
) [private]

Parameters

TType aType
HBufC8 * aUid
TMethod aMethod
TUint aSeqNum

ConstructL(CCalEntryImpl *)

void ConstructL ( CCalEntryImpl * aImpl ) [private]

Parameters

CCalEntryImpl * aImpl

CopyFromL(const CCalEntry &)

IMPORT_C void CopyFromL ( const CCalEntry & aOther )

Parameters

const CCalEntry & aOther

CopyFromL(const CCalEntry &, TCopyType)

IMPORT_C void CopyFromL ( const CCalEntry & aOther,
TCopyType aCopyType
)

Parameters

const CCalEntry & aOther
TCopyType aCopyType

DTStampL()

IMPORT_C TCalTime DTStampL ( ) const

DeleteAttachmentL(const CCalAttachment &)

IMPORT_C void DeleteAttachmentL ( const CCalAttachment & aAttachment )

Parameters

const CCalAttachment & aAttachment

DeleteAttendeeL(TInt)

IMPORT_C void DeleteAttendeeL ( TInt aIndex )

Parameters

TInt aIndex

DeleteCategoryL(TInt)

IMPORT_C void DeleteCategoryL ( TInt aIndex )

Parameters

TInt aIndex

DescriptionL()

IMPORT_C const TDesC & DescriptionL ( ) const

EndTimeL()

IMPORT_C TCalTime EndTimeL ( ) const

EntryTypeL()

IMPORT_C TType EntryTypeL ( ) const

FindRptUntilTimeL(TInt)

IMPORT_C TCalTime FindRptUntilTimeL ( TInt aCount )

Parameters

TInt aCount

GeoValueL()

IMPORT_C CCalGeoValue * GeoValueL ( ) const

GetExceptionDatesL(RArray< TCalTime > &)

IMPORT_C void GetExceptionDatesL ( RArray < TCalTime > & aExDateList ) const

Parameters

RArray < TCalTime > & aExDateList

GetRDatesL(RArray< TCalTime > &)

IMPORT_C void GetRDatesL ( RArray < TCalTime > & aRDateList ) const

Parameters

RArray < TCalTime > & aRDateList

GetRRuleL(TCalRRule &)

IMPORT_C TBool GetRRuleL ( TCalRRule & aRule ) const

Parameters

TCalRRule & aRule

Impl()

CCalEntryImpl * Impl ( ) const

LastModifiedDateL()

IMPORT_C TCalTime LastModifiedDateL ( ) const

LocalUidL()

IMPORT_C TCalLocalUid LocalUidL ( ) const

LocationL()

IMPORT_C const TDesC & LocationL ( ) const

MethodL()

IMPORT_C TMethod MethodL ( ) const

NewL(TType, HBufC8 *, TMethod, TUint)

IMPORT_C CCalEntry * NewL ( TType aType,
HBufC8 * aUid,
TMethod aMethod,
TUint aSeqNum
) [static]

Parameters

TType aType
HBufC8 * aUid
TMethod aMethod
TUint aSeqNum

NewL(TType, HBufC8 *, TMethod, TUint, const TCalTime &, CalCommon::TRecurrenceRange)

IMPORT_C CCalEntry * NewL ( TType aType,
HBufC8 * aUid,
TMethod aMethod,
TUint aSeqNum,
const TCalTime & aRecurrenceId,
CalCommon::TRecurrenceRange aRange
) [static]

Parameters

TType aType
HBufC8 * aUid
TMethod aMethod
TUint aSeqNum
const TCalTime & aRecurrenceId
CalCommon::TRecurrenceRange aRange

NewL(CCalEntryImpl *)

CCalEntry * NewL ( CCalEntryImpl * aImpl ) [static]

Parameters

CCalEntryImpl * aImpl

NextInstanceForLocalUIDL(const TCalTime &)

IMPORT_C TCalTime NextInstanceForLocalUIDL ( const TCalTime & aTime ) const

Parameters

const TCalTime & aTime

OrganizerL()

IMPORT_C CCalUser * OrganizerL ( ) const

PhoneOwnerL()

IMPORT_C CCalUser * PhoneOwnerL ( ) const

PreviousInstanceForLocalUIDL(const TCalTime &)

IMPORT_C TCalTime PreviousInstanceForLocalUIDL ( const TCalTime & aTime ) const

Parameters

const TCalTime & aTime

PriorityL()

IMPORT_C TUint PriorityL ( ) const

RecurrenceIdL()

IMPORT_C TCalTime RecurrenceIdL ( ) const

RecurrenceRangeL()

IMPORT_C CalCommon::TRecurrenceRange RecurrenceRangeL ( ) const

ReplicationStatusL()

IMPORT_C TReplicationStatus ReplicationStatusL ( ) const

SequenceNumberL()

IMPORT_C TInt SequenceNumberL ( ) const

SetAlarmL(CCalAlarm *)

IMPORT_C void SetAlarmL ( CCalAlarm * aAlarm )

Parameters

CCalAlarm * aAlarm

SetCompletedL(TBool, const TCalTime &)

IMPORT_C void SetCompletedL ( TBool aCompleted,
const TCalTime & aTime
)

Parameters

TBool aCompleted
const TCalTime & aTime

SetDTStampL(const TCalTime &)

IMPORT_C void SetDTStampL ( const TCalTime & aTime )

Parameters

const TCalTime & aTime

SetDescriptionL(const TDesC &)

IMPORT_C void SetDescriptionL ( const TDesC & aDescription )

Parameters

const TDesC & aDescription

SetExceptionDatesL(const RArray< TCalTime > &)

IMPORT_C void SetExceptionDatesL ( const RArray < TCalTime > & aExDateList )

Parameters

const RArray < TCalTime > & aExDateList

SetGeoValueL(const CCalGeoValue &)

IMPORT_C void SetGeoValueL ( const CCalGeoValue & aGeoValue )

Parameters

const CCalGeoValue & aGeoValue

SetLastModifiedDateL()

IMPORT_C void SetLastModifiedDateL ( )

SetLastModifiedDateL(const TCalTime &)

IMPORT_C void SetLastModifiedDateL ( const TCalTime & aModifiedTime )

Parameters

const TCalTime & aModifiedTime

SetLocalUidL(TCalLocalUid)

IMPORT_C void SetLocalUidL ( TCalLocalUid aLocalId )

Parameters

TCalLocalUid aLocalId

SetLocationL(const TDesC &)

IMPORT_C void SetLocationL ( const TDesC & aLocation )

Parameters

const TDesC & aLocation

SetMethodL(TMethod)

IMPORT_C void SetMethodL ( TMethod aMethod )

Parameters

TMethod aMethod

SetOrganizerL(CCalUser *)

IMPORT_C void SetOrganizerL ( CCalUser * aUser )

Parameters

CCalUser * aUser

SetPhoneOwnerL(const CCalUser *)

IMPORT_C void SetPhoneOwnerL ( const CCalUser * aOwner )

Parameters

const CCalUser * aOwner

SetPriorityL(TUint)

IMPORT_C void SetPriorityL ( TUint aPriority )

Parameters

TUint aPriority

SetRDatesL(const RArray< TCalTime > &)

IMPORT_C void SetRDatesL ( const RArray < TCalTime > & aRDateList )

Parameters

const RArray < TCalTime > & aRDateList

SetRRuleL(const TCalRRule &)

IMPORT_C void SetRRuleL ( const TCalRRule & aRule )

Parameters

const TCalRRule & aRule

SetReplicationStatusL(TReplicationStatus)

IMPORT_C void SetReplicationStatusL ( TReplicationStatus aReplicationStatus )

Parameters

TReplicationStatus aReplicationStatus

SetSequenceNumberL(TInt)

IMPORT_C void SetSequenceNumberL ( TInt aSeq )

Parameters

TInt aSeq

SetStartAndEndTimeL(const TCalTime &, const TCalTime &)

IMPORT_C void SetStartAndEndTimeL ( const TCalTime & aStartTime,
const TCalTime & aEndTime
)

Parameters

const TCalTime & aStartTime
const TCalTime & aEndTime

SetStatusL(TStatus)

IMPORT_C void SetStatusL ( TStatus aStatus )

Parameters

TStatus aStatus

SetSummaryL(const TDesC &)

IMPORT_C void SetSummaryL ( const TDesC & aSummary )

Parameters

const TDesC & aSummary

SetTimeTransparencyL(TTransp)

IMPORT_C void SetTimeTransparencyL ( TTransp aBusyStatus )

Parameters

TTransp aBusyStatus

SetTzRulesL(const CTzRules &)

IMPORT_C void SetTzRulesL ( const CTzRules & aTzRule )

Parameters

const CTzRules & aTzRule

SetTzRulesL()

IMPORT_C void SetTzRulesL ( )

ShortFileIdL()

TUint8 ShortFileIdL ( )

StartTimeL()

IMPORT_C TCalTime StartTimeL ( ) const

StatusL()

IMPORT_C TStatus StatusL ( ) const

SummaryL()

IMPORT_C const TDesC & SummaryL ( ) const

TimeTransparencyL()

IMPORT_C TTransp TimeTransparencyL ( ) const

TzRulesL()

IMPORT_C CTzRules * TzRulesL ( ) const

UidL()

IMPORT_C const TDesC8 & UidL ( ) const

Member Enumerations Documentation

Enum TCopyType

Specify which entry details are to be copied in CCalEntry::CopyFromL functions.

Enumerators

ECopyAll

Copy the ID of the entry

EDontCopyId

Dont copy ID of the entry

Enum TMethod

The method property of a Group Scheduling entry.

Enumerators

EMethodNone

The RFC2445-defined method value 'None'.

EMethodPublish

The RFC2445-defined method value 'Publish'.

EMethodRequest

The RFC2445-defined method value 'Request'.

EMethodReply

The RFC2445-defined method value 'Reply'.

EMethodAdd

The RFC2445-defined method value 'Add'.

EMethodCancel

The RFC2445-defined method value 'Cancel'.

EMethodRefresh

The RFC2445-defined method value 'Refresh'.

EMethodCounter

The RFC2445-defined method value 'Counter'.

EMethodDeclineCounter

The RFC2445-defined method value 'DeclineCounter'.

Enum TReplicationStatus

Replication status.

Enumerators

EOpen

No restriction on access.

EPrivate

Data is private (no access).

ERestricted

Data is confidential (restricted access).

Enum TStatus

Defines the possible status values of the entry. There are values here to support both iCalendar (RFC 2445) and vCalendar v1.0 STATUS properties. Enumerated values for vCalendar v1.0 contain the prefix 'EVCal'.

Enumerators

ETentative

Used to support iCalendar (RFC 2445) and vCalendar 1.0. The event is tentative.

EConfirmed

Used to support iCalendar (RFC 2445) and vCalendar 1.0. The event has been confirmed.

ECancelled

Used to support iCalendar (RFC 2445). The event has been cancelled.

ETodoNeedsAction

Used to support iCalendar (RFC 2445). The to-do entry needs action.

ETodoCompleted

Used to support iCalendar (RFC 2445) and vCalendar 1.0. The to-do entry has been completed.

ETodoInProcess

Used to support iCalendar (RFC 2445). The to-do entry is in progress.

ENullStatus

No status is set.

EVCalAccepted

Used to support vCalendar 1.0. The entry has been accepted.

EVCalNeedsAction

Used to support vCalendar 1.0. The entry needs action.

EVCalSent

Used to support vCalendar 1.0. The entry has been sent.

EVCalDeclined

Used to support vCalendar 1.0. The entry has been declined.

EVCalDelegated

Used to support vCalendar 1.0. The entry has been delegated.

Enum TTransp

The busy status of an entry and corresponds to the TRANSP property in the iCalendar (RFC 2445) and vCalendar specifications. In the vCalendar specification, the TRANSP property can be any positive integer value. 0 is opaque and blocks time, 1 is transparent and doesn't block time. Any higher values have an implementation-specific meaning. In the iCalendar specification (RFC 2445), the TRANSP property can be either OPAQUE (blocks time) or TRANSPARENT (doesn't block time).

Enumerators

ETranspBusy

The entry blocks time.

ETranspFree

The entry doesn't block time.

ETranspTentative

The entry is tentative and blocks time.

ETranspOutOfOffice

The entry is an out-of-office calendar event and blocks time.

Enum TType

Defines the type of the calendar entry.

Enumerators

EAppt

An appointment, which has a start time and end time.

ETodo

A to-do, which can have a start time and end time (the end time is the due date), or can be undated.

EEvent

An event, which has a start time and end time.

EReminder

A reminder, which has a start time only.

EAnniv

An anniversary, which has a start time and end time.

Member Data Documentation

CCalEntryImpl * iImpl

CCalEntryImpl * iImpl [private]

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.