kabc
KABC::ResourceNet Class Reference
#include <resourcenet.h>

Public Member Functions | |
ResourceNet (const KUrl &url, const QString &format) | |
ResourceNet (const KConfigGroup &group) | |
virtual bool | asyncLoad () |
virtual bool | asyncSave (Ticket *ticket) |
virtual void | doClose () |
virtual bool | doOpen () |
QString | format () const |
virtual bool | load () |
virtual void | releaseSaveTicket (Ticket *ticket) |
virtual Ticket * | requestSaveTicket () |
virtual bool | save (Ticket *ticket) |
void | setFormat (const QString &name) |
void | setUrl (const KUrl &url) |
KUrl | url () const |
virtual void | writeConfig (KConfigGroup &group) |
Protected Member Functions | |
void | init (const KUrl &url, const QString &format) |
Detailed Description
For internal use only.
Definition at line 39 of file resourcenet.h.
Member Function Documentation
bool 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.
Definition at line 173 of file resourcenet.cpp.
bool 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() explicitly.
- Returns:
- Whether the saving was successfully.
Reimplemented from KABC::Resource.
Definition at line 260 of file resourcenet.cpp.
QString ResourceNet::format | ( | ) | const |
Returns the format name.
Definition at line 345 of file resourcenet.cpp.
bool ResourceNet::load | ( | ) | [virtual] |
Loads all addressees synchronously.
- Returns:
- Whether the loading was successfully.
Implements KABC::Resource.
Definition at line 141 of file resourcenet.cpp.
void ResourceNet::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 127 of file resourcenet.cpp.
Ticket * 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.
Definition at line 120 of file resourcenet.cpp.
bool ResourceNet::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 230 of file resourcenet.cpp.
void ResourceNet::setFormat | ( | const QString & | name | ) |
Sets a new format by name.
Definition at line 334 of file resourcenet.cpp.
void ResourceNet::setUrl | ( | const KUrl & | url | ) |
Set url of directory to be used for saving.
Definition at line 324 of file resourcenet.cpp.
KUrl ResourceNet::url | ( | ) | const |
Return url of directory used for loading and saving the address book.
Definition at line 329 of file resourcenet.cpp.
void ResourceNet::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 112 of file resourcenet.cpp.
The documentation for this class was generated from the following files: