CCalEntry Class Reference

#include <app/calentry.h>

Link against: esmrentry.lib

class CCalEntry : public CBase

Inherits from

  • CCalEntry
    Public Member Enumerations
    enumTCopyType { ECopyAll, EDontCopyId }
    enumTMethod { EMethodNone, EMethodPublish, EMethodRequest, EMethodReply, ..., EMethodDeclineCounter }
    enumTReplicationStatus { EOpen, EPrivate, ERestricted }
    enumTStatus { ETentative, EConfirmed, ECancelled, ETodoNeedsAction, ..., EVCalDelegated }
    enumTTransp { ETranspBusy, ETranspFree, ETranspTentative, ETranspOutOfOffice }
    enumTType { EAppt, ETodo, EEvent, EReminder, EAnniv }
    Public Member Functions
    ~CCalEntry()
    IMPORT_C voidAddAttachmentL(CCalAttachment &)
    IMPORT_C voidAddAttendeeL(CCalAttendee *)
    IMPORT_C voidAddCategoryL(CCalCategory *)
    IMPORT_C CCalAlarm *AlarmL()
    IMPORT_C TIntAttachmentCountL()
    IMPORT_C CCalAttachment *AttachmentL(TInt)
    IMPORT_C RPointerArray< CCalAttendee > &AttendeesL()
    IMPORT_C const RPointerArray< CCalCategory > &CategoryListL()
    IMPORT_C voidClearGeoValueL()
    IMPORT_C voidClearRepeatingPropertiesL()
    IMPORT_C TBoolCompareL(const CCalEntry &)
    IMPORT_C TCalTimeCompletedTimeL()
    IMPORT_C voidCopyFromL(const CCalEntry &)
    IMPORT_C voidCopyFromL(const CCalEntry &, TCopyType)
    IMPORT_C TCalTimeDTStampL()
    IMPORT_C voidDeleteAttachmentL(const CCalAttachment &)
    IMPORT_C voidDeleteAttendeeL(TInt)
    IMPORT_C voidDeleteCategoryL(TInt)
    IMPORT_C const TDesC &DescriptionL()
    IMPORT_C TCalTimeEndTimeL()
    IMPORT_C TTypeEntryTypeL()
    IMPORT_C TCalTimeFindRptUntilTimeL(TInt)
    IMPORT_C CCalGeoValue *GeoValueL()
    IMPORT_C voidGetExceptionDatesL(RArray< TCalTime > &)
    IMPORT_C voidGetRDatesL(RArray< TCalTime > &)
    IMPORT_C TBoolGetRRuleL(TCalRRule &)
    CCalEntryImpl *Impl()
    IMPORT_C TCalTimeLastModifiedDateL()
    IMPORT_C TCalLocalUidLocalUidL()
    IMPORT_C const TDesC &LocationL()
    IMPORT_C TMethodMethodL()
    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 TCalTimeNextInstanceForLocalUIDL(const TCalTime &)
    IMPORT_C CCalUser *OrganizerL()
    IMPORT_C CCalUser *PhoneOwnerL()
    IMPORT_C TCalTimePreviousInstanceForLocalUIDL(const TCalTime &)
    IMPORT_C TUintPriorityL()
    IMPORT_C TCalTimeRecurrenceIdL()
    IMPORT_C CalCommon::TRecurrenceRangeRecurrenceRangeL()
    IMPORT_C TReplicationStatusReplicationStatusL()
    IMPORT_C TIntSequenceNumberL()
    IMPORT_C voidSetAlarmL(CCalAlarm *)
    IMPORT_C voidSetCompletedL(TBool, const TCalTime &)
    IMPORT_C voidSetDTStampL(const TCalTime &)
    IMPORT_C voidSetDescriptionL(const TDesC &)
    IMPORT_C voidSetExceptionDatesL(const RArray< TCalTime > &)
    IMPORT_C voidSetGeoValueL(const CCalGeoValue &)
    IMPORT_C voidSetLastModifiedDateL()
    IMPORT_C voidSetLastModifiedDateL(const TCalTime &)
    IMPORT_C voidSetLocalUidL(TCalLocalUid)
    IMPORT_C voidSetLocationL(const TDesC &)
    IMPORT_C voidSetMethodL(TMethod)
    IMPORT_C voidSetOrganizerL(CCalUser *)
    IMPORT_C voidSetPhoneOwnerL(const CCalUser *)
    IMPORT_C voidSetPriorityL(TUint)
    IMPORT_C voidSetRDatesL(const RArray< TCalTime > &)
    IMPORT_C voidSetRRuleL(const TCalRRule &)
    IMPORT_C voidSetReplicationStatusL(TReplicationStatus)
    IMPORT_C voidSetSequenceNumberL(TInt)
    IMPORT_C voidSetStartAndEndTimeL(const TCalTime &, const TCalTime &)
    IMPORT_C voidSetStatusL(TStatus)
    IMPORT_C voidSetSummaryL(const TDesC &)
    IMPORT_C voidSetTimeTransparencyL(TTransp)
    IMPORT_C voidSetTzRulesL(const CTzRules &)
    IMPORT_C voidSetTzRulesL()
    TUint8 ShortFileIdL()
    IMPORT_C TCalTimeStartTimeL()
    IMPORT_C TStatusStatusL()
    IMPORT_C const TDesC &SummaryL()
    IMPORT_C TTranspTimeTransparencyL()
    IMPORT_C CTzRules *TzRulesL()
    IMPORT_C const TDesC8 &UidL()
    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()

    Detailed Description

    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.

    Member Enumeration Documentation

    Enum TCopyType

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

    EnumeratorValueDescription
    ECopyAll

    Copy the ID of the entry

    EDontCopyId

    Dont copy ID of the entry

    Enum TMethod

    The method property of a Group Scheduling entry.

    EnumeratorValueDescription
    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.

    EnumeratorValueDescription
    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'.

    EnumeratorValueDescription
    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).

    EnumeratorValueDescription
    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.

    EnumeratorValueDescription
    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.

    Constructor & Destructor Documentation

    ~CCalEntry ( )

    IMPORT_C~CCalEntry()

    Member Function Documentation

    AddAttachmentL ( CCalAttachment & )

    IMPORT_C voidAddAttachmentL(CCalAttachment &aAttachment)

    AddAttendeeL ( CCalAttendee * )

    IMPORT_C voidAddAttendeeL(CCalAttendee *aAttendee)

    AddCategoryL ( CCalCategory * )

    IMPORT_C voidAddCategoryL(CCalCategory *aCategory)

    AlarmL ( )

    IMPORT_C CCalAlarm *AlarmL()const

    AttachmentCountL ( )

    IMPORT_C TIntAttachmentCountL()const

    AttachmentL ( TInt )

    IMPORT_C CCalAttachment *AttachmentL(TIntaIndex)const

    AttendeesL ( )

    IMPORT_C RPointerArray< CCalAttendee > &AttendeesL()const

    CategoryListL ( )

    IMPORT_C const RPointerArray< CCalCategory > &CategoryListL()

    ClearGeoValueL ( )

    IMPORT_C voidClearGeoValueL()

    ClearRepeatingPropertiesL ( )

    IMPORT_C voidClearRepeatingPropertiesL()

    CompareL ( const CCalEntry & )

    IMPORT_C TBoolCompareL(const CCalEntry &aEntry)const

    CompletedTimeL ( )

    IMPORT_C TCalTimeCompletedTimeL()const

    CopyFromL ( const CCalEntry & )

    IMPORT_C voidCopyFromL(const CCalEntry &aOther)

    CopyFromL ( const CCalEntry &, TCopyType )

    IMPORT_C voidCopyFromL(const CCalEntry &aOther,
    TCopyTypeaCopyType
    )

    DTStampL ( )

    IMPORT_C TCalTimeDTStampL()const

    DeleteAttachmentL ( const CCalAttachment & )

    IMPORT_C voidDeleteAttachmentL(const CCalAttachment &aAttachment)

    DeleteAttendeeL ( TInt )

    IMPORT_C voidDeleteAttendeeL(TIntaIndex)

    DeleteCategoryL ( TInt )

    IMPORT_C voidDeleteCategoryL(TIntaIndex)

    DescriptionL ( )

    IMPORT_C const TDesC &DescriptionL()const

    EndTimeL ( )

    IMPORT_C TCalTimeEndTimeL()const

    EntryTypeL ( )

    IMPORT_C TTypeEntryTypeL()const

    FindRptUntilTimeL ( TInt )

    IMPORT_C TCalTimeFindRptUntilTimeL(TIntaCount)

    GeoValueL ( )

    IMPORT_C CCalGeoValue *GeoValueL()const

    GetExceptionDatesL ( RArray< TCalTime > & )

    IMPORT_C voidGetExceptionDatesL(RArray< TCalTime > &aExDateList)const

    GetRDatesL ( RArray< TCalTime > & )

    IMPORT_C voidGetRDatesL(RArray< TCalTime > &aRDateList)const

    GetRRuleL ( TCalRRule & )

    IMPORT_C TBoolGetRRuleL(TCalRRule &aRule)const

    Impl ( )

    CCalEntryImpl *Impl()const

    LastModifiedDateL ( )

    IMPORT_C TCalTimeLastModifiedDateL()const

    LocalUidL ( )

    IMPORT_C TCalLocalUidLocalUidL()const

    LocationL ( )

    IMPORT_C const TDesC &LocationL()const

    MethodL ( )

    IMPORT_C TMethodMethodL()const

    NewL ( TType, HBufC8 *, TMethod, TUint )

    IMPORT_C CCalEntry *NewL(TTypeaType,
    HBufC8 *aUid,
    TMethodaMethod,
    TUintaSeqNum
    )[static]

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

    IMPORT_C CCalEntry *NewL(TTypeaType,
    HBufC8 *aUid,
    TMethodaMethod,
    TUintaSeqNum,
    const TCalTime &aRecurrenceId,
    CalCommon::TRecurrenceRangeaRange
    )[static]

    NewL ( CCalEntryImpl * )

    CCalEntry *NewL(CCalEntryImpl *aImpl)[static]

    NextInstanceForLocalUIDL ( const TCalTime & )

    IMPORT_C TCalTimeNextInstanceForLocalUIDL(const TCalTime &aTime)const

    OrganizerL ( )

    IMPORT_C CCalUser *OrganizerL()const

    PhoneOwnerL ( )

    IMPORT_C CCalUser *PhoneOwnerL()const

    PreviousInstanceForLocalUIDL ( const TCalTime & )

    IMPORT_C TCalTimePreviousInstanceForLocalUIDL(const TCalTime &aTime)const

    PriorityL ( )

    IMPORT_C TUintPriorityL()const

    RecurrenceIdL ( )

    IMPORT_C TCalTimeRecurrenceIdL()const

    RecurrenceRangeL ( )

    IMPORT_C CalCommon::TRecurrenceRangeRecurrenceRangeL()const

    ReplicationStatusL ( )

    IMPORT_C TReplicationStatusReplicationStatusL()const

    SequenceNumberL ( )

    IMPORT_C TIntSequenceNumberL()const

    SetAlarmL ( CCalAlarm * )

    IMPORT_C voidSetAlarmL(CCalAlarm *aAlarm)

    SetCompletedL ( TBool, const TCalTime & )

    IMPORT_C voidSetCompletedL(TBoolaCompleted,
    const TCalTime &aTime
    )

    SetDTStampL ( const TCalTime & )

    IMPORT_C voidSetDTStampL(const TCalTime &aTime)

    SetDescriptionL ( const TDesC & )

    IMPORT_C voidSetDescriptionL(const TDesC &aDescription)

    SetExceptionDatesL ( const RArray< TCalTime > & )

    IMPORT_C voidSetExceptionDatesL(const RArray< TCalTime > &aExDateList)

    SetGeoValueL ( const CCalGeoValue & )

    IMPORT_C voidSetGeoValueL(const CCalGeoValue &aGeoValue)

    SetLastModifiedDateL ( )

    IMPORT_C voidSetLastModifiedDateL()

    SetLastModifiedDateL ( const TCalTime & )

    IMPORT_C voidSetLastModifiedDateL(const TCalTime &aModifiedTime)

    SetLocalUidL ( TCalLocalUid )

    IMPORT_C voidSetLocalUidL(TCalLocalUidaLocalId)

    SetLocationL ( const TDesC & )

    IMPORT_C voidSetLocationL(const TDesC &aLocation)

    SetMethodL ( TMethod )

    IMPORT_C voidSetMethodL(TMethodaMethod)

    SetOrganizerL ( CCalUser * )

    IMPORT_C voidSetOrganizerL(CCalUser *aUser)

    SetPhoneOwnerL ( const CCalUser * )

    IMPORT_C voidSetPhoneOwnerL(const CCalUser *aOwner)

    SetPriorityL ( TUint )

    IMPORT_C voidSetPriorityL(TUintaPriority)

    SetRDatesL ( const RArray< TCalTime > & )

    IMPORT_C voidSetRDatesL(const RArray< TCalTime > &aRDateList)

    SetRRuleL ( const TCalRRule & )

    IMPORT_C voidSetRRuleL(const TCalRRule &aRule)

    SetReplicationStatusL ( TReplicationStatus )

    IMPORT_C voidSetReplicationStatusL(TReplicationStatusaReplicationStatus)

    SetSequenceNumberL ( TInt )

    IMPORT_C voidSetSequenceNumberL(TIntaSeq)

    SetStartAndEndTimeL ( const TCalTime &, const TCalTime & )

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

    SetStatusL ( TStatus )

    IMPORT_C voidSetStatusL(TStatusaStatus)

    SetSummaryL ( const TDesC & )

    IMPORT_C voidSetSummaryL(const TDesC &aSummary)

    SetTimeTransparencyL ( TTransp )

    IMPORT_C voidSetTimeTransparencyL(TTranspaBusyStatus)

    SetTzRulesL ( const CTzRules & )

    IMPORT_C voidSetTzRulesL(const CTzRules &aTzRule)

    SetTzRulesL ( )

    IMPORT_C voidSetTzRulesL()

    ShortFileIdL ( )

    TUint8 ShortFileIdL()

    StartTimeL ( )

    IMPORT_C TCalTimeStartTimeL()const

    StatusL ( )

    IMPORT_C TStatusStatusL()const

    SummaryL ( )

    IMPORT_C const TDesC &SummaryL()const

    TimeTransparencyL ( )

    IMPORT_C TTranspTimeTransparencyL()const

    TzRulesL ( )

    IMPORT_C CTzRules *TzRulesL()const

    UidL ( )

    IMPORT_C const TDesC8 &UidL()const
    © Nokia 2011.