KABC::ResourceDir Class Reference

#include <resourcedir.h>

Inheritance diagram for KABC::ResourceDir:

Public Member Functions
	ResourceDir (const KConfigGroup &group)
	ResourceDir (const QString &path, const QString &type=QLatin1String("vcard"))
virtual bool	asyncLoad ()
virtual bool	asyncSave (Ticket *ticket)
virtual void	doClose ()
virtual bool	doOpen ()
QString	format () const
virtual bool	load ()
QString	path () const
virtual void	releaseSaveTicket (Ticket *ticket)
virtual void	removeAddressee (const Addressee &addr)
virtual Ticket *	requestSaveTicket ()
virtual bool	save (Ticket *ticket)
void	setFormat (const QString &format)
void	setPath (const QString &)
virtual void	writeConfig (KConfigGroup &group)
Public Member Functions inherited from KABC::Resource
	Resource ()
	Resource (const KConfigGroup &group)
virtual	~Resource ()
AddressBook *	addressBook ()
virtual QStringList	allDistributionListNames () const
virtual QList< DistributionList * >	allDistributionLists ()
virtual ConstIterator	begin () const
virtual Iterator	begin ()
virtual void	clear ()
ConstIterator	constBegin () const
ConstIterator	constEnd () const
virtual ConstIterator	end () const
virtual Iterator	end ()
virtual Addressee::List	findByCategory (const QString &category)
virtual Addressee::List	findByEmail (const QString &email)
virtual Addressee::List	findByName (const QString &name)
virtual Addressee	findByUid (const QString &uid)
virtual DistributionList *	findDistributionListByIdentifier (const QString &identifier)
virtual DistributionList *	findDistributionListByName (const QString &name, Qt::CaseSensitivity caseSensitivity=Qt::CaseSensitive)
virtual void	insertAddressee (const Addressee &addr)
virtual void	insertDistributionList (DistributionList *list)
virtual void	removeDistributionList (DistributionList *list)
void	setAddressBook (AddressBook *addr)
Public Member Functions inherited from KRES::Resource
	Resource (const KConfigGroup &group)
void	close ()
virtual void	dump () const
QString	identifier () const
bool	isActive () const
bool	isOpen () const
bool	open ()
virtual bool	readOnly () const
virtual QString	resourceName () const
void	setActive (bool active)
void	setIdentifier (const QString &identifier)
virtual void	setReadOnly (bool value)
virtual void	setResourceName (const QString &name)
void	setType (const QString &type)
QString	type () const

Additional Inherited Members
Signals inherited from KABC::Resource
void	loadingError (Resource *resource, const QString &msg)
void	loadingFinished (Resource *resource)
void	savingError (Resource *resource, const QString &msg)
void	savingFinished (Resource *resource)
Protected Member Functions inherited from KABC::Resource
Ticket *	createTicket (Resource *)
Protected Attributes inherited from KABC::Resource
Addressee::Map	mAddrMap
DistributionListMap	mDistListMap

Detailed Description

Definition at line 37 of file resourcedir.h.

Member Function Documentation

bool ResourceDir::asyncLoad ( )

virtual

Loads all addressees asyncronously.

You have to make sure that either the loadingFinished() or loadingError() signal is emitted from within this function.

The default implementation simply calls the synchronous load.

Returns

Whether the synchronous part of loading was successfully.

Reimplemented from KABC::Resource.

Definition at line 237 of file resourcedir.cpp.

bool ResourceDir::asyncSave ( Ticket *  ticket )

virtual

Saves all addressees asynchronously.

You have to make sure that either the savingFinished() or savingError() signal is emitted from within this function.

The default implementation simply calls the synchronous save.

Parameters

ticket

You have to release the ticket later with releaseSaveTicket() explicitly.

Returns

Whether the saving was successfully.

Reimplemented from KABC::Resource.

Definition at line 284 of file resourcedir.cpp.

QString ResourceDir::format

(

)

const

Returns the format name.

Definition at line 322 of file resourcedir.cpp.

bool ResourceDir::load ( )

virtual

Loads all addressees synchronously.

Returns

Whether the loading was successfully.

Implements KABC::Resource.

Definition at line 207 of file resourcedir.cpp.

QString ResourceDir::path

(

)

const

Return path used for loading and saving the address book.

Definition at line 307 of file resourcedir.cpp.

void ResourceDir::releaseSaveTicket ( Ticket *  ticket )

virtual

Releases the ticket previousely requested with requestSaveTicket().

The resource has to remove its locks in this function. This function is also responsible for deleting the ticket.

Parameters

ticket

the save ticket acquired with requestSaveTicket()

Implements KABC::Resource.

Definition at line 170 of file resourcedir.cpp.

void ResourceDir::removeAddressee ( const Addressee &  addr )

virtual

Remove a addressee from its source.

This method is mainly called by KABC::AddressBook.

Parameters

addr	The addressee to remove

See also

KABC::AddressBook::removeAddressee()

Reimplemented from KABC::Resource.

Definition at line 327 of file resourcedir.cpp.

Ticket * ResourceDir::requestSaveTicket ( )

virtual

Request a ticket, you have to pass through save() to allow locking.

The resource has to create its locks in this function.

Implements KABC::Resource.

Definition at line 147 of file resourcedir.cpp.

bool ResourceDir::save ( Ticket *  ticket )

virtual

Saves all addressees synchronously.

Parameters

ticket

You have to release the ticket later with releaseSaveTicket() explicitly.

Returns

Whether the saving was successfully.

Implements KABC::Resource.

Definition at line 251 of file resourcedir.cpp.

void ResourceDir::setFormat

(

const QString &

format

)

Set the format by name.

Definition at line 312 of file resourcedir.cpp.

void ResourceDir::setPath

(

const QString &

path

)

Set path to be used for saving.

Definition at line 295 of file resourcedir.cpp.

void ResourceDir::writeConfig ( KConfigGroup &  group )

virtual

Writes the resource specific config to file.

Parameters

group

The config section to write into

Reimplemented from KABC::Resource.

Definition at line 134 of file resourcedir.cpp.

---

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

• resourcedir.h
• resourcedir.cpp