Symbian^3 Application Developer Library >

ESMRHelper Class Reference

class ESMRHelper

Static helpers methods ES MR UI subsystem

Public Member Functions
IMPORT_C TPtrC AddressWithoutMailtoPrefix (const TDesC &)
IMPORT_C CCalAttendee * CopyAttendeeL ( CCalAttendee &)
IMPORT_C CCalAttendee * CopyAttendeeLC ( CCalAttendee &)
IMPORT_C CCalEntry * CopyEntryL (const CCalEntry &, CCalEntry::TMethod , TCopyFields , TESMRCalendarEventType )
IMPORT_C CCalEntry * CopyEntryLC (const CCalEntry &, CCalEntry::TMethod , TCopyFields , TESMRCalendarEventType )
IMPORT_C void CopyFieldsL (const CCalEntry &, CCalEntry &, TCopyFields )
IMPORT_C CCalUser * CopyUserL ( CCalUser &)
IMPORT_C CCalUser * CopyUserLC ( CCalUser &)
IMPORT_C TMsvId CorrespondingSmtpServiceL ( TMsvId , CMsvSession &)
IMPORT_C TInt CreateAndAppendOthersDirToFileName ( TFileName &)
IMPORT_C TInt CreateAndAppendPrivateDirToFileName ( TFileName &)
IMPORT_C void GetCorrectDllDriveL ( TFileName &)
IMPORT_C TInt LoadResourceL (const TDesC &, const TDesC &)
IMPORT_C TInt LocateResourceFile (const TDesC &, const TDesC &, TFileName &, RFs *)
IMPORT_C void PopulateChildFromParentL ( CCalEntry &, const CCalEntry &)
Private Member Functions
void AddOrganizerL ( CCalEntry &)
CCalEntry * CopyEntryAndSwitchTypeL (const CCalEntry &, TESMRCalendarEventType )
CCalEntry * CreateEntryL ( CCalEntry::TType , const TDesC8 &, CCalEntry::TMethod , CalCommon::TRecurrenceRange )
TESMRSwitchEventType ResolveSwitchType ( TESMRCalendarEventType , TESMRCalendarEventType )
void SetDefaultAlarmForMeetingL ( CCalEntry &)
void SetMeetingTimeL ( CCalEntry &, const CCalEntry &)
CCalEntry * SwitchToAnniversaryL (const CCalEntry &)
CCalEntry * SwitchToMRL (const CCalEntry &)
CCalEntry * SwitchToMeetingL (const CCalEntry &)
CCalEntry * SwitchToMemoL (const CCalEntry &)
CCalEntry * SwitchToTodoL (const CCalEntry &)
Public Member Enumerations
enum TCopyFields { ECopyFull , ECopyOrganizer , ECopySkeleton }
Private Member Enumerations
enum TESMRSwitchEventType {
EMRSwitchUnknown  = -1, EMRSwitchMRToMeeting  = 0, EMRSwitchMRToMemo , EMRSwitchMRToAnniversary , EMRSwitchMRToTodo , EMRSwitchMeetingToMR , EMRSwitchMeetingToMemo , EMRSwitchMeetingToAnniversary , EMRSwitchMeetingToTodo , EMRSwitchMemoToMR , EMRSwitchMemoToMeeting , EMRSwitchMemoToAnniversary , EMRSwitchMemoToTodo , EMRSwitchAnniversaryToMR , EMRSwitchAnniversaryToMeeting , EMRSwitchAnniversaryToMemo , EMRSwitchAnniversaryToTodo , EMRSwitchTodoToMR , EMRSwitchTodoToMeeting , EMRSwitchTodoToMemo , EMRSwitchTodoToAnniversary
}

Member Functions Documentation

AddOrganizerL(CCalEntry &)

void AddOrganizerL ( CCalEntry & aTargetEntry ) [private, static]

Parameters

CCalEntry & aTargetEntry

AddressWithoutMailtoPrefix(const TDesC &)

IMPORT_C TPtrC AddressWithoutMailtoPrefix ( const TDesC & aAddress ) [static]

Returns TPtrC to all/part of the aAddress parameter so that possible "mailto:" or "MAILTO:" prefix is stripped out.

Parameters

const TDesC & aAddress address which might contain the prefix

CopyAttendeeL(CCalAttendee &)

IMPORT_C CCalAttendee * CopyAttendeeL ( CCalAttendee & aSource ) [static]

Creates a new copy of the given attendee.

Parameters

CCalAttendee & aSource

