Contents
QContactRelationshipFilter Class Reference
The QContactRelationshipFilter class provides a filter based around relationship criteria. More...
#include <QContactRelationshipFilter>
Inherits QContactFilter.
Public Functions
QContactRelationshipFilter () | |
QContactRelationshipFilter ( const QContactFilter & other ) | |
QContactId | relatedContactId () const |
QContactRelationship::Role | relatedContactRole () const |
QString | relationshipType () const |
void | setRelatedContactId ( const QContactId & relatedContactId ) |
void | setRelatedContactRole ( QContactRelationship::Role relatedContactRole ) |
void | setRelationshipType ( const QString & relationshipType ) |
- 4 public functions inherited from QContactFilter
Detailed Description
The QContactRelationshipFilter class provides a filter based around relationship criteria.
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:
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(QContactRelationshipFilter::First); // where the group contact is the first participant
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:
QContactRelationshipFilter whichGroupsFilter; // select all contacts which are involved whichGroupsFilter.setRelationshipType(QContactRelationshipFilter::HasMember); // in a group relationship whichGroupsFilter.setRelatedContactId(particularContact.id()); // with the particular contact whichGroupsFilter.setRelatedContactRole(QContactRelationshipFilter::Second); // where the particular contact is the second participant