---

KABC::StdAddressBook Class Reference

#include <stdaddressbook.h>

Inheritance diagram for KABC::StdAddressBook:

List of all members.

Static Public Methods
AddressBook *	self ()
AddressBook *	self (bool onlyFastResources)
bool	save ()
void	handleCrash ()
QString	fileName ()
QString	directoryName ()
void	setAutomaticSave (bool enable)
void	close ()
bool	automaticSave ()

---

Detailed Description

Standard KDE address book

This class provides access to the standard KDE address book shared by all applications.

It's implemented as a singleton. Use self() to get the address book object.

Example:

  KABC::AddressBook *ab = KABC::StdAddressBook::self();
 
  if ( !ab->load() ) {
    // error
  }
 
  KABC::AddressBook::Iterator it;
  for ( it = ab->begin(); it != ab->end(); ++it ) {
    kdDebug() << "UID=" << (*it).uid() << endl;
 
    // do some other stuff
  }
 
  KABC::StdAddressBook::save();
  

Definition at line 56 of file stdaddressbook.h.

---

Member Function Documentation

bool KABC::StdAddressBook::automaticSave (    )  [static]

Returns whether the address book is saved at destruction time. See also setAutomaticSave().

void KABC::StdAddressBook::close (    )  [static]

Closes the address book. Depending on automaticSave() it will save the address book first.

QString KABC::StdAddressBook::directoryName (    )  [static]

Returns the default directory name for vcard-based addressbook

QString KABC::StdAddressBook::fileName (    )  [static]

Returns the default file name for vcard-based addressbook

void KABC::StdAddressBook::handleCrash (    )  [static]

Call this method in your crash handler to allow the library clean up possible locks.

bool KABC::StdAddressBook::save (    )  [static]

Save the standard address book to disk.

AddressBook* KABC::StdAddressBook::self (  bool    onlyFastResources )  [static]

This is the same as above, but with specified behaviour of resource loading. Parameters: onlyFastResource  Only resources marked as 'fast' should be loaded

AddressBook* KABC::StdAddressBook::self (    )  [static]

Return the standard addressbook object.

void KABC::StdAddressBook::setAutomaticSave (  bool    enable )  [static]

Set the automatic save property of the address book. If enable is TRUE (default) the address book is saved at destruction time otherwise you have to call save() to explicitely save it.

---

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

• stdaddressbook.h

---