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
190
191
192
193
194
195
196
197
198
199
200
|
/****************************************************************************
**
** 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 QCONTACTMANAGER_H
#define QCONTACTMANAGER_H
#include <QtCore/qmap.h>
#include <QtCore/qobject.h>
#include <QtCore/qstringlist.h>
#include <QtContacts/qcontact.h>
#include <QtContacts/qcontactcollection.h>
#include <QtContacts/qcontactid.h>
#include <QtContacts/qcontactfetchhint.h>
#include <QtContacts/qcontactrelationship.h>
#include <QtContacts/qcontactsortorder.h>
#include <QtContacts/qcontacttype.h>
QT_BEGIN_NAMESPACE_CONTACTS
class QContactAction;
class QContactFilter;
class QContactManagerData;
class Q_CONTACTS_EXPORT QContactManager : public QObject
{
Q_OBJECT
public:
#ifdef Q_QDOC // qdoc's parser fails to recognise the default map argument
explicit QContactManager(const QString& managerName = QString(), const QMap<QString, QString>& parameters = 0, QObject* parent = nullptr);
QContactManager(const QString& managerName, int implementationVersion, const QMap<QString, QString>& parameters = 0, QObject* parent = nullptr);
#else
explicit QContactManager(const QString& managerName = QString(), const QMap<QString, QString>& parameters = (QMap<QString, QString>()), QObject* parent = nullptr);
QContactManager(const QString& managerName, int implementationVersion, const QMap<QString, QString>& parameters = (QMap<QString, QString>()), QObject* parent = nullptr);
#endif
explicit QContactManager(QObject* parent);
inline static const QString ParameterSignalSources() {return QStringLiteral("SignalSources");};
inline static const QString ParameterSignalDefinitions() {return QStringLiteral("SignalDefinitions");};
inline static const QString ParameterValueOnlyOtherProcesses() {return QStringLiteral("OnlyOtherProcesses");};
inline static const QString ParameterValueOnlyOtherManagers() {return QStringLiteral("OnlyOtherManagers");};
static QContactManager* fromUri(const QString& uri, QObject* parent = nullptr);
~QContactManager(); // dtor
QString managerName() const; // e.g. "memory"
QMap<QString, QString> managerParameters() const; // e.g. "filename=private.db"
QString managerUri() const; // managerName + managerParameters
int managerVersion() const;
static bool parseUri(const QString &uri, QString *managerName, QMap<QString, QString> *params);
static QString buildUri(const QString &managerName, const QMap<QString, QString> ¶ms);
static QString buildUri(const QString &managerName, const QMap<QString, QString> ¶ms, int implementationVersion);
enum Error {
NoError = 0,
DoesNotExistError,
AlreadyExistsError,
InvalidDetailError,
InvalidRelationshipError,
LockedError,
DetailAccessError,
PermissionsError,
OutOfMemoryError,
NotSupportedError,
BadArgumentError,
UnspecifiedError,
VersionMismatchError,
LimitReachedError,
InvalidContactTypeError,
TimeoutError,
MissingPlatformRequirementsError
};
enum Operation {
Add,
Change,
Remove
};
/* Error reporting */
QContactManager::Error error() const;
QMap<int, QContactManager::Error> errorMap() const;
/* Contacts - Accessors and Mutators */
QList<QContactId> contactIds(const QList<QContactSortOrder>& sortOrders = QList<QContactSortOrder>()) const;
QList<QContactId> contactIds(const QContactFilter& filter, const QList<QContactSortOrder>& sortOrders = QList<QContactSortOrder>()) const;
QList<QContact> contacts(const QList<QContactSortOrder>& sortOrders = QList<QContactSortOrder>(), const QContactFetchHint& fetchHint = QContactFetchHint()) const;
QList<QContact> contacts(const QContactFilter& filter, const QList<QContactSortOrder>& sortOrders = QList<QContactSortOrder>(), const QContactFetchHint& fetchHint = QContactFetchHint()) const;
QList<QContact> contacts(const QList<QContactId>& contactIds, const QContactFetchHint& fetchHint = QContactFetchHint(), QMap<int, QContactManager::Error>* errorMap = nullptr) const;
QContact contact(const QContactId& contactId, const QContactFetchHint& fetchHint = QContactFetchHint()) const; // retrieve a contact
bool saveContact(QContact* contact); // note: MODIFIES contact (sets the contactId)
bool removeContact(const QContactId& contactId); // remove the contact from the persistent store
bool saveContacts(QList<QContact>* contacts, QMap<int, QContactManager::Error>* errorMap = nullptr); // batch API - save.
bool saveContacts(QList<QContact>* contacts, const QList<QContactDetail::DetailType>& typeMask, QMap<int, QContactManager::Error>* errorMap = nullptr); // Partial save
bool removeContacts(const QList<QContactId>& contactIds, QMap<int, QContactManager::Error>* errorMap = nullptr); // batch API - remove.
/* "Self" contact id (MyCard) */
bool setSelfContactId(const QContactId& contactId);
QContactId selfContactId() const;
/* Relationships */
QList<QContactRelationship> relationships(const QContactId& participantId, QContactRelationship::Role role = QContactRelationship::Either) const;
QList<QContactRelationship> relationships(const QString& relationshipType = QString(), const QContactId& participantId = QContactId(), QContactRelationship::Role role = QContactRelationship::Either) const;
bool saveRelationship(QContactRelationship* relationship);
bool saveRelationships(QList<QContactRelationship>* relationships, QMap<int, QContactManager::Error>* errorMap = nullptr);
bool removeRelationship(const QContactRelationship& relationship);
bool removeRelationships(const QList<QContactRelationship>& relationships, QMap<int, QContactManager::Error>* errorMap = nullptr);
/* Capabilities reporting */
bool isRelationshipTypeSupported(const QString& relationshipType, QContactType::TypeValues contactType = QContactType::TypeContact) const;
QList<QMetaType::Type> supportedDataTypes() const;
bool isFilterSupported(const QContactFilter& filter) const;
QList<QContactType::TypeValues> supportedContactTypes() const;
QList<QContactDetail::DetailType> supportedContactDetailTypes() const;
// collections
QContactCollectionId defaultCollectionId() const;
QContactCollection collection(const QContactCollectionId& collectionId) const;
QList<QContactCollection> collections() const;
bool saveCollection(QContactCollection* collection);
bool removeCollection(const QContactCollectionId& collectionId);
/* return a list of available backends for which a QContactManager can be constructed. */
static QStringList availableManagers();
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); // need both? or just new?
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);
protected:
void connectNotify(const QMetaMethod &signal) override;
void disconnectNotify(const QMetaMethod &signal) override;
private:
friend class QContactManagerData;
void createEngine(const QString& managerName, const QMap<QString, QString>& parameters);
Q_DISABLE_COPY(QContactManager)
Q_PRIVATE_SLOT(d, void _q_contactsUpdated(const QList<QContactId>& ids, const QList<QContactDetail::DetailType>& typesChanged))
Q_PRIVATE_SLOT(d, void _q_contactsDeleted(const QList<QContactId>& ids))
// private data pointer
QContactManagerData* d;
};
QT_END_NAMESPACE_CONTACTS
#endif // QCONTACTMANAGER_H
|
