• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 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:
KABC::Resource KRES::Resource

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 Iterator begin ()
 
virtual ConstIterator begin () const
 
virtual void clear ()
 
ConstIterator constBegin () const
 
ConstIterator constEnd () const
 
virtual Iterator end ()
 
virtual ConstIterator end () const
 
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
 
virtual void writeConfig (KConfigGroup &group)
 

Additional Inherited Members

- Protected Member Functions inherited from KABC::Resource
Ticket * createTicket (Resource *)
 
- Protected Member Functions inherited from KRES::Resource
virtual void doClose ()
 
virtual bool doOpen ()
 
- Protected Attributes inherited from KABC::Resource
Addressee::Map mAddrMap
 
DistributionListMap mDistListMap
 

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.

Constructor & Destructor Documentation

◆ ResourceABC() [1/2]

ResourceABC::ResourceABC ( )

Definition at line 26 of file resourceabc.cpp.

◆ ResourceABC() [2/2]

ResourceABC::ResourceABC ( const KConfigGroup &  group)

Definition at line 31 of file resourceabc.cpp.

◆ ~ResourceABC()

ResourceABC::~ResourceABC ( )
virtual

Definition at line 36 of file resourceabc.cpp.

Member Function Documentation

◆ setSubresourceActive

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

(De-)activate a subresource.

◆ setSubresourceCompletionWeight

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

Set completion weight for a given subresource.

◆ signalSubresourceAdded

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

This signal is emitted when a subresource is added.

◆ signalSubresourceChanged

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

This signal is emitted when subresource properties have changed.

◆ signalSubresourceRemoved

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

This signal is emitted when a subresource is removed.

◆ subresourceActive()

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

Is this subresource active or not?

Definition at line 45 of file resourceabc.cpp.

◆ subresourceCompletionWeight()

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

Completion weight for a given subresource.

◆ subresourceLabel()

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

Label for a given subresource.

◆ subresources()

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.

◆ subresourceWritable()

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

Is the given subresource writable?

◆ uidToResourceMap()

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-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 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.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 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
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