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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Mobility Components.
**
** $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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QCONTACTMANAGER_H
#define QCONTACTMANAGER_H
#include <QObject>
#include <QMap>
#include <QString>
#include <QStringList>
#include <QList>
#include <QDateTime>
#include "qtcontactsglobal.h"
#include "qcontact.h"
#include "qcontactid.h"
#include "qcontactrelationship.h"
#include "qcontactsortorder.h"
#include "qcontactfetchhint.h"
#include "qcontacttype.h"
QTM_BEGIN_NAMESPACE
class QContactFilter;
class QContactAction;
class QContactManagerData;
class Q_CONTACTS_EXPORT QContactManager : public QObject
{
Q_OBJECT
public:
#if 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 = 0);
QContactManager(const QString& managerName, int implementationVersion, const QMap<QString, QString>& parameters = 0, QObject* parent = 0);
#else
explicit QContactManager(const QString& managerName = QString(), const QMap<QString, QString>& parameters = (QMap<QString, QString>()), QObject* parent = 0);
QContactManager(const QString& managerName, int implementationVersion, const QMap<QString, QString>& parameters = (QMap<QString, QString>()), QObject* parent = 0);
#endif
explicit QContactManager(QObject* parent);
#if Q_QDOC
static const QLatin1Constant ParameterSignalSources;
static const QLatin1Constant ParameterSignalDefinitions;
static const QLatin1Constant ParameterValueOnlyOtherProcesses;
static const QLatin1Constant ParameterValueOnlyOtherManagers;
#else
Q_DECLARE_LATIN1_CONSTANT(ParameterSignalSources, "SignalSources");
Q_DECLARE_LATIN1_CONSTANT(ParameterSignalDefinitions, "SignalDefinitions");
Q_DECLARE_LATIN1_CONSTANT(ParameterValueOnlyOtherProcesses, "OnlyOtherProcesses");
Q_DECLARE_LATIN1_CONSTANT(ParameterValueOnlyOtherManagers, "OnlyOtherManagers");
#endif
static QContactManager* fromUri(const QString& uri, QObject* parent = 0);
~QContactManager(); // dtor
QString managerName() const; // e.g. "Symbian"
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>& params, int implementationVersion = -1);
enum Error {
NoError = 0,
DoesNotExistError,
AlreadyExistsError,
InvalidDetailError,
InvalidRelationshipError,
LockedError,
DetailAccessError,
PermissionsError,
OutOfMemoryError,
NotSupportedError,
BadArgumentError,
UnspecifiedError,
VersionMismatchError,
LimitReachedError,
InvalidContactTypeError,
TimeoutError
};
/* Error reporting */
QContactManager::Error error() const;
QMap<int, QContactManager::Error> errorMap() const;
/* Contacts - Accessors and Mutators */
QList<QContactLocalId> contactIds(const QList<QContactSortOrder>& sortOrders = QList<QContactSortOrder>()) const;
QList<QContactLocalId> 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<QContactLocalId>& localIds, const QContactFetchHint& fetchHint = QContactFetchHint(), QMap<int, QContactManager::Error>* errorMap = 0) const;
QContact contact(const QContactLocalId& contactId, const QContactFetchHint& fetchHint = QContactFetchHint()) const; // retrieve a contact
bool saveContact(QContact* contact); // note: MODIFIES contact (sets the contactId)
bool removeContact(const QContactLocalId& contactId); // remove the contact from the persistent store
bool saveContacts(QList<QContact>* contacts, QMap<int, QContactManager::Error>* errorMap = 0); // batch API - save.
bool saveContacts(QList<QContact>* contacts, const QStringList& definitionMask, QMap<int, QContactManager::Error>* errorMap = 0); // Partial save
bool removeContacts(const QList<QContactLocalId>& contactIds, QMap<int, QContactManager::Error>* errorMap = 0); // batch API - remove.
/* Return a pruned or modified contact which is valid and can be saved in the manager */
QContact compatibleContact(const QContact& original);
/* Synthesize the display label of a contact */
QString synthesizedContactDisplayLabel(const QContact& contact) const;
void synthesizeContactDisplayLabel(QContact* contact) const;
/* "Self" contact id (MyCard) */
bool setSelfContactId(const QContactLocalId& contactId);
QContactLocalId 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 = 0);
bool removeRelationship(const QContactRelationship& relationship);
bool removeRelationships(const QList<QContactRelationship>& relationships, QMap<int, QContactManager::Error>* errorMap = 0);
/* Definitions - Accessors and Mutators */
QMap<QString, QContactDetailDefinition> detailDefinitions(const QString& contactType = QContactType::TypeContact) const;
QContactDetailDefinition detailDefinition(const QString& definitionName, const QString& contactType = QContactType::TypeContact) const;
bool saveDetailDefinition(const QContactDetailDefinition& def, const QString& contactType = QContactType::TypeContact);
bool removeDetailDefinition(const QString& definitionName, const QString& contactType = QContactType::TypeContact);
/* Functionality reporting */
enum ManagerFeature {
Groups = 0, // backend supports QContactType::TypeGroup type contacts (convenience for clients)
ActionPreferences, // per-contact action preferences
MutableDefinitions,
Relationships,
ArbitraryRelationshipTypes,
DetailOrdering,
SelfContact,
Anonymous,
ChangeLogs
};
bool hasFeature(QContactManager::ManagerFeature feature, const QString& contactType = QContactType::TypeContact) const;
bool isRelationshipTypeSupported(const QString& relationshipType, const QString& contactType = QContactType::TypeContact) const;
QList<QVariant::Type> supportedDataTypes() const;
bool isFilterSupported(const QContactFilter& filter) const;
QStringList supportedContactTypes() const;
/* return a list of available backends for which a QContactManager can be constructed. */
static QStringList availableManagers();
Q_SIGNALS:
void dataChanged();
void contactsAdded(const QList<QContactLocalId>& contactIds);
void contactsChanged(const QList<QContactLocalId>& contactIds);
void contactsRemoved(const QList<QContactLocalId>& contactIds);
void relationshipsAdded(const QList<QContactLocalId>& affectedContactIds);
void relationshipsRemoved(const QList<QContactLocalId>& affectedContactIds);
void selfContactIdChanged(const QContactLocalId& oldId, const QContactLocalId& newId); // need both? or just new?
protected:
void connectNotify(const char *signal);
void disconnectNotify(const char *signal);
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<QContactLocalId>& ids))
Q_PRIVATE_SLOT(d, void _q_contactsDeleted(const QList<QContactLocalId>& ids))
// private data pointer
QContactManagerData* d;
};
QTM_END_NAMESPACE
#endif
|
