Class CCalEntryView

class CCalEntryView : public CBase;

Description

View class for accessing calendar entries.

Once a session to a calendar file has been created, a view to the session can be created.

This view can be used to fetch, store and delete entries.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CCalEntryView - View class for accessing calendar entries.

Members

Defined in CCalEntryView:

• DeleteL(const CCalEntry &)Deletes an entry from the calender file. If this a parent entry all it's childre...
• DeleteL(const CCalEntry &)
• DeleteL(const CDesC8Array &)Deletes multiple entries from the calendar file.
• DeleteL(const CDesC8Array &)
• DeleteL(const RArray< TCalLocalUid > &,TInt &)Deletes multiple entries from the calendar file.
• DeleteL(const RArray< TCalLocalUid > &,TInt &)
• FetchL(TCalLocalUid)constFetches a CCalEntry object related to the cal unique id.
• FetchL(TCalLocalUid)const
• FetchL(const TDesC8 &,RPointerArray< CCalEntry > &)constFetches all CCalEntry objects related to the Uid. The first entry in the array w...
• FetchL(const TDesC8 &,RPointerArray< CCalEntry > &)const
• GetIdsModifiedSinceDateL(const TCalTime &,RArray< TCalLocalUid > &)constGets all the modified calendar local ids in the file since a specified date
• GetIdsModifiedSinceDateL(const TCalTime &,RArray< TCalLocalUid > &)const
• NewL(CCalSession &)
• NewL(CCalSession &,MCalProgressCallBack &)
• NewL(CCalSession &,MCalProgressCallBack &)Allocates and constructs an entry view, with a reference to a state callback obj...
• StoreL(const RPointerArray< CCalEntry > &,TInt &)Stores entries in the calendar file.
• StoreL(const RPointerArray< CCalEntry > &,TInt &)
• UpdateL(const RPointerArray< CCalEntry > &,TInt &)Updates entries in the calendar file.
• UpdateL(const RPointerArray< CCalEntry > &,TInt &)
• ~CCalEntryView()The destructor frees all resources owned by the entry view, prior to its destruc...
• ~CCalEntryView()

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Related Topics

 » Symbian OS v9.4 » Examples » Application Engines example code » CalinterimAPI: Using Calendar API

• CalInterimAPI: Using the Calendar API » Class Summary

IMPORT_C static CCalEntryView* NewL(CCalSession &aSession, MCalProgressCallBack &aProgressCallBack);

Description

Parameters

Return value

IMPORT_C static CCalEntryView* NewL(CCalSession &aSession, MCalProgressCallBack &aProgressCallBack);

Description

Allocates and constructs an entry view, with a reference to a state callback object.

Parameters

Return value

IMPORT_C static CCalEntryView* NewL(CCalSession &aSession);

Description

Parameters

Return value

IMPORT_C ~CCalEntryView();

Description

The destructor frees all resources owned by the entry view, prior to its destruction. It cancels any active asynchronous operation, providing notification by calling Completed() function with the value KErrCancel on progress callback object. Note: Progress callback object must not be deleted before the entry view is destroyed, otherwise a panic will occur.

IMPORT_C ~CCalEntryView();

Description

IMPORT_C void FetchL(const TDesC8 &aUid, RPointerArray< CCalEntry > &aCalEntryArray) const;

Description

Fetches all CCalEntry objects related to the Uid. The first entry in the array will always be the parent entry. see CCalEntry for definition of parent entry.

Parameters

See also:

• CCalEntryClass representing a calendar entry. This can be an appointment, to-do item, rem...

IMPORT_C CCalEntry* FetchL(TCalLocalUid aId) const;

Description

Fetches a CCalEntry object related to the cal unique id.

Parameters

Return value

IMPORT_C void FetchL(const TDesC8 &aUid, RPointerArray< CCalEntry > &aCalEntryArray) const;

Description

Parameters

IMPORT_C CCalEntry* FetchL(TCalLocalUid aId) const;

Description

Parameters

Return value

IMPORT_C void GetIdsModifiedSinceDateL(const TCalTime &aTime, RArray< TCalLocalUid > &aIds) const;

Description

Gets all the modified calendar local ids in the file since a specified date

Parameters

IMPORT_C void GetIdsModifiedSinceDateL(const TCalTime &aTime, RArray< TCalLocalUid > &aIds) const;

Description

Parameters

IMPORT_C void StoreL(const RPointerArray< CCalEntry > &aCalEntryList, TInt &aNumSuccessfulEntry);

Description

Stores entries in the calendar file.

Parameters

IMPORT_C void UpdateL(const RPointerArray< CCalEntry > &aCalEntryList, TInt &aNumSuccessfulEntry);

Description

Updates entries in the calendar file.

Parameters

Leave codes

See also:

• CCalEntryClass representing a calendar entry. This can be an appointment, to-do item, rem...

IMPORT_C void StoreL(const RPointerArray< CCalEntry > &aCalEntryList, TInt &aNumSuccessfulEntry);

Description

Parameters

IMPORT_C void UpdateL(const RPointerArray< CCalEntry > &aCalEntryList, TInt &aNumSuccessfulEntry);

Description

Parameters

IMPORT_C void DeleteL(const CDesC8Array &aUidList);

Description

Deletes multiple entries from the calendar file.

Parameters

IMPORT_C void DeleteL(const CCalEntry &aCalEntry);

Description

Deletes an entry from the calender file. If this a parent entry all it's children will also be deleted. see CCalEntry for definition of parent entry.

Parameters

See also:

• CCalEntryClass representing a calendar entry. This can be an appointment, to-do item, rem...

IMPORT_C void DeleteL(const CDesC8Array &aUidList);

Description

Parameters

IMPORT_C void DeleteL(const CalCommon::TCalTimeRange &aCalTimeRange, CalCommon::TCalViewFilter aFilter, MCalProgressCallBack &aProgressCallBack);

Description

Deletes a subset of the model's entries. The entries affected are those which occur within the time range specified by aCalTimeRange.

This method will lock the calendar file. Any request made, by any client, before this has completed will leave with KErrLocked.

Parameters

IMPORT_C void DeleteL(const CCalEntry &aCalEntry);

Description

Parameters

IMPORT_C void DeleteL(const RArray< TCalLocalUid > &aIds, TInt &aNumSuccessfulDeleted);

Description

Deletes multiple entries from the calendar file.

Parameters

IMPORT_C void DeleteL(const CalCommon::TCalTimeRange &aCalTimeRange, CalCommon::TCalViewFilter aFilter, MCalProgressCallBack &aProgressCallBack);

Description

Parameters

IMPORT_C void DeleteL(const RArray< TCalLocalUid > &aIds, TInt &aNumSuccessfulDeleted);

Description

Parameters