QContactRelationshipFilter Class

The QContactRelationshipFilter class provides a filter based around relationship criteria. More...

Header: #include <QContactRelationshipFilter>
Inherits: QContactFilter.

Public Functions

QContactRelationshipFilter()
QContactRelationshipFilter(const QContactFilter & other)
QContact relatedContact() const
QContactRelationship::Role relatedContactRole() const
QString relationshipType() const
void setRelatedContact(const QContact & relatedContact)
void setRelatedContactRole(QContactRelationship::Role relatedContactRole)
void setRelationshipType(const QString & relationshipType)

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.setRelatedContact(groupContact());                   // with the group contact
groupFilter.setRelatedContactRole(QContactRelationship::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(QContactRelationship::HasMember); // in a group relationship
whichGroupsFilter.setRelatedContact(particularContact());                // with the particular contact
whichGroupsFilter.setRelatedContactRole(QContactRelationship::Second);  // where the particular contact is the second participant

Member Function Documentation

QContactRelationshipFilter::QContactRelationshipFilter()

Constructs a new relationship filter

QContactRelationshipFilter::QContactRelationshipFilter(const QContactFilter & other)

Constructs a copy of other if possible, else constructs a new QContactRelationshipFilter.

QContact QContactRelationshipFilter::relatedContact() const

Returns the contact with whom the tested contact must have a relationship in order for the tested contact to match this filter

See also setRelatedContact().

QContactRelationship::Role QContactRelationshipFilter::relatedContactRole() const

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

See also setRelatedContactRole().

QString QContactRelationshipFilter::relationshipType() const

Returns the type of relationship that a contact must have in order to match the filter

See also setRelationshipType().

void QContactRelationshipFilter::setRelatedContact(const QContact & relatedContact)

Sets the contact with whom the tested contact must have a relationship in order for the tested contact to match this filter to be relatedContact

See also relatedContact().

void QContactRelationshipFilter::setRelatedContactRole(QContactRelationship::Role relatedContactRole)

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 relatedContactRole

See also relatedContactRole().

void QContactRelationshipFilter::setRelationshipType(const QString & relationshipType)

Sets the type of relationship which a contact must have in order to match this filter to relationshipType

See also relationshipType().