19
|
1 |
/*
|
|
2 |
* Copyright (c) 2007 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 the License "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:
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
#ifndef __CALENDARENTRY_H
|
|
19 |
#define __CALENDARENTRY_H
|
|
20 |
|
|
21 |
#include <calentry.h>
|
|
22 |
#include <calrrule.h>
|
|
23 |
|
|
24 |
class CCalUser;
|
|
25 |
|
|
26 |
class CAttendeeInfo : public CBase
|
|
27 |
{
|
|
28 |
public:
|
|
29 |
|
|
30 |
/**
|
|
31 |
* Two-phased constructor.
|
|
32 |
* @param aAddress The address of the attendee
|
|
33 |
* @return An instance of CAttendeeInfo
|
|
34 |
*/
|
|
35 |
IMPORT_C static CAttendeeInfo* NewL( const TDesC& aAddress );
|
|
36 |
|
|
37 |
/**
|
|
38 |
* Destructor.
|
|
39 |
*/
|
|
40 |
~CAttendeeInfo();
|
|
41 |
|
|
42 |
/**
|
|
43 |
* Sets the iCalender-defined common name of the user
|
|
44 |
* @param aName It is the common name of the user
|
|
45 |
*/
|
|
46 |
IMPORT_C void SetCommonNameL( const TDesC& aName );
|
|
47 |
|
|
48 |
/**
|
|
49 |
* Set the role of this attendee
|
|
50 |
* @param aRole The role
|
|
51 |
*/
|
|
52 |
IMPORT_C void SetRoleL( const TDesC& aRole );
|
|
53 |
|
|
54 |
/**
|
|
55 |
* Set the status of this attendee
|
|
56 |
* @param aStatus The status
|
|
57 |
*/
|
|
58 |
IMPORT_C void SetStatusL( const TDesC& aStatus );
|
|
59 |
|
|
60 |
/**
|
|
61 |
* Sets whether or not a response was requested for this attendee
|
|
62 |
* @param aResponse ETrue if a response was requested, EFalse if not
|
|
63 |
*/
|
|
64 |
IMPORT_C void SetRsvp( const TBool aResponse );
|
|
65 |
|
|
66 |
/**
|
|
67 |
* Gets the address of the attendee.
|
|
68 |
* @return The address of the attendee.
|
|
69 |
*/
|
|
70 |
IMPORT_C TPtrC Address();
|
|
71 |
|
|
72 |
/**
|
|
73 |
* Gets the iCalender-defined common name of the user.
|
|
74 |
* @return The common name of the user.
|
|
75 |
*/
|
|
76 |
IMPORT_C TPtrC CommonName();
|
|
77 |
|
|
78 |
/**
|
|
79 |
* Get the role of this attendee
|
|
80 |
* @return The role
|
|
81 |
*/
|
|
82 |
IMPORT_C TPtrC Role();
|
|
83 |
|
|
84 |
/**
|
|
85 |
* Get the status of this attendee
|
|
86 |
* @return The status
|
|
87 |
*/
|
|
88 |
IMPORT_C TPtrC Status();
|
|
89 |
|
|
90 |
/**
|
|
91 |
* Gets whether or not a response was requested for this attendee.
|
|
92 |
* @return ETrue if a response was requested, EFalse if not.
|
|
93 |
*/
|
|
94 |
IMPORT_C TBool ResponseRequested();
|
|
95 |
|
|
96 |
|
|
97 |
private:
|
|
98 |
|
|
99 |
/**
|
|
100 |
* Constructor
|
|
101 |
*/
|
|
102 |
CAttendeeInfo();
|
|
103 |
|
|
104 |
/**
|
|
105 |
* Constructor
|
|
106 |
*/
|
|
107 |
void ConstructL( const TDesC& aAddress );
|
|
108 |
|
|
109 |
private:
|
|
110 |
|
|
111 |
|
|
112 |
/**
|
|
113 |
* Repeat type: can be daily, weekly, monthly or yearly
|
|
114 |
*/
|
|
115 |
HBufC* iAddress;
|
|
116 |
|
|
117 |
/**
|
|
118 |
* Repeat type: can be daily, weekly, monthly or yearly
|
|
119 |
*/
|
|
120 |
HBufC* iRole;
|
|
121 |
|
|
122 |
/**
|
|
123 |
* Until time of the repeat rule
|
|
124 |
*/
|
|
125 |
HBufC* iStatus;
|
|
126 |
|
|
127 |
/**
|
|
128 |
* Start time of the repeat rule
|
|
129 |
*/
|
|
130 |
HBufC* iCommonName;
|
|
131 |
|
|
132 |
/**
|
|
133 |
* Interval for the repeat rule
|
|
134 |
*/
|
|
135 |
TBool iResponse;
|
|
136 |
|
|
137 |
|
|
138 |
|
|
139 |
};
|
|
140 |
|
|
141 |
class CRepeatInfo : public CBase
|
|
142 |
{
|
|
143 |
|
|
144 |
public:
|
|
145 |
/**
|
|
146 |
* Two-phased constructor.
|
|
147 |
* @param
|
|
148 |
* @return An instance of CRepeatInfo
|
|
149 |
*/
|
|
150 |
IMPORT_C static CRepeatInfo* NewL( const TInt aType );
|
|
151 |
|
|
152 |
/**
|
|
153 |
* Destructor.
|
|
154 |
*/
|
|
155 |
~CRepeatInfo();
|
|
156 |
|
|
157 |
/**
|
|
158 |
* Sets the until time for the repeat rule
|
|
159 |
* @param aUntilTime It is the time until which we want this rule to
|
|
160 |
* repeat
|
|
161 |
*/
|
|
162 |
IMPORT_C void SetUntilTimeL( const TTime& aUntilTime );
|
|
163 |
|
|
164 |
/**
|
|
165 |
* Sets the number of instances for the repeat rule
|
|
166 |
* @param aCount It is the number of instances we want this rule to
|
|
167 |
* repeat
|
|
168 |
*/
|
|
169 |
IMPORT_C void SetCount( const TUint aCount );
|
|
170 |
|
|
171 |
/**
|
|
172 |
* Sets the start time for the repeat rule
|
|
173 |
* @param aStartTime It is the start time for the repeat rule
|
|
174 |
*/
|
|
175 |
IMPORT_C void SetStartTimeL( const TTime& aStartTime );
|
|
176 |
|
|
177 |
/**
|
|
178 |
* Sets the interval for the repeat rule
|
|
179 |
* @param aInterval It is the interval between two successive repeats
|
|
180 |
*/
|
|
181 |
IMPORT_C void SetInterval( const TInt aInterval );
|
|
182 |
|
|
183 |
/**
|
|
184 |
* Sets all week days on which this rule is repeated, applicable only
|
|
185 |
* for weekly repeat rule
|
|
186 |
* @param aDay It specifies the day of the week on which this rule
|
|
187 |
* repeats.
|
|
188 |
*/
|
|
189 |
IMPORT_C void SetDaysInWeek( const RArray<TDay>& aDays );
|
|
190 |
|
|
191 |
/**
|
|
192 |
* Sets all dates of the month on which this rule is repeated, applicable
|
|
193 |
* only for monthly repeat rule
|
|
194 |
* @param aDay It specifies the day of the month on which this rule
|
|
195 |
* repeats.
|
|
196 |
*/
|
|
197 |
IMPORT_C void SetMonthDates( const RArray<TInt>& aMonthDates );
|
|
198 |
|
|
199 |
/**
|
|
200 |
* Sets all days of the month on which this rule is repeated, applicable
|
|
201 |
* only for monthly and yearly repeat rule
|
|
202 |
* @param aDay It specifies the day of the week on which this rule
|
|
203 |
* repeats.
|
|
204 |
* @param aWeekNum The week number in the month i.e.1, 2, 3, 4 for the 1st,
|
|
205 |
2nd, 3rd and 4th week of the month, or -1 for the last week
|
|
206 |
of the month.
|
|
207 |
*/
|
|
208 |
IMPORT_C void SetMonthDays( const RArray<TCalRRule::TDayOfMonth>& aDays );
|
|
209 |
|
|
210 |
/**
|
|
211 |
* Sets the month of the year for this repeat rule
|
|
212 |
* @param aMonthNum It is the month number in which we want the rule to repeat
|
|
213 |
*/
|
|
214 |
IMPORT_C void SetMonth( const TInt aMonthNum );
|
|
215 |
|
|
216 |
|
|
217 |
/**
|
|
218 |
* Sets the first day of the week for this repeat rule.
|
|
219 |
* @param aDay The weekday to be the first
|
|
220 |
*/
|
|
221 |
IMPORT_C void SetWeekStart( const TInt aDay );
|
|
222 |
|
|
223 |
/**
|
|
224 |
* Gets the month of the year for this repeat rule
|
|
225 |
* @return The month of the yearly repeat
|
|
226 |
*/
|
|
227 |
IMPORT_C TMonth Month();
|
|
228 |
|
|
229 |
/**
|
|
230 |
* Gets all weekdays on which this rule is repeated
|
|
231 |
* @return Array containing all weekdays that are to be set
|
|
232 |
*/
|
|
233 |
IMPORT_C RArray< TDay >& DaysInWeek();
|
|
234 |
|
|
235 |
/**
|
|
236 |
* Gets all days in the month on which this rule is repeated
|
|
237 |
* @return Array containing all days in the month that are to be set
|
|
238 |
*/
|
|
239 |
IMPORT_C RArray< TCalRRule::TDayOfMonth >& DaysInMonth();
|
|
240 |
|
|
241 |
/**
|
|
242 |
* Gets all dates in the month on which this rule is repeated
|
|
243 |
* @return Array containing all dates in the month that are to be set
|
|
244 |
*/
|
|
245 |
IMPORT_C RArray< TInt >& DatesInMonth();
|
|
246 |
|
|
247 |
/**
|
|
248 |
* Gets the repeat interval.
|
|
249 |
* @return The repeat interval
|
|
250 |
*/
|
|
251 |
IMPORT_C TInt Interval();
|
|
252 |
|
|
253 |
/**
|
|
254 |
* Gets the repeat interval.
|
|
255 |
* @return The end date, as a TCalTime so it may be accessed in utc or system local time
|
|
256 |
*/
|
|
257 |
IMPORT_C TCalTime& UntilDate();
|
|
258 |
|
|
259 |
/**
|
|
260 |
* Gets the repeat definition's type.
|
|
261 |
* @return The repeat definition's type
|
|
262 |
*/
|
|
263 |
IMPORT_C TCalRRule::TType Type();
|
|
264 |
|
|
265 |
/**
|
|
266 |
* Gets the first day of the week for this repeat rule.
|
|
267 |
* @return The first day of the week for this repeat rule.
|
|
268 |
*/
|
|
269 |
IMPORT_C TDay WeekStart();
|
|
270 |
|
|
271 |
/**
|
|
272 |
* Gets the repeat rule
|
|
273 |
* @return The repeat rule.
|
|
274 |
*/
|
|
275 |
IMPORT_C TCalRRule& GetRepeatRule();
|
|
276 |
private:
|
|
277 |
|
|
278 |
/**
|
|
279 |
* Constructor
|
|
280 |
*/
|
|
281 |
CRepeatInfo();
|
|
282 |
|
|
283 |
/**
|
|
284 |
* Constructor
|
|
285 |
*/
|
|
286 |
void ConstructL( const TInt aType );
|
|
287 |
private:
|
|
288 |
|
|
289 |
|
|
290 |
/**
|
|
291 |
* Repeat type: can be daily, weekly, monthly or yearly
|
|
292 |
*/
|
|
293 |
TCalRRule::TType iType;
|
|
294 |
|
|
295 |
/**
|
|
296 |
* Until time of the repeat rule
|
|
297 |
*/
|
|
298 |
TCalTime iUntilTime;
|
|
299 |
|
|
300 |
/**
|
|
301 |
* Start time of the repeat rule
|
|
302 |
*/
|
|
303 |
TCalTime iStartTime;
|
|
304 |
|
|
305 |
/**
|
|
306 |
* Interval for the repeat rule
|
|
307 |
*/
|
|
308 |
TInt iInterval;
|
|
309 |
|
|
310 |
/**
|
|
311 |
* Month for the yearly repeat rule
|
|
312 |
*/
|
|
313 |
TMonth iMonth;
|
|
314 |
|
|
315 |
/**
|
|
316 |
* Array of month days for the monthly/yearly repeat rule
|
|
317 |
*/
|
|
318 |
RArray<TCalRRule::TDayOfMonth> iMonthDays;
|
|
319 |
|
|
320 |
/**
|
|
321 |
* Array of month dates for the monthly repeat rule
|
|
322 |
*/
|
|
323 |
RArray<TInt> iMonthDates;
|
|
324 |
|
|
325 |
/**
|
|
326 |
* Array of weekdays for the weekly repeat rule
|
|
327 |
*/
|
|
328 |
RArray<TDay> iWeekDays;
|
|
329 |
|
|
330 |
TDay iWkSt;
|
|
331 |
|
|
332 |
TCalRRule iRule;
|
|
333 |
|
|
334 |
};
|
|
335 |
|
|
336 |
/**
|
|
337 |
* This class provides function to set and get various attributes
|
|
338 |
* associated with a calendar entry.
|
|
339 |
*/
|
|
340 |
class CEntryAttributes : public CBase
|
|
341 |
{
|
|
342 |
public:
|
|
343 |
|
|
344 |
/**
|
|
345 |
* TModifiedParameters enum for indicating which entry fields have new values
|
|
346 |
* for modification
|
|
347 |
*/
|
|
348 |
enum TModifiedParameters
|
|
349 |
{
|
|
350 |
ESummary =0x00001,
|
|
351 |
ESeqNum =0x00002,
|
|
352 |
EStartTime =0x00004,
|
|
353 |
EEndTime =0x00008,
|
|
354 |
EReplication =0x00010,
|
|
355 |
EDescription =0x00020,
|
|
356 |
EPriority =0x00040,
|
|
357 |
EMethod =0x00080,
|
|
358 |
EAlarmTime =0x00100,
|
|
359 |
ELocation =0x00200,
|
|
360 |
EStatus =0x00400,
|
|
361 |
ERepeatRule =0x00800,
|
|
362 |
EExDates =0x01000,
|
|
363 |
ERepeatDates =0x02000,
|
|
364 |
EPhoneOwner =0x04000,
|
|
365 |
EOrganizer =0x08000,
|
|
366 |
EAttendees =0x10000,
|
|
367 |
ELocalUid =0x20000,
|
|
368 |
EEntryType =0x40000,
|
|
369 |
EInsStartTime =0x80000,
|
|
370 |
};
|
|
371 |
|
|
372 |
public:
|
|
373 |
|
|
374 |
/**
|
|
375 |
* Two-phased constructor.
|
|
376 |
* @param aType It is the type of calendar entry and can be an appointment,
|
|
377 |
* to-do item, reminder, event or anniversary
|
|
378 |
* @return An instance of CEntryAttributes
|
|
379 |
*/
|
|
380 |
IMPORT_C static CEntryAttributes* NewL( const TDesC& aType );
|
|
381 |
|
|
382 |
/**
|
|
383 |
* Two-phased constructor.
|
|
384 |
* @return An instance of CEntryAttributes
|
|
385 |
*/
|
|
386 |
IMPORT_C static CEntryAttributes* CEntryAttributes::NewL();
|
|
387 |
/**
|
|
388 |
* Destructor.
|
|
389 |
*/
|
|
390 |
~CEntryAttributes();
|
|
391 |
|
|
392 |
/**
|
|
393 |
* Sets the start time for the calendar entry
|
|
394 |
* @param aStartTime It is the start time that we want to set to the
|
|
395 |
* calendar entry.
|
|
396 |
* @return void
|
|
397 |
*/
|
|
398 |
IMPORT_C void SetTypeL( const TDesC& aType );
|
|
399 |
|
|
400 |
/**
|
|
401 |
* Sets the start time for the calendar entry
|
|
402 |
* @param aStartTime It is the start time that we want to set to the
|
|
403 |
* calendar entry.
|
|
404 |
* @return void
|
|
405 |
*/
|
|
406 |
IMPORT_C void SetStartTimeL( const TTime& aStartTime );
|
|
407 |
|
|
408 |
/**
|
|
409 |
* Sets the end time for the calendar entry
|
|
410 |
* @param aEndTime It is the start time that we want to set to the
|
|
411 |
* calendar entry.
|
|
412 |
* @return void
|
|
413 |
*/
|
|
414 |
IMPORT_C void SetEndTimeL( const TTime& aEndTime );
|
|
415 |
|
|
416 |
/**
|
|
417 |
* Sets the instance start time for the calendar entry, valid for "Update"
|
|
418 |
* opration
|
|
419 |
* @param aEndTime It is the start time that we want to set to the
|
|
420 |
* calendar entry.
|
|
421 |
* @return void
|
|
422 |
*/
|
|
423 |
IMPORT_C void SetInstanceStartTimeL( const TTime& aStartTime );
|
|
424 |
|
|
425 |
/**
|
|
426 |
* Sets the sequence number for the calendar entry
|
|
427 |
* @param aSeqNum It is the sequence number that we want to set to the
|
|
428 |
* calendar entry.
|
|
429 |
* @return void
|
|
430 |
*/
|
|
431 |
IMPORT_C void SetSequenceNumber( const TInt aSeqNum );
|
|
432 |
|
|
433 |
/**
|
|
434 |
* Sets the status of the calendar entry
|
|
435 |
* @param aStatus It specifies the current status of the calendar entry.
|
|
436 |
* @return void
|
|
437 |
*/
|
|
438 |
IMPORT_C void SetEntryStatusL( const TDesC& aStatus );
|
|
439 |
|
|
440 |
/**
|
|
441 |
* Sets the phone owner for a calendar entry
|
|
442 |
* @param aCommonName It is the common name of the calendar user
|
|
443 |
* @param aEmailAddress It is the email address of the calendar user
|
|
444 |
* @return void
|
|
445 |
*/
|
|
446 |
IMPORT_C void SetPhoneOwnerDataL( const TDesC& aPhoneOwner );
|
|
447 |
/**
|
|
448 |
|
|
449 |
* Sets the organizer of a calendar entry of type appointment
|
|
450 |
* @param aCommonName It is the common name of the group to which
|
|
451 |
* this user belongs.
|
|
452 |
* @param aEmailAddress It is the email address of the meeting organizer
|
|
453 |
* @return void
|
|
454 |
*/
|
|
455 |
IMPORT_C void SetOrganizerDataL( CAttendeeInfo* aPhoneOwner );
|
|
456 |
|
|
457 |
/**
|
|
458 |
* Adds the attendees of a calendar entry of type appointment
|
|
459 |
* @param aAttendee attendee for the appointment. Ownership is transfered
|
|
460 |
* @return void
|
|
461 |
*/
|
|
462 |
IMPORT_C void AddAttendeeL( CAttendeeInfo* aAttendee );
|
|
463 |
|
|
464 |
/**
|
|
465 |
* Adds the out-of-sequence dates on which this entry occurs.
|
|
466 |
* @param aRepeatDate date that we want to add to the original schedule.
|
|
467 |
* @return void
|
|
468 |
*/
|
|
469 |
IMPORT_C void AddRepeatDateL( const TTime& aRepeatDate );
|
|
470 |
|
|
471 |
/**
|
|
472 |
* Adds the date that is to be exceptioned in the original schedule.
|
|
473 |
* @param aExDate It is the date that we want to remove
|
|
474 |
* from the original schedule.
|
|
475 |
* @return void
|
|
476 |
*/
|
|
477 |
IMPORT_C void AddExceptionDateL( const TTime& aExDate );
|
|
478 |
|
|
479 |
/**
|
|
480 |
* Sets the summary for the calendar entry.
|
|
481 |
* @param aSummary It is the summary that we want to set for the
|
|
482 |
* calendar entry.
|
|
483 |
* @return void
|
|
484 |
*/
|
|
485 |
IMPORT_C void SetSummaryL( const TDesC& aSummary );
|
|
486 |
|
|
487 |
/**
|
|
488 |
* Sets the description for the calendar entry.
|
|
489 |
* @param aDescription It is the description that we want to set for the
|
|
490 |
* calendar entry.
|
|
491 |
* @return void
|
|
492 |
*/
|
|
493 |
IMPORT_C void SetDescriptionL( const TDesC& aDescription );
|
|
494 |
|
|
495 |
/**
|
|
496 |
* Sets the location for the calendar entry.
|
|
497 |
* @param aLocation It is the location that we want to set for the
|
|
498 |
* meeting entry.
|
|
499 |
* @return void
|
|
500 |
*/
|
|
501 |
IMPORT_C void SetLocationL( const TDesC& aLocation );
|
|
502 |
|
|
503 |
/**
|
|
504 |
* Sets the method for the calendar entry.
|
|
505 |
* @param aMethod It is the method that we want to set for the
|
|
506 |
* meeting entry.
|
|
507 |
* @return void
|
|
508 |
*/
|
|
509 |
IMPORT_C void SetMethodL( const TDesC& aMethod );
|
|
510 |
|
|
511 |
/**
|
|
512 |
* Sets the replication for the calendar entry.
|
|
513 |
* @param aLocation It is the location that we want to set for the
|
|
514 |
* meeting entry.
|
|
515 |
* @return void
|
|
516 |
*/
|
|
517 |
IMPORT_C void SetReplicationL( const TDesC& aRepStatus );
|
|
518 |
|
|
519 |
/**
|
|
520 |
* Sets the priority for the calendar entry.
|
|
521 |
* @param aLocation It is the location that we want to set for the
|
|
522 |
* meeting entry.
|
|
523 |
* @return Error code
|
|
524 |
*/
|
|
525 |
IMPORT_C int SetPriority(const TInt aPriority );
|
|
526 |
|
|
527 |
/**
|
|
528 |
* Sets the alarm for the calendar entry.
|
|
529 |
* @param aAlarmTime It is the time that we want to set for the
|
|
530 |
* entry alarm.
|
|
531 |
* @return void
|
|
532 |
*/
|
|
533 |
IMPORT_C void SetAlarm( const TTime& aAlarmTime);
|
|
534 |
|
|
535 |
/**
|
|
536 |
* Sets the local uid for the calendar entry.
|
|
537 |
* @param aLocation It is the location that we want to set for the
|
|
538 |
* meeting entry.
|
|
539 |
* @return void
|
|
540 |
*/
|
|
541 |
IMPORT_C void SetLocalUid( const TCalLocalUid aLUid);
|
|
542 |
|
|
543 |
/**
|
|
544 |
* Gets the start time for the calendar entry.
|
|
545 |
* @param aLocation It is the location that we want to set for the
|
|
546 |
* meeting entry.
|
|
547 |
* @return void
|
|
548 |
*/
|
|
549 |
|
|
550 |
|
|
551 |
IMPORT_C TCalTime& StartTime();
|
|
552 |
|
|
553 |
/**
|
|
554 |
* Sets the entry's repeat rule
|
|
555 |
* @param aRptInfo It is the repeat rule information for this entry
|
|
556 |
*/
|
|
557 |
IMPORT_C void SetRepeatRule( CRepeatInfo* aRptInfo);
|
|
558 |
|
|
559 |
/**
|
|
560 |
* Gets the end time for the calendar entry.
|
|
561 |
* @return The end time for the calendar entry.
|
|
562 |
*/
|
|
563 |
IMPORT_C TCalTime& EndTime();
|
|
564 |
|
|
565 |
/**
|
|
566 |
* Gets the instance start time.
|
|
567 |
* @return void The instance start time.
|
|
568 |
*/
|
|
569 |
IMPORT_C TCalTime& InstanceStartTime();
|
|
570 |
|
|
571 |
/**
|
|
572 |
* Gets the entry type for the calendar entry.
|
|
573 |
* @return void The entry type for the calendar entry.
|
|
574 |
*/
|
|
575 |
IMPORT_C CCalEntry::TType EntryType();
|
|
576 |
|
|
577 |
/**
|
|
578 |
* Gets the sequence number for the calendar entry.
|
|
579 |
* @return void The sequence number for the calendar entry.
|
|
580 |
*/
|
|
581 |
IMPORT_C TInt SequenceNumber();
|
|
582 |
|
|
583 |
/**
|
|
584 |
* Gets the entry status for the calendar entry.
|
|
585 |
* @return void The entry status for the calendar entry.
|
|
586 |
*/
|
|
587 |
IMPORT_C CCalEntry::TStatus EntryStatus();
|
|
588 |
|
|
589 |
/**
|
|
590 |
* Gets the alarm time for the calendar entry.
|
|
591 |
* @return void The alarm time for the calendar entry.
|
|
592 |
*/
|
|
593 |
IMPORT_C TTime AlarmTime();
|
|
594 |
|
|
595 |
/**
|
|
596 |
* Gets the phone owner for the calendar entry.
|
|
597 |
* @return void The phone owner for the calendar entry.
|
|
598 |
*/
|
|
599 |
IMPORT_C TPtrC PhoneOwner();
|
|
600 |
|
|
601 |
/**
|
|
602 |
* Gets the method for the calendar entry.
|
|
603 |
* @return void The method for the calendar entry
|
|
604 |
*/
|
|
605 |
IMPORT_C CCalEntry::TMethod Method();
|
|
606 |
|
|
607 |
/**
|
|
608 |
* Gets the organizer for the calendar entry.
|
|
609 |
* @return void The organizer for the calendar entry.
|
|
610 |
*/
|
|
611 |
IMPORT_C CCalUser* Organizer();
|
|
612 |
|
|
613 |
/**
|
|
614 |
* Gets the list of attendees for the calendar entry.
|
|
615 |
* @return RPointerArray<CCalAttendee>&
|
|
616 |
*/
|
|
617 |
IMPORT_C RPointerArray<CCalAttendee>& AttendeeList();
|
|
618 |
|
|
619 |
/**
|
|
620 |
* Gets the list of repeat dates for the calendar entry.
|
|
621 |
* @return void
|
|
622 |
*/
|
|
623 |
IMPORT_C RArray<TCalTime>& RepeatDates();
|
|
624 |
|
|
625 |
/**
|
|
626 |
* Gets the exception dates for the calendar entry.
|
|
627 |
* @return void
|
|
628 |
*/
|
|
629 |
IMPORT_C RArray<TCalTime>& ExceptionDates();
|
|
630 |
|
|
631 |
/**
|
|
632 |
* Gets the summary for the calendar entry.
|
|
633 |
* @return void
|
|
634 |
*/
|
|
635 |
IMPORT_C TPtrC Summary();
|
|
636 |
|
|
637 |
/**
|
|
638 |
* Gets the description for the calendar entry.
|
|
639 |
* @return void
|
|
640 |
*/
|
|
641 |
IMPORT_C TPtrC Description();
|
|
642 |
|
|
643 |
/**
|
|
644 |
* Gets the location for the calendar entry.
|
|
645 |
* @return void
|
|
646 |
*/
|
|
647 |
IMPORT_C TPtrC Location();
|
|
648 |
|
|
649 |
/**
|
|
650 |
* Gets the priority for the calendar entry.
|
|
651 |
* @return void
|
|
652 |
*/
|
|
653 |
IMPORT_C TInt Priority();
|
|
654 |
|
|
655 |
/**
|
|
656 |
* Gets the replication status for the calendar entry.
|
|
657 |
* @return void
|
|
658 |
*/
|
|
659 |
IMPORT_C CCalEntry::TReplicationStatus ReplicationStatus();
|
|
660 |
|
|
661 |
/**
|
|
662 |
* Gets the repeat rule for the calendar entry.
|
|
663 |
* @return void
|
|
664 |
*/
|
|
665 |
IMPORT_C TCalRRule& RepeatRuleL();
|
|
666 |
|
|
667 |
/**
|
|
668 |
* Gets the local uid for the calendar entry.
|
|
669 |
* @return void
|
|
670 |
*/
|
|
671 |
IMPORT_C TCalLocalUid LocalUid();
|
|
672 |
|
|
673 |
/**
|
|
674 |
* Gets the attributes that have changed for the calendar entry.
|
|
675 |
* @return A 32-bit integer indicating which attributes have been modified.
|
|
676 |
*/
|
|
677 |
IMPORT_C TInt32 ModifiedAttributes();
|
|
678 |
|
|
679 |
private:
|
|
680 |
|
|
681 |
/**
|
|
682 |
* Constructor
|
|
683 |
*/
|
|
684 |
CEntryAttributes();
|
|
685 |
|
|
686 |
/**
|
|
687 |
* Constructor
|
|
688 |
*/
|
|
689 |
void ConstructL( const TDesC& aType );
|
|
690 |
private:
|
|
691 |
|
|
692 |
|
|
693 |
/**
|
|
694 |
* Entry type: can be an appointment, to-do item, reminder, event or anniversary
|
|
695 |
*/
|
|
696 |
CCalEntry::TType iType;
|
|
697 |
|
|
698 |
/**
|
|
699 |
* Start time of the entry
|
|
700 |
*/
|
|
701 |
TCalTime iStartTime;
|
|
702 |
|
|
703 |
/**
|
|
704 |
* End time of the entry
|
|
705 |
*/
|
|
706 |
TCalTime iEndTime;
|
|
707 |
|
|
708 |
/**
|
|
709 |
* Start time of the instance to be modified
|
|
710 |
*/
|
|
711 |
TCalTime iInstanceStartTime;
|
|
712 |
|
|
713 |
/**
|
|
714 |
* Sequence number for the entry
|
|
715 |
*/
|
|
716 |
TInt iSequenceNum;
|
|
717 |
|
|
718 |
/**
|
|
719 |
* Summary for the entry
|
|
720 |
*/
|
|
721 |
HBufC* iSummary;
|
|
722 |
|
|
723 |
/**
|
|
724 |
* Description for the entry
|
|
725 |
*/
|
|
726 |
HBufC* iDescription;
|
|
727 |
|
|
728 |
/**
|
|
729 |
* Location for entry of appointment type
|
|
730 |
*/
|
|
731 |
HBufC* iLocation;
|
|
732 |
|
|
733 |
/**
|
|
734 |
* Alarm time for the entry
|
|
735 |
*/
|
|
736 |
TTime iAlarmTime;
|
|
737 |
|
|
738 |
/**
|
|
739 |
* Status of the entry: valid for entries of "appointment" and "todo" type
|
|
740 |
*/
|
|
741 |
CCalEntry::TStatus iEntryStatus;
|
|
742 |
|
|
743 |
/**
|
|
744 |
* Entry's method property for group scheduling
|
|
745 |
*/
|
|
746 |
CCalEntry::TMethod iMethod;
|
|
747 |
|
|
748 |
/**
|
|
749 |
* Replication status of the entry
|
|
750 |
*/
|
|
751 |
CCalEntry::TReplicationStatus iRepStatus;
|
|
752 |
|
|
753 |
/**
|
|
754 |
* Phone owner data for the entry: applicable only for entries of "appointment" type
|
|
755 |
*/
|
|
756 |
HBufC* iPhoneOwner;
|
|
757 |
|
|
758 |
/**
|
|
759 |
* Organizer of an appointment entry
|
|
760 |
*/
|
|
761 |
CCalUser* iOrganizer;
|
|
762 |
|
|
763 |
/**
|
|
764 |
* An array of out-of-sequence dates on which this entry repeats
|
|
765 |
*/
|
|
766 |
RArray<TCalTime> iRepeatDates;
|
|
767 |
|
|
768 |
/**
|
|
769 |
* An array of exception dates i.e occurrences in the original schedule that
|
|
770 |
* have been removed and may be replaced with a different occurrence
|
|
771 |
*/
|
|
772 |
RArray<TCalTime> iExDates;
|
|
773 |
|
|
774 |
/**
|
|
775 |
* Array of attendees of an appointment entry
|
|
776 |
*/
|
|
777 |
RPointerArray<CCalAttendee> iAttendees;
|
|
778 |
|
|
779 |
/**
|
|
780 |
* The entry's repeat definition: valid for repeating entries of "appointment" type
|
|
781 |
*/
|
|
782 |
TCalRRule iRepeatRule;
|
|
783 |
|
|
784 |
/**
|
|
785 |
* Priority of the entry
|
|
786 |
*/
|
|
787 |
TInt iPriority;
|
|
788 |
|
|
789 |
/**
|
|
790 |
* Local Uid of an entry which can uniquely identify entries having the same Global Uid
|
|
791 |
*/
|
|
792 |
TCalLocalUid iLocal;
|
|
793 |
|
|
794 |
/**
|
|
795 |
* Indicates which entries have new values for the update operation
|
|
796 |
*/
|
|
797 |
TInt32 iSetAttributes;
|
|
798 |
};
|
|
799 |
|
|
800 |
#endif __CALENDARENTRY_H |