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

kabc

  • KABC
  • ResourceABC
Public Slots | Signals | Public Member Functions | List of all members
KABC::ResourceABC Class Referenceabstract

#include <resourceabc.h>

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

Public Slots

virtual void setSubresourceActive (const QString &subResource, bool active)=0
 
virtual void setSubresourceCompletionWeight (const QString &subResource, int weight)=0
 

Signals

void signalSubresourceAdded (KABC::ResourceABC *, const QString &type, const QString &subResource)
 
void signalSubresourceChanged (KABC::ResourceABC *, const QString &type, const QString &subResource)
 
void signalSubresourceRemoved (KABC::ResourceABC *, const QString &type, const QString &subResource)
 
- 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)
 

Public Member Functions

 ResourceABC (const KConfigGroup &group)
 
virtual bool subresourceActive (const QString &) const
 
virtual int subresourceCompletionWeight (const QString &subResource) const =0
 
virtual QString subresourceLabel (const QString &subResource) const =0
 
virtual QStringList subresources () const
 
virtual bool subresourceWritable (const QString &) const =0
 
virtual QMap< QString, QString > uidToResourceMap () const =0
 
- 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 bool asyncLoad ()
 
virtual bool asyncSave (Ticket *ticket)
 
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 bool load ()=0
 
virtual void releaseSaveTicket (Ticket *ticket)=0
 
virtual void removeAddressee (const Addressee &addr)
 
virtual void removeDistributionList (DistributionList *list)
 
virtual Ticket * requestSaveTicket ()=0
 
virtual bool save (Ticket *ticket)=0
 
void setAddressBook (AddressBook *addr)
 
virtual void writeConfig (KConfigGroup &group)
 
- 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
 

Additional Inherited Members

- 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)
 
- Protected Member Functions inherited from KABC::Resource
Ticket * createTicket (Resource *)
 
- Protected Member Functions inherited from KRES::Resource
virtual void doClose ()
 
virtual bool doOpen ()
 
- 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)
 
- 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

This class is the implementation of subfolder resources for KABC.

More methods will be added to give KAddressBook the possibility to handle subresources.

Definition at line 41 of file resourceabc.h.

Member Function Documentation

virtual void KABC::ResourceABC::setSubresourceActive ( const QString &  subResource,
bool  active 
)
pure virtualslot

(De-)activate a subresource.

virtual void KABC::ResourceABC::setSubresourceCompletionWeight ( const QString &  subResource,
int  weight 
)
pure virtualslot

Set completion weight for a given subresource.

void KABC::ResourceABC::signalSubresourceAdded ( KABC::ResourceABC *  ,
const QString &  type,
const QString &  subResource 
)
signal

This signal is emitted when a subresource is added.

void KABC::ResourceABC::signalSubresourceChanged ( KABC::ResourceABC *  ,
const QString &  type,
const QString &  subResource 
)
signal

This signal is emitted when subresource properties have changed.

void KABC::ResourceABC::signalSubresourceRemoved ( KABC::ResourceABC *  ,
const QString &  type,
const QString &  subResource 
)
signal

This signal is emitted when a subresource is removed.

bool ResourceABC::subresourceActive ( const QString &  subResource) const
virtual

Is this subresource active or not?

Definition at line 45 of file resourceabc.cpp.

virtual int KABC::ResourceABC::subresourceCompletionWeight ( const QString &  subResource) const
pure virtual

Completion weight for a given subresource.

virtual QString KABC::ResourceABC::subresourceLabel ( const QString &  subResource) const
pure virtual

Label for a given subresource.

QStringList ResourceABC::subresources ( ) const
virtual

If this resource has subresources, return a QStringList of them.

In most cases, resources do not have subresources, so this is by default just empty.

Definition at line 40 of file resourceabc.cpp.

virtual bool KABC::ResourceABC::subresourceWritable ( const QString &  ) const
pure virtual

Is the given subresource writable?

virtual QMap<QString, QString> KABC::ResourceABC::uidToResourceMap ( ) const
pure virtual

Get the UID to subresource map.

This is necessary to implement the search order. The returned map has the UID as key and the resource it's in as the data.


The documentation for this class was generated from the following files:
  • resourceabc.h
  • resourceabc.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