• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.8.3 API Reference
  • KDE Home
  • Contact Us
 

kabc

  • KABC
  • ResourceDir
Public Member Functions
KABC::ResourceDir Class Reference

#include <resourcedir.h>

Inheritance diagram for KABC::ResourceDir:
Inheritance graph
[legend]

List of all members.

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)

Detailed Description

Definition at line 35 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:
ticketYou 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:
ticketthe 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:
addrThe 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:
ticketYou 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:
groupThe 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
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Thu May 10 2012 22:20:27 by doxygen 1.8.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kabc

Skip menu "kabc"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.8.3 API Reference

Skip menu "kdepimlibs-4.8.3 API Reference"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal