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
|
/****************************************************************************
**
** 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 "qmessagesortorder.h"
#include "qmessagesortorder_p.h"
QTM_BEGIN_NAMESPACE
/*!
\class QMessageSortOrder
\brief The QMessageSortOrder class defines the parameters used for sorting a subset of
queried messages from the messaging store.
\inmodule QtMessaging
\ingroup messaging
\since 1.0
A QMessageSortOrder is composed of a message property to sort and a sort order.
The QMessageSortOrder class is used in conjunction with the QMessageManager::queryMessages()
and QMessageService::queryMessages() functions to sort message results according to
the criteria defined by the sort order.
For example:
To create a query for all messages sorted by their timestamp in decending order:
\code
QMessageSortOrder sortOrder(QMessageSortOrder::byTimeStamp(Qt::DescendingOrder));
QMessageIdList results = QMessageManager().queryMessages(QMessageFilter(), sortOrder);
\endcode
\sa QMessageManager, QMessageFilter
*/
/*!
\fn QMessageSortOrder::QMessageSortOrder()
Create a QMessageSortOrder with specifying matching parameters.
A default-constructed sort order (one for which isEmpty() returns true) sorts no messages.
The result of combining an empty sort order with a non-empty sort order is the same as the original
non-empty sort order.
The result of combining two empty sort orders is an empty sort order.
Windows mobile and desktop platforms do not support sorting bySender() and byRecipients(),
additionally the Windows mobile platform does not support sorting byTimeStamp() and bySize().
*/
/*!
\fn QMessageSortOrder::QMessageSortOrder(const QMessageSortOrder &other)
Constructs a copy of \a other.
\since 1.0
*/
/*!
\fn QMessageSortOrder::~QMessageSortOrder()
Destroys the sort order.
*/
/*!
\internal
\fn QMessageSortOrder::operator=(const QMessageSortOrder& other)
\since 1.0
*/
/*!
\fn QMessageSortOrder::isEmpty() const
Returns true if the sort order remains empty after default construction; otherwise returns false.
\since 1.0
*/
/*!
\fn QMessageSortOrder::isSupported() const
Returns true if the sort order is supported on the current platform; otherwise returns false.
\since 1.0
*/
/*!
\fn QMessageSortOrder::operator+(const QMessageSortOrder& other) const
Returns a sort order that which is the result of concatenating the vaue of this sort order and the value
of sort order \a other.
This function determines sorting precedence.
On the Windows Mobile platform bySubject() and byReceptionTimeStamp() sort orders can not
be combined with each other.
\since 1.0
*/
/*!
\fn QMessageSortOrder::operator+=(const QMessageSortOrder& other)
Appends the value of the sort order \a other with the value of this sort order and assigns the result
to this sort order.
This function determines sorting precedence.
On the Windows Mobile platform bySubject() and byReceptionTimeStamp() sort orders can not
be combined with each other.
\since 1.0
*/
/*!
\internal
\fn QMessageSortOrder::operator==(const QMessageSortOrder& other) const
\since 1.0
*/
/*!
\internal
\since 1.0
*/
bool QMessageSortOrder::operator!=(const QMessageSortOrder& other) const
{
return !operator==(other);
}
/*!
\fn QMessageSortOrder::byType(Qt::SortOrder order)
Returns a sort order that sorts messages by their message type, according to \a order.
\since 1.0
\sa QMessage::type()
*/
/*!
\fn QMessageSortOrder::bySender(Qt::SortOrder order)
Returns a sort order that sorts messages by the address from which they were sent, according to \a order.
Not supported on the Windows mobile and desktop platforms.
\since 1.0
\sa QMessage::from()
*/
/*!
\fn QMessageSortOrder::byRecipients(Qt::SortOrder order)
Returns a sort order that sorts messages by the addresses to which they were sent, according to \a order.
Not supported on the Windows mobile and desktop platforms.
\since 1.0
\sa QMessage::to()
*/
/*!
\fn QMessageSortOrder::bySubject(Qt::SortOrder order)
Returns a sort order that sorts messages by their subject, according to \a order.
\since 1.0
\sa QMessage::subject()
*/
/*!
\fn QMessageSortOrder::byTimeStamp(Qt::SortOrder order)
Returns a sort order that sorts messages by their origination timestamp, according to \a order.
Not supported on the Windows mobile platform.
\since 1.0
\sa QMessage::date(), byReceptionTimeStamp()
*/
/*!
\fn QMessageSortOrder::byReceptionTimeStamp(Qt::SortOrder order)
Returns a sort order that sorts messages by their reception timestamp, according to \a order.
\since 1.0
\sa QMessage::receivedDate()
*/
/*!
\fn QMessageSortOrder::byStatus(QMessage::Status flag, Qt::SortOrder order)
Returns a sort order that sorts messages by their status value \a flag, according to \a order.
\since 1.0
\sa QMessage::status()
*/
/*!
\fn QMessageSortOrder::byPriority(Qt::SortOrder order)
Returns a sort order that sorts messages by their priority, according to \a order.
\since 1.0
\sa QMessage::priority()
*/
/*!
\fn QMessageSortOrder::bySize(Qt::SortOrder order)
Returns a sort order that sorts messages by their size, according to \a order.
Not supported on the Windows mobile platform.
\since 1.0
\sa QMessage::size()
*/
QTM_END_NAMESPACE
|
