MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

QContactFilter Class Reference

The QContactFilter class is used to select contacts made available through a QContactManager. More...

 #include <QContactFilter>

Inherited by: QContactActionFilter, QContactChangeLogFilter, QContactDetailFilter, QContactDetailRangeFilter, QContactIntersectionFilter, QContactInvalidFilter, QContactLocalIdFilter, QContactRelationshipFilter, and QContactUnionFilter.

This class was introduced in Qt Mobility 1.0.

Public Types

enum FilterType { InvalidFilter, ContactDetailFilter, ContactDetailRangeFilter, ChangeLogFilter, ..., DefaultFilter }
enum MatchFlag { MatchExactly, MatchContains, MatchStartsWith, MatchEndsWith, ..., MatchKeypadCollation }
flags MatchFlags

Public Functions

QContactFilter ()
QContactFilter ( const QContactFilter & other )
~QContactFilter ()
FilterType type () const
bool operator!= ( const QContactFilter & other ) const
QContactFilter & operator= ( const QContactFilter & other )
bool operator== ( const QContactFilter & other ) const

Related Non-Members

const QContactFilter operator& ( const QContactFilter & left, const QContactFilter & right )
const QContactFilter operator| ( const QContactFilter & left, const QContactFilter & right )

Detailed Description

The QContactFilter class is used to select contacts made available through a QContactManager.

This class is used as a parameter to various functions offered by QContactManager, to allow selection of contacts which have certain details or properties.

Member Type Documentation

enum QContactFilter::FilterType

Describes the type of the filter

Constant Value Description
QContactFilter::InvalidFilter 0 An invalid filter which matches nothing
QContactFilter::ContactDetailFilter 1 A filter which matches contacts containing one or more details of a particular definition with a particular value
QContactFilter::ContactDetailRangeFilter 2 A filter which matches contacts containing one or more details of a particular definition whose values are within a particular range
QContactFilter::ChangeLogFilter 3 A filter which matches contacts whose timestamps have been updated since some particular date and time
QContactFilter::ActionFilter 4 A filter which matches contacts for which a particular action is available, or which contain a detail with a particular value for which a particular action is available
QContactFilter::RelationshipFilter 5 A filter which matches contacts which participate in a particular type of relationship, or relationship with a specified contact
QContactFilter::IntersectionFilter 6 A filter which matches all contacts that are matched by all filters it includes
QContactFilter::UnionFilter 7 A filter which matches any contact that is matched by any of the filters it includes
QContactFilter::LocalIdFilter 8 A filter which matches any contact whose local id is contained in a particular list of contact local ids
QContactFilter::DefaultFilter 9 A filter which matches everything

enum QContactFilter::MatchFlag
flags QContactFilter::MatchFlags

Describes the semantics of matching followed by the filter

Constant Value Description
QContactFilter::MatchExactly Qt::MatchExactly Performs QVariant-based matching
QContactFilter::MatchContains Qt::MatchContains The search term is contained in the item
QContactFilter::MatchStartsWith Qt::MatchStartsWith The search term matches the start of the item
QContactFilter::MatchEndsWith Qt::MatchEndsWith The search term matches the end of the item
QContactFilter::MatchFixedString Qt::MatchFixedString Performs string-based matching. String-based comparisons are case-insensitive unless the MatchCaseSensitive flag is also specified
QContactFilter::MatchCaseSensitive Qt::MatchCaseSensitive The search is case sensitive
QContactFilter::MatchPhoneNumber 1024 The search term is considered to be in the form of a phone number, and special processing (removing dialing prefixes, non significant characters like '-'. ')' etc). may be performed when matching the item.
QContactFilter::MatchKeypadCollation 2048 The search term is in the form of text entered by a numeric phone keypad (such as ITU-T E.161 compliant keypads). Each digit in the search term can represent a number of alphanumeric symbols. For example, the search string "43556" would match items "HELLO", "GEKKO", "HELL6" and "43556" among others. Accented characters and other punctuation characters may additionally be matched by the QContactManager in a way consistent with the platform.

The MatchFlags type is a typedef for QFlags<MatchFlag>. It stores an OR combination of MatchFlag values.

Member Function Documentation

QContactFilter::QContactFilter ()

Constructs an empty filter

QContactFilter::QContactFilter ( const QContactFilter & other )

Constructs a new copy of other

QContactFilter::~QContactFilter ()

Cleans up the memory used by this filter

FilterType QContactFilter::type () const

Returns the type of the filter

bool QContactFilter::operator!= ( const QContactFilter & other ) const

Returns true if this filter is not identical to the other filter.

See also operator==().

QContactFilter & QContactFilter::operator= ( const QContactFilter & other )

Assigns this filter to be other

This function was introduced in Qt Mobility 1.0.

bool QContactFilter::operator== ( const QContactFilter & other ) const

Returns true if the filter has the same type and criteria as other

This function was introduced in Qt Mobility 1.0.

Related Non-Members

const QContactFilter operator& ( const QContactFilter & left, const QContactFilter & right )

Returns a filter which is the intersection of the left and right filters

See also QContactIntersectionFilter.

const QContactFilter operator| ( const QContactFilter & left, const QContactFilter & right )

Returns a filter which is the union of the left and right filters

See also QContactUnionFilter.