1/****************************************************************************
2**
3** Copyright (C) 2015 The Qt Company Ltd.
4** Contact: http://www.qt.io/licensing/
5**
6** This file is part of the QtContacts module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL21$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see http://www.qt.io/terms-conditions. For further
15** information use the contact form at http://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 2.1 or version 3 as published by the Free
20** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22** following information to ensure the GNU Lesser General Public License
23** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25**
26** As a special exception, The Qt Company gives you certain additional
27** rights. These rights are described in The Qt Company LGPL Exception
28** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29**
30** $QT_END_LICENSE$
31**
32****************************************************************************/
33
34#ifndef QCONTACTSORTORDER_H
35#define QCONTACTSORTORDER_H
36
37#include <QtCore/qlist.h>
38#include <QtCore/qshareddata.h>
39
40#include <QtContacts/qcontactdetail.h>
41
42QT_BEGIN_NAMESPACE_CONTACTS
43
44class QContactSortOrderPrivate;
45class Q_CONTACTS_EXPORT QContactSortOrder
46{
47public:
48 QContactSortOrder();
49 ~QContactSortOrder();
50
51 QContactSortOrder(const QContactSortOrder& other);
52 QContactSortOrder& operator=(const QContactSortOrder& other);
53
54 enum BlankPolicy {
55 BlanksFirst,
56 BlanksLast
57 };
58
59 /* Mutators */
60 void setDetailType(QContactDetail::DetailType type, int field = -1);
61 void setBlankPolicy(BlankPolicy blankPolicy);
62 void setDirection(Qt::SortOrder direction);
63 void setCaseSensitivity(Qt::CaseSensitivity sensitivity);
64
65 /* Accessors */
66 QContactDetail::DetailType detailType() const;
67 int detailField() const;
68 BlankPolicy blankPolicy() const;
69 Qt::SortOrder direction() const;
70 Qt::CaseSensitivity caseSensitivity() const;
71
72 bool isValid() const;
73
74 bool operator==(const QContactSortOrder& other) const;
75 bool operator!=(const QContactSortOrder& other) const {return !operator==(other);}
76
77 /* Convenience cast */
78 operator QList<QContactSortOrder>() const {return QList<QContactSortOrder>() << *this;}
79
80private:
81 QSharedDataPointer<QContactSortOrderPrivate> d;
82};
83
84#ifndef QT_NO_DATASTREAM
85Q_CONTACTS_EXPORT QDataStream& operator<<(QDataStream& out, const QContactSortOrder& sortOrder);
86Q_CONTACTS_EXPORT QDataStream& operator>>(QDataStream& in, QContactSortOrder& sortOrder);
87#endif
88
89#ifndef QT_NO_DEBUG_STREAM
90Q_CONTACTS_EXPORT QDebug operator<<(QDebug dbg, const QContactSortOrder& sortOrder);
91#endif
92
93QT_END_NAMESPACE_CONTACTS
94
95QT_BEGIN_NAMESPACE
96Q_DECLARE_TYPEINFO(QTCONTACTS_PREPEND_NAMESPACE(QContactSortOrder), Q_MOVABLE_TYPE);
97QT_END_NAMESPACE
98
99#endif // QCONTACTSORTORDER_H
100

source code of qtpim/src/contacts/qcontactsortorder.h