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
|
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** 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, Nokia gives you certain additional
** rights. These rights are described in the Nokia 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.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QCONTACTMANAGERENGINE_H
#define QCONTACTMANAGERENGINE_H
#include <QSharedData>
#include <QMap>
#include <QList>
#include <QString>
#include <QDateTime>
#include <QVariant>
#include <QObject>
#include "qcontact.h"
#include "qcontactdetaildefinition.h"
#include "qcontactmanager.h"
#include "qcontactabstractrequest.h"
#include "qcontactrequests.h"
#include "qcontactfetchhint.h"
QTM_BEGIN_NAMESPACE
class QContactFilter;
class QContactSortOrder;
class Q_CONTACTS_EXPORT QContactManagerEngine : public QObject
{
Q_OBJECT
public:
QContactManagerEngine() {}
/* URI reporting */
virtual QString managerName() const = 0; // e.g. "Symbian"
virtual QMap<QString, QString> managerParameters() const; // e.g. "filename=private.db"
virtual int managerVersion() const = 0;
/* Default and only implementation of this */
QString managerUri() const;
/* Filtering */
virtual QList<QContactLocalId> 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 QContact contact(const QContactLocalId& contactId, const QContactFetchHint& fetchHint, QContactManager::Error* error) const;
virtual bool saveContact(QContact* contact, QContactManager::Error* error);
virtual bool removeContact(const QContactLocalId& 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 removeContacts(const QList<QContactLocalId>& contactIds, QMap<int, QContactManager::Error>* errorMap, QContactManager::Error* error);
/* Return a pruned or modified contact which is valid and can be saved in the backend */
virtual QContact compatibleContact(const QContact& original, QContactManager::Error* error) const;
/* Synthesize the display label of a contact */
virtual QString synthesizedDisplayLabel(const QContact& contact, QContactManager::Error* error) const;
/* "Self" contact id (MyCard) */
virtual bool setSelfContactId(const QContactLocalId& contactId, QContactManager::Error* error);
virtual QContactLocalId 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);
/* Validation for saving */
virtual bool validateContact(const QContact& contact, QContactManager::Error* error) const;
virtual bool validateDefinition(const QContactDetailDefinition& def, QContactManager::Error* error) const;
/* Definitions - Accessors and Mutators */
virtual QMap<QString, QContactDetailDefinition> detailDefinitions(const QString& contactType, QContactManager::Error* error) const;
virtual QContactDetailDefinition detailDefinition(const QString& definitionId, const QString& contactType, QContactManager::Error* error) const;
virtual bool saveDetailDefinition(const QContactDetailDefinition& def, const QString& contactType, QContactManager::Error* error);
virtual bool removeDetailDefinition(const QString& definitionId, const QString& contactType, QContactManager::Error* error);
/* 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 hasFeature(QContactManager::ManagerFeature feature, const QString& contactType) const;
virtual bool isRelationshipTypeSupported(const QString& relationshipType, const QString& contactType) const;
virtual bool isFilterSupported(const QContactFilter& filter) const;
virtual QList<QVariant::Type> supportedDataTypes() const;
virtual QStringList supportedContactTypes() const;
/* Reports the built-in definitions from the schema */
static QMap<QString, QMap<QString, QContactDetailDefinition> > schemaDefinitions(); // returns version 1 of the schema
static QMap<QString, QMap<QString, QContactDetailDefinition> > schemaDefinitions(int schemaVersion); // returns schema of the specified version
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);
public:
// Async update functions
static void updateRequestState(QContactAbstractRequest* req, QContactAbstractRequest::State state);
static void updateContactLocalIdFetchRequest(QContactLocalIdFetchRequest* req, const QList<QContactLocalId>& result, QContactManager::Error error, QContactAbstractRequest::State);
static void updateContactFetchRequest(QContactFetchRequest* req, const QList<QContact>& result, QContactManager::Error error, 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 updateDefinitionSaveRequest(QContactDetailDefinitionSaveRequest* req, const QList<QContactDetailDefinition>& result, QContactManager::Error error, const QMap<int, QContactManager::Error>& errorMap, QContactAbstractRequest::State);
static void updateDefinitionRemoveRequest(QContactDetailDefinitionRemoveRequest* req, QContactManager::Error error, const QMap<int, QContactManager::Error>& errorMap, QContactAbstractRequest::State);
static void updateDefinitionFetchRequest(QContactDetailDefinitionFetchRequest* req, const QMap<QString, QContactDetailDefinition>& 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);
// Other protected area update functions
static void setDetailAccessConstraints(QContactDetail* detail, QContactDetail::AccessConstraints constraints);
static void setContactDisplayLabel(QContact* contact, const QString& displayLabel);
static void setContactRelationships(QContact* contact, const QList<QContactRelationship>& relationships);
/* 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<QContactLocalId> 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;
};
class QContactLocalIdFetchRequest;
class QContactFetchRequest;
class QContactSaveRequest;
class QContactRemoveRequest;
class QContactDetailDefinitionFetchRequest;
class QContactDetailDefinitionRemoveRequest;
class QContactDetailDefinitionSaveRequest;
class QContactRelationshipFetchRequest;
class QContactRelationshipSaveRequest;
class QContactRelationshipRemoveRequest;
class Q_CONTACTS_EXPORT QContactManagerEngineV2 : public QContactManagerEngine
{
Q_OBJECT
public:
QContactManagerEngineV2() : QContactManagerEngine() {}
// This is the V1 function - c++ overloading rules require this here, or to use "using"
bool saveContacts(QList<QContact>* contacts, QMap<int, QContactManager::Error>* errorMap, QContactManager::Error* error);
virtual bool saveContacts(QList<QContact>* contacts, const QStringList& definitionMask, QMap<int, QContactManager::Error>* errorMap, QContactManager::Error* error);
// Again, this is the v1 function
QList<QContact> contacts(const QContactFilter& filter, const QList<QContactSortOrder>& sortOrders, const QContactFetchHint& fetchHint, QContactManager::Error* error) const;
virtual QList<QContact> contacts(const QList<QContactLocalId>& localIds, const QContactFetchHint& fetchHint, QMap<int, QContactManager::Error>* errorMap, QContactManager::Error* error) const;
static void updateContactFetchByIdRequest(QContactFetchByIdRequest* req, const QList<QContact>& result, QContactManager::Error error, const QMap<int, QContactManager::Error>& errorMap, QContactAbstractRequest::State);
};
QTM_END_NAMESPACE
QT_BEGIN_NAMESPACE
#define QT_CONTACTS_ENGINEV2_INTERFACE "com.nokia.qt.mobility.contacts.engine/2.0"
Q_DECLARE_INTERFACE(QtMobility::QContactManagerEngineV2, QT_CONTACTS_ENGINEV2_INTERFACE);
QT_END_NAMESPACE
#endif
|
