Symbian^3 Product Developer Library >

CCalenEntryUtil Class Reference

class CCalenEntryUtil : public CBase

CCalenEntryUtil contains edited data in exactly same format that editor fields show them. For example, alarm time is represented as alarm time, not as offset to entry start time, like CalInterimApi represents it.

This class or CCalenEditorDataHandler encapsulates rules how this data is then read from and write to CalInterimApi CCalEntry.

CalenDefaultEditors
Since
S60 v3.0

Inherits from

Public Member Functions
~CCalenEntryUtil()
IMPORT_C const TTime &AlarmDateTime()
IMPORT_C TIntAttachmentCount()
IMPORT_C CCalAttachment *AttachmentL(TInt)
IMPORT_C voidAttachmentNamesL(RPointerArray< HBufC > &)
IMPORT_C TBoolCheckForAlldayEventL(TTime, TTime)
IMPORT_C const TDesC &Description()
IMPORT_C const TTime &EndDateTime()
IMPORT_C const CCalEntry::TType &EntryType()
IMPORT_C const TTime &EventDateTime()
IMPORT_C const RArray< TCalTime >GetRdatesL()
IMPORT_C TBoolIsAlarmActivated()
IMPORT_C TBoolIsAllDayEvent()
IMPORT_C TBoolIsRepeating()
IMPORT_C const TDesC &Location()
IMPORT_C CCalenEntryUtil *NewL(CCalEntry &, const TCalTime &)
IMPORT_C TTodoPriorityPriority()
IMPORT_C TCalenRepeatIndexRepeatType()
IMPORT_C const TTime &RepeatUntilDateTime()
IMPORT_C voidSetAlarmDateTimeL(const TTime &)
IMPORT_C voidSetAlarmOffL()
IMPORT_C voidSetAlarmOnL(const TTime &)
IMPORT_C voidSetAllDayEvent(TBool)
IMPORT_C voidSetAttachmentCount(TInt)
IMPORT_C voidSetDescriptionL(const TDesC &)
IMPORT_C voidSetDescriptionTransferOwnershipL(HBufC *)
IMPORT_C voidSetEndDateTimeL(const TTime &)
IMPORT_C voidSetEntryType(CCalEntry::TType)
IMPORT_C voidSetEventDateL(const TTime &)
IMPORT_C voidSetLocationL(const TDesC &)
IMPORT_C voidSetNonRepeatingL()
IMPORT_C voidSetPriorityL(TTodoPriority)
IMPORT_C voidSetRepeatUntilDateTimeL(const TTime &)
IMPORT_C voidSetRepeatingL(TCalenRepeatIndex, const TTime &)
IMPORT_C voidSetStartDateTimeL(const TTime &)
IMPORT_C voidSetSummaryL(const TDesC &)
IMPORT_C voidSetSynchTypeL(TSynchType)
IMPORT_C const TTime &StartDateTime()
IMPORT_C const CCalEntry::TStatus &Status()
IMPORT_C const TDesC &Summary()
IMPORT_C TSynchTypeSynchType()
Private Member Functions
CCalenEntryUtil(CCalEntry &)
voidConstructL(CCalEntry &, const TCalTime &)
voidCopyDataFromEntryL(CCalEntry &, const TCalTime &)
TSynchType GetSynchTypeL(const CCalEntry &)
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
enumTSynchType { ESynchPrivate = 0, ESynchPublic, ESynchNoSync }
enumTTodoPriority { ETodoPriorityHigh = 1, ETodoPriorityNormal = 2, ETodoPriorityLow = 3 }
Private Attributes
TTime iAlarmDateTime
TInt iAttachmentCount
HBufC *iDescription
TTime iEndDateTime
CCalEntry &iEntry
CCalEntry::TStatus iEntryStatus
CCalEntry::TType iEntryType
TBool iIsAlarmActivated
TBool iIsAllDayEvent
HBufC *iLocation
TTodoPriority iPriority
CalCommon::TRecurrenceRange iRecurrenceType
TCalenRepeatIndex iRepeatType
TTime iRepeatUntilDateTime
TTime iStartDateTime
HBufC *iSummary
TSynchType iSynchType

Constructor & Destructor Documentation

CCalenEntryUtil(CCalEntry &)

CCalenEntryUtil(CCalEntry &aEntry)[private]

