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
|
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtContacts module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qcontactdetailrangefilter.h"
#include "qcontactdetailrangefilter_p.h"
QT_BEGIN_NAMESPACE_CONTACTS
/*!
\class QContactDetailRangeFilter
\brief The QContactDetailRangeFilter class provides a filter based around
a detail value range criterion.
\inmodule QtContacts
\ingroup contacts-filters
It may be used to select contacts which contain a detail of a particular type
with a particular value that lies in a range (either open or closed).
*/
Q_IMPLEMENT_CONTACTFILTER_PRIVATE(QContactDetailRangeFilter);
/*!
* \fn QContactDetailRangeFilter::QContactDetailRangeFilter(const QContactFilter& other)
* Constructs a copy of \a other if possible, otherwise constructs a new detail range filter
*/
/*!
* \enum QContactDetailRangeFilter::RangeFlag
* Enumerates the semantics of the boundary conditions of the detail range filter
* \value IncludeLower The filter will match if the field value is equal to or greater than the minimum value
* \value IncludeUpper The filter will match if the field value is equal to or less than the maximum value
* \value ExcludeLower The filter will match if the field value is greater than the minimum value (but not equal)
* \value ExcludeUpper The filter will match if the field value is less than the maximum value (but not equal)
*/
/*!
* Constructs a new detail range filter
*/
QContactDetailRangeFilter::QContactDetailRangeFilter()
: QContactFilter(new QContactDetailRangeFilterPrivate)
{
}
/*!
* Sets the value range criterion of the filter to within \a min and \a max, with boundary conditions specified in the given \a flags.
* If \a min or \a max is a null variant, that condition will not be checked. For example, to check for
* fields with a value greater than 7, you would specify:
* \code
* filter.setRange(7, QVariant(), QContactDetailRangeFilter::ExcludeLower);
* \endcode
* \sa minValue(), maxValue()
*/
void QContactDetailRangeFilter::setRange(const QVariant& min, const QVariant& max, RangeFlags flags)
{
Q_D(QContactDetailRangeFilter);
d->m_minValue = min;
d->m_maxValue = max;
d->m_rangeflags = flags;
}
/*!
* Sets the match flags of the filter criterion to \a flags
*
* Not all flags are supported by a range filter. The supported flags include:
*
* \list
* \li QContactFilter::MatchExactly
* \li QContactFilter::MatchFixedString
* \li QContactFilter::MatchCaseSensitive
* \endlist
*
* Unsupported flags will be ignored.
*
* \sa matchFlags()
*/
void QContactDetailRangeFilter::setMatchFlags(QContactFilter::MatchFlags flags)
{
Q_D(QContactDetailRangeFilter);
flags &= (QContactFilter::MatchExactly | QContactFilter::MatchFixedString | QContactFilter::MatchCaseSensitive);
d->m_flags = flags;
}
/*!
* Sets the type of detail which will be matched to \a type, and the field of the detail
* which will contain the value criterion to \a field.
*
* If \a type is QContactDetail::TypeUndefined, the detail filter will match no contacts. If \a field
* is not specified, or equal to -1, the detail filter acts like a "detail exists" filter; if any
* detail of the specified type is present in a contact, that contact will match the filter, regardless
* of what values might be stored in that detail.
*
* \sa detailType(), detailField()
*/
void QContactDetailRangeFilter::setDetailType(QContactDetail::DetailType type, int field)
{
Q_D(QContactDetailRangeFilter);
d->m_typeId = type;
d->m_fieldId = field;
}
/*!
* Returns the match flags of the criterion, which define semantics such as case sensitivity, and exact matching.
* \sa setMatchFlags()
*/
QContactFilter::MatchFlags QContactDetailRangeFilter::matchFlags() const
{
Q_D(const QContactDetailRangeFilter);
return d->m_flags;
}
/*!
* Returns the type of the details which will be inspected for matching values
* \sa setDetailType()
*/
QContactDetail::DetailType QContactDetailRangeFilter::detailType() const
{
Q_D(const QContactDetailRangeFilter);
return d->m_typeId;
}
/*!
* Returns the detail field containinig the value which will be matched against the value criterion
* \sa setDetailType()
*/
int QContactDetailRangeFilter::detailField() const
{
Q_D(const QContactDetailRangeFilter);
return d->m_fieldId;
}
/*!
* Returns the lower bound of the value range criterion.
* If this value is null, there is no lower bound.
* If it is valid, the \l rangeFlags() determines whether this value is included in the valid values.
* \sa setRange()
*/
QVariant QContactDetailRangeFilter::minValue() const
{
Q_D(const QContactDetailRangeFilter);
return d->m_minValue;
}
/*!
* Returns the upper bound of the value range criterion
* If this value is null, there is no upper bound.
* If it is valid, the \l rangeFlags() determines whether this value is included in the valid values.
* \sa setRange()
*/
QVariant QContactDetailRangeFilter::maxValue() const
{
Q_D(const QContactDetailRangeFilter);
return d->m_maxValue;
}
/*!
* Returns a set of flags which defines the boundary condition semantics of the value range criterion
* \sa setRange()
*/
QContactDetailRangeFilter::RangeFlags QContactDetailRangeFilter::rangeFlags() const
{
Q_D(const QContactDetailRangeFilter);
return d->m_rangeflags;
}
QT_END_NAMESPACE_CONTACTS
|
