kabc Library API Documentation

KABC::ResourceNet Class Reference

Inheritance diagram for KABC::ResourceNet:

Inheritance graph
[legend]
Collaboration diagram for KABC::ResourceNet:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ResourceNet (const KConfig *)
 ResourceNet (const KURL &url, const QString &format)
virtual void writeConfig (KConfig *)
virtual bool doOpen ()
virtual void doClose ()
virtual TicketrequestSaveTicket ()
virtual void releaseSaveTicket (Ticket *)
virtual bool load ()
virtual bool asyncLoad ()
virtual bool save (Ticket *)
virtual bool asyncSave (Ticket *)
void setUrl (const KURL &)
KURL url () const
void setFormat (const QString &name)
QString format () const

Protected Member Functions

void init (const KURL &url, const QString &format)

Detailed Description

Definition at line 44 of file resourcenet.h.


Member Function Documentation

virtual void KABC::ResourceNet::writeConfig KConfig  )  [virtual]
 

Writes the resource specific config to file.

Reimplemented from KABC::Resource.

virtual Ticket* KABC::ResourceNet::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.

virtual void KABC::ResourceNet::releaseSaveTicket 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.

Implements KABC::Resource.

virtual bool KABC::ResourceNet::load  )  [virtual]
 

Loads all addressees synchronously.

Returns:
Whether the loading was successfully.

Implements KABC::Resource.

virtual bool KABC::ResourceNet::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.

virtual bool KABC::ResourceNet::save Ticket  )  [virtual]
 

Saves all addressees synchronously.

Parameters:
ticket You have to release the ticket later with releaseSaveTicket() explicitely.
Returns:
Whether the saving was successfully.

Implements KABC::Resource.

virtual bool KABC::ResourceNet::asyncSave 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() explicitely.
Returns:
Whether the saving was successfully.

Reimplemented from KABC::Resource.

void KABC::ResourceNet::setUrl const KURL  ) 
 

Set url of directory to be used for saving.

Referenced by KABC::ResourceNetConfig::saveSettings().

KURL KABC::ResourceNet::url  )  const
 

Return url of directory used for loading and saving the address book.

Referenced by KABC::ResourceNetConfig::loadSettings().

void KABC::ResourceNet::setFormat const QString name  ) 
 

Sets a new format by name.

Referenced by KABC::ResourceNetConfig::saveSettings().

QString KABC::ResourceNet::format  )  const
 

Returns the format name.

Referenced by KABC::ResourceNetConfig::loadSettings().


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for kabc Library Version 3.4.3.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sun Oct 9 08:07:01 2005 by doxygen 1.4.4 written by Dimitri van Heesch, © 1997-2003