class StdAddressBook

Standard KDE address book More...

Full nameKABC::StdAddressBook
Definition#include <stdaddressbook.h>
InheritsKABC::AddressBook [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Static Methods

Protected Methods


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

AddressBook * self ()

self

[static]

Return the standard addressbook object.

AddressBook * self ( bool onlyFastResources )

self

[static]

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

Parameters:
onlyFastResourceOnly resources marked as 'fast' should be loaded

bool  save ()

save

[static]

Save the standard address book to disk.

Reimplemented from AddressBook.

QString  fileName ()

fileName

[static]

Returns the default file name for vcard-based addressbook

QString  directoryName ()

directoryName

[static]

Returns the default directory name for vcard-based addressbook

void  setAutomaticSave ( bool enable )

setAutomaticSave

[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.

void  close ()

close

[static]

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

bool  automaticSave ()

automaticSave

[static]

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

 StdAddressBook ()

StdAddressBook

[protected]

 StdAddressBook ( bool onlyFastResources )

StdAddressBook

[protected]

 ~StdAddressBook ()

~StdAddressBook

[protected]

void  init ( bool onlyFastResources )

init

[protected]


Generated by: caleb on tcdevel on Tue Jan 28 12:54:33 2003, using kdoc $.