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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
/****************************************************************************
**
** 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$
** 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$
**
****************************************************************************/
#include "qmessagefolderfilter.h"
#include "qmessagefolderfilter_p.h"
#include "messagingutil_p.h"
#include "qmessagefolder.h"
#include "qmessagemanager.h"
QTM_BEGIN_NAMESPACE
/*!
\class QMessageFolderFilter
\brief The QMessageFolderFilter class defines the parameters used for querying a subset of
all available folders from the messaging store.
\inmodule QtMessaging
\ingroup messaging
\since 1.0
A QMessageFolderFilter is composed of a folder property, an optional comparison operator
and a comparison value. The QMessageFolderFilter class is used in conjunction with the
QMessageManager::queryFolders() and QMessageManager::countFolders() functions to filter results
which meet the criteria defined by the filter.
QMessageFolderFilters can be combined using the logical operators (&), (|) and (~) to
create more refined queries.
Evaluation of filters is delayed until they are used in a QMessageManager function
such as queryFolders, except where explicitly documented otherwise.
\sa QMessageManager, QMessageFolder
*/
/*!
\fn QMessageFolderFilter::QMessageFolderFilter()
Creates a QMessageFolderFilter without specifying matching parameters.
A default-constructed filter (one for which isEmpty() returns true) matches all folders.
\sa isEmpty()
*/
/*!
\fn QMessageFolderFilter::QMessageFolderFilter(const QMessageFolderFilter &other)
Constructs a copy of \a other.
\since 1.0
*/
/*!
\fn QMessageFolderFilter::~QMessageFolderFilter()
Destroys the filter.
*/
/*!
\internal
\fn QMessageFolderFilter::operator=(const QMessageFolderFilter& other)
\since 1.0
*/
/*!
\fn QMessageFolderFilter::setMatchFlags(QMessageDataComparator::MatchFlags matchFlags)
Set the match flags for the search filter to \a matchFlags.
\since 1.0
\sa matchFlags()
*/
/*!
\fn QMessageDataComparator::MatchFlags QMessageFolderFilter::matchFlags() const
Return the match flags for the search filter.
Default is no match flags set.
\since 1.0
\sa setMatchFlags()
*/
/*!
\fn QMessageFolderFilter::isEmpty() const
Returns true if the filter remains empty after default construction; otherwise returns false.
An empty filter matches all folders.
The result of combining an empty filter with a non-empty filter using an AND operation is the
original non-empty filter.
The result of combining an empty filter with a non-empty filter using an OR operation is the
empty filter.
The result of combining two empty filters is an empty filter.
\since 1.0
*/
/*!
\fn QMessageFolderFilter::isSupported() const
Returns true if the filter is supported on the current platform; otherwise returns false.
\since 1.0
*/
/*!
\fn QMessageFolderFilter::operator~() const
Returns a filter that is the logical NOT of the value of this filter (ignoring any
matchFlags() set on the filter).
If this filter is empty, the result will be a non-matching filter; if this filter is
non-matching, the result will be an empty filter.
\since 1.0
\sa isEmpty()
*/
/*!
\fn QMessageFolderFilter::operator&(const QMessageFolderFilter& other) const
Returns a filter that is the logical AND of this filter and the value of filter \a other.
\since 1.0
*/
/*!
\fn QMessageFolderFilter::operator|(const QMessageFolderFilter& other) const
Returns a filter that is the logical OR of this filter and the value of filter \a other.
\since 1.0
*/
/*!
\fn QMessageFolderFilter::operator&=(const QMessageFolderFilter& other)
Performs a logical AND with this filter and the filter \a other and assigns the result
to this filter.
\since 1.0
*/
/*!
\fn QMessageFolderFilter::operator|=(const QMessageFolderFilter& other)
Performs a logical OR with this filter and the filter \a other and assigns the result
to this filter.
\since 1.0
*/
/*!
\internal
\fn QMessageFolderFilter::operator==(const QMessageFolderFilter& other) const
\since 1.0
*/
/*!
\internal
\since 1.0
*/
bool QMessageFolderFilter::operator!=(const QMessageFolderFilter& other) const
{
return !operator==(other);
}
/*!
\fn QMessageFolderFilter::byId(const QMessageFolderId &id, QMessageDataComparator::EqualityComparator cmp)
Returns a filter matching folders whose identifier matches \a id, according to \a cmp.
\since 1.0
\sa QMessageFolder::id()
*/
/*!
\fn QMessageFolderFilter::byId(const QMessageFolderIdList &ids, QMessageDataComparator::InclusionComparator cmp)
Returns a filter matching folders whose identifier is a member of \a ids, according to \a cmp.
\since 1.0
\sa QMessageFolder::id()
*/
/*!
\fn QMessageFolderFilter::byId(const QMessageFolderFilter &filter, QMessageDataComparator::InclusionComparator cmp)
Returns a filter matching folders whose identifier is a member of the set yielded by \a filter, according to \a cmp.
\since 1.0
\sa QMessageFolder::id()
*/
/*!
\fn QMessageFolderFilter::byName(const QString &pattern, QMessageDataComparator::LikeComparator cmp)
Returns a filter matching folders whose display name matches \a pattern, according to \a cmp.
This filter is evaluated when it is constructed.
\since 1.2
\sa QMessageFolder::name()
*/
/*!
\fn QMessageFolderFilter::byName(const QString &value, QMessageDataComparator::EqualityComparator cmp)
Returns a filter matching folders whose display name matches \a value, according to \a cmp.
Not supported on Linux, Harmattan and Meego.com (use InclusionComparator).
\since 1.0
\sa QMessageFolder::name()
*/
/*!
\fn QMessageFolderFilter::byName(const QString &value, QMessageDataComparator::InclusionComparator cmp)
Returns a filter matching folders whose display name matches the substring \a value, according to \a cmp.
\since 1.0
\sa QMessageFolder::name()
*/
/*!
\fn QMessageFolderFilter::byPath(const QString &pattern, QMessageDataComparator::LikeComparator cmp)
Returns a filter matching folders whose path matches \a pattern, according to \a cmp.
This filter is evaluated when it is constructed.
\since 1.2
\sa QMessageFolder::path()
*/
/*!
\fn QMessageFolderFilter::byPath(const QString &value, QMessageDataComparator::EqualityComparator cmp)
Returns a filter matching folders whose path matches \a value, according to \a cmp.
Not supported on Linux, Harmattan and Meego.com (use InclusionComparator).
\since 1.0
\sa QMessageFolder::path()
*/
/*!
\fn QMessageFolderFilter::byPath(const QString &value, QMessageDataComparator::InclusionComparator cmp)
Returns a filter matching folders whose path matches the substring \a value, according to \a cmp.
\since 1.0
\sa QMessageFolder::path()
*/
/*!
\fn QMessageFolderFilter::byParentAccountId(const QMessageAccountId &id, QMessageDataComparator::EqualityComparator cmp)
Returns a filter matching folders whose parent account identifier matches \a id, according to \a cmp.
\since 1.0
\sa QMessageAccount::id()
*/
/*!
\fn QMessageFolderFilter::byParentAccountId(const QMessageAccountFilter &filter, QMessageDataComparator::InclusionComparator cmp)
Returns a filter matching folders whose parent account identifier is a member of the set yielded by \a filter, according to \a cmp.
\since 1.0
\sa QMessageAccount::id()
*/
/*!
\fn QMessageFolderFilter::byParentFolderId(const QMessageFolderId &id, QMessageDataComparator::EqualityComparator cmp)
Returns a filter matching folders whose parent folder identifier matches \a id, according to \a cmp.
\since 1.0
\sa QMessageFolder::id()
*/
/*!
\fn QMessageFolderFilter::byParentFolderId(const QMessageFolderFilter &filter, QMessageDataComparator::InclusionComparator cmp)
Returns a filter matching folders whose parent folder identifier is a member of the set yielded by \a filter, according to \a cmp.
\since 1.0
\sa QMessageFolder::id()
*/
/*!
\fn QMessageFolderFilter::byAncestorFolderIds(const QMessageFolderId &id, QMessageDataComparator::InclusionComparator cmp)
Returns a filter matching folders whose ancestor folders' identifiers contain \a id, according to \a cmp.
\since 1.0
\sa QMessageFolder::id()
*/
/*!
\fn QMessageFolderFilter::byAncestorFolderIds(const QMessageFolderFilter &filter, QMessageDataComparator::InclusionComparator cmp)
Returns a filter matching folders whose ancestor folders' identifiers contain a member of the set yielded by \a filter, according to \a cmp.
\since 1.0
\sa QMessageFolder::id()
*/
QMessageFolderFilter QMessageFolderFilter::byName(const QString &pattern, QMessageDataComparator::LikeComparator cmp)
{
QMessageFolderIdList ids;
foreach(QMessageFolderId const& id, QMessageManager().queryFolders()) {
if (MessagingUtil::globMatch(pattern, QMessageFolder(id).name())) {
ids.push_back(id);
}
}
return QMessageFolderFilter::byId(ids);
}
QMessageFolderFilter QMessageFolderFilter::byPath(const QString &pattern, QMessageDataComparator::LikeComparator cmp)
{
QMessageFolderIdList ids;
foreach(QMessageFolderId const& id, QMessageManager().queryFolders()) {
if (MessagingUtil::globMatch(pattern, QMessageFolder(id).path())) {
ids.push_back(id);
}
}
return QMessageFolderFilter::byId(ids);
}
QTM_END_NAMESPACE
|
