summaryrefslogtreecommitdiffabout
path: root/kabc/addressee.h
Unidiff
Diffstat (limited to 'kabc/addressee.h') (more/less context) (ignore whitespace changes)
-rw-r--r--kabc/addressee.h1
1 files changed, 1 insertions, 0 deletions
diff --git a/kabc/addressee.h b/kabc/addressee.h
index 0aa2c51..03138f6 100644
--- a/kabc/addressee.h
+++ b/kabc/addressee.h
@@ -1,852 +1,853 @@
1/*** Warning! This file has been generated by the script makeaddressee ***/ 1/*** Warning! This file has been generated by the script makeaddressee ***/
2/* 2/*
3 This file is part of libkabc. 3 This file is part of libkabc.
4 Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org> 4 Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org>
5 5
6 This library is free software; you can redistribute it and/or 6 This library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public 7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either 8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version. 9 version 2 of the License, or (at your option) any later version.
10 10
11 This library is distributed in the hope that it will be useful, 11 This library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of 12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details. 14 Library General Public License for more details.
15 15
16 You should have received a copy of the GNU Library General Public License 16 You should have received a copy of the GNU Library General Public License
17 along with this library; see the file COPYING.LIB. If not, write to 17 along with this library; see the file COPYING.LIB. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. 19 Boston, MA 02111-1307, USA.
20*/ 20*/
21 21
22/* 22/*
23Enhanced Version of the file for platform independent KDE tools. 23Enhanced Version of the file for platform independent KDE tools.
24Copyright (c) 2004 Ulf Schenk 24Copyright (c) 2004 Ulf Schenk
25 25
26$Id$ 26$Id$
27*/ 27*/
28 28
29#ifndef KABC_ADDRESSEE_H 29#ifndef KABC_ADDRESSEE_H
30#define KABC_ADDRESSEE_H 30#define KABC_ADDRESSEE_H
31 31
32#include <qdatetime.h> 32#include <qdatetime.h>
33#include <qstring.h> 33#include <qstring.h>
34#include <qstringlist.h> 34#include <qstringlist.h>
35#include <qvaluelist.h> 35#include <qvaluelist.h>
36 36
37#include <ksharedptr.h> 37#include <ksharedptr.h>
38#include <kurl.h> 38#include <kurl.h>
39 39
40#include "address.h" 40#include "address.h"
41#include "agent.h" 41#include "agent.h"
42#include "geo.h" 42#include "geo.h"
43#include "key.h" 43#include "key.h"
44#include "phonenumber.h" 44#include "phonenumber.h"
45#include "picture.h" 45#include "picture.h"
46#include "secrecy.h" 46#include "secrecy.h"
47#include "sound.h" 47#include "sound.h"
48#include "timezone.h" 48#include "timezone.h"
49 49
50namespace KABC { 50namespace KABC {
51 51
52class Resource; 52class Resource;
53 53
54/** 54/**
55 @short address book entry 55 @short address book entry
56 56
57 This class represents an entry in the address book. 57 This class represents an entry in the address book.
58 58
59 The data of this class is implicitly shared. You can pass this class by value. 59 The data of this class is implicitly shared. You can pass this class by value.
60 60
61 If you need the name of a field for presenting it to the user you should use 61 If you need the name of a field for presenting it to the user you should use
62 the functions ending in Label(). They return a translated string which can be 62 the functions ending in Label(). They return a translated string which can be
63 used as label for the corresponding field. 63 used as label for the corresponding field.
64 64
65 About the name fields: 65 About the name fields:
66 66
67 givenName() is the first name and familyName() the last name. In some 67 givenName() is the first name and familyName() the last name. In some
68 countries the family name comes first, that's the reason for the 68 countries the family name comes first, that's the reason for the
69 naming. formattedName() is the full name with the correct formatting. 69 naming. formattedName() is the full name with the correct formatting.
70 It is used as an override, when the correct formatting can't be generated 70 It is used as an override, when the correct formatting can't be generated
71 from the other name fields automatically. 71 from the other name fields automatically.
72 72
73 realName() returns a fully formatted name(). It uses formattedName, if set, 73 realName() returns a fully formatted name(). It uses formattedName, if set,
74 otherwise it constucts the name from the name fields. As fallback, if 74 otherwise it constucts the name from the name fields. As fallback, if
75 nothing else is set it uses name(). 75 nothing else is set it uses name().
76 76
77 name() is the NAME type of RFC2426. It can be used as internal name for the 77 name() is the NAME type of RFC2426. It can be used as internal name for the
78 data enty, but shouldn't be used for displaying the data to the user. 78 data enty, but shouldn't be used for displaying the data to the user.
79 */ 79 */
80class Addressee 80class Addressee
81{ 81{
82 friend QDataStream &operator<<( QDataStream &, const Addressee & ); 82 friend QDataStream &operator<<( QDataStream &, const Addressee & );
83 friend QDataStream &operator>>( QDataStream &, Addressee & ); 83 friend QDataStream &operator>>( QDataStream &, Addressee & );
84 84
85 public: 85 public:
86 typedef QValueList<Addressee> List; 86 typedef QValueList<Addressee> List;
87 87
88 /** 88 /**
89 Construct an empty address book entry. 89 Construct an empty address book entry.
90 */ 90 */
91 Addressee(); 91 Addressee();
92 ~Addressee(); 92 ~Addressee();
93 93
94 Addressee( const Addressee & ); 94 Addressee( const Addressee & );
95 Addressee &operator=( const Addressee & ); 95 Addressee &operator=( const Addressee & );
96 96
97 bool operator==( const Addressee & ) const; 97 bool operator==( const Addressee & ) const;
98 bool operator!=( const Addressee & ) const; 98 bool operator!=( const Addressee & ) const;
99 // sync stuff 99 // sync stuff
100 void setTempSyncStat(int id); 100 void setTempSyncStat(int id);
101 int tempSyncStat() const; 101 int tempSyncStat() const;
102 void setIDStr( const QString & ); 102 void setIDStr( const QString & );
103 QString IDStr() const; 103 QString IDStr() const;
104 void setID( const QString &, const QString & ); 104 void setID( const QString &, const QString & );
105 QString getID( const QString & ); 105 QString getID( const QString & );
106 void setCsum( const QString &, const QString & ); 106 void setCsum( const QString &, const QString & );
107 QString getCsum( const QString & ); 107 QString getCsum( const QString & );
108 void removeID(const QString &); 108 void removeID(const QString &);
109 void computeCsum(const QString &dev); 109 void computeCsum(const QString &dev);
110 ulong getCsum4List( const QStringList & attList); 110 ulong getCsum4List( const QStringList & attList);
111 /** 111 /**
112 Return, if the address book entry is empty. 112 Return, if the address book entry is empty.
113 */ 113 */
114 bool isEmpty() const; 114 bool isEmpty() const;
115 void setExternalUID( const QString &id ); 115 void setExternalUID( const QString &id );
116 QString externalUID() const; 116 QString externalUID() const;
117 void setOriginalExternalUID( const QString &id ); 117 void setOriginalExternalUID( const QString &id );
118 QString originalExternalUID() const; 118 QString originalExternalUID() const;
119 void mergeContact( const Addressee& ad ); 119 void mergeContact( const Addressee& ad );
120 void simplifyEmails(); 120 void simplifyEmails();
121 void simplifyAddresses(); 121 void simplifyAddresses();
122 void simplifyPhoneNumbers(); 122 void simplifyPhoneNumbers();
123 void simplifyPhoneNumberTypes(); 123 void simplifyPhoneNumberTypes();
124 bool removeVoice(); 124 bool removeVoice();
125 bool containsAdr(const Addressee& addr );
125 126
126 /** 127 /**
127 Set unique identifier. 128 Set unique identifier.
128 */ 129 */
129 void setUid( const QString &uid ); 130 void setUid( const QString &uid );
130 /** 131 /**
131 Return unique identifier. 132 Return unique identifier.
132 */ 133 */
133 QString uid() const; 134 QString uid() const;
134 /** 135 /**
135 Return translated label for uid field. 136 Return translated label for uid field.
136 */ 137 */
137 static QString uidLabel(); 138 static QString uidLabel();
138 139
139 /** 140 /**
140 Set name. 141 Set name.
141 */ 142 */
142 void setName( const QString &name ); 143 void setName( const QString &name );
143 /** 144 /**
144 Return name. 145 Return name.
145 */ 146 */
146 QString name() const; 147 QString name() const;
147 /** 148 /**
148 Return translated label for name field. 149 Return translated label for name field.
149 */ 150 */
150 static QString nameLabel(); 151 static QString nameLabel();
151 152
152 /** 153 /**
153 Set formatted name. 154 Set formatted name.
154 */ 155 */
155 void setFormattedName( const QString &formattedName ); 156 void setFormattedName( const QString &formattedName );
156 /** 157 /**
157 Return formatted name. 158 Return formatted name.
158 */ 159 */
159 QString formattedName() const; 160 QString formattedName() const;
160 /** 161 /**
161 Return translated label for formattedName field. 162 Return translated label for formattedName field.
162 */ 163 */
163 static QString formattedNameLabel(); 164 static QString formattedNameLabel();
164 165
165 /** 166 /**
166 Set family name. 167 Set family name.
167 */ 168 */
168 void setFamilyName( const QString &familyName ); 169 void setFamilyName( const QString &familyName );
169 /** 170 /**
170 Return family name. 171 Return family name.
171 */ 172 */
172 QString familyName() const; 173 QString familyName() const;
173 /** 174 /**
174 Return translated label for familyName field. 175 Return translated label for familyName field.
175 */ 176 */
176 static QString familyNameLabel(); 177 static QString familyNameLabel();
177 178
178 /** 179 /**
179 Set given name. 180 Set given name.
180 */ 181 */
181 void setGivenName( const QString &givenName ); 182 void setGivenName( const QString &givenName );
182 /** 183 /**
183 Return given name. 184 Return given name.
184 */ 185 */
185 QString givenName() const; 186 QString givenName() const;
186 /** 187 /**
187 Return translated label for givenName field. 188 Return translated label for givenName field.
188 */ 189 */
189 static QString givenNameLabel(); 190 static QString givenNameLabel();
190 191
191 /** 192 /**
192 Set additional names. 193 Set additional names.
193 */ 194 */
194 void setAdditionalName( const QString &additionalName ); 195 void setAdditionalName( const QString &additionalName );
195 /** 196 /**
196 Return additional names. 197 Return additional names.
197 */ 198 */
198 QString additionalName() const; 199 QString additionalName() const;
199 /** 200 /**
200 Return translated label for additionalName field. 201 Return translated label for additionalName field.
201 */ 202 */
202 static QString additionalNameLabel(); 203 static QString additionalNameLabel();
203 204
204 /** 205 /**
205 Set honorific prefixes. 206 Set honorific prefixes.
206 */ 207 */
207 void setPrefix( const QString &prefix ); 208 void setPrefix( const QString &prefix );
208 /** 209 /**
209 Return honorific prefixes. 210 Return honorific prefixes.
210 */ 211 */
211 QString prefix() const; 212 QString prefix() const;
212 /** 213 /**
213 Return translated label for prefix field. 214 Return translated label for prefix field.
214 */ 215 */
215 static QString prefixLabel(); 216 static QString prefixLabel();
216 217
217 /** 218 /**
218 Set honorific suffixes. 219 Set honorific suffixes.
219 */ 220 */
220 void setSuffix( const QString &suffix ); 221 void setSuffix( const QString &suffix );
221 /** 222 /**
222 Return honorific suffixes. 223 Return honorific suffixes.
223 */ 224 */
224 QString suffix() const; 225 QString suffix() const;
225 /** 226 /**
226 Return translated label for suffix field. 227 Return translated label for suffix field.
227 */ 228 */
228 static QString suffixLabel(); 229 static QString suffixLabel();
229 230
230 /** 231 /**
231 Set nick name. 232 Set nick name.
232 */ 233 */
233 void setNickName( const QString &nickName ); 234 void setNickName( const QString &nickName );
234 /** 235 /**
235 Return nick name. 236 Return nick name.
236 */ 237 */
237 QString nickName() const; 238 QString nickName() const;
238 /** 239 /**
239 Return translated label for nickName field. 240 Return translated label for nickName field.
240 */ 241 */
241 static QString nickNameLabel(); 242 static QString nickNameLabel();
242 243
243 /** 244 /**
244 Set birthday. 245 Set birthday.
245 */ 246 */
246 void setBirthday( const QDateTime &birthday ); 247 void setBirthday( const QDateTime &birthday );
247 /** 248 /**
248 Return birthday. 249 Return birthday.
249 */ 250 */
250 QDateTime birthday() const; 251 QDateTime birthday() const;
251 /** 252 /**
252 Return translated label for birthday field. 253 Return translated label for birthday field.
253 */ 254 */
254 static QString birthdayLabel(); 255 static QString birthdayLabel();
255 256
256 /** 257 /**
257 Return translated label for homeAddressStreet field. 258 Return translated label for homeAddressStreet field.
258 */ 259 */
259 static QString homeAddressStreetLabel(); 260 static QString homeAddressStreetLabel();
260 261
261 /** 262 /**
262 Return translated label for homeAddressLocality field. 263 Return translated label for homeAddressLocality field.
263 */ 264 */
264 static QString homeAddressLocalityLabel(); 265 static QString homeAddressLocalityLabel();
265 266
266 /** 267 /**
267 Return translated label for homeAddressRegion field. 268 Return translated label for homeAddressRegion field.
268 */ 269 */
269 static QString homeAddressRegionLabel(); 270 static QString homeAddressRegionLabel();
270 271
271 /** 272 /**
272 Return translated label for homeAddressPostalCode field. 273 Return translated label for homeAddressPostalCode field.
273 */ 274 */
274 static QString homeAddressPostalCodeLabel(); 275 static QString homeAddressPostalCodeLabel();
275 276
276 /** 277 /**
277 Return translated label for homeAddressCountry field. 278 Return translated label for homeAddressCountry field.
278 */ 279 */
279 static QString homeAddressCountryLabel(); 280 static QString homeAddressCountryLabel();
280 281
281 /** 282 /**
282 Return translated label for homeAddressLabel field. 283 Return translated label for homeAddressLabel field.
283 */ 284 */
284 static QString homeAddressLabelLabel(); 285 static QString homeAddressLabelLabel();
285 286
286 /** 287 /**
287 Return translated label for businessAddressStreet field. 288 Return translated label for businessAddressStreet field.
288 */ 289 */
289 static QString businessAddressStreetLabel(); 290 static QString businessAddressStreetLabel();
290 291
291 /** 292 /**
292 Return translated label for businessAddressLocality field. 293 Return translated label for businessAddressLocality field.
293 */ 294 */
294 static QString businessAddressLocalityLabel(); 295 static QString businessAddressLocalityLabel();
295 296
296 /** 297 /**
297 Return translated label for businessAddressRegion field. 298 Return translated label for businessAddressRegion field.
298 */ 299 */
299 static QString businessAddressRegionLabel(); 300 static QString businessAddressRegionLabel();
300 301
301 /** 302 /**
302 Return translated label for businessAddressPostalCode field. 303 Return translated label for businessAddressPostalCode field.
303 */ 304 */
304 static QString businessAddressPostalCodeLabel(); 305 static QString businessAddressPostalCodeLabel();
305 306
306 /** 307 /**
307 Return translated label for businessAddressCountry field. 308 Return translated label for businessAddressCountry field.
308 */ 309 */
309 static QString businessAddressCountryLabel(); 310 static QString businessAddressCountryLabel();
310 311
311 /** 312 /**
312 Return translated label for businessAddressLabel field. 313 Return translated label for businessAddressLabel field.
313 */ 314 */
314 static QString businessAddressLabelLabel(); 315 static QString businessAddressLabelLabel();
315 316
316 /** 317 /**
317 Return translated label for homePhone field. 318 Return translated label for homePhone field.
318 */ 319 */
319 static QString homePhoneLabel(); 320 static QString homePhoneLabel();
320 321
321 /** 322 /**
322 Return translated label for businessPhone field. 323 Return translated label for businessPhone field.
323 */ 324 */
324 static QString businessPhoneLabel(); 325 static QString businessPhoneLabel();
325 326
326 /** 327 /**
327 Return translated label for mobilePhone field. 328 Return translated label for mobilePhone field.
328 */ 329 */
329 static QString mobilePhoneLabel(); 330 static QString mobilePhoneLabel();
330 331
331 /** 332 /**
332 Return translated label for homeFax field. 333 Return translated label for homeFax field.
333 */ 334 */
334 static QString homeFaxLabel(); 335 static QString homeFaxLabel();
335 336
336 /** 337 /**
337 Return translated label for businessFax field. 338 Return translated label for businessFax field.
338 */ 339 */
339 static QString businessFaxLabel(); 340 static QString businessFaxLabel();
340 341
341 /** 342 /**
342 Return translated label for carPhone field. 343 Return translated label for carPhone field.
343 */ 344 */
344 static QString carPhoneLabel(); 345 static QString carPhoneLabel();
345 346
346 /** 347 /**
347 Return translated label for isdn field. 348 Return translated label for isdn field.
348 */ 349 */
349 static QString isdnLabel(); 350 static QString isdnLabel();
350 351
351 /** 352 /**
352 Return translated label for pager field. 353 Return translated label for pager field.
353 */ 354 */
354 static QString pagerLabel(); 355 static QString pagerLabel();
355 356
356 /** 357 /**
357 Return translated label for sip field. 358 Return translated label for sip field.
358 */ 359 */
359 static QString sipLabel(); 360 static QString sipLabel();
360 361
361 /** 362 /**
362 Return translated label for email field. 363 Return translated label for email field.
363 */ 364 */
364 static QString emailLabel(); 365 static QString emailLabel();
365 366
366 /** 367 /**
367 Set mail client. 368 Set mail client.
368 */ 369 */
369 void setMailer( const QString &mailer ); 370 void setMailer( const QString &mailer );
370 /** 371 /**
371 Return mail client. 372 Return mail client.
372 */ 373 */
373 QString mailer() const; 374 QString mailer() const;
374 /** 375 /**
375 Return translated label for mailer field. 376 Return translated label for mailer field.
376 */ 377 */
377 static QString mailerLabel(); 378 static QString mailerLabel();
378 379
379 /** 380 /**
380 Set time zone. 381 Set time zone.
381 */ 382 */
382 void setTimeZone( const TimeZone &timeZone ); 383 void setTimeZone( const TimeZone &timeZone );
383 /** 384 /**
384 Return time zone. 385 Return time zone.
385 */ 386 */
386 TimeZone timeZone() const; 387 TimeZone timeZone() const;
387 /** 388 /**
388 Return translated label for timeZone field. 389 Return translated label for timeZone field.
389 */ 390 */
390 static QString timeZoneLabel(); 391 static QString timeZoneLabel();
391 392
392 /** 393 /**
393 Set geographic position. 394 Set geographic position.
394 */ 395 */
395 void setGeo( const Geo &geo ); 396 void setGeo( const Geo &geo );
396 /** 397 /**
397 Return geographic position. 398 Return geographic position.
398 */ 399 */
399 Geo geo() const; 400 Geo geo() const;
400 /** 401 /**
401 Return translated label for geo field. 402 Return translated label for geo field.
402 */ 403 */
403 static QString geoLabel(); 404 static QString geoLabel();
404 405
405 /** 406 /**
406 Set title. 407 Set title.
407 */ 408 */
408 void setTitle( const QString &title ); 409 void setTitle( const QString &title );
409 /** 410 /**
410 Return title. 411 Return title.
411 */ 412 */
412 QString title() const; 413 QString title() const;
413 /** 414 /**
414 Return translated label for title field. 415 Return translated label for title field.
415 */ 416 */
416 static QString titleLabel(); 417 static QString titleLabel();
417 418
418 /** 419 /**
419 Set role. 420 Set role.
420 */ 421 */
421 void setRole( const QString &role ); 422 void setRole( const QString &role );
422 /** 423 /**
423 Return role. 424 Return role.
424 */ 425 */
425 QString role() const; 426 QString role() const;
426 /** 427 /**
427 Return translated label for role field. 428 Return translated label for role field.
428 */ 429 */
429 static QString roleLabel(); 430 static QString roleLabel();
430 431
431 /** 432 /**
432 Set organization. 433 Set organization.
433 */ 434 */
434 void setOrganization( const QString &organization ); 435 void setOrganization( const QString &organization );
435 /** 436 /**
436 Return organization. 437 Return organization.
437 */ 438 */
438 QString organization() const; 439 QString organization() const;
439 /** 440 /**
440 Return translated label for organization field. 441 Return translated label for organization field.
441 */ 442 */
442 static QString organizationLabel(); 443 static QString organizationLabel();
443 444
444 /** 445 /**
445 Set note. 446 Set note.
446 */ 447 */
447 void setNote( const QString &note ); 448 void setNote( const QString &note );
448 /** 449 /**
449 Return note. 450 Return note.
450 */ 451 */
451 QString note() const; 452 QString note() const;
452 /** 453 /**
453 Return translated label for note field. 454 Return translated label for note field.
454 */ 455 */
455 static QString noteLabel(); 456 static QString noteLabel();
456 457
457 /** 458 /**
458 Set product identifier. 459 Set product identifier.
459 */ 460 */
460 void setProductId( const QString &productId ); 461 void setProductId( const QString &productId );
461 /** 462 /**
462 Return product identifier. 463 Return product identifier.
463 */ 464 */
464 QString productId() const; 465 QString productId() const;
465 /** 466 /**
466 Return translated label for productId field. 467 Return translated label for productId field.
467 */ 468 */
468 static QString productIdLabel(); 469 static QString productIdLabel();
469 470
470 /** 471 /**
471 Set revision date. 472 Set revision date.
472 */ 473 */
473 void setRevision( const QDateTime &revision ); 474 void setRevision( const QDateTime &revision );
474 /** 475 /**
475 Return revision date. 476 Return revision date.
476 */ 477 */
477 QDateTime revision() const; 478 QDateTime revision() const;
478 /** 479 /**
479 Return translated label for revision field. 480 Return translated label for revision field.
480 */ 481 */
481 static QString revisionLabel(); 482 static QString revisionLabel();
482 483
483 /** 484 /**
484 Set sort string. 485 Set sort string.
485 */ 486 */
486 void setSortString( const QString &sortString ); 487 void setSortString( const QString &sortString );
487 /** 488 /**
488 Return sort string. 489 Return sort string.
489 */ 490 */
490 QString sortString() const; 491 QString sortString() const;
491 /** 492 /**
492 Return translated label for sortString field. 493 Return translated label for sortString field.
493 */ 494 */
494 static QString sortStringLabel(); 495 static QString sortStringLabel();
495 496
496 /** 497 /**
497 Set URL. 498 Set URL.
498 */ 499 */
499 void setUrl( const KURL &url ); 500 void setUrl( const KURL &url );
500 /** 501 /**
501 Return URL. 502 Return URL.
502 */ 503 */
503 KURL url() const; 504 KURL url() const;
504 /** 505 /**
505 Return translated label for url field. 506 Return translated label for url field.
506 */ 507 */
507 static QString urlLabel(); 508 static QString urlLabel();
508 509
509 /** 510 /**
510 Set security class. 511 Set security class.
511 */ 512 */
512 void setSecrecy( const Secrecy &secrecy ); 513 void setSecrecy( const Secrecy &secrecy );
513 /** 514 /**
514 Return security class. 515 Return security class.
515 */ 516 */
516 Secrecy secrecy() const; 517 Secrecy secrecy() const;
517 /** 518 /**
518 Return translated label for secrecy field. 519 Return translated label for secrecy field.
519 */ 520 */
520 static QString secrecyLabel(); 521 static QString secrecyLabel();
521 522
522 /** 523 /**
523 Set logo. 524 Set logo.
524 */ 525 */
525 void setLogo( const Picture &logo ); 526 void setLogo( const Picture &logo );
526 /** 527 /**
527 Return logo. 528 Return logo.
528 */ 529 */
529 Picture logo() const; 530 Picture logo() const;
530 /** 531 /**
531 Return translated label for logo field. 532 Return translated label for logo field.
532 */ 533 */
533 static QString logoLabel(); 534 static QString logoLabel();
534 535
535 /** 536 /**
536 Set photo. 537 Set photo.
537 */ 538 */
538 void setPhoto( const Picture &photo ); 539 void setPhoto( const Picture &photo );
539 /** 540 /**
540 Return photo. 541 Return photo.
541 */ 542 */
542 Picture photo() const; 543 Picture photo() const;
543 /** 544 /**
544 Return translated label for photo field. 545 Return translated label for photo field.
545 */ 546 */
546 static QString photoLabel(); 547 static QString photoLabel();
547 548
548 /** 549 /**
549 Set sound. 550 Set sound.
550 */ 551 */
551 void setSound( const Sound &sound ); 552 void setSound( const Sound &sound );
552 /** 553 /**
553 Return sound. 554 Return sound.
554 */ 555 */
555 Sound sound() const; 556 Sound sound() const;
556 /** 557 /**
557 Return translated label for sound field. 558 Return translated label for sound field.
558 */ 559 */
559 static QString soundLabel(); 560 static QString soundLabel();
560 561
561 /** 562 /**
562 Set agent. 563 Set agent.
563 */ 564 */
564 void setAgent( const Agent &agent ); 565 void setAgent( const Agent &agent );
565 /** 566 /**
566 Return agent. 567 Return agent.
567 */ 568 */
568 Agent agent() const; 569 Agent agent() const;
569 /** 570 /**
570 Return translated label for agent field. 571 Return translated label for agent field.
571 */ 572 */
572 static QString agentLabel(); 573 static QString agentLabel();
573 574
574 /** 575 /**
575 Set name fields by parsing the given string and trying to associate the 576 Set name fields by parsing the given string and trying to associate the
576 parts of the string with according fields. This function should probably 577 parts of the string with according fields. This function should probably
577 be a bit more clever. 578 be a bit more clever.
578 */ 579 */
579 void setNameFromString( const QString & ); 580 void setNameFromString( const QString & );
580 581
581 /** 582 /**
582 Return the name of the addressee. This is calculated from all the name 583 Return the name of the addressee. This is calculated from all the name
583 fields. 584 fields.
584 */ 585 */
585 QString realName() const; 586 QString realName() const;
586 587
587 /** 588 /**
588 Return the name that consists of all name parts. 589 Return the name that consists of all name parts.
589 */ 590 */
590 QString assembledName() const; 591 QString assembledName() const;
591 592
592 /** 593 /**
593 Return email address including real name. 594 Return email address including real name.
594 595
595 @param email Email address to be used to construct the full email string. 596 @param email Email address to be used to construct the full email string.
596 If this is QString::null the preferred email address is used. 597 If this is QString::null the preferred email address is used.
597 */ 598 */
598 QString fullEmail( const QString &email=QString::null ) const; 599 QString fullEmail( const QString &email=QString::null ) const;
599 600
600 /** 601 /**
601 Insert an email address. If the email address already exists in this 602 Insert an email address. If the email address already exists in this
602 addressee it is not duplicated. 603 addressee it is not duplicated.
603 604
604 @param email Email address 605 @param email Email address
605 @param preferred Set to true, if this is the preferred email address of 606 @param preferred Set to true, if this is the preferred email address of
606 the addressee. 607 the addressee.
607 */ 608 */
608 void insertEmail( const QString &email, bool preferred=false ); 609 void insertEmail( const QString &email, bool preferred=false );
609 610
610 /** 611 /**
611 Remove email address. If the email address doesn't exist, nothing happens. 612 Remove email address. If the email address doesn't exist, nothing happens.
612 */ 613 */
613 void removeEmail( const QString &email ); 614 void removeEmail( const QString &email );
614 615
615 /** 616 /**
616 Return preferred email address. This is the first email address or the 617 Return preferred email address. This is the first email address or the
617 last one added with @ref insertEmail() with a set preferred parameter. 618 last one added with @ref insertEmail() with a set preferred parameter.
618 */ 619 */
619 QString preferredEmail() const; 620 QString preferredEmail() const;
620 621
621 /** 622 /**
622 Return list of all email addresses. 623 Return list of all email addresses.
623 */ 624 */
624 QStringList emails() const; 625 QStringList emails() const;
625 626
626 /** 627 /**
627 Set the emails to @param. 628 Set the emails to @param.
628 The first email address gets the preferred one! 629 The first email address gets the preferred one!
629 @param list The list of email addresses. 630 @param list The list of email addresses.
630 */ 631 */
631 void setEmails( const QStringList& list); 632 void setEmails( const QStringList& list);
632 633
633 /** 634 /**
634 Insert a phone number. If a phone number with the same id already exists 635 Insert a phone number. If a phone number with the same id already exists
635 in this addressee it is not duplicated. 636 in this addressee it is not duplicated.
636 */ 637 */
637 void insertPhoneNumber( const PhoneNumber &phoneNumber ); 638 void insertPhoneNumber( const PhoneNumber &phoneNumber );
638 639
639 /** 640 /**
640 Remove phone number. If no phone number with the given id exists for this 641 Remove phone number. If no phone number with the given id exists for this
641 addresse nothing happens. 642 addresse nothing happens.
642 */ 643 */
643 void removePhoneNumber( const PhoneNumber &phoneNumber ); 644 void removePhoneNumber( const PhoneNumber &phoneNumber );
644 645
645 /** 646 /**
646 Return phone number, which matches the given type. 647 Return phone number, which matches the given type.
647 */ 648 */
648 PhoneNumber phoneNumber( int type ) const; 649 PhoneNumber phoneNumber( int type ) const;
649 650
650 /** 651 /**
651 Return list of all phone numbers. 652 Return list of all phone numbers.
652 */ 653 */
653 PhoneNumber::List phoneNumbers() const; 654 PhoneNumber::List phoneNumbers() const;
654 655
655 /** 656 /**
656 Return list of phone numbers with a special type. 657 Return list of phone numbers with a special type.
657 */ 658 */
658 PhoneNumber::List phoneNumbers( int type ) const; 659 PhoneNumber::List phoneNumbers( int type ) const;
659 660
660 /** 661 /**
661 Return phone number with the given id. 662 Return phone number with the given id.
662 */ 663 */
663 PhoneNumber findPhoneNumber( const QString &id ) const; 664 PhoneNumber findPhoneNumber( const QString &id ) const;
664 665
665 /** 666 /**
666 Insert a key. If a key with the same id already exists 667 Insert a key. If a key with the same id already exists
667 in this addressee it is not duplicated. 668 in this addressee it is not duplicated.
668 */ 669 */
669 void insertKey( const Key &key ); 670 void insertKey( const Key &key );
670 671
671 /** 672 /**
672 Remove a key. If no key with the given id exists for this 673 Remove a key. If no key with the given id exists for this
673 addresse nothing happens. 674 addresse nothing happens.
674 */ 675 */
675 void removeKey( const Key &key ); 676 void removeKey( const Key &key );
676 677
677 /** 678 /**
678 Return key, which matches the given type. 679 Return key, which matches the given type.
679 If @p type == Key::Custom you can specify a string 680 If @p type == Key::Custom you can specify a string
680 that should match. If you leave the string empty, the first 681 that should match. If you leave the string empty, the first
681 key with a custom value is returned. 682 key with a custom value is returned.
682 */ 683 */
683 Key key( int type, QString customTypeString = QString::null ) const; 684 Key key( int type, QString customTypeString = QString::null ) const;
684 685
685 /** 686 /**
686 Return list of all keys. 687 Return list of all keys.
687 */ 688 */
688 Key::List keys() const; 689 Key::List keys() const;
689 690
690 /** 691 /**
691 Set the list of keys 692 Set the list of keys
692 @param keys The keys to be set. 693 @param keys The keys to be set.
693 */ 694 */
694 void setKeys( const Key::List& keys); 695 void setKeys( const Key::List& keys);
695 696
696 /** 697 /**
697 Return list of keys with a special type. 698 Return list of keys with a special type.
698 If @p type == Key::Custom you can specify a string 699 If @p type == Key::Custom you can specify a string
699 that should match. If you leave the string empty, all custom 700 that should match. If you leave the string empty, all custom
700 keys will be returned. 701 keys will be returned.
701 */ 702 */
702 Key::List keys( int type, QString customTypeString = QString::null ) const; 703 Key::List keys( int type, QString customTypeString = QString::null ) const;
703 704
704 /** 705 /**
705 Return key with the given id. 706 Return key with the given id.
706 */ 707 */
707 Key findKey( const QString &id ) const; 708 Key findKey( const QString &id ) const;
708 709
709 /** 710 /**
710 Insert an address. If an address with the same id already exists 711 Insert an address. If an address with the same id already exists
711 in this addressee it is not duplicated. 712 in this addressee it is not duplicated.
712 */ 713 */
713 void insertAddress( const Address &address ); 714 void insertAddress( const Address &address );
714 715
715 /** 716 /**
716 Remove address. If no address with the given id exists for this 717 Remove address. If no address with the given id exists for this
717 addresse nothing happens. 718 addresse nothing happens.
718 */ 719 */
719 void removeAddress( const Address &address ); 720 void removeAddress( const Address &address );
720 721
721 /** 722 /**
722 Return address, which matches the given type. 723 Return address, which matches the given type.
723 */ 724 */
724 Address address( int type ) const; 725 Address address( int type ) const;
725 726
726 /** 727 /**
727 Return list of all addresses. 728 Return list of all addresses.
728 */ 729 */
729 Address::List addresses() const; 730 Address::List addresses() const;
730 731
731 /** 732 /**
732 Return list of addresses with a special type. 733 Return list of addresses with a special type.
733 */ 734 */
734 Address::List addresses( int type ) const; 735 Address::List addresses( int type ) const;
735 736
736 /** 737 /**
737 Return address with the given id. 738 Return address with the given id.
738 */ 739 */
739 Address findAddress( const QString &id ) const; 740 Address findAddress( const QString &id ) const;
740 741
741 /** 742 /**
742 Insert category. If the category already exists it is not duplicated. 743 Insert category. If the category already exists it is not duplicated.
743 */ 744 */
744 void insertCategory( const QString & ); 745 void insertCategory( const QString & );
745 746
746 /** 747 /**
747 Remove category. 748 Remove category.
748 */ 749 */
749 void removeCategory( const QString & ); 750 void removeCategory( const QString & );
750 751
751 /** 752 /**
752 Return, if addressee has the given category. 753 Return, if addressee has the given category.
753 */ 754 */
754 bool hasCategory( const QString & ) const; 755 bool hasCategory( const QString & ) const;
755 756
756 /** 757 /**
757 Set categories to given value. 758 Set categories to given value.
758 */ 759 */
759 void setCategories( const QStringList & ); 760 void setCategories( const QStringList & );
760 761
761 /** 762 /**
762 Return list of all set categories. 763 Return list of all set categories.
763 */ 764 */
764 QStringList categories() const; 765 QStringList categories() const;
765 766
766 /** 767 /**
767 Insert custom entry. The entry is identified by the name of the inserting 768 Insert custom entry. The entry is identified by the name of the inserting
768 application and a unique name. If an entry with the given app and name 769 application and a unique name. If an entry with the given app and name
769 already exists its value is replaced with the new given value. 770 already exists its value is replaced with the new given value.
770 */ 771 */
771 void insertCustom( const QString &app, const QString &name, 772 void insertCustom( const QString &app, const QString &name,
772 const QString &value ); 773 const QString &value );
773 774
774 /** 775 /**
775 Remove custom entry. 776 Remove custom entry.
776 */ 777 */
777 void removeCustom( const QString &app, const QString &name ); 778 void removeCustom( const QString &app, const QString &name );
778 779
779 /** 780 /**
780 Return value of custom entry, identified by app and entry name. 781 Return value of custom entry, identified by app and entry name.
781 */ 782 */
782 QString custom( const QString &app, const QString &name ) const; 783 QString custom( const QString &app, const QString &name ) const;
783 784
784 /** 785 /**
785 Set all custom entries. 786 Set all custom entries.
786 */ 787 */
787 void setCustoms( const QStringList & ); 788 void setCustoms( const QStringList & );
788 789
789 /** 790 /**
790 Return list of all custom entries. 791 Return list of all custom entries.
791 */ 792 */
792 QStringList customs() const; 793 QStringList customs() const;
793 794
794 /** 795 /**
795 Parse full email address. The result is given back in fullName and email. 796 Parse full email address. The result is given back in fullName and email.
796 */ 797 */
797 static void parseEmailAddress( const QString &rawEmail, QString &fullName, 798 static void parseEmailAddress( const QString &rawEmail, QString &fullName,
798 QString &email ); 799 QString &email );
799 800
800 /** 801 /**
801 Debug output. 802 Debug output.
802 */ 803 */
803 void dump() const; 804 void dump() const;
804 805
805 /** 806 /**
806 Returns string representation of the addressee. 807 Returns string representation of the addressee.
807 */ 808 */
808 QString asString() const; 809 QString asString() const;
809 810
810 /** 811 /**
811 Set resource where the addressee is from. 812 Set resource where the addressee is from.
812 */ 813 */
813 void setResource( Resource *resource ); 814 void setResource( Resource *resource );
814 815
815 /** 816 /**
816 Return pointer to resource. 817 Return pointer to resource.
817 */ 818 */
818 Resource *resource() const; 819 Resource *resource() const;
819 820
820 /** 821 /**
821 Return resourcelabel. 822 Return resourcelabel.
822 */ 823 */
823 //US 824 //US
824 static QString resourceLabel(); 825 static QString resourceLabel();
825 826
826 /** 827 /**
827 Mark addressee as changed. 828 Mark addressee as changed.
828 */ 829 */
829 void setChanged( bool value ); 830 void setChanged( bool value );
830 831
831 /** 832 /**
832 Return whether the addressee is changed. 833 Return whether the addressee is changed.
833 */ 834 */
834 bool changed() const; 835 bool changed() const;
835 836
836 void setTagged( bool value ); 837 void setTagged( bool value );
837 bool tagged() const; 838 bool tagged() const;
838 839
839 private: 840 private:
840 Addressee copy(); 841 Addressee copy();
841 void detach(); 842 void detach();
842 843
843 struct AddresseeData; 844 struct AddresseeData;
844 mutable KSharedPtr<AddresseeData> mData; 845 mutable KSharedPtr<AddresseeData> mData;
845}; 846};
846 847
847QDataStream &operator<<( QDataStream &, const Addressee & ); 848QDataStream &operator<<( QDataStream &, const Addressee & );
848QDataStream &operator>>( QDataStream &, Addressee & ); 849QDataStream &operator>>( QDataStream &, Addressee & );
849 850
850} 851}
851 852
852#endif 853#endif