Symbian^3 Application 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 TInt AttachmentCount ()
IMPORT_C CCalAttachment * AttachmentL ( TInt )
IMPORT_C void AttachmentNamesL ( RPointerArray < HBufC > &)
IMPORT_C TBool CheckForAlldayEventL ( 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 TBool IsAlarmActivated ()
IMPORT_C TBool IsAllDayEvent ()
IMPORT_C TBool IsRepeating ()
IMPORT_C const TDesC & Location ()
IMPORT_C CCalenEntryUtil * NewL ( CCalEntry &, const TCalTime &)
IMPORT_C TTodoPriority Priority ()
IMPORT_C TCalenRepeatIndex RepeatType ()
IMPORT_C const TTime & RepeatUntilDateTime ()
IMPORT_C void SetAlarmDateTimeL (const TTime &)
IMPORT_C void SetAlarmOffL ()
IMPORT_C void SetAlarmOnL (const TTime &)
IMPORT_C void SetAllDayEvent ( TBool )
IMPORT_C void SetAttachmentCount ( TInt )
IMPORT_C void SetDescriptionL (const TDesC &)
IMPORT_C void SetDescriptionTransferOwnershipL ( HBufC *)
IMPORT_C void SetEndDateTimeL (const TTime &)
IMPORT_C void SetEntryType ( CCalEntry::TType )
IMPORT_C void SetEventDateL (const TTime &)
IMPORT_C void SetLocationL (const TDesC &)
IMPORT_C void SetNonRepeatingL ()
IMPORT_C void SetPriorityL ( TTodoPriority )
IMPORT_C void SetRepeatUntilDateTimeL (const TTime &)
IMPORT_C void SetRepeatingL ( TCalenRepeatIndex , const TTime &)
IMPORT_C void SetStartDateTimeL (const TTime &)
IMPORT_C void SetSummaryL (const TDesC &)
IMPORT_C void SetSynchTypeL ( TSynchType )
IMPORT_C const TTime & StartDateTime ()
IMPORT_C const CCalEntry::TStatus & Status ()
IMPORT_C const TDesC & Summary ()
IMPORT_C TSynchType SynchType ()
Private Member Functions
CCalenEntryUtil ( CCalEntry &)
void ConstructL ( CCalEntry &, const TCalTime &)
void CopyDataFromEntryL ( 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
enum TSynchType { ESynchPrivate  = 0, ESynchPublic , ESynchNoSync }
enum TTodoPriority { 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 TInt AttachmentCount ( ) const

AttachmentL(TInt)

IMPORT_C CCalAttachment * AttachmentL ( TInt aIndex ) const

Parameters

TInt aIndex

AttachmentNamesL(RPointerArray< HBufC > &)

IMPORT_C void AttachmentNamesL ( RPointerArray < HBufC > & aAttachmentNames )

Return attachment names

Parameters

RPointerArray < HBufC > & aAttachmentNames

CheckForAlldayEventL(TTime, TTime)

IMPORT_C TBool CheckForAlldayEventL ( TTime aStartTime,
TTime aStopTime
)

Parameters

TTime aStartTime
TTime aStopTime

ConstructL(CCalEntry &, const TCalTime &)

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

Parameters

CCalEntry & aEntry
const TCalTime & aInstanceDateTime

CopyDataFromEntryL(CCalEntry &, const TCalTime &)

void CopyDataFromEntryL ( 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 TBool IsAlarmActivated ( ) const

IsAllDayEvent()

IMPORT_C TBool IsAllDayEvent ( )

IsRepeating()

IMPORT_C TBool IsRepeating ( ) 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 TTodoPriority Priority ( ) const

RepeatType()

IMPORT_C TCalenRepeatIndex RepeatType ( ) const

RepeatUntilDateTime()

IMPORT_C const TTime & RepeatUntilDateTime ( ) const

SetAlarmDateTimeL(const TTime &)

IMPORT_C void SetAlarmDateTimeL ( const TTime & aTime )

Parameters

const TTime & aTime

SetAlarmOffL()

IMPORT_C void SetAlarmOffL ( )

SetAlarmOnL(const TTime &)

IMPORT_C void SetAlarmOnL ( const TTime & aTime )

Parameters

const TTime & aTime

SetAllDayEvent(TBool)

IMPORT_C void SetAllDayEvent ( TBool aAllDayEvent )

Parameters

TBool aAllDayEvent

SetAttachmentCount(TInt)

IMPORT_C void SetAttachmentCount ( TInt aAttachmentCount )

Parameters

TInt aAttachmentCount

SetDescriptionL(const TDesC &)

IMPORT_C void SetDescriptionL ( const TDesC & aDescription )

Parameters

const TDesC & aDescription

SetDescriptionTransferOwnershipL(HBufC *)

IMPORT_C void SetDescriptionTransferOwnershipL ( 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 void SetEndDateTimeL ( const TTime & aEnd )

Parameters

const TTime & aEnd

SetEntryType(CCalEntry::TType)

IMPORT_C void SetEntryType ( CCalEntry::TType aEntryType )

Parameters

CCalEntry::TType aEntryType

SetEventDateL(const TTime &)

IMPORT_C void SetEventDateL ( const TTime & aDate )

Parameters

const TTime & aDate

SetLocationL(const TDesC &)

IMPORT_C void SetLocationL ( const TDesC & aLocation )

Parameters

const TDesC & aLocation

SetNonRepeatingL()

IMPORT_C void SetNonRepeatingL ( )

SetPriorityL(TTodoPriority)

IMPORT_C void SetPriorityL ( TTodoPriority aPriority )

Parameters

TTodoPriority aPriority

SetRepeatUntilDateTimeL(const TTime &)

IMPORT_C void SetRepeatUntilDateTimeL ( const TTime & aTime )

Parameters

const TTime & aTime

SetRepeatingL(TCalenRepeatIndex, const TTime &)

IMPORT_C void SetRepeatingL ( TCalenRepeatIndex aRepeatType,
const TTime & aUntilDateTime
)

Parameters

TCalenRepeatIndex aRepeatType
const TTime & aUntilDateTime

SetStartDateTimeL(const TTime &)

IMPORT_C void SetStartDateTimeL ( const TTime & aStart )

Parameters

const TTime & aStart

SetSummaryL(const TDesC &)

IMPORT_C void SetSummaryL ( const TDesC & aSummary )

Parameters

const TDesC & aSummary

SetSynchTypeL(TSynchType)

IMPORT_C void SetSynchTypeL ( TSynchType aSynchType )

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 TSynchType SynchType ( ) 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.