The QMessageFolderFilter class defines the parameters used for querying a subset of all available folders from the messaging store. More...
#include <QMessageFolderFilter>
QMessageFolderFilter () | |
QMessageFolderFilter ( const QMessageFolderFilter & other ) | |
virtual | ~QMessageFolderFilter () |
bool | isEmpty () const |
bool | isSupported () const |
QMessageDataComparator::MatchFlags | matchFlags () const |
void | setMatchFlags ( QMessageDataComparator::MatchFlags matchFlags ) |
QMessageFolderFilter | operator& ( const QMessageFolderFilter & other ) const |
const QMessageFolderFilter & | operator&= ( const QMessageFolderFilter & other ) |
QMessageFolderFilter | operator| ( const QMessageFolderFilter & other ) const |
const QMessageFolderFilter & | operator|= ( const QMessageFolderFilter & other ) |
QMessageFolderFilter | operator~ () const |
QMessageFolderFilter | byAncestorFolderIds ( const QMessageFolderId & id, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFolderFilter | byAncestorFolderIds ( const QMessageFolderFilter & filter, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFolderFilter | byId ( const QMessageFolderId & id, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal ) |
QMessageFolderFilter | byId ( const QMessageFolderIdList & ids, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFolderFilter | byId ( const QMessageFolderFilter & filter, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFolderFilter | byName ( const QString & value, QMessageDataComparator::EqualityComparator cmp ) |
QMessageFolderFilter | byName ( const QString & value, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFolderFilter | byParentAccountId ( const QMessageAccountId & id, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal ) |
QMessageFolderFilter | byParentAccountId ( const QMessageAccountFilter & filter, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFolderFilter | byParentFolderId ( const QMessageFolderId & id, QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal ) |
QMessageFolderFilter | byParentFolderId ( const QMessageFolderFilter & filter, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
QMessageFolderFilter | byPath ( const QString & value, QMessageDataComparator::EqualityComparator cmp ) |
QMessageFolderFilter | byPath ( const QString & value, QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes ) |
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.
Creates a QMessageFolderFilter without specifying matching parameters.
A default-constructed filter (one for which isEmpty() returns true) matches all folders.
See also isEmpty().
Constructs a copy of other.
Destroys the filter.
Returns a filter matching folders whose ancestor folders' identifiers contain id, according to cmp.
See also QMessageFolder::id().
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().
Returns a filter matching folders whose identifier matches id, according to cmp.
See also QMessageFolder::id().
Returns a filter matching folders whose identifier is a member of ids, according to cmp.
See also QMessageFolder::id().
Returns a filter matching folders whose identifier is a member of the set yielded by filter, according to cmp.
See also QMessageFolder::id().
Returns a filter matching folders whose display name matches value, according to cmp.
See also QMessageFolder::name().
Returns a filter matching folders whose display name matches the substring value, according to cmp.
See also QMessageFolder::name().
Returns a filter matching folders whose parent account identifier matches id, according to cmp.
See also QMessageAccount::id().
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().
Returns a filter matching folders whose parent folder identifier matches id, according to cmp.
See also QMessageFolder::id().
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().
Returns a filter matching folders whose path matches value, according to cmp.
See also QMessageFolder::path().
Returns a filter matching folders whose path matches the substring value, according to cmp.
See also QMessageFolder::path().
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 using an AND operation is the original non-empty filter.
The result of combining an empty filter with a non-empty filter using an OR operation is the empty filter.
The result of combining two empty filters is an empty filter.
Returns true if the filter is supported on the current platform; otherwise returns false.
Return the match flags for the search filter.
Default is no match flags set.
See also setMatchFlags().
Set the match flags for the search filter to matchFlags.
See also matchFlags().
Returns a filter that is the logical AND of this filter and the value of filter other.
Performs a logical AND with this filter and the filter other and assigns the result to this filter.
Returns a filter that is the logical OR of this filter and the value of filter other.
Performs a logical OR with this filter and the filter other and assigns the result to this filter.
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().