|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the Qt Mobility Components. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 #include "qmessageaccountsortorder.h" |
|
42 |
|
43 QTM_BEGIN_NAMESPACE |
|
44 |
|
45 /*! |
|
46 \class QMessageAccountSortOrder |
|
47 |
|
48 \brief The QMessageAccountSortOrder class defines the parameters used for sorting a subset of |
|
49 queried accounts from the messaging store. |
|
50 \ingroup messaging |
|
51 |
|
52 A QMessageAccountSortOrder is composed of a account property to sort and a sort order. |
|
53 The QMessageAccountSortOrder class is used in conjunction with the QMessageManager::queryAccounts() |
|
54 function to sort account results according to the criteria defined by the sort order. |
|
55 |
|
56 \sa QMessageManager, QMessageAccountFilter |
|
57 */ |
|
58 |
|
59 /*! |
|
60 \fn QMessageAccountSortOrder::QMessageAccountSortOrder() |
|
61 |
|
62 Create a QMessageAccountSortOrder with specifying matching parameters. |
|
63 |
|
64 A default-constructed sort order (one for which isEmpty() returns true) sorts no accounts. |
|
65 |
|
66 The result of combining an empty sort order with a non-empty sort order is the same as the original |
|
67 non-empty sort order. |
|
68 |
|
69 The result of combining two empty sort orders is an empty sort order. |
|
70 */ |
|
71 |
|
72 /*! |
|
73 \fn QMessageAccountSortOrder::QMessageAccountSortOrder(const QMessageAccountSortOrder &other) |
|
74 |
|
75 Constructs a copy of \a other. |
|
76 */ |
|
77 |
|
78 /*! |
|
79 \fn QMessageAccountSortOrder::~QMessageAccountSortOrder() |
|
80 |
|
81 Destroys the sort order. |
|
82 */ |
|
83 |
|
84 /*! |
|
85 \internal |
|
86 \fn QMessageAccountSortOrder::operator=(const QMessageAccountSortOrder& other) |
|
87 */ |
|
88 |
|
89 /*! |
|
90 \fn QMessageAccountSortOrder::isEmpty() const |
|
91 |
|
92 Returns true if the sort order remains empty after default construction; otherwise returns false. |
|
93 */ |
|
94 |
|
95 /*! |
|
96 \fn QMessageAccountSortOrder::isSupported() const |
|
97 |
|
98 Returns true if the sort order is supported on the current platform; otherwise returns false. |
|
99 */ |
|
100 |
|
101 /*! |
|
102 \internal |
|
103 \fn QMessageAccountSortOrder::operator==(const QMessageAccountSortOrder& other) const |
|
104 */ |
|
105 |
|
106 /*! |
|
107 \internal |
|
108 */ |
|
109 bool QMessageAccountSortOrder::operator!=(const QMessageAccountSortOrder& other) const |
|
110 { |
|
111 return !operator==(other); |
|
112 } |
|
113 |
|
114 /*! |
|
115 \fn QMessageAccountSortOrder::byName(Qt::SortOrder order) |
|
116 |
|
117 Returns an sort order that sorts accounts by name, according to \a order. |
|
118 |
|
119 \sa QMessageAccount::name() |
|
120 */ |
|
121 |
|
122 QTM_END_NAMESPACE |