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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtContacts module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QCONTACTMANAGERENGINE_H
#define QCONTACTMANAGERENGINE_H
#include <QtCore/qdatetime.h>
#include <QtCore/qmap.h>
#include <QtCore/qobject.h>
#include <QtCore/qstringlist.h>
#include <QtCore/qvariant.h>
#include <QtContacts/qcontact.h>
#include <QtContacts/qcontactabstractrequest.h>
#include <QtContacts/qcontactfetchhint.h>
#include <QtContacts/qcontactfilter.h>
#include <QtContacts/qcontactid.h>
#include <QtContacts/qcontactmanager.h>
#include <QtContacts/qcontactrequests.h>
#include <QtContacts/qcontactsortorder.h>
#include <QtContacts/qcontactcollectionfetchrequest.h>
#include <QtContacts/qcontactcollectionsaverequest.h>
#include <QtContacts/qcontactcollectionremoverequest.h>
QT_BEGIN_NAMESPACE_CONTACTS
class Q_CONTACTS_EXPORT QContactManagerEngine : public QObject
{
Q_OBJECT
public:
QContactManagerEngine() {}
/* URI reporting */
virtual QString managerName() const = 0; // e.g. "memory"
virtual QMap<QString, QString> managerParameters() const; // e.g. "filename=private.db,cachesize=1024"
virtual QMap<QString, QString> idInterpretationParameters() const; // e.g. "filename=private.db"
virtual int managerVersion() const = 0;
inline QString managerUri() const
{ if (m_uri.isNull()) m_uri = QContactManager::buildUri(managerName(), idInterpretationParameters()); return m_uri; }
inline QContactId contactId(const QByteArray &localId) const
{ return QContactId(managerUri(), localId); }
inline QContactCollectionId collectionId(const QByteArray &localId) const
{ return QContactCollectionId(managerUri(), localId); }
/* Filtering */
virtual QList<QContactId> contactIds(const QContactFilter &filter, const QList<QContactSortOrder> &sortOrders, QContactManager::Error *error) const;
virtual QList<QContact> contacts(const QContactFilter &filter, const QList<QContactSortOrder>& sortOrders, const QContactFetchHint &fetchHint, QContactManager::Error *error) const;
virtual QList<QContact> contacts(const QList<QContactId> &contactIds, const QContactFetchHint& fetchHint, QMap<int, QContactManager::Error> *errorMap, QContactManager::Error *error) const;
virtual QContact contact(const QContactId &contactId, const QContactFetchHint &fetchHint, QContactManager::Error *error) const;
virtual bool saveContact(QContact *contact, QContactManager::Error *error);
virtual bool removeContact(const QContactId &contactId, QContactManager::Error *error);
virtual bool saveRelationship(QContactRelationship *relationship, QContactManager::Error *error);
virtual bool removeRelationship(const QContactRelationship &relationship, QContactManager::Error *error);
virtual bool saveContacts(QList<QContact> *contacts, QMap<int, QContactManager::Error> *errorMap, QContactManager::Error *error);
virtual bool saveContacts(QList<QContact> *contacts, const QList<QContactDetail::DetailType> &typeMask, QMap<int, QContactManager::Error> *errorMap, QContactManager::Error *error);
virtual bool removeContacts(const QList<QContactId> &contactIds, QMap<int, QContactManager::Error> *errorMap, QContactManager::Error *error);
/* "Self" contact id (MyCard) */
virtual bool setSelfContactId(const QContactId &contactId, QContactManager::Error *error);
virtual QContactId selfContactId(QContactManager::Error *error) const;
/* Relationships between contacts */
virtual QList<QContactRelationship> relationships(const QString &relationshipType, const QContactId& participantId, QContactRelationship::Role role, QContactManager::Error *error) const;
virtual bool saveRelationships(QList<QContactRelationship> *relationships, QMap<int, QContactManager::Error>* errorMap, QContactManager::Error *error);
virtual bool removeRelationships(const QList<QContactRelationship> &relationships, QMap<int, QContactManager::Error> *errorMap, QContactManager::Error *error);
// collections
virtual QContactCollectionId defaultCollectionId() const;
virtual QContactCollection collection(const QContactCollectionId &collectionId, QContactManager::Error *error) const;
virtual QList<QContactCollection> collections(QContactManager::Error *error) const;
virtual bool saveCollection(QContactCollection *collection, QContactManager::Error *error);
virtual bool removeCollection(const QContactCollectionId &collectionId, QContactManager::Error *error);
/* Validation for saving */
virtual bool validateContact(const QContact &contact, QContactManager::Error *error) const;
/* Asynchronous Request Support */
virtual void requestDestroyed(QContactAbstractRequest *req);
virtual bool startRequest(QContactAbstractRequest *req);
virtual bool cancelRequest(QContactAbstractRequest *req);
virtual bool waitForRequestFinished(QContactAbstractRequest *req, int msecs);
/* Capabilities reporting */
virtual bool isRelationshipTypeSupported(const QString &relationshipType, QContactType::TypeValues contactType) const;
virtual bool isFilterSupported(const QContactFilter &filter) const;
virtual QList<QMetaType::Type> supportedDataTypes() const;
virtual QList<QContactType::TypeValues> supportedContactTypes() const;
virtual QList<QContactDetail::DetailType> supportedContactDetailTypes() const;
Q_SIGNALS:
void dataChanged();
void contactsAdded(const QList<QContactId> &contactIds);
void contactsChanged(const QList<QContactId> &contactIds, const QList<QContactDetail::DetailType> &typesChanged);
void contactsRemoved(const QList<QContactId> &contactIds);
void relationshipsAdded(const QList<QContactId> &affectedContactIds);
void relationshipsRemoved(const QList<QContactId> &affectedContactIds);
void selfContactIdChanged(const QContactId &oldId, const QContactId &newId);
void collectionsAdded(const QList<QContactCollectionId> &collectionIds);
void collectionsChanged(const QList<QContactCollectionId> &collectionIds);
void collectionsRemoved(const QList<QContactCollectionId> &collectionIds);
void collectionsModified(const QList<QPair<QContactCollectionId, QContactManager::Operation> > &collectionIds);
public:
// Async update functions
static void updateRequestState(QContactAbstractRequest *req, QContactAbstractRequest::State state);
static void updateContactIdFetchRequest(QContactIdFetchRequest *req, const QList<QContactId>& result, QContactManager::Error error, QContactAbstractRequest::State);
static void updateContactFetchRequest(QContactFetchRequest *req, const QList<QContact> &result, QContactManager::Error error, QContactAbstractRequest::State);
static void updateContactFetchByIdRequest(QContactFetchByIdRequest *req, const QList<QContact>& result, QContactManager::Error error, const QMap<int, QContactManager::Error> &errorMap, QContactAbstractRequest::State);
static void updateContactRemoveRequest(QContactRemoveRequest *req, QContactManager::Error error, const QMap<int, QContactManager::Error> &errorMap, QContactAbstractRequest::State);
static void updateContactSaveRequest(QContactSaveRequest *req, const QList<QContact> &result, QContactManager::Error error, const QMap<int, QContactManager::Error> &errorMap, QContactAbstractRequest::State);
static void updateRelationshipSaveRequest(QContactRelationshipSaveRequest *req, const QList<QContactRelationship> &result, QContactManager::Error error, const QMap<int, QContactManager::Error> &errorMap, QContactAbstractRequest::State);
static void updateRelationshipRemoveRequest(QContactRelationshipRemoveRequest *req, QContactManager::Error error, const QMap<int, QContactManager::Error> &errorMap, QContactAbstractRequest::State);
static void updateRelationshipFetchRequest(QContactRelationshipFetchRequest *req, const QList<QContactRelationship> &result, QContactManager::Error error, QContactAbstractRequest::State);
// collections
static void updateCollectionFetchRequest(QContactCollectionFetchRequest *request, const QList<QContactCollection> &result, QContactManager::Error error, QContactAbstractRequest::State newState);
static void updateCollectionRemoveRequest(QContactCollectionRemoveRequest *request, QContactManager::Error error, const QMap<int, QContactManager::Error> &errorMap, QContactAbstractRequest::State newState);
static void updateCollectionSaveRequest(QContactCollectionSaveRequest *request, const QList<QContactCollection> &result, QContactManager::Error error, const QMap<int, QContactManager::Error> &errorMap, QContactAbstractRequest::State newState);
// Other protected area update functions
static void setDetailAccessConstraints(QContactDetail *detail, QContactDetail::AccessConstraints constraints);
static void setContactRelationships(QContact *contact, const QList<QContactRelationship> &relationships);
static void setDetailProvenance(QContactDetail *detail, const QString &provenance);
/* Helper functions */
static int compareContact(const QContact &a, const QContact &b, const QList<QContactSortOrder> &sortOrders);
static void addSorted(QList<QContact>* sorted, const QContact &toAdd, const QList<QContactSortOrder> &sortOrders);
static int compareVariant(const QVariant &first, const QVariant &second, Qt::CaseSensitivity sensitivity);
static bool testFilter(const QContactFilter& filter, const QContact &contact);
static QList<QContactId> sortContacts(const QList<QContact> &contacts, const QList<QContactSortOrder> &sortOrders);
static QContactFilter canonicalizedFilter(const QContactFilter &filter);
private:
/* QContactChangeSet is a utility class used to emit the appropriate signals */
friend class QContactChangeSet;
mutable QString m_uri;
};
QT_END_NAMESPACE_CONTACTS
QT_BEGIN_NAMESPACE
Q_DECLARE_INTERFACE(QtContacts::QContactManagerEngine, "org.qt-project.Qt.QContactManagerEngine")
QT_END_NAMESPACE
#endif // QCONTACTMANAGERENGINE_H
|
