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> This class is under development and is subject to change.
Public Functions
Static Public Members
QMessageFilter byAncestorFolderIds id , QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )QMessageFilter byAncestorFolderIds filter , QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )QMessageFilter byId id , QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )QMessageFilter byId ids , QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )QMessageFilter byId filter , QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )QMessageFilter byParentAccountId id , QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )QMessageFilter byParentAccountId filter , QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )QMessageFilter byParentFolderId id , QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )QMessageFilter byParentFolderId filter , QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )QMessageFilter byPriority value , QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )QMessageFilter byReceptionTimeStamp value , QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )QMessageFilter byReceptionTimeStamp value , QMessageDataComparator::RelationComparator cmp )QMessageFilter byRecipients value , QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )QMessageFilter bySender value , QMessageDataComparator::EqualityComparator cmp )QMessageFilter bySender value , QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )QMessageFilter bySize value , QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )QMessageFilter bySize value , QMessageDataComparator::RelationComparator cmp )QMessageFilter byStandardFolder folder , QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )QMessageFilter byStatus value , QMessageDataComparator::EqualityComparator cmp )QMessageFilter byStatus mask , QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )QMessageFilter bySubject value , QMessageDataComparator::EqualityComparator cmp )QMessageFilter bySubject value , QMessageDataComparator::InclusionComparator cmp = QMessageDataComparator::Includes )QMessageFilter byTimeStamp value , QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )QMessageFilter byTimeStamp value , QMessageDataComparator::RelationComparator cmp )QMessageFilter byType type , QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal )QMessageFilter byType type , QMessageDataComparator::InclusionComparator cmp )
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 QMessageStore::queryMessages (), QMessageStore::countMessages (), QMessageServiceAction::queryMessages (), and QMessageServiceAction::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 = QMessageStore::instance()->queryMessages(subjectFilter & senderFilter);
See also QMessageStore and QMessage .
Member Function Documentation
Creates a QMessageFilter without specifying matching parameters.
A default-constructed filter (one for which isEmpty () returns true) matches all messages.
See also isEmpty ().
other )Constructs a copy of other .
[virtual] Destroys the filter.
Returns a filter matching messages whose ancestor folders' identifiers contain id , according to cmp .
See also QMessage::parentFolderId ().
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 ().
Returns a filter matching messages whose identifier matches id , according to cmp .
See also QMessage::id ().
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 ().
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 ().
Returns a filter matching messages whose parent account's identifier matches id , according to cmp .
See also QMessage::parentAccountId ().
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 ().
Returns a filter matching messages whose parent folder's identifier matches id , according to cmp .
See also QMessage::parentFolderId ().
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 ().
Returns a filter matching messages whose priority matches value , according to cmp .
See also QMessage::priority ().
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 ().
Returns a filter matching messages whose reception timestamp has the relation to value that is specified by cmp .
See also QMessage::receivedDate ().
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 ().
Returns a filter matching messages whose sender matches value , according to cmp .
See also QMessage::from ().
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 ().
value , QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal ) [static] Returns a filter matching messages whose size matches value , according to cmp .
See also QMessage::size ().
Returns a filter matching messages whose size matches value , according to cmp .
See also QMessage::size ().
Returns a filter matching messages whose standard folder location matches folder , according to cmp .
See also QMessage::parentAccountId ().
Returns a filter matching messages whose status matches value , according to cmp .
See also QMessage::status ().
Returns a filter matching messages whose status is a bitwise match to mask , according to cmp .
See also QMessage::status ().
Returns a filter matching messages whose subject matches value , according to cmp .
See also QMessage::subject ().
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 ().
QDateTime & value , QMessageDataComparator::EqualityComparator cmp = QMessageDataComparator::Equal ) [static] Returns a filter matching messages whose timestamp matches value , according to cmp .
See also QMessage::date ().
Returns a filter matching messages whose timestamp has the relation to value that is specified by cmp .
See also QMessage::date ().
Returns a filter matching messages whose type matches type , according to cmp .
See also QMessage::type ().
Returns a filter matching accounts whose type is a bitwise match to type , according to cmp .
See also QMessage::type ().
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.
Returns true if the filter is supported on the current platform; otherwise returns false.
Return the options for the search filter.
Default is no options set.
See also setOptions ().
Set the options for the search filter to options .
See also options ().
other ) constReturns a filter that is the logical AND of this filter and the value of filter other .
other )
Performs a logical AND with this filter and the filter other and assigns the result to this filter.
other ) constReturns a filter that is the logical OR of this filter and the value of filter other .
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 options () 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 ().
Publicité
Best Of
Actualités les plus lues
Le blog Digia au hasard
Le blog Digia est l'endroit privilégié pour la communication sur l'édition commerciale de Qt, où des réponses publiques sont apportées aux questions les plus posées au support.
Lire l'article.
Communauté
Ressources
Liens utiles
Contact
Vous souhaitez rejoindre la rédaction ou proposer un tutoriel, une traduction, une question... ? Postez dans le forum Contribuez ou contactez-nous par MP ou par email (voir en bas de page).
Qt dans le magazine
