1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
|
/*
This file is part of libtdeabc.
Copyright (c) 2001 Cornelius Schumacher <[email protected]>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KABC_ADDRESSBOOK_H
#define KABC_ADDRESSBOOK_H
#include <tqobject.h>
#include <tqptrlist.h>
#include <tderesources/manager.h>
#include "addressee.h"
#include "field.h"
namespace TDEABC {
class ErrorHandler;
class Resource;
class Ticket;
/**
@short Address Book
This class provides access to a collection of address book entries.
*/
class KABC_EXPORT AddressBook : public TQObject
{
TQ_OBJECT
friend KABC_EXPORT TQDataStream &operator<<( TQDataStream &, const AddressBook & );
friend KABC_EXPORT TQDataStream &operator>>( TQDataStream &, AddressBook & );
friend class StdAddressBook;
public:
/**
@short Address Book Iterator
This class provides an iterator for address book entries.
*/
class KABC_EXPORT Iterator
{
public:
Iterator();
Iterator( const Iterator & );
~Iterator();
Iterator &operator=( const Iterator & );
const Addressee &operator*() const;
Addressee &operator*();
Addressee* operator->();
Iterator &operator++();
Iterator &operator++(int);
Iterator &operator--();
Iterator &operator--(int);
bool operator==( const Iterator &it );
bool operator!=( const Iterator &it );
struct IteratorData;
IteratorData *d;
};
/**
@short Address Book Const Iterator
This class provides a const iterator for address book entries.
*/
class KABC_EXPORT ConstIterator
{
public:
ConstIterator();
ConstIterator( const ConstIterator & );
ConstIterator( const Iterator & );
~ConstIterator();
ConstIterator &operator=( const ConstIterator & );
const Addressee &operator*() const;
const Addressee* operator->() const;
ConstIterator &operator++();
ConstIterator &operator++(int);
ConstIterator &operator--();
ConstIterator &operator--(int);
bool operator==( const ConstIterator &it );
bool operator!=( const ConstIterator &it );
struct ConstIteratorData;
ConstIteratorData *d;
};
/**
Constructs an address book object.
You have to add the resources manually before calling load().
*/
AddressBook();
/**
Constructs an address book object.
The resources are loaded automatically.
@param config The config file which contains the resource settings.
*/
AddressBook( const TQString &config );
/**
Destructor.
*/
virtual ~AddressBook();
/**
Requests a ticket for saving the addressbook. Calling this function locks
the addressbook for all other processes. You need the returned ticket
object for calling the save() function.
@param resource A pointer to the resource which shall be locked. If 0,
the default resource is locked.
@return 0 if the resource is already locked or a valid save ticket
otherwise.
@see save()
*/
Ticket *requestSaveTicket( Resource *resource = 0 );
/**
Releases the ticket requested previously with requestSaveTicket().
Call this function, if you want to release a ticket without saving.
*/
void releaseSaveTicket( Ticket *ticket );
/**
Loads all addressees synchronously.
@return Whether the loading was successfully.
*/
bool load();
/**
Loads all addressees asynchronously. This function returns immediately
and emits the addressBookChanged() signal as soon as the loading has
finished.
@return Whether the synchronous part of loading was successfully.
*/
bool asyncLoad();
/**
Saves all addressees of one resource synchronously. If the save is
successfull the ticket is deleted.
@param ticket The ticket returned by requestSaveTicket().
@return Whether the saving was successfully.
*/
bool save( Ticket *ticket );
/**
Saves all addressees of one resource asynchronously. If the save is
successfull the ticket is deleted.
@param ticket The ticket returned by requestSaveTicket().
@return Whether the synchronous part of saving was successfully.
*/
bool asyncSave( Ticket *ticket );
/**
Returns an iterator pointing to the first addressee of address book.
This iterator equals end() if the address book is empty.
*/
ConstIterator begin() const;
/**
This is an overloaded member function, provided for convenience. It
behaves essentially like the above function.
*/
Iterator begin();
/**
Returns an iterator pointing to the last addressee of address book.
This iterator equals begin() if the address book is empty.
*/
ConstIterator end() const;
/**
This is an overloaded member function, provided for convenience. It
behaves essentially like the above function.
*/
Iterator end();
/**
Removes all addressees from the address book.
*/
void clear();
/**
Insert an addressee into the address book. If an addressee with the same
unique id already exists, it is replaced by the new one, otherwise it is
appended.
@param addr The addressee which shall be insert.
*/
void insertAddressee( const Addressee &addr );
/**
Removes an addressee from the address book.
@param addr The addressee which shall be removed.
*/
void removeAddressee( const Addressee &addr );
/**
This is an overloaded member function, provided for convenience. It
behaves essentially like the above function.
@param it An iterator pointing to the addressee which shall be removed.
*/
void removeAddressee( const Iterator &it );
/**
Returns an iterator pointing to the specified addressee. It will return
end() if no addressee matched.
@param addr The addresee you are looking for.
*/
Iterator find( const Addressee &addr ); // KDE4: const
/**
Searches an addressee with the specified unique identifier.
@param uid The unique identifier you are looking for.
@return The addressee with the specified unique identifier or an
empty addressee.
*/
Addressee findByUid( const TQString &uid ); // KDE4: const
/**
Returns a list of all addressees in the address book.
*/
Addressee::List allAddressees(); // KDE4: const
/**
Searches all addressees which match the specified name.
@param name The name you are looking for.
@return A list of all matching addressees.
*/
Addressee::List findByName( const TQString &name ); // KDE4: const
/**
Searches all addressees which match the specified email address.
@param email The email address you are looking for.
@return A list of all matching addressees.
*/
Addressee::List findByEmail( const TQString &email ); // KDE4: const
/**
Searches all addressees which belongs to the specified category.
@param category The category you are looking for.
@return A list of all matching addressees.
*/
Addressee::List findByCategory( const TQString &category ); // KDE4: const
/**
Returns a string identifying this addressbook. The identifier is
created by concatenation of the resource identifiers.
*/
virtual TQString identifier(); // KDE4: const
/**
Returns a list of all Fields known to the address book which are associated
with the given field category.
*/
Field::List fields( int category = Field::All ); // KDE4: const
/**
Add custom field to address book.
@param label User visible label of the field.
@param category Ored list of field categories.
@param key Identifier used as key for reading and writing the field.
@param app String used as application key for reading and writing
the field.
*/
bool addCustomField( const TQString &label, int category = Field::All,
const TQString &key = TQString::null,
const TQString &app = TQString::null );
/**
Adds a resource to the address book.
@param resource The resource you want to add.
@return Whether opening the resource was successfully.
*/
bool addResource( Resource *resource );
/**
Removes a resource from the address book.
@param resource The resource you want to remove.
@return Whether closing the resource was successfully.
*/
bool removeResource( Resource *resource );
/**
Returns a list of all resources.
*/
TQPtrList<Resource> resources(); // KDE4: const
/**
Sets the @p ErrorHandler, that is used by error() to
provide GUI independent error messages.
@param errorHandler The error handler you want to use.
*/
void setErrorHandler( ErrorHandler *errorHandler );
/**
Shows GUI independent error messages.
@param msg The error message that shall be displayed.
*/
void error( const TQString &msg );
/**
@deprecated There is no need to call this function anymore.
*/
void cleanUp() KDE_DEPRECATED;
/**
Used for debug output. This function prints out the list
of all addressees to kdDebug(5700).
*/
void dump() const;
/**
*/
void emitAddressBookLocked() { emit addressBookLocked( this ); }
void emitAddressBookUnlocked() { emit addressBookUnlocked( this ); }
void emitAddressBookChanged() { emit addressBookChanged( this ); }
/**
Returns true when the loading of the addressbook has finished,
otherwise false.
@since 3.5
*/
bool loadingHasFinished() const;
signals:
/**
Emitted when one of the resources discovered a change in its backend
or the asynchronous loading of all resources has finished.
You should connect to this signal to update the presentation of
the contact data in your application.
@param addressBook The address book which emitted this signal.
*/
void addressBookChanged( AddressBook *addressBook );
/**
Emitted when one of the resources has been locked for writing.
@param addressBook The address book which emitted this signal.
*/
void addressBookLocked( AddressBook *addressBook );
/**
Emitted when one of the resources has been unlocked.
You should connect to this signal if you want to save your changes
to a resource which is currently locked, and want to get notified when
saving is possible again.
@param addressBook The address book which emitted this signal.
*/
void addressBookUnlocked( AddressBook *addressBook );
/**
Emitted when the asynchronous loading of one resource has finished
after calling asyncLoad().
@param resource The resource which emitted this signal.
*/
void loadingFinished( Resource *resource );
/**
Emitted when the asynchronous saving of one resource has finished
after calling asyncSave().
@param resource The resource which emitted this signal.
*/
void savingFinished( Resource *resource );
protected slots:
void resourceLoadingFinished( Resource* );
void resourceSavingFinished( Resource* );
void resourceLoadingError( Resource*, const TQString& );
void resourceSavingError( Resource*, const TQString& );
protected:
void deleteRemovedAddressees();
void setStandardResource( Resource* );
Resource *standardResource();
KRES::Manager<Resource> *resourceManager();
private:
TQPtrList<Resource> mDummy; // Remove in KDE 4
struct AddressBookData;
AddressBookData *d;
};
KABC_EXPORT TQDataStream &operator<<( TQDataStream &, const AddressBook & );
KABC_EXPORT TQDataStream &operator>>( TQDataStream &, AddressBook & );
}
#endif
|