Home · All Classes · All Functions ·

QMessageFolderFilter Class Reference

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

    #include <QMessageFolderFilter>

Public Functions

Static Public Members


Detailed Description

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

A QMessageFolderFilter is composed of a folder property, an optional comparison operator and a comparison value. The QMessageFolderFilter class is used in conjunction with the QMessageManager::queryFolders() and QMessageManager::countFolders() functions to filter results which meet the criteria defined by the filter.

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

See also QMessageManager and QMessageFolder.


Member Function Documentation

QMessageFolderFilter::QMessageFolderFilter ()

Creates a QMessageFolderFilter without specifying matching parameters.

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

See also isEmpty().

QMessageFolderFilter::QMessageFolderFilter ( const QMessageFolderFilter & other )

Constructs a copy of other.

QMessageFolderFilter::~QMessageFolderFilter ()   [virtual]

Destroys the filter.

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

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

See also QMessageFolder::id().

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

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

See also QMessageFolder::id().

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

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

See also QMessageFolder::id().

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

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

See also QMessageFolder::id().

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

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

See also QMessageFolder::id().

QMessageFolderFilter QMessageFolderFilter::byName ( const QString & value, QMessageDataComparator::EqualityComparator cmp )   [static]

Returns a filter matching folders whose display name matches value, according to cmp.

See also QMessageFolder::name().

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

Returns a filter matching folders whose display name matches the substring value, according to cmp.

See also QMessageFolder::name().

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

Returns a filter matching folders whose parent account identifier matches id, according to cmp.

See also QMessageAccount::id().

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

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

See also QMessageAccount::id().

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

Returns a filter matching folders whose parent folder identifier matches id, according to cmp.

See also QMessageFolder::id().

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

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

See also QMessageFolder::id().

QMessageFolderFilter QMessageFolderFilter::byPath ( const QString & value, QMessageDataComparator::EqualityComparator cmp )   [static]

Returns a filter matching folders whose path matches value, according to cmp.

See also QMessageFolder::path().

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

Returns a filter matching folders whose path matches the substring value, according to cmp.

See also QMessageFolder::path().

bool QMessageFolderFilter::isEmpty () const

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

An empty filter matches all folders.

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 QMessageFolderFilter::isSupported () const

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

QMessageDataComparator::MatchFlags QMessageFolderFilter::matchFlags () const

Return the match flags for the search filter.

Default is no match flags set.

See also setMatchFlags().

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

Set the match flags for the search filter to matchFlags.

See also matchFlags().

QMessageFolderFilter QMessageFolderFilter::operator& ( const QMessageFolderFilter & other ) const

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

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

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

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

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

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

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

QMessageFolderFilter QMessageFolderFilter::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