CCalenInterimUtils2 Class Reference

API published in: S60 3rd Ed

Link against: caleninterimutils2.lib

Capability Information

Required Capabilities

None

Exceptions

ReadDeviceData is required in GlobalUidL() ReadUserData + WriteUserData are required in StoreL() ReadUserData is required in MRViewersEnabledL()

#include <caleninterimutils2.h>

Detailed Description

This class contains utility methods related to usage of Calendar Interim API.

Public Member Functions
IMPORT_C  ~CCalenInterimUtils2 ()
  Destructor.
IMPORT_C HBufC8 *  GlobalUidL ()
  Allocates and returns a new global UID.
IMPORT_C TBool  MRViewersEnabledL (TBool aForceCheck=EFalse)
  Checks to see if Meeting Request Viewer functionality is enabled and is available to use.

Static Public Member Functions
static IMPORT_C CCalenInterimUtils2 *  NewL ()
  Create a new instance of CalenInterimUtils2.
static IMPORT_C void  PopulateChildFromParentL (CCalEntry &aChild, const CCalEntry &aParent)
  Populates empty fields of a child entry with data from the parent entry.
static IMPORT_C void  StoreL (CCalEntryView &aEntryView, CCalEntry &aEntry, TBool aCopyToChildren=EFalse)
  This function is a wrapper around CCalEntryView::StoreL() and CCalEntryView::UpdateL().
static IMPORT_C TBool  IsMeetingRequestL (CCalEntry &aEntry)
  Checks to see if the given entry has properties consistent with a meeting request.

Constructor & Destructor Documentation

IMPORT_C CCalenInterimUtils2::~CCalenInterimUtils2 (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C HBufC8* CCalenInterimUtils2::GlobalUidL (   ) 
 

Allocates and returns a new global UID.

Returns:
UID, ownership is transferred to caller
static IMPORT_C TBool CCalenInterimUtils2::IsMeetingRequestL (  CCalEntry &  aEntry  )  [static]
 

Checks to see if the given entry has properties consistent with a meeting request.

Parameters:
aEntry  Entry to test
Returns:
ETrue if the entry is a meeting request, EFalse otherwise
IMPORT_C TBool CCalenInterimUtils2::MRViewersEnabledL (  TBool  aForceCheck = EFalse  ) 
 

Checks to see if Meeting Request Viewer functionality is enabled and is available to use.

Returns:
current state of MR Viewers implementation
static IMPORT_C CCalenInterimUtils2* CCalenInterimUtils2::NewL (   )  [static]
 

Create a new instance of CalenInterimUtils2.

static IMPORT_C void CCalenInterimUtils2::PopulateChildFromParentL (  CCalEntry &  aChild,
const CCalEntry &  aParent
)  [static]
 

Populates empty fields of a child entry with data from the parent entry.

Parameters:
aChild  child (modifying) entry to be populated
aParent  parent (originating) entry
static IMPORT_C void CCalenInterimUtils2::StoreL (  CCalEntryView &  aEntryView,
CCalEntry &  aEntry,
TBool  aCopyToChildren = EFalse
)  [static]
 

This function is a wrapper around CCalEntryView::StoreL() and CCalEntryView::UpdateL().

The function makes the appropriate call to either of those functions, depending on several factors, such as whether the entry is a child or parent, and whether it has exceptions or not. If aCopyToChildren is set to ETrue, extra logic is applied as follows: For each exception, for each field, if the field is NOT the reason for the entry being an exception, copy the new parent's field across to the exception.

Parameters:
aEntryView  view of the entries
aEntry  entry to be stored
aCopyToChildren  whether the extra logic regarding exception data should be run
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top