64
|
1 |
/*
|
|
2 |
* Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
3 |
* All rights reserved.
|
|
4 |
* This component and the accompanying materials are made available
|
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
6 |
* which accompanies this distribution, and is available
|
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
8 |
*
|
|
9 |
* Initial Contributors:
|
|
10 |
* Nokia Corporation - initial contribution.
|
|
11 |
*
|
|
12 |
* Contributors:
|
|
13 |
*
|
|
14 |
* Description: Definition for static helper methods
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
#ifndef ESMRHELPER_H
|
|
19 |
#define ESMRHELPER_H
|
|
20 |
|
|
21 |
#include <e32base.h>
|
|
22 |
#include <msvstd.h>
|
|
23 |
#include <calentry.h>
|
|
24 |
|
|
25 |
#include "esmrdef.h"
|
|
26 |
|
|
27 |
class CCalAttendee;
|
|
28 |
class CCalUser;
|
|
29 |
class CMsvSession;
|
|
30 |
|
|
31 |
/**
|
|
32 |
* Static helpers methods ES MR UI subsystem
|
|
33 |
*
|
|
34 |
*/
|
|
35 |
NONSHARABLE_CLASS(ESMRHelper)
|
|
36 |
{
|
|
37 |
public: // Data types
|
|
38 |
/**
|
|
39 |
* Enumeration for entry copy method
|
|
40 |
*/
|
|
41 |
enum TCopyFields
|
|
42 |
{
|
|
43 |
ECopyFull,
|
|
44 |
ECopyOrganizer,
|
|
45 |
ECopySkeleton
|
|
46 |
};
|
|
47 |
|
|
48 |
public: // New functions
|
|
49 |
/**
|
|
50 |
* Creates a new copy of the given attendee.
|
|
51 |
*
|
|
52 |
* @param aSource
|
|
53 |
* @return attendee, ownership is transferred to caller.
|
|
54 |
*/
|
|
55 |
IMPORT_C static CCalAttendee* CopyAttendeeL(
|
|
56 |
CCalAttendee& aSource );
|
|
57 |
|
|
58 |
/**
|
|
59 |
* Creates a new copy of the given attendee. Item is
|
|
60 |
* left in the cleanup stack.
|
|
61 |
*
|
|
62 |
* @param aSource
|
|
63 |
* @return attendee, ownership is transferred to caller.
|
|
64 |
*/
|
|
65 |
IMPORT_C static CCalAttendee* CopyAttendeeLC(
|
|
66 |
CCalAttendee& aSource );
|
|
67 |
|
|
68 |
/**
|
|
69 |
* Creates a new copy of the given cal user.
|
|
70 |
*
|
|
71 |
* @param aSource
|
|
72 |
* @return user, ownership is transferred to caller.
|
|
73 |
*/
|
|
74 |
IMPORT_C static CCalUser* CopyUserL(
|
|
75 |
CCalUser& aSource );
|
|
76 |
|
|
77 |
/**
|
|
78 |
* Creates a new copy of the given cal user. Item is
|
|
79 |
* left in the cleanup stack.
|
|
80 |
*
|
|
81 |
* @param aSource
|
|
82 |
* @return user, ownership is transferred to caller.
|
|
83 |
*/
|
|
84 |
IMPORT_C static CCalUser* CopyUserLC(
|
|
85 |
CCalUser& aSource );
|
|
86 |
|
|
87 |
/**
|
|
88 |
* Creates a copy with given method type.
|
|
89 |
* Start/end time and DTSTAMP are set even for a skeleton.
|
|
90 |
* @param aEntry source entry
|
|
91 |
* @param aCopyType specifies copied data
|
|
92 |
* @return instantiated entry, ownership transferred to caller
|
|
93 |
*/
|
|
94 |
IMPORT_C static CCalEntry* CopyEntryL(
|
|
95 |
const CCalEntry& aEntry,
|
|
96 |
CCalEntry::TMethod aMethod,
|
|
97 |
TCopyFields aCopyType,
|
|
98 |
TESMRCalendarEventType aEntryType = EESMREventTypeNone );
|
|
99 |
|
|
100 |
/**
|
|
101 |
* Creates a copy with given method type.
|
|
102 |
* Start/end time and DTSTAMP are set even for a skeleton.
|
|
103 |
* Copied entry is left in the cleanup stack.
|
|
104 |
* @param aEntry source entry
|
|
105 |
* @param aCopyType specifies copied data
|
|
106 |
* @return instantiated entry, ownership transferred to caller
|
|
107 |
*/
|
|
108 |
IMPORT_C static CCalEntry* CopyEntryLC(
|
|
109 |
const CCalEntry& aEntry,
|
|
110 |
CCalEntry::TMethod aMethod,
|
|
111 |
TCopyFields aCopyType,
|
|
112 |
TESMRCalendarEventType aEntryType = EESMREventTypeNone );
|
|
113 |
|
|
114 |
/**
|
|
115 |
* Copies entry fields according to the copy type specification.
|
|
116 |
* Unlike CCalEntry::CopyFromL() this function never copies
|
|
117 |
* the entry method property.
|
|
118 |
* @param aSource source for copying
|
|
119 |
* @param aTarget target for copying
|
|
120 |
* @param aCopyType specifies what data to copy
|
|
121 |
*/
|
|
122 |
IMPORT_C static void CopyFieldsL(
|
|
123 |
const CCalEntry& aSource,
|
|
124 |
CCalEntry& aTarget,
|
|
125 |
TCopyFields aCopyType );
|
|
126 |
|
|
127 |
/**
|
|
128 |
* Returns TPtrC to all/part of the aAddress parameter
|
|
129 |
* so that possible "mailto:" or "MAILTO:" prefix is
|
|
130 |
* stripped out.
|
|
131 |
*
|
|
132 |
* @param aAddress address which might contain the prefix
|
|
133 |
* @return TPtrC which represents only the address
|
|
134 |
*/
|
|
135 |
IMPORT_C static TPtrC AddressWithoutMailtoPrefix(
|
|
136 |
const TDesC& aAddress );
|
|
137 |
|
|
138 |
/**
|
|
139 |
* Parses drive name of dll(eg. "c:") and sets it to
|
|
140 |
* aDriveName parameter.
|
|
141 |
*
|
|
142 |
* @param aDriveName TFileName where parsed drive letter
|
|
143 |
* shall be set.
|
|
144 |
*/
|
|
145 |
IMPORT_C static void GetCorrectDllDriveL(
|
|
146 |
TFileName& aDriveName );
|
|
147 |
|
|
148 |
/**
|
|
149 |
* Loads resource file into CONE environment.
|
|
150 |
* @param aResourceFile Resource file name.
|
|
151 |
* @param aResourcePath Resource file path.
|
|
152 |
* @return Resource file offset.
|
|
153 |
*/
|
|
154 |
IMPORT_C static TInt LoadResourceL(
|
|
155 |
const TDesC& aResourceFile,
|
|
156 |
const TDesC& aResourcePath );
|
|
157 |
/**
|
|
158 |
* Resolves corresponding SMTP service for received MTM
|
|
159 |
* @param aRelatedService Related service
|
|
160 |
* @param aMsvSession Reference to MSV session.
|
|
161 |
* @return TMsvId for sending service.
|
|
162 |
*/
|
|
163 |
IMPORT_C static TMsvId CorrespondingSmtpServiceL(
|
|
164 |
TMsvId aRelatedService,
|
|
165 |
CMsvSession& aMsvSession );
|
|
166 |
|
|
167 |
/**
|
|
168 |
* Populates empty fields of a child entry with data from the
|
|
169 |
* parent entry.
|
|
170 |
* @param aChild Child (modifying) entry to be populated .
|
|
171 |
* @param Parent (originating) entry
|
|
172 |
*/
|
|
173 |
IMPORT_C static void PopulateChildFromParentL (
|
|
174 |
CCalEntry &aChild,
|
|
175 |
const CCalEntry &aParent);
|
|
176 |
|
|
177 |
/**
|
|
178 |
* Locates the calentry policy resource file.
|
|
179 |
*
|
|
180 |
* @param aResource Resourcefile to be located.
|
|
181 |
* @param aPath Path from which file is searched
|
|
182 |
* @param aResourceFile On return contains the resource file name.
|
|
183 |
* @param aFs File server session reference. Ownership is not transfered.
|
|
184 |
* @return KErrNone on success, otherwise system wide error code.
|
|
185 |
*/
|
|
186 |
IMPORT_C static TInt LocateResourceFile(
|
|
187 |
const TDesC& aResource,
|
|
188 |
const TDesC& aPath,
|
|
189 |
TFileName &aResourceFile,
|
|
190 |
RFs* aFs = NULL );
|
|
191 |
|
|
192 |
//<cmail> getting temporary file name is not hard coded
|
|
193 |
/**
|
|
194 |
* Creates and appends process' private directory to beginning of file.
|
|
195 |
* It also appends two back slashes, so aFileName should not contain any
|
|
196 |
* backslashes in the begining.
|
|
197 |
*
|
|
198 |
* @param aFileName private directory is appended to this file name
|
|
199 |
* @return error code
|
|
200 |
*/
|
|
201 |
IMPORT_C static TInt CreateAndAppendPrivateDirToFileName(
|
|
202 |
TFileName& aFileName);
|
|
203 |
//</cmail>
|
|
204 |
|
|
205 |
/**
|
|
206 |
* Creates and appends system private directory to beginning of file.
|
|
207 |
* It also appends two back slashes, so aFileName should not contain any
|
|
208 |
* backslashes in the begining.
|
|
209 |
*
|
|
210 |
* @param aFileName Others directory is appended to this file name
|
|
211 |
* @return error code
|
|
212 |
*/
|
|
213 |
IMPORT_C static TInt CreateAndAppendOthersDirToFileName(
|
|
214 |
TFileName& aFileName);
|
|
215 |
|
|
216 |
private:
|
|
217 |
/**
|
|
218 |
* Enumeration for entry type switching
|
|
219 |
*/
|
|
220 |
|
|
221 |
enum TESMRSwitchEventType
|
|
222 |
{
|
|
223 |
EMRSwitchUnknown = -1,
|
|
224 |
EMRSwitchMRToMeeting = 0,
|
|
225 |
EMRSwitchMRToMemo,
|
|
226 |
EMRSwitchMRToAnniversary,
|
|
227 |
EMRSwitchMRToTodo,
|
|
228 |
|
|
229 |
EMRSwitchMeetingToMR,
|
|
230 |
EMRSwitchMeetingToMemo,
|
|
231 |
EMRSwitchMeetingToAnniversary,
|
|
232 |
EMRSwitchMeetingToTodo,
|
|
233 |
|
|
234 |
EMRSwitchMemoToMR,
|
|
235 |
EMRSwitchMemoToMeeting,
|
|
236 |
EMRSwitchMemoToAnniversary,
|
|
237 |
EMRSwitchMemoToTodo,
|
|
238 |
|
|
239 |
EMRSwitchAnniversaryToMR,
|
|
240 |
EMRSwitchAnniversaryToMeeting,
|
|
241 |
EMRSwitchAnniversaryToMemo,
|
|
242 |
EMRSwitchAnniversaryToTodo,
|
|
243 |
|
|
244 |
EMRSwitchTodoToMR,
|
|
245 |
EMRSwitchTodoToMeeting,
|
|
246 |
EMRSwitchTodoToMemo,
|
|
247 |
EMRSwitchTodoToAnniversary
|
|
248 |
};
|
|
249 |
|
|
250 |
private: // implementation
|
|
251 |
|
|
252 |
static CCalEntry* CopyEntryAndSwitchTypeL(
|
|
253 |
const CCalEntry& aSourceEntry,
|
|
254 |
TESMRCalendarEventType aTargetType );
|
|
255 |
|
|
256 |
static TESMRSwitchEventType ResolveSwitchType(
|
|
257 |
TESMRCalendarEventType aSourceType,
|
|
258 |
TESMRCalendarEventType aTargetType );
|
|
259 |
|
|
260 |
// This handles all entry type changes to Memo
|
|
261 |
static CCalEntry* SwitchToMemoL( const CCalEntry& aSourceEntry );
|
|
262 |
// This handles all entry type changes to Anniversary
|
|
263 |
static CCalEntry* SwitchToAnniversaryL( const CCalEntry& aSourceEntry );
|
|
264 |
// This handles all entry type changes to To-do
|
|
265 |
static CCalEntry* SwitchToTodoL( const CCalEntry& aSourceEntry );
|
|
266 |
// This handles all entry type changes to Meeting
|
|
267 |
static CCalEntry* SwitchToMeetingL( const CCalEntry& aSourceEntry );
|
|
268 |
// This handles all entry type changes to Meeting request
|
|
269 |
static CCalEntry* SwitchToMRL( const CCalEntry& aSourceEntry );
|
|
270 |
|
|
271 |
// Helper functions
|
|
272 |
static CCalEntry* CreateEntryL(
|
|
273 |
CCalEntry::TType aType,
|
|
274 |
const TDesC8& aUid,
|
|
275 |
CCalEntry::TMethod aMethod,
|
|
276 |
CalCommon::TRecurrenceRange aRange );
|
|
277 |
static void SetMeetingTimeL(
|
|
278 |
CCalEntry& aTargetEntry,
|
|
279 |
const CCalEntry& aSourceEntry );
|
|
280 |
static void SetDefaultAlarmForMeetingL(
|
|
281 |
CCalEntry& aTargetEntry );
|
|
282 |
static void AddOrganizerL( CCalEntry& aTargetEntry );
|
|
283 |
};
|
|
284 |
|
|
285 |
#endif // ESMRHELPER_H
|