CopyAttendeeLC(CCalAttendee &)

IMPORT_C CCalAttendee * CopyAttendeeLC ( CCalAttendee & aSource ) [static]

Creates a new copy of the given attendee. Item is left in the cleanup stack.

Parameters

CCalAttendee & aSource

CopyEntryAndSwitchTypeL(const CCalEntry &, TESMRCalendarEventType)

CCalEntry * CopyEntryAndSwitchTypeL ( const CCalEntry & aSourceEntry,
TESMRCalendarEventType aTargetType
) [private, static]

Parameters

const CCalEntry & aSourceEntry
TESMRCalendarEventType aTargetType

CopyEntryL(const CCalEntry &, CCalEntry::TMethod, TCopyFields, TESMRCalendarEventType)

IMPORT_C CCalEntry * CopyEntryL ( const CCalEntry & aEntry,
CCalEntry::TMethod aMethod,
TCopyFields aCopyType,
TESMRCalendarEventType aEntryType = EESMREventTypeNone
) [static]

Creates a copy with given method type. Start/end time and DTSTAMP are set even for a skeleton.

Parameters

const CCalEntry & aEntry source entry
CCalEntry::TMethod aMethod
TCopyFields aCopyType specifies copied data
TESMRCalendarEventType aEntryType = EESMREventTypeNone

CopyEntryLC(const CCalEntry &, CCalEntry::TMethod, TCopyFields, TESMRCalendarEventType)

IMPORT_C CCalEntry * CopyEntryLC ( const CCalEntry & aEntry,
CCalEntry::TMethod aMethod,
TCopyFields aCopyType,
TESMRCalendarEventType aEntryType = EESMREventTypeNone
) [static]

Creates a copy with given method type. Start/end time and DTSTAMP are set even for a skeleton. Copied entry is left in the cleanup stack.

Parameters

const CCalEntry & aEntry source entry
CCalEntry::TMethod aMethod
TCopyFields aCopyType specifies copied data
TESMRCalendarEventType aEntryType = EESMREventTypeNone

CopyFieldsL(const CCalEntry &, CCalEntry &, TCopyFields)

IMPORT_C void CopyFieldsL ( const CCalEntry & aSource,
CCalEntry & aTarget,
TCopyFields aCopyType
) [static]

Copies entry fields according to the copy type specification. Unlike CCalEntry::CopyFromL() this function never copies the entry method property.

Parameters

const CCalEntry & aSource source for copying
CCalEntry & aTarget target for copying
TCopyFields aCopyType specifies what data to copy

CopyUserL(CCalUser &)

IMPORT_C CCalUser * CopyUserL ( CCalUser & aSource ) [static]

Creates a new copy of the given cal user.

Parameters

CCalUser & aSource

CopyUserLC(CCalUser &)

IMPORT_C CCalUser * CopyUserLC ( CCalUser & aSource ) [static]

Creates a new copy of the given cal user. Item is left in the cleanup stack.

Parameters

CCalUser & aSource

CorrespondingSmtpServiceL(TMsvId, CMsvSession &)

IMPORT_C TMsvId CorrespondingSmtpServiceL ( TMsvId aRelatedService,
CMsvSession & aMsvSession
) [static]

Resolves corresponding SMTP service for received MTM

Parameters

TMsvId aRelatedService Related service
CMsvSession & aMsvSession Reference to MSV session.

CreateAndAppendOthersDirToFileName(TFileName &)

IMPORT_C TInt CreateAndAppendOthersDirToFileName ( TFileName & aFileName ) [static]

Creates and appends system private directory to beginning of file. It also appends two back slashes, so aFileName should not contain any backslashes in the begining.

Parameters

TFileName & aFileName Others directory is appended to this file name

CreateAndAppendPrivateDirToFileName(TFileName &)

IMPORT_C TInt CreateAndAppendPrivateDirToFileName ( TFileName & aFileName ) [static]

Creates and appends process' private directory to beginning of file. It also appends two back slashes, so aFileName should not contain any backslashes in the begining.

Parameters

TFileName & aFileName private directory is appended to this file name

CreateEntryL(CCalEntry::TType, const TDesC8 &, CCalEntry::TMethod, CalCommon::TRecurrenceRange)

CCalEntry * CreateEntryL ( CCalEntry::TType aType,
const TDesC8 & aUid,
CCalEntry::TMethod aMethod,
CalCommon::TRecurrenceRange aRange
) [private, static]

Parameters

