---

KABC::AddressBook Class Reference

Address Book. More...

#include <addressbook.h>

Inheritance diagram for KABC::AddressBook:

List of all members.

Signals
void	addressBookChanged (AddressBook *)
void	addressBookLocked (AddressBook *)
void	addressBookUnlocked (AddressBook *)
Public Methods
	AddressBook ()
Ticket *	requestSaveTicket (Resource *resource=0)
bool	load ()
bool	save (Ticket *ticket)
Iterator	begin ()
ConstIterator	begin () const
Iterator	end ()
ConstIterator	end () const
void	clear ()
void	insertAddressee (const Addressee &)
void	removeAddressee (const Addressee &)
void	removeAddressee (const Iterator &)
Iterator	find (const Addressee &)
Addressee	findByUid (const QString &)
Addressee::List	findByName (const QString &)
Addressee::List	findByEmail (const QString &)
Addressee::List	findByCategory (const QString &)
virtual QString	identifier ()
void	dump () const
Field::List	fields (int category=Field::All)
bool	addCustomField (const QString &label, int category=Field::All, const QString &key=QString::null, const QString &app=QString::null)
bool	addResource (Resource *)
bool	removeResource (Resource *)
QPtrList< Resource >	resources ()
void	setErrorHandler (ErrorHandler *)
void	error (const QString &)
void	cleanUp ()

---

Detailed Description

Address Book.

This class provides access to a collection of address book entries.

Definition at line 41 of file addressbook.h.

---

Constructor & Destructor Documentation

KABC::AddressBook::AddressBook (    )

Constructs a address book object. Parameters: format  File format class.

---

Member Function Documentation

bool KABC::AddressBook::addCustomField (  const QString &    label, int    category = Field::All, const QString &    key = QString::null, const QString &    app = QString::null )

Add custom field to address book. Parameters: label  User visible label of the field. category  Ored list of field categories. key  Identifier used as key for reading and writing the field. app  String used as application key for reading and writing the field.

bool KABC::AddressBook::addResource (  Resource *    )

Add address book resource.

void KABC::AddressBook::addressBookChanged (  AddressBook *    )  [signal]

Emitted, when the address book has changed on disk.

void KABC::AddressBook::addressBookLocked (  AddressBook *    )  [signal]

Emitted, when the address book has been locked for writing.

void KABC::AddressBook::addressBookUnlocked (  AddressBook *    )  [signal]

Emitted, when the address book has been unlocked.

ConstIterator KABC::AddressBook::begin (    )

Returns a const iterator for first entry of address book.

Iterator KABC::AddressBook::begin (    )

Returns a iterator for first entry of address book.

void KABC::AddressBook::cleanUp (    )

Query all resources to clean up their lock files

void KABC::AddressBook::clear (    )

Removes all entries from address book.

void KABC::AddressBook::dump (    )

Used for debug output.

ConstIterator KABC::AddressBook::end (    )

Returns a const iterator for first entry of address book.

Iterator KABC::AddressBook::end (    )

Returns a iterator for first entry of address book.

void KABC::AddressBook::error (  const QString &    )

Shows gui independend error messages.

Field::List KABC::AddressBook::fields (  int    category = Field::All )

Return list of all Fields known to the address book which are associated with the given field category.

Iterator KABC::AddressBook::find (  const Addressee &    )

Find the specified entry in address book. Returns end(), if the entry couldn't be found.

Addressee::List KABC::AddressBook::findByCategory (  const QString &    )

Find all entries wich have the specified category in the address book. Returns an empty list, if no entries couldn't be found.

Addressee::List KABC::AddressBook::findByEmail (  const QString &    )

Find all entries with the specified email address in the address book. Returns an empty list, if no entries couldn't be found.

Addressee::List KABC::AddressBook::findByName (  const QString &    )

Find all entries with the specified name in the address book. Returns an empty list, if no entries couldn't be found.

Addressee KABC::AddressBook::findByUid (  const QString &    )

Find the entry specified by an unique id. Returns an empty Addressee object, if the address book does not contain an entry with this id.

virtual QString KABC::AddressBook::identifier (    )  [virtual]

Return a string identifying this addressbook.

void KABC::AddressBook::insertAddressee (  const Addressee &    )

Insert an Addressee object into address book. If an object with the same unique id already exists in the address book it it replaced by the new one. If not the new object is appended to the address book.

bool KABC::AddressBook::load (    )

Load address book from file.

void KABC::AddressBook::removeAddressee (  const Iterator &    )

This is like removeAddressee() just above, with the difference that the first element is a iterator, returned by begin().

void KABC::AddressBook::removeAddressee (  const Addressee &    )

Removes entry from the address book.

bool KABC::AddressBook::removeResource (  Resource *    )

Remove address book resource.

Ticket* KABC::AddressBook::requestSaveTicket (  Resource *    resource = 0 )

Requests a ticket for saving the addressbook. Calling this function locks the addressbook for all other processes. If the address book is already locked the function returns 0. You need the returned Ticket object for calling the save() function. See also: save()

QPtrList<Resource> KABC::AddressBook::resources (    )

Return pointer list of all resources.

bool KABC::AddressBook::save (  Ticket *    ticket )

Save address book. The address book is saved to the file, the Ticket object has been requested for by requestSaveTicket(). Parameters: ticket  a ticket object returned by requestSaveTicket()

void KABC::AddressBook::setErrorHandler (  ErrorHandler *    )

Set the ErrorHandler, that is used by error() to provide gui-independend error messages.

---

The documentation for this class was generated from the following file:

• addressbook.h

---