/usr/include/KF5/KPeople/kpeoplebackend/allcontactsmonitor.h is in libkf5people-dev 5.44.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 | /*
* Copyright (C) 2013 David Edmundson <davidedmundson@kde.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifndef ALLCONTACTSMONITOR_H
#define ALLCONTACTSMONITOR_H
#include <QObject>
#include <QSharedPointer>
#include <kpeoplebackend/kpeoplebackend_export.h>
#include <kpeoplebackend/abstractcontact.h>
namespace KPeople
{
class AllContactsMonitorPrivate;
/**
* 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
*/
class KPEOPLEBACKEND_EXPORT AllContactsMonitor : public QObject
{
Q_OBJECT
public:
explicit AllContactsMonitor(); //TODO make protected? this isn't useful unless subclassed
virtual ~AllContactsMonitor();
/**
* Returns all currently loaded contacts
*/
virtual QMap<QString, AbstractContact::Ptr> contacts();
//TODO redo as a state enum - InitialLoad, Fail, Loaded
bool isInitialFetchComplete() const;
bool initialFetchSuccess() const;
Q_SIGNALS:
/**
* DataSources should emit this whenever a known contact changes
*/
void contactChanged(const QString &contactUri, const AbstractContact::Ptr &contact);
/**
* DataSources should emit this whenever a contact is added
*/
void contactAdded(const QString &contactUri, const AbstractContact::Ptr &contact);
/**
* DataSources should emit this whenever a contact is removed and they are no longer able to supply up-to-date data on a contact
*/
void contactRemoved(const QString &contactUri);
/**
* Notifies that the DataSource has completed it's initial fetch.
*
* @warning DataSources should use emitInitialFetchComplete() instead of emitting this signal
* directly.
*
* @param success True when the fetch was successful, False when an error occurred.
*/
void initialFetchComplete(bool success);
protected Q_SLOTS:
/**
* DataSources should call this once they have finished initial retrieval of all contacts from their
* storage.
*
* This will emit initialFetchComplete() signal
*
* @p success Whether the fetch was successful.
*/
void emitInitialFetchComplete(bool success);
private:
Q_DISABLE_COPY(AllContactsMonitor)
Q_DECLARE_PRIVATE(AllContactsMonitor)
AllContactsMonitorPrivate *d_ptr;
};
}
typedef QSharedPointer<KPeople::AllContactsMonitor> AllContactsMonitorPtr;
#endif // ALLCONTACTSMONITOR_H
|