KABC::ResourceNet Class Reference

Inheritance diagram for KABC::ResourceNet:

KABC::Resource List of all members.

Detailed Description

Definition at line 45 of file resourcenet.h.


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 *ticket)
virtual bool asyncSave (Ticket *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)

Member Function Documentation

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::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() explicitely.
Returns:
Whether the saving was successfully.

Reimplemented from KABC::Resource.

QString KABC::ResourceNet::format (  )  const

Returns the format name.

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

Loads all addressees synchronously.

Returns:
Whether the loading was successfully.

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 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 bool KABC::ResourceNet::save ( Ticket 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.

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

Sets a new format by name.

void KABC::ResourceNet::setUrl ( const KURL  ) 

Set url of directory to be used for saving.

KURL KABC::ResourceNet::url (  )  const

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

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

Writes the resource specific config to file.

Reimplemented from KABC::Resource.


The documentation for this class was generated from the following file:
KDE Home | KDE Accessibility Home | Description of Access Keys