• Skip to content
  • Skip to link menu
KDE API Documentation - KPeople::AllContactsMonitor Class Reference (KPeople)
  • KDE Home
  • Contact Us
 

KPeople

  • View on LXR
  • Comments
  • KPeople
  • AllContactsMonitor
Signals | Public Member Functions | Protected Slots | List of all members
KPeople::AllContactsMonitor Class Reference

#include <allcontactsmonitor.h>

Inherits QObject.

Inherited by AkonadiAllContacts.

Signals

void contactAdded (const QString &contactUri, const AbstractContact::Ptr &contact)
 
void contactChanged (const QString &contactUri, const AbstractContact::Ptr &contact)
 
void contactRemoved (const QString &contactUri)
 
void initialFetchComplete (bool success)
 

Public Member Functions

virtual QMap< QString, AbstractContact::Ptr > contacts ()
 
bool initialFetchSuccess () const
 
bool isInitialFetchComplete () const
 

Protected Slots

void emitInitialFetchComplete (bool success)
 

Detailed Description

This class should be subclassed by each datasource and return a list of all contacts that the datasource knows about.

Subclasses are expected to be asynchronous

Definition at line 43 of file allcontactsmonitor.h.

Member Function Documentation

void KPeople::AllContactsMonitor::contactAdded ( const QString &  contactUri,
const AbstractContact::Ptr &  contact 
)
signal

DataSources should emit this whenever a contact is added.

void KPeople::AllContactsMonitor::contactChanged ( const QString &  contactUri,
const AbstractContact::Ptr &  contact 
)
signal

DataSources should emit this whenever a known contact changes.

void KPeople::AllContactsMonitor::contactRemoved ( const QString &  contactUri)
signal

DataSources should emit this whenever a contact is removed and they are no longer able to supply up-to-date data on a contact.

QMap< QString, AbstractContact::Ptr > AllContactsMonitor::contacts ( )
virtual

Returns all currently loaded contacts.

Definition at line 51 of file allcontactsmonitor.cpp.

void AllContactsMonitor::emitInitialFetchComplete ( bool  success)
protectedslot

DataSources should call this once they have finished initial retrieval of all contacts from their storage.

This will emit initialFetchComplete() signal

success Whether the fetch was successful.

Definition at line 66 of file allcontactsmonitor.cpp.

void KPeople::AllContactsMonitor::initialFetchComplete ( bool  success)
signal

Notifies that the DataSource has completed it's initial fetch.

Warning
DataSources should use emitInitialFetchComplete() instead of emitting this signal directly.
Parameters
successTrue when the fetch was successful, False when an error occurred.

The documentation for this class was generated from the following files:
  • allcontactsmonitor.h
  • allcontactsmonitor.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2015 The KDE developers.
Generated on Fri Feb 13 2015 15:16:39 by doxygen 1.8.9.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KPeople

Skip menu "KPeople"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • File List

Class Picker

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