Parameters

CCalEntry & aEntry

~CCalenEntryUtil()

~CCalenEntryUtil()[virtual]

Member Functions Documentation

AlarmDateTime()

IMPORT_C const TTime &AlarmDateTime()const

AttachmentCount()

IMPORT_C TIntAttachmentCount()const

AttachmentL(TInt)

IMPORT_C CCalAttachment *AttachmentL(TIntaIndex)const

Parameters

TInt aIndex

AttachmentNamesL(RPointerArray< HBufC > &)

IMPORT_C voidAttachmentNamesL(RPointerArray< HBufC > &aAttachmentNames)

Return attachment names

Parameters

RPointerArray< HBufC > & aAttachmentNames

CheckForAlldayEventL(TTime, TTime)

IMPORT_C TBoolCheckForAlldayEventL(TTimeaStartTime,
TTimeaStopTime
)

Parameters

TTime aStartTime
TTime aStopTime

ConstructL(CCalEntry &, const TCalTime &)

voidConstructL(CCalEntry &aEntry,
const TCalTime &aInstanceDateTime
)[private]

Parameters

CCalEntry & aEntry
const TCalTime & aInstanceDateTime

CopyDataFromEntryL(CCalEntry &, const TCalTime &)

voidCopyDataFromEntryL(CCalEntry &aEntry,
const TCalTime &aInstanceDateTime
)[private]

Parameters

CCalEntry & aEntry
const TCalTime & aInstanceDateTime

Description()

IMPORT_C const TDesC &Description()const

EndDateTime()

IMPORT_C const TTime &EndDateTime()const

EntryType()

IMPORT_C const CCalEntry::TType &EntryType()const

EventDateTime()

IMPORT_C const TTime &EventDateTime()const

GetRdatesL()

IMPORT_C const RArray< TCalTime >GetRdatesL()

Return array of Rdates

GetSynchTypeL(const CCalEntry &)

TSynchType GetSynchTypeL(const CCalEntry &aEntry)[private]

Parameters

const CCalEntry & aEntry

IsAlarmActivated()

IMPORT_C TBoolIsAlarmActivated()const

IsAllDayEvent()

IMPORT_C TBoolIsAllDayEvent()

IsRepeating()

IMPORT_C TBoolIsRepeating()const

Location()

IMPORT_C const TDesC &Location()const

NewL(CCalEntry &, const TCalTime &)

IMPORT_C CCalenEntryUtil *NewL(CCalEntry &aEntry,
const TCalTime &aInstanceDateTime
)[static]

Parameters

CCalEntry & aEntry
const TCalTime & aInstanceDateTime

Priority()

IMPORT_C TTodoPriorityPriority()const

RepeatType()

IMPORT_C TCalenRepeatIndexRepeatType()const

RepeatUntilDateTime()

IMPORT_C const TTime &RepeatUntilDateTime()const

SetAlarmDateTimeL(const TTime &)

IMPORT_C voidSetAlarmDateTimeL(const TTime &aTime)

Parameters

const TTime & aTime

SetAlarmOffL()

IMPORT_C voidSetAlarmOffL()

SetAlarmOnL(const TTime &)

IMPORT_C voidSetAlarmOnL(const TTime &aTime)

Parameters

const TTime & aTime

SetAllDayEvent(TBool)

IMPORT_C voidSetAllDayEvent(TBoolaAllDayEvent)

Parameters

TBool aAllDayEvent

SetAttachmentCount(TInt)

IMPORT_C voidSetAttachmentCount(TIntaAttachmentCount)

Parameters

TInt aAttachmentCount

SetDescriptionL(const TDesC &)

IMPORT_C voidSetDescriptionL(const TDesC &aDescription)

Parameters

const TDesC & aDescription

SetDescriptionTransferOwnershipL(HBufC *)

IMPORT_C voidSetDescriptionTransferOwnershipL(HBufC *aDescription)

Set description by passing in new description in HBufC. CCalenEntryUtil takes ownership of new description. This can be used to save unnecessary copying when setting description created by Notepad API:

Parameters

HBufC * aDescription

SetEndDateTimeL(const TTime &)

IMPORT_C voidSetEndDateTimeL(const TTime &aEnd)

Parameters

const TTime & aEnd

SetEntryType(CCalEntry::TType)

