class AddressBook

Public Types

• class Iterator
• class ConstIterator

Public Methods

•  AddressBook ()
• virtual  ~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
• void  emitAddressBookLocked ()
• void  emitAddressBookUnlocked ()
• void  emitAddressBookChanged ()
• 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  resources ()
• void  setErrorHandler ( ErrorHandler * )
• void  error ( const QString& )
• void  cleanUp ()

Signals

• void  addressBookChanged ( AddressBook * )
• void  addressBookLocked ( AddressBook * )
• void  addressBookUnlocked ( AddressBook * )

Protected Methods

• void  deleteRemovedAddressees ()
• void  setStandardResource ( Resource * )
• Resource * standardResource ()

Detailed Description

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

This class provides an iterator for address book entries.

This class provides a const iterator for address book entries.

Constructs a address book object.

Parameters:

format

File format class.

[virtual]

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()

Load address book from file.

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()

Returns a iterator for first entry of address book.

[const]

Returns a const iterator for first entry of address book.

Returns a iterator for first entry of address book.

[const]

Returns a const iterator for first entry of address book.

Removes all entries from address book.

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.

Removes entry from the address book.

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

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

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.

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

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

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

[virtual]

Return a string identifying this addressbook.

[const]

Used for debug output.

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

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.

Add address book resource.

Remove address book resource.

Return pointer list of all resources.

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

Shows gui independend error messages.

Query all resources to clean up their lock files

[signal]

Emitted, when the address book has changed on disk.

[signal]

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

[signal]

Emitted, when the address book has been unlocked.

[protected]

[protected]

[protected]