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 44f0629..9336edc 100644
--- a/kabc/addressee.h
+++ b/kabc/addressee.h
@@ -1,507 +1,508 @@
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 125
125 /** 126 /**
126 Set unique identifier. 127 Set unique identifier.
127 */ 128 */
128 void setUid( const QString &uid ); 129 void setUid( const QString &uid );
129 /** 130 /**
130 Return unique identifier. 131 Return unique identifier.
131 */ 132 */
132 QString uid() const; 133 QString uid() const;
133 /** 134 /**
134 Return translated label for uid field. 135 Return translated label for uid field.
135 */ 136 */
136 static QString uidLabel(); 137 static QString uidLabel();
137 138
138 /** 139 /**
139 Set name. 140 Set name.
140 */ 141 */
141 void setName( const QString &name ); 142 void setName( const QString &name );
142 /** 143 /**
143 Return name. 144 Return name.
144 */ 145 */
145 QString name() const; 146 QString name() const;
146 /** 147 /**
147 Return translated label for name field. 148 Return translated label for name field.
148 */ 149 */
149 static QString nameLabel(); 150 static QString nameLabel();
150 151
151 /** 152 /**
152 Set formatted name. 153 Set formatted name.
153 */ 154 */
154 void setFormattedName( const QString &formattedName ); 155 void setFormattedName( const QString &formattedName );
155 /** 156 /**
156 Return formatted name. 157 Return formatted name.
157 */ 158 */
158 QString formattedName() const; 159 QString formattedName() const;
159 /** 160 /**
160 Return translated label for formattedName field. 161 Return translated label for formattedName field.
161 */ 162 */
162 static QString formattedNameLabel(); 163 static QString formattedNameLabel();
163 164
164 /** 165 /**
165 Set family name. 166 Set family name.
166 */ 167 */
167 void setFamilyName( const QString &familyName ); 168 void setFamilyName( const QString &familyName );
168 /** 169 /**
169 Return family name. 170 Return family name.
170 */ 171 */
171 QString familyName() const; 172 QString familyName() const;
172 /** 173 /**
173 Return translated label for familyName field. 174 Return translated label for familyName field.
174 */ 175 */
175 static QString familyNameLabel(); 176 static QString familyNameLabel();
176 177
177 /** 178 /**
178 Set given name. 179 Set given name.
179 */ 180 */
180 void setGivenName( const QString &givenName ); 181 void setGivenName( const QString &givenName );
181 /** 182 /**
182 Return given name. 183 Return given name.
183 */ 184 */
184 QString givenName() const; 185 QString givenName() const;
185 /** 186 /**
186 Return translated label for givenName field. 187 Return translated label for givenName field.
187 */ 188 */
188 static QString givenNameLabel(); 189 static QString givenNameLabel();
189 190
190 /** 191 /**
191 Set additional names. 192 Set additional names.
192 */ 193 */
193 void setAdditionalName( const QString &additionalName ); 194 void setAdditionalName( const QString &additionalName );
194 /** 195 /**
195 Return additional names. 196 Return additional names.
196 */ 197 */
197 QString additionalName() const; 198 QString additionalName() const;
198 /** 199 /**
199 Return translated label for additionalName field. 200 Return translated label for additionalName field.
200 */ 201 */
201 static QString additionalNameLabel(); 202 static QString additionalNameLabel();
202 203
203 /** 204 /**
204 Set honorific prefixes. 205 Set honorific prefixes.
205 */ 206 */
206 void setPrefix( const QString &prefix ); 207 void setPrefix( const QString &prefix );
207 /** 208 /**
208 Return honorific prefixes. 209 Return honorific prefixes.
209 */ 210 */
210 QString prefix() const; 211 QString prefix() const;
211 /** 212 /**
212 Return translated label for prefix field. 213 Return translated label for prefix field.
213 */ 214 */
214 static QString prefixLabel(); 215 static QString prefixLabel();
215 216
216 /** 217 /**
217 Set honorific suffixes. 218 Set honorific suffixes.
218 */ 219 */
219 void setSuffix( const QString &suffix ); 220 void setSuffix( const QString &suffix );
220 /** 221 /**
221 Return honorific suffixes. 222 Return honorific suffixes.
222 */ 223 */
223 QString suffix() const; 224 QString suffix() const;
224 /** 225 /**
225 Return translated label for suffix field. 226 Return translated label for suffix field.
226 */ 227 */
227 static QString suffixLabel(); 228 static QString suffixLabel();
228 229
229 /** 230 /**
230 Set nick name. 231 Set nick name.
231 */ 232 */
232 void setNickName( const QString &nickName ); 233 void setNickName( const QString &nickName );
233 /** 234 /**
234 Return nick name. 235 Return nick name.
235 */ 236 */
236 QString nickName() const; 237 QString nickName() const;
237 /** 238 /**
238 Return translated label for nickName field. 239 Return translated label for nickName field.
239 */ 240 */
240 static QString nickNameLabel(); 241 static QString nickNameLabel();
241 242
242 /** 243 /**
243 Set birthday. 244 Set birthday.
244 */ 245 */
245 void setBirthday( const QDateTime &birthday ); 246 void setBirthday( const QDateTime &birthday );
246 /** 247 /**
247 Return birthday. 248 Return birthday.
248 */ 249 */
249 QDateTime birthday() const; 250 QDateTime birthday() const;
250 /** 251 /**
251 Return translated label for birthday field. 252 Return translated label for birthday field.
252 */ 253 */
253 static QString birthdayLabel(); 254 static QString birthdayLabel();
254 255
255 /** 256 /**
256 Return translated label for homeAddressStreet field. 257 Return translated label for homeAddressStreet field.
257 */ 258 */
258 static QString homeAddressStreetLabel(); 259 static QString homeAddressStreetLabel();
259 260
260 /** 261 /**
261 Return translated label for homeAddressLocality field. 262 Return translated label for homeAddressLocality field.
262 */ 263 */
263 static QString homeAddressLocalityLabel(); 264 static QString homeAddressLocalityLabel();
264 265
265 /** 266 /**
266 Return translated label for homeAddressRegion field. 267 Return translated label for homeAddressRegion field.
267 */ 268 */
268 static QString homeAddressRegionLabel(); 269 static QString homeAddressRegionLabel();
269 270
270 /** 271 /**
271 Return translated label for homeAddressPostalCode field. 272 Return translated label for homeAddressPostalCode field.
272 */ 273 */
273 static QString homeAddressPostalCodeLabel(); 274 static QString homeAddressPostalCodeLabel();
274 275
275 /** 276 /**
276 Return translated label for homeAddressCountry field. 277 Return translated label for homeAddressCountry field.
277 */ 278 */
278 static QString homeAddressCountryLabel(); 279 static QString homeAddressCountryLabel();
279 280
280 /** 281 /**
281 Return translated label for homeAddressLabel field. 282 Return translated label for homeAddressLabel field.
282 */ 283 */
283 static QString homeAddressLabelLabel(); 284 static QString homeAddressLabelLabel();
284 285
285 /** 286 /**
286 Return translated label for businessAddressStreet field. 287 Return translated label for businessAddressStreet field.
287 */ 288 */
288 static QString businessAddressStreetLabel(); 289 static QString businessAddressStreetLabel();
289 290
290 /** 291 /**
291 Return translated label for businessAddressLocality field. 292 Return translated label for businessAddressLocality field.
292 */ 293 */
293 static QString businessAddressLocalityLabel(); 294 static QString businessAddressLocalityLabel();
294 295
295 /** 296 /**
296 Return translated label for businessAddressRegion field. 297 Return translated label for businessAddressRegion field.
297 */ 298 */
298 static QString businessAddressRegionLabel(); 299 static QString businessAddressRegionLabel();
299 300
300 /** 301 /**
301 Return translated label for businessAddressPostalCode field. 302 Return translated label for businessAddressPostalCode field.
302 */ 303 */
303 static QString businessAddressPostalCodeLabel(); 304 static QString businessAddressPostalCodeLabel();
304 305
305 /** 306 /**
306 Return translated label for businessAddressCountry field. 307 Return translated label for businessAddressCountry field.
307 */ 308 */
308 static QString businessAddressCountryLabel(); 309 static QString businessAddressCountryLabel();
309 310
310 /** 311 /**
311 Return translated label for businessAddressLabel field. 312 Return translated label for businessAddressLabel field.
312 */ 313 */
313 static QString businessAddressLabelLabel(); 314 static QString businessAddressLabelLabel();
314 315
315 /** 316 /**
316 Return translated label for homePhone field. 317 Return translated label for homePhone field.
317 */ 318 */
318 static QString homePhoneLabel(); 319 static QString homePhoneLabel();
319 320
320 /** 321 /**
321 Return translated label for businessPhone field. 322 Return translated label for businessPhone field.
322 */ 323 */
323 static QString businessPhoneLabel(); 324 static QString businessPhoneLabel();
324 325
325 /** 326 /**
326 Return translated label for mobilePhone field. 327 Return translated label for mobilePhone field.
327 */ 328 */
328 static QString mobilePhoneLabel(); 329 static QString mobilePhoneLabel();
329 330
330 /** 331 /**
331 Return translated label for homeFax field. 332 Return translated label for homeFax field.
332 */ 333 */
333 static QString homeFaxLabel(); 334 static QString homeFaxLabel();
334 335
335 /** 336 /**
336 Return translated label for businessFax field. 337 Return translated label for businessFax field.
337 */ 338 */
338 static QString businessFaxLabel(); 339 static QString businessFaxLabel();
339 340
340 /** 341 /**
341 Return translated label for carPhone field. 342 Return translated label for carPhone field.
342 */ 343 */
343 static QString carPhoneLabel(); 344 static QString carPhoneLabel();
344 345
345 /** 346 /**
346 Return translated label for isdn field. 347 Return translated label for isdn field.
347 */ 348 */
348 static QString isdnLabel(); 349 static QString isdnLabel();
349 350
350 /** 351 /**
351 Return translated label for pager field. 352 Return translated label for pager field.
352 */ 353 */
353 static QString pagerLabel(); 354 static QString pagerLabel();
354 355
355 /** 356 /**
356 Return translated label for sip field. 357 Return translated label for sip field.
357 */ 358 */
358 static QString sipLabel(); 359 static QString sipLabel();
359 360
360 /** 361 /**
361 Return translated label for email field. 362 Return translated label for email field.
362 */ 363 */
363 static QString emailLabel(); 364 static QString emailLabel();
364 365
365 /** 366 /**
366 Set mail client. 367 Set mail client.
367 */ 368 */
368 void setMailer( const QString &mailer ); 369 void setMailer( const QString &mailer );
369 /** 370 /**
370 Return mail client. 371 Return mail client.
371 */ 372 */
372 QString mailer() const; 373 QString mailer() const;
373 /** 374 /**
374 Return translated label for mailer field. 375 Return translated label for mailer field.
375 */ 376 */
376 static QString mailerLabel(); 377 static QString mailerLabel();
377 378
378 /** 379 /**
379 Set time zone. 380 Set time zone.
380 */ 381 */
381 void setTimeZone( const TimeZone &timeZone ); 382 void setTimeZone( const TimeZone &timeZone );
382 /** 383 /**
383 Return time zone. 384 Return time zone.
384 */ 385 */
385 TimeZone timeZone() const; 386 TimeZone timeZone() const;
386 /** 387 /**
387 Return translated label for timeZone field. 388 Return translated label for timeZone field.
388 */ 389 */
389 static QString timeZoneLabel(); 390 static QString timeZoneLabel();
390 391
391 /** 392 /**
392 Set geographic position. 393 Set geographic position.
393 */ 394 */
394 void setGeo( const Geo &geo ); 395 void setGeo( const Geo &geo );
395 /** 396 /**
396 Return geographic position. 397 Return geographic position.
397 */ 398 */
398 Geo geo() const; 399 Geo geo() const;
399 /** 400 /**
400 Return translated label for geo field. 401 Return translated label for geo field.
401 */ 402 */
402 static QString geoLabel(); 403 static QString geoLabel();
403 404
404 /** 405 /**
405 Set title. 406 Set title.
406 */ 407 */
407 void setTitle( const QString &title ); 408 void setTitle( const QString &title );
408 /** 409 /**
409 Return title. 410 Return title.
410 */ 411 */
411 QString title() const; 412 QString title() const;
412 /** 413 /**
413 Return translated label for title field. 414 Return translated label for title field.
414 */ 415 */
415 static QString titleLabel(); 416 static QString titleLabel();
416 417
417 /** 418 /**
418 Set role. 419 Set role.
419 */ 420 */
420 void setRole( const QString &role ); 421 void setRole( const QString &role );
421 /** 422 /**
422 Return role. 423 Return role.
423 */ 424 */
424 QString role() const; 425 QString role() const;
425 /** 426 /**
426 Return translated label for role field. 427 Return translated label for role field.
427 */ 428 */
428 static QString roleLabel(); 429 static QString roleLabel();
429 430
430 /** 431 /**
431 Set organization. 432 Set organization.
432 */ 433 */
433 void setOrganization( const QString &organization ); 434 void setOrganization( const QString &organization );
434 /** 435 /**
435 Return organization. 436 Return organization.
436 */ 437 */
437 QString organization() const; 438 QString organization() const;
438 /** 439 /**
439 Return translated label for organization field. 440 Return translated label for organization field.
440 */ 441 */
441 static QString organizationLabel(); 442 static QString organizationLabel();
442 443
443 /** 444 /**
444 Set note. 445 Set note.
445 */ 446 */
446 void setNote( const QString &note ); 447 void setNote( const QString &note );
447 /** 448 /**
448 Return note. 449 Return note.
449 */ 450 */
450 QString note() const; 451 QString note() const;
451 /** 452 /**
452 Return translated label for note field. 453 Return translated label for note field.
453 */ 454 */
454 static QString noteLabel(); 455 static QString noteLabel();
455 456
456 /** 457 /**
457 Set product identifier. 458 Set product identifier.
458 */ 459 */
459 void setProductId( const QString &productId ); 460 void setProductId( const QString &productId );
460 /** 461 /**
461 Return product identifier. 462 Return product identifier.
462 */ 463 */
463 QString productId() const; 464 QString productId() const;
464 /** 465 /**
465 Return translated label for productId field. 466 Return translated label for productId field.
466 */ 467 */
467 static QString productIdLabel(); 468 static QString productIdLabel();
468 469
469 /** 470 /**
470 Set revision date. 471 Set revision date.
471 */ 472 */
472 void setRevision( const QDateTime &revision ); 473 void setRevision( const QDateTime &revision );
473 /** 474 /**
474 Return revision date. 475 Return revision date.
475 */ 476 */
476 QDateTime revision() const; 477 QDateTime revision() const;
477 /** 478 /**
478 Return translated label for revision field. 479 Return translated label for revision field.
479 */ 480 */
480 static QString revisionLabel(); 481 static QString revisionLabel();
481 482
482 /** 483 /**
483 Set sort string. 484 Set sort string.
484 */ 485 */
485 void setSortString( const QString &sortString ); 486 void setSortString( const QString &sortString );
486 /** 487 /**
487 Return sort string. 488 Return sort string.
488 */ 489 */
489 QString sortString() const; 490 QString sortString() const;
490 /** 491 /**
491 Return translated label for sortString field. 492 Return translated label for sortString field.
492 */ 493 */
493 static QString sortStringLabel(); 494 static QString sortStringLabel();
494 495
495 /** 496 /**
496 Set URL. 497 Set URL.
497 */ 498 */
498 void setUrl( const KURL &url ); 499 void setUrl( const KURL &url );
499 /** 500 /**
500 Return URL. 501 Return URL.
501 */ 502 */
502 KURL url() const; 503 KURL url() const;
503 /** 504 /**
504 Return translated label for url field. 505 Return translated label for url field.
505 */ 506 */
506 static QString urlLabel(); 507 static QString urlLabel();
507 508