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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Copyright (C) 2017 Canonical 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$
**
****************************************************************************/
#include "qcontactcollectionid.h"
#ifndef QT_NO_DATASTREAM
#include <QtCore/qdatastream.h>
#endif
#ifndef QT_NO_DEBUG_STREAM
#include <QtCore/qdebug.h>
#endif
#include "qcontactmanager_p.h"
QT_BEGIN_NAMESPACE_CONTACTS
/*!
\class QContactCollectionId
\brief The QContactCollectionId class provides information that uniquely identifies a collection
in a particular manager.
\inmodule QtContact
\ingroup contact-main
It consists of a manager URI which identifies the manager which contains the collection,
and the engine specific ID of the collection in that manager.
An invalid QContactCollectionId has an empty manager URI.
*/
/*!
\fn QContactCollectionId::QContactCollectionId()
Constructs a new, invalid collection ID.
*/
// TODO: Document and remove internal once the correct signature has been determined
/*!
\fn QContactCollectionId::QContactCollectionId(const QString &managerUri, const QByteArray &localId)
\internal
Constructs an ID from the supplied manager URI \a managerUri and the engine
specific \a localId string.
*/
/*!
\fn bool QContactCollectionId::operator==(const QContactCollectionId &other) const
Returns true if this collection ID has the same manager URI and
engine specific ID as \a other. Returns true also, if both IDs are null.
*/
/*!
\fn bool QContactCollectionId::operator!=(const QContactCollectionId &other) const
Returns true if either the manager URI or engine specific ID of this
collection ID is different to that of \a other.
*/
/*!
\fn bool operator<(const QContactCollectionId &id1, const QContactCollectionId &id2)
\relates QContactCollectionId
Returns true if the collection ID \a id1 will be considered less than
the collection ID \a id2 if the manager URI of ID \a id1 is alphabetically
less than the manager URI of the \a id2 ID. If both IDs have the same
manager URI, ID \a id1 will be considered less than the ID \a id2
if the the engine specific ID of \a id1 is less than the engine specific ID of \a id2.
The invalid, null collection ID consists of an empty manager URI and a null engine ID,
and hence will be less than any valid, non-null collection ID.
This operator is provided primarily to allow use of a QContactCollectionId as a key in a QMap.
*/
/*!
\fn size_t qHash(const QContactCollectionId &id)
\relates QContactCollectionId
Returns the hash value for \a id.
*/
/*!
\fn bool QContactCollectionId::isValid() const
Returns true if the manager URI part is not null; returns false otherwise.
Note that valid ID may be null at the same time, which means new collection.
\sa isNull()
*/
/*!
\fn bool QContactCollectionId::isNull() const
Returns true if the engine specific ID part is a null (default constructed);
returns false otherwise.
\sa isValid()
*/
/*!
\fn QString QContactCollectionId::managerUri() const
Returns the URI of the manager which contains the collection identified by this ID.
\sa localId()
*/
/*!
\fn QByteArray QContactCollectionId::localId() const
Returns the collection's engine specific ID part.
\sa managerUri()
*/
/*!
Serializes the collection ID to a string. The format of the string will be:
"qtcontacts:managerName:params:localId", where localId is encoded binary data
formatted as hexadecimal to ensure it is in a printable form.
\sa fromString(), toByteArray()
*/
QString QContactCollectionId::toString() const
{
if (!isNull()) {
// Ensure the localId component has a valid string representation by hex encoding
const QByteArray encodedLocalId(m_localId.toHex());
return QString::fromUtf8(QContactManagerData::buildIdData(m_managerUri, encodedLocalId));
}
return QString();
}
/*!
Deserializes the given \a idString. Returns a default-constructed (null)
collection ID if the given \a idString is not a valid, serialized collection ID.
\sa toString(), fromByteArray()
*/
QContactCollectionId QContactCollectionId::fromString(const QString &idString)
{
QString managerUri;
QByteArray localId;
if (QContactManagerData::parseIdData(idString.toUtf8(), 0, 0, &managerUri, &localId)) {
// The localId component must be decoded from hex
return QContactCollectionId(managerUri, QByteArray::fromHex(localId));
}
return QContactCollectionId();
}
/*!
Serializes the collection ID to a byte array.
\sa fromByteArray(), toString()
*/
QByteArray QContactCollectionId::toByteArray() const
{
if (!isNull())
return QContactManagerData::buildIdData(m_managerUri, m_localId);
return QByteArray();
}
/*!
Deserializes the given \a idData. Returns a default-constructed (null)
collection ID if the given \a idData does not contain a valid, serialized collection ID.
\sa toByteArray(), fromString()
*/
QContactCollectionId QContactCollectionId::fromByteArray(const QByteArray &idData)
{
QString managerUri;
QByteArray localId;
if (QContactManagerData::parseIdData(idData, 0, 0, &managerUri, &localId))
return QContactCollectionId(managerUri, localId);
return QContactCollectionId();
}
#ifndef QT_NO_DEBUG_STREAM
/*!
\relates QContactCollectionId
Outputs \a id to the debug stream \a dbg.
*/
QDebug operator<<(QDebug dbg, const QContactCollectionId &id)
{
dbg.nospace() << "QContactCollectionId(" << id.toString().toUtf8().constData() << ")";
return dbg.maybeSpace();
}
#endif // QT_NO_DEBUG_STREAM
#ifndef QT_NO_DATASTREAM
/*!
\relates QContactCollectionId
Streams \a id to the data stream \a out.
*/
QDataStream &operator<<(QDataStream &out, const QContactCollectionId &id)
{
out << id.toByteArray();
return out;
}
/*!
\relates QContactCollectionId
Streams \a id in from the data stream \a in.
*/
QDataStream &operator>>(QDataStream &in, QContactCollectionId &id)
{
QByteArray idData;
in >> idData;
id = QContactCollectionId::fromByteArray(idData);
return in;
}
#endif // QT_NO_DATASTREAM
QT_END_NAMESPACE_CONTACTS
|
