KPeople::AllContactsMonitor Class Reference

#include <allcontactsmonitor.h>

Inheritance diagram for KPeople::AllContactsMonitor:

Signals
void	contactAdded (const QString &contactUri, const KPeople::AbstractContact::Ptr &contact)
void	contactChanged (const QString &contactUri, const KPeople::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
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Protected Slots
void	emitInitialFetchComplete (bool success)

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
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)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

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

Since

5.8

Definition at line 28 of file allcontactsmonitor.h.

Constructor & Destructor Documentation

AllContactsMonitor()

AllContactsMonitor::AllContactsMonitor ( )

explicit

Definition at line 22 of file allcontactsmonitor.cpp.

~AllContactsMonitor()

AllContactsMonitor::~AllContactsMonitor ( )

override

Definition at line 27 of file allcontactsmonitor.cpp.

Member Function Documentation

contactAdded

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

signal

DataSources should emit this whenever a contact is added.

contactChanged

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

signal

DataSources should emit this whenever a known contact changes.

contactRemoved

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.

contacts()

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

virtual

Returns all currently loaded contacts.

Definition at line 32 of file allcontactsmonitor.cpp.

emitInitialFetchComplete

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 47 of file allcontactsmonitor.cpp.

initialFetchComplete

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

success

True when the fetch was successful, False when an error occurred.

initialFetchSuccess()

bool AllContactsMonitor::initialFetchSuccess

(

)

const

Definition at line 42 of file allcontactsmonitor.cpp.

isInitialFetchComplete()

bool AllContactsMonitor::isInitialFetchComplete

(

)

const

Definition at line 37 of file allcontactsmonitor.cpp.

---

The documentation for this class was generated from the following files:

• allcontactsmonitor.h
• allcontactsmonitor.cpp