IMPORT_C voidSetEntryType(CCalEntry::TTypeaEntryType)

Parameters

CCalEntry::TType aEntryType

SetEventDateL(const TTime &)

IMPORT_C voidSetEventDateL(const TTime &aDate)

Parameters

const TTime & aDate

SetLocationL(const TDesC &)

IMPORT_C voidSetLocationL(const TDesC &aLocation)

Parameters

const TDesC & aLocation

SetNonRepeatingL()

IMPORT_C voidSetNonRepeatingL()

SetPriorityL(TTodoPriority)

IMPORT_C voidSetPriorityL(TTodoPriorityaPriority)

Parameters

TTodoPriority aPriority

SetRepeatUntilDateTimeL(const TTime &)

IMPORT_C voidSetRepeatUntilDateTimeL(const TTime &aTime)

Parameters

const TTime & aTime

SetRepeatingL(TCalenRepeatIndex, const TTime &)

IMPORT_C voidSetRepeatingL(TCalenRepeatIndexaRepeatType,
const TTime &aUntilDateTime
)

Parameters

TCalenRepeatIndex aRepeatType
const TTime & aUntilDateTime

SetStartDateTimeL(const TTime &)

IMPORT_C voidSetStartDateTimeL(const TTime &aStart)

Parameters

const TTime & aStart

SetSummaryL(const TDesC &)

IMPORT_C voidSetSummaryL(const TDesC &aSummary)

Parameters

const TDesC & aSummary

SetSynchTypeL(TSynchType)

IMPORT_C voidSetSynchTypeL(TSynchTypeaSynchType)

Parameters

TSynchType aSynchType

StartDateTime()

IMPORT_C const TTime &StartDateTime()const

Status()

IMPORT_C const CCalEntry::TStatus &Status()const

Summary()

IMPORT_C const TDesC &Summary()const

SynchType()

IMPORT_C TSynchTypeSynchType()const

Member Enumerations Documentation

Enum TSynchType

Enumerators

ESynchPrivate = 0
ESynchPublic
ESynchNoSync

Enum TTodoPriority

Enumerators

ETodoPriorityHigh = 1
ETodoPriorityNormal = 2
ETodoPriorityLow = 3

Member Data Documentation

TTime iAlarmDateTime

TTime iAlarmDateTime[private]

TInt iAttachmentCount

TInt iAttachmentCount[private]

HBufC * iDescription

HBufC *iDescription[private]

?description_of_pointer_member Own.

TTime iEndDateTime

TTime iEndDateTime[private]

?description_of_member

CCalEntry & iEntry

CCalEntry &iEntry[private]

CCalEntry::TStatus iEntryStatus

CCalEntry::TStatus iEntryStatus[private]

Tells the status values of the entry.

CCalEntry::TType iEntryType

CCalEntry::TType iEntryType[private]

Tells what type of entry does editor data referring to (i.e. Anniv, ToDo). Set at construction. Used in DataHandler to force the correctness of fields. (i.e. The rules to force the correctness of alarm fields vary based on entry type)

TBool iIsAlarmActivated

TBool iIsAlarmActivated[private]

?description_of_member

TBool iIsAllDayEvent

TBool iIsAllDayEvent[private]

?description_of_member

HBufC * iLocation

HBufC *iLocation[private]

?description_of_pointer_member Own.

TTodoPriority iPriority

TTodoPriority iPriority[private]

?description_of_member

CalCommon::TRecurrenceRange iRecurrenceType

CalCommon::TRecurrenceRange iRecurrenceType[private]

The identifier for editing entry or instance

TCalenRepeatIndex iRepeatType

TCalenRepeatIndex iRepeatType[private]

?description_of_member

TTime iRepeatUntilDateTime

TTime iRepeatUntilDateTime[private]

?description_of_member

TTime iStartDateTime

TTime iStartDateTime[private]

?description_of_member

HBufC * iSummary

HBufC *iSummary[private]

?description_of_member ?description_of_pointer_member Own. *** Write "Own" if this class owns the object pointed to; in other words, if this class is responsible for deleting it. ?description_of_pointer_member Not own. *** Write "Not own" if some other class owns this object. ?description_of_pointer_member Own.

TSynchType iSynchType

TSynchType iSynchType[private]

?description_of_member

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.