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

kabc

  • KABC
  • ResourceNet
Public Member Functions | Protected Member Functions | List of all members
KABC::ResourceNet Class Reference

#include <resourcenet.h>

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

Public Member Functions

 ResourceNet (const KConfigGroup &group)
 
 ResourceNet (const KUrl &url, const QString &format)
 
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)
 
- 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 removeAddressee (const Addressee &addr)
 
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
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Protected Member Functions

void init (const KUrl &url, const QString &format)
 
- Protected Member Functions inherited from KABC::Resource
Ticket * createTicket (Resource *)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

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)
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Protected Attributes inherited from KABC::Resource
Addressee::Map mAddrMap
 
DistributionListMap mDistListMap
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Definition at line 41 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
ticketYou 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 343 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
ticketthe 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
ticketYou 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
groupThe 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:
  • resourcenet.h
  • resourcenet.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:38:39 by doxygen 1.8.7 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 API Reference

Skip menu "kdepimlibs API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2

Search



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