KABC::StdAddressBook Class Reference

#include <stdaddressbook.h>

Inheritance diagram for KABC::StdAddressBook:

Public Member Functions
	~StdAddressBook ()
void	setWhoAmI (const Addressee &addr)
Addressee	whoAmI () const
Public Member Functions inherited from KABC::AddressBook
	AddressBook ()
	AddressBook (const QString &config)
virtual	~AddressBook ()
bool	addCustomField (const QString &label, int category=Field::All, const QString &key=QString(), const QString &app=QString()) const
bool	addResource (Resource *resource)
Addressee::List	allAddressees () const
QStringList	allDistributionListNames () const
QList< DistributionList * >	allDistributionLists ()
bool	asyncLoad ()
bool	asyncSave (Ticket *ticket)
ConstIterator	begin () const
Iterator	begin ()
void	clear ()
ConstIterator	constBegin () const
ConstIterator	constEnd () const
DistributionList *	createDistributionList (const QString &name, Resource *resource=0)
void	dump () const
void	emitAddressBookChanged ()
void	emitAddressBookLocked ()
void	emitAddressBookUnlocked ()
ConstIterator	end () const
Iterator	end ()
void	error (const QString &msg)
Field::List	fields (int category=Field::All) const
Iterator	find (const Addressee &addr)
ConstIterator	find (const Addressee &addr) const
Addressee::List	findByCategory (const QString &category) const
Addressee::List	findByEmail (const QString &email) const
Addressee::List	findByName (const QString &name) const
Addressee	findByUid (const QString &uid) const
DistributionList *	findDistributionListByIdentifier (const QString &identifier)
DistributionList *	findDistributionListByName (const QString &name, Qt::CaseSensitivity caseSensitivity=Qt::CaseSensitive)
virtual QString	identifier () const
void	insertAddressee (const Addressee &addr)
bool	load ()
bool	loadingHasFinished () const
void	releaseSaveTicket (Ticket *ticket)
void	removeAddressee (const Addressee &addr)
void	removeAddressee (const Iterator &it)
void	removeDistributionList (DistributionList *list)
bool	removeResource (Resource *resource)
Ticket *	requestSaveTicket (Resource *resource=0)
QList< Resource * >	resources () const
bool	save (Ticket *ticket)
void	setErrorHandler (ErrorHandler *errorHandler)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Static Public Member Functions
static bool	automaticSave ()
static void	close ()
static QString	directoryName ()
static QString	fileName ()
static KABC_DEPRECATED bool	save ()
static StdAddressBook *	self ()
static StdAddressBook *	self (bool asynchronous)
static void	setAutomaticSave (bool state)
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Protected Member Functions
	StdAddressBook (bool asynchronous)
Protected Member Functions inherited from KABC::AddressBook
KRES::Manager< Resource > *	resourceManager ()
void	setStandardResource (Resource *resource)
Resource *	standardResource ()
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Signals inherited from KABC::AddressBook
void	addressBookChanged (AddressBook *addressBook)
void	addressBookLocked (AddressBook *addressBook)
void	addressBookUnlocked (AddressBook *addressBook)
void	loadingFinished (Resource *resource)
void	savingFinished (Resource *resource)
Protected Slots inherited from KABC::AddressBook
void	resourceLoadingError (Resource *resource, const QString &errMsg)
void	resourceLoadingFinished (Resource *resource)
void	resourceSavingError (Resource *resource, const QString &errMsg)
void	resourceSavingFinished (Resource *resource)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

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. On the first self() call the address book also gets loaded.

Example:

KABC::AddressBook *ab = KABC::StdAddressBook::self();

AddressBook::Ticket *ticket = ab->requestSaveTicket();

if ( ticket ) {
  KABC::AddressBook::Iterator it;
  for ( it = ab->begin(); it != ab->end(); ++it ) {
    kDebug( 5700 ) << "UID=" << ( *it ).uid();

    // do some other stuff
  }

  KABC::StdAddressBook::save( ticket );
}

Deprecated:

Port to libakonadi-kontact. For instance using Akonadi::ContactSearchJob. See http://techbase.kde.org/Development/AkonadiPorting/AddressBook for details.

Definition at line 59 of file stdaddressbook.h.

Constructor & Destructor Documentation

StdAddressBook::~StdAddressBook

(

)

Destructor.

Definition at line 135 of file stdaddressbook.cpp.

Member Function Documentation

bool StdAddressBook::automaticSave ( )

static

Returns whether the address book is saved at destruction time.

See also setAutomaticSave().

Definition at line 235 of file stdaddressbook.cpp.

void StdAddressBook::close ( )

static

Closes the address book.

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

Definition at line 224 of file stdaddressbook.cpp.

QString StdAddressBook::directoryName ( )

static

Returns the default directory name for vcard-based addressbook.

Definition at line 69 of file stdaddressbook.cpp.

QString StdAddressBook::fileName ( )

static

Returns the default file name for vcard-based addressbook.

Definition at line 64 of file stdaddressbook.cpp.

bool StdAddressBook::save ( )

static

Saves the standard address book to disk.

Deprecated:

Use AddressBook::save( Ticket* ) instead

Definition at line 213 of file stdaddressbook.cpp.

StdAddressBook * StdAddressBook::self ( )

static

Returns the standard addressbook object.

It also loads all resources of the users standard address book synchronously.

Definition at line 74 of file stdaddressbook.cpp.

StdAddressBook * StdAddressBook::self ( bool  asynchronous )

static

This is the same as above, but with specified behaviour of resource loading.

Parameters

asynchronous

When true, the resources are loaded asynchronous, that means you have the data foremost the addressBookChanged() signal has been emitted. So connect to this signal when using this method!

Definition at line 84 of file stdaddressbook.cpp.

void StdAddressBook::setAutomaticSave ( bool  state )

static

Sets the automatic save property of the address book.

Parameters

state

If true, the address book is saved automatically at destruction time, otherwise you have to call AddressBook::save( Ticket* ).

Definition at line 230 of file stdaddressbook.cpp.

void StdAddressBook::setWhoAmI

(

const Addressee &

addr

)

Sets the users contact.

See whoAmI() for more information.

Parameters

addr	The users contact.

Definition at line 248 of file stdaddressbook.cpp.

Addressee StdAddressBook::whoAmI

(

)

const

Returns the contact, that is associated with the owner of the address book.

This contact should be used by other programs to access user specific data.

Definition at line 240 of file stdaddressbook.cpp.

---

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

• stdaddressbook.h
• stdaddressbook.cpp