summaryrefslogtreecommitdiffabout
path: root/kabc/addressee.h
Unidiff
Diffstat (limited to 'kabc/addressee.h') (more/less context) (ignore whitespace changes)
-rw-r--r--kabc/addressee.h3
1 files changed, 0 insertions, 3 deletions
diff --git a/kabc/addressee.h b/kabc/addressee.h
index 0d688f8..a2fbcf5 100644
--- a/kabc/addressee.h
+++ b/kabc/addressee.h
@@ -29,267 +29,264 @@ $Id$
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 const QString IDStr() const; 103 const QString IDStr() const;
104 void setID( const QString &, const QString & ); 104 void setID( const QString &, const QString & );
105 const QString getID( const QString & ) const; 105 const QString getID( const QString & ) const;
106 void setCsum( const QString &, const QString & ); 106 void setCsum( const QString &, const QString & );
107 const QString getCsum( const QString & ) const ; 107 const QString getCsum( const QString & ) const ;
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 const QString externalUID() const; 116 const 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, bool isSubSet ); 119 void mergeContact( const Addressee& ad, bool isSubSet );
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 bool containsAdr(const Addressee& addr );
126 126
127 /** 127 /**
128 Set unique identifier. 128 Set unique identifier.
129 */ 129 */
130 void setUid( const QString &uid ); 130 void setUid( const QString &uid );
131 /** 131 /**
132 Return unique identifier. 132 Return unique identifier.
133 */ 133 */
134 const QString uid() const; 134 const QString uid() const;
135 /** 135 /**
136 Return translated label for uid field. 136 Return translated label for uid field.
137 */ 137 */
138 static QString uidLabel(); 138 static QString uidLabel();
139 139
140 /** 140 /**
141 Set name. 141 Set name.
142 */ 142 */
143 void setName( const QString &name ); 143 void setName( const QString &name );
144 /** 144 /**
145 Return name. 145 Return name.
146 */ 146 */
147 QString name() const; 147 QString name() const;
148 /** 148 /**
149 Return translated label for name field. 149 Return translated label for name field.
150 */ 150 */
151 static QString nameLabel(); 151 static QString nameLabel();
152 152
153 /** 153 /**
154 Set formatted name. 154 Set formatted name.
155 */ 155 */
156 void setFormattedName( const QString &formattedName ); 156 void setFormattedName( const QString &formattedName );
157 void setDefaultFormattedName( const QString &formattedName );
158 /** 157 /**
159 Return formatted name. 158 Return formatted name.
160 */ 159 */
161 QString formattedName() const; 160 QString formattedName() const;
162 QString defaultFormattedName() const;
163 /** 161 /**
164 Return translated label for formattedName field. 162 Return translated label for formattedName field.
165 */ 163 */
166 static QString formattedNameLabel(); 164 static QString formattedNameLabel();
167 static QString defaultFormattedNameLabel();
168 165
169 /** 166 /**
170 Set family name. 167 Set family name.
171 */ 168 */
172 void setFamilyName( const QString &familyName ); 169 void setFamilyName( const QString &familyName );
173 /** 170 /**
174 Return family name. 171 Return family name.
175 */ 172 */
176 QString familyName() const; 173 QString familyName() const;
177 /** 174 /**
178 Return translated label for familyName field. 175 Return translated label for familyName field.
179 */ 176 */
180 static QString familyNameLabel(); 177 static QString familyNameLabel();
181 178
182 /** 179 /**
183 Set given name. 180 Set given name.
184 */ 181 */
185 void setGivenName( const QString &givenName ); 182 void setGivenName( const QString &givenName );
186 /** 183 /**
187 Return given name. 184 Return given name.
188 */ 185 */
189 QString givenName() const; 186 QString givenName() const;
190 /** 187 /**
191 Return translated label for givenName field. 188 Return translated label for givenName field.
192 */ 189 */
193 static QString givenNameLabel(); 190 static QString givenNameLabel();
194 191
195 /** 192 /**
196 Set additional names. 193 Set additional names.
197 */ 194 */
198 void setAdditionalName( const QString &additionalName ); 195 void setAdditionalName( const QString &additionalName );
199 /** 196 /**
200 Return additional names. 197 Return additional names.
201 */ 198 */
202 QString additionalName() const; 199 QString additionalName() const;
203 /** 200 /**
204 Return translated label for additionalName field. 201 Return translated label for additionalName field.
205 */ 202 */
206 static QString additionalNameLabel(); 203 static QString additionalNameLabel();
207 204
208 /** 205 /**
209 Set honorific prefixes. 206 Set honorific prefixes.
210 */ 207 */
211 void setPrefix( const QString &prefix ); 208 void setPrefix( const QString &prefix );
212 /** 209 /**
213 Return honorific prefixes. 210 Return honorific prefixes.
214 */ 211 */
215 QString prefix() const; 212 QString prefix() const;
216 /** 213 /**
217 Return translated label for prefix field. 214 Return translated label for prefix field.
218 */ 215 */
219 static QString prefixLabel(); 216 static QString prefixLabel();
220 217
221 /** 218 /**
222 Set honorific suffixes. 219 Set honorific suffixes.
223 */ 220 */
224 void setSuffix( const QString &suffix ); 221 void setSuffix( const QString &suffix );
225 /** 222 /**
226 Return honorific suffixes. 223 Return honorific suffixes.
227 */ 224 */
228 QString suffix() const; 225 QString suffix() const;
229 /** 226 /**
230 Return translated label for suffix field. 227 Return translated label for suffix field.
231 */ 228 */
232 static QString suffixLabel(); 229 static QString suffixLabel();
233 230
234 /** 231 /**
235 Set nick name. 232 Set nick name.
236 */ 233 */
237 void setNickName( const QString &nickName ); 234 void setNickName( const QString &nickName );
238 /** 235 /**
239 Return nick name. 236 Return nick name.
240 */ 237 */
241 QString nickName() const; 238 QString nickName() const;
242 /** 239 /**
243 Return translated label for nickName field. 240 Return translated label for nickName field.
244 */ 241 */
245 static QString nickNameLabel(); 242 static QString nickNameLabel();
246 243
247 /** 244 /**
248 Set birthday. 245 Set birthday.
249 */ 246 */
250 void setBirthday( const QDateTime &birthday ); 247 void setBirthday( const QDateTime &birthday );
251 /** 248 /**
252 Return birthday. 249 Return birthday.
253 */ 250 */
254 QDateTime birthday() const; 251 QDateTime birthday() const;
255 /** 252 /**
256 Return translated label for birthday field. 253 Return translated label for birthday field.
257 */ 254 */
258 static QString birthdayLabel(); 255 static QString birthdayLabel();
259 256
260 /** 257 /**
261 Return translated label for homeAddressStreet field. 258 Return translated label for homeAddressStreet field.
262 */ 259 */
263 static QString homeAddressStreetLabel(); 260 static QString homeAddressStreetLabel();
264 261
265 /** 262 /**
266 Return translated label for homeAddressLocality field. 263 Return translated label for homeAddressLocality field.
267 */ 264 */
268 static QString homeAddressLocalityLabel(); 265 static QString homeAddressLocalityLabel();
269 266
270 /** 267 /**
271 Return translated label for homeAddressRegion field. 268 Return translated label for homeAddressRegion field.
272 */ 269 */
273 static QString homeAddressRegionLabel(); 270 static QString homeAddressRegionLabel();
274 271
275 /** 272 /**
276 Return translated label for homeAddressPostalCode field. 273 Return translated label for homeAddressPostalCode field.
277 */ 274 */
278 static QString homeAddressPostalCodeLabel(); 275 static QString homeAddressPostalCodeLabel();
279 276
280 /** 277 /**
281 Return translated label for homeAddressCountry field. 278 Return translated label for homeAddressCountry field.
282 */ 279 */
283 static QString homeAddressCountryLabel(); 280 static QString homeAddressCountryLabel();
284 281
285 /** 282 /**
286 Return translated label for homeAddressLabel field. 283 Return translated label for homeAddressLabel field.
287 */ 284 */
288 static QString homeAddressLabelLabel(); 285 static QString homeAddressLabelLabel();
289 286
290 /** 287 /**
291 Return translated label for businessAddressStreet field. 288 Return translated label for businessAddressStreet field.
292 */ 289 */
293 static QString businessAddressStreetLabel(); 290 static QString businessAddressStreetLabel();
294 291
295 /** 292 /**