summaryrefslogtreecommitdiffstats
path: root/src/libraries/qmfclient/qmailthreadkey.h
blob: e398caa40c8de7b6041f551f539402b149989c34 (plain)
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
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Messaging Framework.
**
** $QT_BEGIN_LICENSE:LGPL21$
** 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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://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 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QMAILTHREADKEY_H
#define QMAILTHREADKEY_H

#include "qmaildatacomparator.h"
#include "qmailkeyargument.h"
#include <QList>
#include <QSharedData>
#include "qmailid.h"
#include <QVariant>
#include "qmailipc.h"
#include "qmailglobal.h"

class QMailAccountKey;

class QMailThreadKeyPrivate;
class QMailMessageKey;

template <typename Key>
class MailKeyImpl;

class QMF_EXPORT QMailThreadKey
{
public:
    enum Property
    {
        Id = (1 << 0),
        ServerUid = (1 << 1),
        MessageCount = (1 << 2),
        UnreadCount = (1 << 3),
        Custom = (1 << 4), // This is for internal use only. It will be removed without notice
        Includes = (1 << 5),
        ParentAccountId = (1 << 6),
        Subject = (1 << 7),
        Senders = (1 << 8),
        LastDate = (1 << 9),
        StartedDate = (1 << 10),
        Status = (1 << 11),
        Preview = (1 << 12)
    };
    Q_DECLARE_FLAGS(Properties,Property)

    typedef QMailThreadId IdType;
    typedef QMailKeyArgument<Property> ArgumentType;

    QMailThreadKey();
    QMailThreadKey(const QMailThreadKey& other);
    virtual ~QMailThreadKey();

    QMailThreadKey operator~() const;
    QMailThreadKey operator&(const QMailThreadKey& other) const;
    QMailThreadKey operator|(const QMailThreadKey& other) const;
    const QMailThreadKey& operator&=(const QMailThreadKey& other);
    const QMailThreadKey& operator|=(const QMailThreadKey& other);

    bool operator==(const QMailThreadKey& other) const;
    bool operator !=(const QMailThreadKey& other) const;

    const QMailThreadKey& operator=(const QMailThreadKey& other);

    bool isEmpty() const;
    bool isNonMatching() const;
    bool isNegated() const;

    // for subqueries
    operator QVariant() const;

    const QList<ArgumentType> &arguments() const;
    const QList<QMailThreadKey> &subKeys() const;

    QMailKey::Combiner combiner() const;

    template <typename Stream> void serialize(Stream &stream) const;
    template <typename Stream> void deserialize(Stream &stream);

    static QMailThreadKey nonMatchingKey();

    static QMailThreadKey id(const QMailThreadId &id, QMailDataComparator::EqualityComparator cmp = QMailDataComparator::Equal);
    static QMailThreadKey id(const QMailThreadIdList &ids, QMailDataComparator::InclusionComparator cmp = QMailDataComparator::Includes);
    static QMailThreadKey id(const QMailThreadKey &key, QMailDataComparator::InclusionComparator cmp = QMailDataComparator::Includes);

    static QMailThreadKey serverUid(const QString &uid, QMailDataComparator::EqualityComparator cmp = QMailDataComparator::Equal);
    static QMailThreadKey serverUid(const QString &uid, QMailDataComparator::InclusionComparator cmp);
    static QMailThreadKey serverUid(const QStringList &uids, QMailDataComparator::InclusionComparator cmp = QMailDataComparator::Includes);

    static QMailThreadKey includes(const QMailMessageIdList &ids, QMailDataComparator::InclusionComparator cmp = QMailDataComparator::Includes);
    static QMailThreadKey includes(const QMailMessageKey &key, QMailDataComparator::InclusionComparator cmp = QMailDataComparator::Includes);

    static QMailThreadKey parentAccountId(const QMailAccountId &id, QMailDataComparator::EqualityComparator cmp = QMailDataComparator::Equal);
    static QMailThreadKey parentAccountId(const QMailAccountIdList &ids, QMailDataComparator::InclusionComparator cmp = QMailDataComparator::Includes);
    static QMailThreadKey parentAccountId(const QMailAccountKey &key, QMailDataComparator::InclusionComparator cmp = QMailDataComparator::Includes);

    static QMailThreadKey countMessages(const int count, QMailDataComparator::InclusionComparator cmp = QMailDataComparator::Includes);

    static QMailThreadKey lastDate(const QDateTime &value, QMailDataComparator::EqualityComparator cmp = QMailDataComparator::Equal);
    static QMailThreadKey lastDate(const QDateTime &value, QMailDataComparator::RelationComparator cmp);

private:
    QMailThreadKey(Property p, const QVariant& value, QMailKey::Comparator c);

    template <typename ListType>
    QMailThreadKey(const ListType &valueList, Property p, QMailKey::Comparator c);

    friend class QMailThreadKeyPrivate;
    friend class MailKeyImpl<QMailThreadKey>;

    QSharedDataPointer<QMailThreadKeyPrivate> d;
};

Q_DECLARE_USER_METATYPE(QMailThreadKey)

#endif