CCalEntry::TType aType
const TDesC8 & aUid
CCalEntry::TMethod aMethod
CalCommon::TRecurrenceRange aRange

GetCorrectDllDriveL(TFileName &)

IMPORT_C void GetCorrectDllDriveL ( TFileName & aDriveName ) [static]

Parses drive name of dll(eg. "c:") and sets it to aDriveName parameter.

Parameters

TFileName & aDriveName TFileName where parsed drive letter shall be set.

LoadResourceL(const TDesC &, const TDesC &)

IMPORT_C TInt LoadResourceL ( const TDesC & aResourceFile,
const TDesC & aResourcePath
) [static]

Loads resource file into CONE environment.

Parameters

const TDesC & aResourceFile Resource file name.
const TDesC & aResourcePath Resource file path.

LocateResourceFile(const TDesC &, const TDesC &, TFileName &, RFs *)

IMPORT_C TInt LocateResourceFile ( const TDesC & aResource,
const TDesC & aPath,
TFileName & aResourceFile,
RFs * aFs = NULL
) [static]

Locates the calentry policy resource file.

Parameters

const TDesC & aResource Resourcefile to be located.
const TDesC & aPath Path from which file is searched
TFileName & aResourceFile On return contains the resource file name.
RFs * aFs = NULL File server session reference. Ownership is not transfered.

PopulateChildFromParentL(CCalEntry &, const CCalEntry &)

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

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

Parameters

CCalEntry & aChild Child (modifying) entry to be populated .
const CCalEntry & aParent

ResolveSwitchType(TESMRCalendarEventType, TESMRCalendarEventType)

TESMRSwitchEventType ResolveSwitchType ( TESMRCalendarEventType aSourceType,
TESMRCalendarEventType aTargetType
) [private, static]

Parameters

TESMRCalendarEventType aSourceType
TESMRCalendarEventType aTargetType

SetDefaultAlarmForMeetingL(CCalEntry &)

void SetDefaultAlarmForMeetingL ( CCalEntry & aTargetEntry ) [private, static]

Parameters

CCalEntry & aTargetEntry

SetMeetingTimeL(CCalEntry &, const CCalEntry &)

void SetMeetingTimeL ( CCalEntry & aTargetEntry,
const CCalEntry & aSourceEntry
) [private, static]

Parameters

CCalEntry & aTargetEntry
const CCalEntry & aSourceEntry

SwitchToAnniversaryL(const CCalEntry &)

CCalEntry * SwitchToAnniversaryL ( const CCalEntry & aSourceEntry ) [private, static]

Parameters

const CCalEntry & aSourceEntry

SwitchToMRL(const CCalEntry &)

CCalEntry * SwitchToMRL ( const CCalEntry & aSourceEntry ) [private, static]

Parameters

const CCalEntry & aSourceEntry

SwitchToMeetingL(const CCalEntry &)

CCalEntry * SwitchToMeetingL ( const CCalEntry & aSourceEntry ) [private, static]

Parameters

const CCalEntry & aSourceEntry

SwitchToMemoL(const CCalEntry &)

CCalEntry * SwitchToMemoL ( const CCalEntry & aSourceEntry ) [private, static]

Parameters

const CCalEntry & aSourceEntry

SwitchToTodoL(const CCalEntry &)

CCalEntry * SwitchToTodoL ( const CCalEntry & aSourceEntry ) [private, static]

Parameters

const CCalEntry & aSourceEntry

Member Enumerations Documentation

Enum TCopyFields

Enumeration for entry copy method

Enumerators

ECopyFull
ECopyOrganizer
ECopySkeleton

Enum TESMRSwitchEventType

Enumeration for entry type switching

Enumerators

EMRSwitchUnknown = -1
EMRSwitchMRToMeeting = 0
EMRSwitchMRToMemo
EMRSwitchMRToAnniversary
EMRSwitchMRToTodo
EMRSwitchMeetingToMR
EMRSwitchMeetingToMemo
EMRSwitchMeetingToAnniversary
EMRSwitchMeetingToTodo
EMRSwitchMemoToMR
EMRSwitchMemoToMeeting
EMRSwitchMemoToAnniversary
EMRSwitchMemoToTodo
EMRSwitchAnniversaryToMR
EMRSwitchAnniversaryToMeeting
EMRSwitchAnniversaryToMemo
EMRSwitchAnniversaryToTodo
EMRSwitchTodoToMR
EMRSwitchTodoToMeeting
EMRSwitchTodoToMemo
EMRSwitchTodoToAnniversary

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.