Home · All Classes · All Functions ·

QMessageFilter Class Reference

The QMessageFilter class defines the parameters used for querying a subset of all available messages from the messaging store. More...

    #include <QMessageFilter>

Public Functions

Static Public Members


Detailed Description

The QMessageFilter class defines the parameters used for querying a subset of all available messages from the messaging store.

A QMessageFilter is composed of a message property, an optional comparison operator and a comparison value. The QMessageFilter class is used in conjunction with the QMessageManager::queryMessages(), QMessageManager::countMessages(), QMessageService::queryMessages(), and QMessageService::countMessages() functions to filter results which meet the criteria defined by the filter.

QMessageFilters can be combined using the logical operators (&), (|) and (~) to create more refined queries.

For example:

To create a query for all messages sent from "joe@user.com" with subject "meeting":

    QMessageFilter subjectFilter(QMessageFilter::bySubject("meeting"));
    QMessageFilter senderFilter(QMessageFilter::bySender("joe@user.com"));
    QMessageIdList results = QMessageManager().queryMessages(subjectFilter & senderFilter);

See also QMessageManager and QMessage.


Member Function Documentation

QMessageFilter::QMessageFilter ()

Creates a QMessageFilter without specifying matching parameters.

A default-constructed filter (one for which isEmpty() returns true) matches all messages.

See also isEmpty().

QMessageFilter::QMessageFilter ( const QMessageFilter & other )

Constructs a copy of other.

QMessageFilter::~QMessageFilter ()   [virtual]

Destroys the filter.

QMessageFilter QMessageFilter::byAncestorFolderIds ( const QMessageFolderId & id, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )   [static]

Returns a filter matching messages whose ancestor folders' identifiers contain id, according to cmp.

See also QMessage::parentFolderId().

QMessageFilter QMessageFilter::byAncestorFolderIds ( const QMessageFolderFilter & filter, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )   [static]

Returns a filter matching messages whose ancestor folders' identifiers contain a member of the set yielded by filter, according to cmp.

See also QMessage::parentFolderId().

QMessageFilter QMessageFilter::byId ( const QMessageId & id, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )   [static]

Returns a filter matching messages whose identifier matches id, according to cmp.

See also QMessage::id().

QMessageFilter QMessageFilter::byId ( const QMessageIdList & ids, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )   [static]

Returns a filter matching messages whose identifier is a member of ids, according to cmp.

See also QMessage::id().

QMessageFilter QMessageFilter::byId ( const QMessageFilter & filter, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )   [static]

Returns a filter matching messages whose identifier is a member of the set yielded by filter, according to cmp.

See also QMessage::id().

QMessageFilter QMessageFilter::byParentAccountId ( const QMessageAccountId & id, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )   [static]

Returns a filter matching messages whose parent account's identifier matches id, according to cmp.

See also QMessage::parentAccountId().

QMessageFilter QMessageFilter::byParentAccountId ( const QMessageAccountFilter & filter, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )   [static]

Returns a filter matching messages whose parent account's identifier is a member of the set yielded by filter, according to cmp.

See also QMessage::parentAccountId().

QMessageFilter QMessageFilter::byParentFolderId ( const QMessageFolderId & id, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )   [static]

Returns a filter matching messages whose parent folder's identifier matches id, according to cmp.

See also QMessage::parentFolderId().

QMessageFilter QMessageFilter::byParentFolderId ( const QMessageFolderFilter & filter, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )   [static]

Returns a filter matching messages whose parent folder's identifier is a member of the set yielded by filter, according to cmp.

See also QMessage::parentFolderId().

QMessageFilter QMessageFilter::byPriority ( QMessage::Priority value, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )   [static]

Returns a filter matching messages whose priority matches value, according to cmp.

See also QMessage::priority().

QMessageFilter QMessageFilter::byReceptionTimeStamp ( const QDateTime & value, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )   [static]

Returns a filter matching messages whose reception timestamp matches value, according to cmp.

See also QMessage::receivedDate().

QMessageFilter QMessageFilter::byReceptionTimeStamp ( const QDateTime & value, QMessageDataComparator::RelationComparator cmp )   [static]

Returns a filter matching messages whose reception timestamp has the relation to value that is specified by cmp.

See also QMessage::receivedDate().

QMessageFilter QMessageFilter::byRecipients ( const QString & value, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )   [static]

Returns a filter matching messages whose recipients include the substring value, according to cmp.

