• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

kabc

  • kabc
addressbook.h
1/*
2 This file is part of libkabc.
3 Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org>
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either
8 version 2 of the License, or (at your option) any later version.
9
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public License
16 along with this library; see the file COPYING.LIB. If not, write to
17 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
19*/
20
21#ifndef KABC_ADDRESSBOOK_H
22#define KABC_ADDRESSBOOK_H
23
24#include "kabc_export.h"
25
26#include "addressee.h"
27#include "field.h"
28
29#include "kresources/manager.h"
30
31#include <QtCore/QObject>
32#include <QtCore/QList>
33
34namespace KABC {
35
36class DistributionList;
37class ErrorHandler;
38class Resource;
39class Ticket;
40
46class KABC_DEPRECATED_EXPORT AddressBook : public QObject
47{
48 Q_OBJECT
49
50 friend KABC_EXPORT QDataStream &operator<<( QDataStream &lhs,
51 const AddressBook &rhs );
52 friend KABC_EXPORT QDataStream &operator>>( QDataStream &lhs,
53 AddressBook &rhs );
54 friend class StdAddressBook;
55
56 public:
57 class ConstIterator;
58
64 class KABC_DEPRECATED_EXPORT Iterator //krazy:exclude=dpointer
65 {
66 friend class AddressBook;
67 friend class ConstIterator;
68 public:
72 Iterator();
73
77 Iterator( const Iterator & );
78 ~Iterator();
79
85 Iterator &operator=( const Iterator & );
86
93 const Addressee &operator*() const;
94
101 Addressee &operator*();
102
109 Addressee *operator->();
110
116 Iterator &operator++();
117
124 Iterator &operator++(int);
125
131 Iterator &operator--();
132
139 Iterator &operator--(int);
140
148 bool operator==( const Iterator &it ) const;
149
157 bool operator!=( const Iterator &it ) const;
158
159 private:
160 struct IteratorData;
161 IteratorData *const d;
162 };
163
169 class KABC_DEPRECATED_EXPORT ConstIterator //krazy:exclude=dpointer
170 {
171 friend class AddressBook;
172 public:
176 ConstIterator();
177
181 ConstIterator( const ConstIterator & );
182
183#ifndef QT_STRICT_ITERATORS
188 ConstIterator( const Iterator & );
189#endif
190
191 ~ConstIterator();
192
198 ConstIterator &operator=( const ConstIterator & );
199
208 const Addressee &operator*() const;
209
216 const Addressee *operator->() const;
217
223 ConstIterator &operator++();
224
231 ConstIterator &operator++(int);
232
238 ConstIterator &operator--();
239
246 ConstIterator &operator--(int);
247
255 bool operator==( const ConstIterator &it ) const;
256
264 bool operator!=( const ConstIterator &it ) const;
265
266 private:
267 struct ConstIteratorData;
268 ConstIteratorData *const d;
269 };
270
274 typedef Iterator iterator;
275
279 typedef ConstIterator const_iterator;
280
285 AddressBook();
286
293 AddressBook( const QString &config );
294
298 virtual ~AddressBook();
299
311 Ticket *requestSaveTicket( Resource *resource = 0 );
312
319 void releaseSaveTicket( Ticket *ticket );
320
326 bool load();
327
335 bool asyncLoad();
336
344 bool save( Ticket *ticket );
345
353 bool asyncSave( Ticket *ticket );
354
359 ConstIterator begin() const;
360 ConstIterator constBegin() const { return begin(); }
361
366 Iterator begin();
367
372 ConstIterator end() const;
373 ConstIterator constEnd() const { return end(); }
374
379 Iterator end();
380
384 void clear();
385
393 void insertAddressee( const Addressee &addr );
394
400 void removeAddressee( const Addressee &addr );
401
408 void removeAddressee( const Iterator &it );
409
416 Iterator find( const Addressee &addr );
417
424 ConstIterator find( const Addressee &addr ) const;
425
433 Addressee findByUid( const QString &uid ) const;
434
438 Addressee::List allAddressees() const;
439
446 Addressee::List findByName( const QString &name ) const;
447
454 Addressee::List findByEmail( const QString &email ) const;
455
462 Addressee::List findByCategory( const QString &category ) const;
463
477 DistributionList *createDistributionList( const QString &name, Resource *resource = 0 );
478
484 void removeDistributionList( DistributionList *list );
485
491 DistributionList *findDistributionListByIdentifier( const QString &identifier );
492
500 DistributionList *findDistributionListByName(
501 const QString &name,
502 Qt::CaseSensitivity caseSensitivity = Qt::CaseSensitive );
503
508 QList<DistributionList*> allDistributionLists();
509
517 QStringList allDistributionListNames() const;
518
523 virtual QString identifier() const;
524
529 Field::List fields( int category = Field::All ) const;
530
540 bool addCustomField( const QString &label, int category = Field::All,
541 const QString &key = QString(),
542 const QString &app = QString() ) const;
543
550 bool addResource( Resource *resource );
551
558 bool removeResource( Resource *resource );
559
563 QList<Resource*> resources() const;
564
571 void setErrorHandler( ErrorHandler *errorHandler );
572
578 void error( const QString &msg );
579
584 void dump() const;
585
589 void emitAddressBookLocked() { addressBookLocked( this ); }
593 void emitAddressBookUnlocked() { addressBookUnlocked( this ); }
597 void emitAddressBookChanged() { addressBookChanged( this ); }
598
603 bool loadingHasFinished() const;
604
605 Q_SIGNALS:
614 void addressBookChanged( AddressBook *addressBook );
615
621 void addressBookLocked( AddressBook *addressBook );
622
631 void addressBookUnlocked( AddressBook *addressBook );
632
639 void loadingFinished( Resource *resource );
640
647 void savingFinished( Resource *resource );
648
649 protected Q_SLOTS:
660 void resourceLoadingFinished( Resource *resource );
661
669 void resourceSavingFinished( Resource *resource );
670
681 void resourceLoadingError( Resource *resource, const QString &errMsg );
682
691 void resourceSavingError( Resource *resource, const QString &errMsg );
692
693 protected:
703 void setStandardResource( Resource *resource );
704
712 Resource *standardResource();
713
717 KRES::Manager<Resource> *resourceManager();
718
719 private:
720 class Private;
721 Private *const d;
722};
723
724KABC_EXPORT QDataStream &operator<<( QDataStream &lhs, const AddressBook &rhs );
725KABC_EXPORT QDataStream &operator>>( QDataStream &lhs, AddressBook &rhs );
726
727}
728
729#endif
KABC::AddressBook::ConstIterator
Address Book Const Iterator.
Definition addressbook.h:170
KABC::AddressBook::Iterator
Address Book Iterator.
Definition addressbook.h:65
KABC::AddressBook
Address Book.
Definition addressbook.h:47
KABC::AddressBook::savingFinished
void savingFinished(Resource *resource)
Emitted when the asynchronous saving of one resource has finished after calling asyncSave().
KABC::AddressBook::addressBookLocked
void addressBookLocked(AddressBook *addressBook)
Emitted when one of the resources has been locked for writing.
KABC::AddressBook::emitAddressBookChanged
void emitAddressBookChanged()
Emits the signal addressBookChanged() using this as the parameter.
Definition addressbook.h:597
KABC::AddressBook::addressBookUnlocked
void addressBookUnlocked(AddressBook *addressBook)
Emitted when one of the resources has been unlocked.
KABC::AddressBook::addressBookChanged
void addressBookChanged(AddressBook *addressBook)
Emitted when one of the resources discovered a change in its backend or the asynchronous loading of a...
KABC::AddressBook::emitAddressBookUnlocked
void emitAddressBookUnlocked()
Emits the signal addressBookUnlocked() using this as the parameter.
Definition addressbook.h:593
KABC::AddressBook::loadingFinished
void loadingFinished(Resource *resource)
Emitted when the asynchronous loading of one resource has finished after calling asyncLoad().
KABC::AddressBook::emitAddressBookLocked
void emitAddressBookLocked()
Emits the signal addressBookLocked() using this as the parameter.
Definition addressbook.h:589
KABC::Addressee
address book entry
Definition addressee.h:79
KABC::Resource
Definition resource.h:65
KABC::StdAddressBook
Standard KDE address book.
Definition stdaddressbook.h:60
KABC::Ticket
Helper class for handling coordinated save of address books.
Definition resource.h:38
KRES::Manager
KABC
Class that holds a Calendar Url (FBURL/CALADRURI/CALURI)
Definition address.h:29
KABC::operator<<
QDataStream & operator<<(QDataStream &stream, const Address &address)
Serializes the address object into the stream.
Definition address.cpp:680
KABC::operator>>
QDataStream & operator>>(QDataStream &stream, Address &address)
Initializes the address object from the stream.
Definition address.cpp:688
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kabc

Skip menu "kabc"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal