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#include "qcontactcollectionfilter.h"
35#include "qcontactcollectionfilter_p.h"
36
37QT_BEGIN_NAMESPACE_CONTACTS
38
39/*!
40 \class QContactCollectionFilter
41 \brief The QContactCollectionFilter class provides a filter based around the collection one
42 contact belongs to.
43 \inmodule QtContacts
44 \ingroup contacts-filters
45
46 It may be used to select contacts belonging to certain collections.
47 */
48
49Q_IMPLEMENT_CONTACTFILTER_PRIVATE(QContactCollectionFilter)
50
51/*!
52 \fn QContactCollectionFilter::QContactCollectionFilter(const QContactCollectionFilter &other)
53
54 Constructs a copy of \a other if possible, otherwise constructs a new contact collection filter.
55 */
56
57/*!
58 Constructs a new contact collection filter.
59 */
60QContactCollectionFilter::QContactCollectionFilter()
61 : QContactFilter(new QContactCollectionFilterPrivate)
62{
63}
64
65/*!
66 Sets the \a id of the collection, which the contacts should belong to.
67 */
68void QContactCollectionFilter::setCollectionId(const QContactCollectionId &id)
69{
70 Q_D(QContactCollectionFilter);
71 d->m_ids.clear();
72 d->m_ids.insert(value: id);
73}
74
75/*!
76 Sets the list of collection \a ids, which the contacts should belong to.
77 */
78void QContactCollectionFilter::setCollectionIds(const QSet<QContactCollectionId> &ids)
79{
80 Q_D(QContactCollectionFilter);
81 d->m_ids = ids;
82}
83
84/*!
85 Returns the list of collection IDs of contacts should belong to.
86 */
87QSet<QContactCollectionId> QContactCollectionFilter::collectionIds() const
88{
89 Q_D(const QContactCollectionFilter);
90 return d->m_ids;
91}
92
93QT_END_NAMESPACE_CONTACTS
94

source code of qtpim/src/contacts/filters/qcontactcollectionfilter.cpp