blob: e559497730af72ecd63a8d829a8240a99a3474f7 (
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/****************************************************************************
**
** 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 "qcontactrelationshipfilter.h"
#include "qcontactrelationshipfilter_p.h"
QT_BEGIN_NAMESPACE_CONTACTS
/*!
\class QContactRelationshipFilter
\brief The QContactRelationshipFilter class provides a filter based
around relationship criteria.
\inmodule QtContacts
\ingroup contacts-filters
It may be used to select contacts which are involved in relationships
which are of a certain type, or which involve certain contacts.
One common use-case might be to select the contacts which are a member of a particular group.
This use-case may be met with the following filter:
\code
QContactRelationshipFilter groupFilter; // select all contacts which are involved
groupFilter.setRelationshipType(QContactRelationship::HasMember); // in a group relationship
groupFilter.setRelatedContactId(groupContact.id()); // with the group contact
groupFilter.setRelatedContactRole(QContactRelationship::First); // where the group contact is the first participant
\endcode
Another common use-case might be to select the groups which a particular contact is a member of.
This use-case may be met with the following filter:
\code
QContactRelationshipFilter whichGroupsFilter; // select all contacts which are involved
whichGroupsFilter.setRelationshipType(QContactRelationship::HasMember); // in a group relationship
whichGroupsFilter.setRelatedContactId(particularContact.id()); // with the particular contact
whichGroupsFilter.setRelatedContactRole(QContactRelationship::Second); // where the particular contact is the second participant
\endcode
Relationships are also used to define composition of facets into contacts. To find the
facets from which a contact is composed:
\code
QContactRelationshipFilter whichFacetsFilter; // select all facets which are involved
whichFacetsFilter.setRelationshipType(QContactRelationship::Aggregates); // in an aggregation relationship
whichFacetsFilter.setRelatedContact(particularContact()); // with the particular contact
whichFacetsFilter.setRelatedContactRole(QContactRelationship::First); // where the particular contact is the first participant
\endcode
*/
Q_IMPLEMENT_CONTACTFILTER_PRIVATE(QContactRelationshipFilter)
/*!
\fn QContactRelationshipFilter::QContactRelationshipFilter(const QContactFilter& other)
Constructs a copy of \a other if possible, else constructs a new QContactRelationshipFilter.
*/
/*!
Constructs a new relationship filter
*/
QContactRelationshipFilter::QContactRelationshipFilter()
: QContactFilter(new QContactRelationshipFilterPrivate)
{
}
/*!
Sets the type of relationship which a contact must have in order to match this filter to \a relationshipType
*/
void QContactRelationshipFilter::setRelationshipType(const QString& relationshipType)
{
Q_D(QContactRelationshipFilter);
d->m_relationshipType = relationshipType;
}
/*!
Returns the type of relationship that a contact must have in order to match the filter
*/
QString QContactRelationshipFilter::relationshipType() const
{
Q_D(const QContactRelationshipFilter);
return d->m_relationshipType;
}
/*!
Sets the ID of the contact with whom the tested contact must have a relationship in order for the tested contact to match this filter, to be \a relatedContactId
*/
void QContactRelationshipFilter::setRelatedContactId(const QContactId &relatedContactId)
{
Q_D(QContactRelationshipFilter);
d->m_relatedContactId = relatedContactId;
}
/*!
Returns the ID of the contact with whom the tested contact must have a relationship in order for the tested contact to match this filter
*/
QContactId QContactRelationshipFilter::relatedContactId() const
{
Q_D(const QContactRelationshipFilter);
return d->m_relatedContactId;
}
/*!
Sets the role in the relationship with the tested contact that the related contact must play in order for the tested contact to match this filter to be \a relatedContactRole
*/
void QContactRelationshipFilter::setRelatedContactRole(QContactRelationship::Role relatedContactRole)
{
Q_D(QContactRelationshipFilter);
d->m_relatedContactRole = relatedContactRole;
}
/*!
Returns the role in the relationship with the tested contact that the related contact must play in order for the tested contact to match this filter
*/
QContactRelationship::Role QContactRelationshipFilter::relatedContactRole() const
{
Q_D(const QContactRelationshipFilter);
return d->m_relatedContactRole;
}
QT_END_NAMESPACE_CONTACTS
|