See also QMessage::to(), QMessage::cc(), and QMessage::bcc().

QMessageFilter QMessageFilter::bySender ( const QString & value, QMessageDataComparator::EqualityComparator cmp )   [static]

Returns a filter matching messages whose sender matches value, according to cmp.

See also QMessage::from().

QMessageFilter QMessageFilter::bySender ( const QString & value, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )   [static]

Returns a filter matching messages whose sender matches the substring value, according to cmp.

See also QMessage::from().

QMessageFilter QMessageFilter::bySize ( int value, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )   [static]

Returns a filter matching messages whose size matches value, according to cmp.

See also QMessage::size().

QMessageFilter QMessageFilter::bySize ( int value, QMessageDataComparator::RelationComparator cmp )   [static]

Returns a filter matching messages whose size matches value, according to cmp.

See also QMessage::size().

QMessageFilter QMessageFilter::byStandardFolder ( QMessage::StandardFolder folder, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )   [static]

Returns a filter matching messages whose standard folder location matches folder, according to cmp.

See also QMessage::parentAccountId().

QMessageFilter QMessageFilter::byStatus ( QMessage::Status value, QMessageDataComparator::EqualityComparator cmp )   [static]

Returns a filter matching messages whose status matches value, according to cmp.

See also QMessage::status().

QMessageFilter QMessageFilter::byStatus ( QMessage::StatusFlags mask, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )   [static]

Returns a filter matching messages whose status is a bitwise match to mask, according to cmp.

See also QMessage::status().

QMessageFilter QMessageFilter::bySubject ( const QString & value, QMessageDataComparator::EqualityComparator cmp )   [static]

Returns a filter matching messages whose subject matches value, according to cmp.

See also QMessage::subject().

QMessageFilter QMessageFilter::bySubject ( const QString & value, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )   [static]

Returns a filter matching messages whose subject matches the substring value, according to cmp.

See also QMessage::subject().

QMessageFilter QMessageFilter::byTimeStamp ( const QDateTime & value, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )   [static]

Returns a filter matching messages whose timestamp matches value, according to cmp.

See also QMessage::date().

QMessageFilter QMessageFilter::byTimeStamp ( const QDateTime & value, QMessageDataComparator::RelationComparator cmp )   [static]

Returns a filter matching messages whose timestamp has the relation to value that is specified by cmp.

See also QMessage::date().

QMessageFilter QMessageFilter::byType ( QMessage::Type type, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )   [static]

Returns a filter matching messages whose type matches type, according to cmp.

See also QMessage::type().

QMessageFilter QMessageFilter::byType ( QMessage::TypeFlags type, QMessageDataComparator::InclusionComparator cmp )   [static]

Returns a filter matching accounts whose type is a bitwise match to type, according to cmp.

See also QMessage::type().

bool QMessageFilter::isEmpty () const

Returns true if the filter remains empty after default construction; otherwise returns false.

An empty filter matches all messages.

The result of combining an empty filter with a non-empty filter is the original non-empty filter. This is true regardless of whether the combination is formed by an AND or an OR operation.

The result of combining two empty filters is an empty filter.

bool QMessageFilter::isSupported () const

Returns true if the filter is supported on the current platform; otherwise returns false.

QMessageDataComparator::MatchFlags QMessageFilter::matchFlags () const

Return the match flags for the search filter.

Default is no match flags set.

See also setMatchFlags().

void QMessageFilter::setMatchFlags ( QMessageDataComparator::MatchFlags matchFlags )

Set the match flags for the search filter to matchFlags.

See also matchFlags().

QMessageFilter QMessageFilter::operator& ( const QMessageFilter & other ) const

Returns a filter that is the logical AND of this filter and the value of filter other.

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

Performs a logical AND with this filter and the filter other and assigns the result to this filter.

QMessageFilter QMessageFilter::operator| ( const QMessageFilter & other ) const

Returns a filter that is the logical OR of this filter and the value of filter other.

const QMessageFilter & QMessageFilter::operator|= ( const QMessageFilter & other )

Performs a logical OR with this filter and the filter other and assigns the result to this filter.

QMessageFilter QMessageFilter::operator~ () const

Returns a filter that is the logical NOT of the value of this filter (ignoring any matchFlags() set on the filter).

If this filter is empty, the result will be a non-matching filter; if this filter is non-matching, the result will be an empty filter.

See also isEmpty().


Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt Mobility Project 1.0.1