diff options
Diffstat (limited to 'src/messaging/qmessagesortorder.cpp')
| -rw-r--r-- | src/messaging/qmessagesortorder.cpp | 73 |
1 files changed, 37 insertions, 36 deletions
diff --git a/src/messaging/qmessagesortorder.cpp b/src/messaging/qmessagesortorder.cpp index 23cc487d15..d42275ba76 100644 --- a/src/messaging/qmessagesortorder.cpp +++ b/src/messaging/qmessagesortorder.cpp @@ -47,16 +47,17 @@ QTM_BEGIN_NAMESPACE /*! \class QMessageSortOrder - \brief The QMessageSortOrder class defines the parameters used for sorting a subset of + \brief The QMessageSortOrder class defines the parameters used for sorting a subset of queried messages from the messaging store. - + \inmodule QtMessaging - + \ingroup messaging + \since 1.0 - A QMessageSortOrder is composed of a message property to sort and a sort order. - The QMessageSortOrder class is used in conjunction with the QMessageManager::queryMessages() - and QMessageService::queryMessages() functions to sort message results according to + A QMessageSortOrder is composed of a message property to sort and a sort order. + The QMessageSortOrder class is used in conjunction with the QMessageManager::queryMessages() + and QMessageService::queryMessages() functions to sort message results according to the criteria defined by the sort order. For example: @@ -65,35 +66,35 @@ QTM_BEGIN_NAMESPACE QMessageSortOrder sortOrder(QMessageSortOrder::byTimeStamp(Qt::DescendingOrder)); QMessageIdList results = QMessageManager().queryMessages(QMessageFilter(), sortOrder); \endcode - + \sa QMessageManager, QMessageFilter */ /*! \fn QMessageSortOrder::QMessageSortOrder() - + Create a QMessageSortOrder with specifying matching parameters. - A default-constructed sort order (one for which isEmpty() returns true) sorts no messages. + A default-constructed sort order (one for which isEmpty() returns true) sorts no messages. - The result of combining an empty sort order with a non-empty sort order is the same as the original + The result of combining an empty sort order with a non-empty sort order is the same as the original non-empty sort order. The result of combining two empty sort orders is an empty sort order. - - Windows mobile and desktop platforms do not support sorting bySender() and byRecipients(), + + Windows mobile and desktop platforms do not support sorting bySender() and byRecipients(), additionally the Windows mobile platform does not support sorting byTimeStamp() and bySize(). */ /*! \fn QMessageSortOrder::QMessageSortOrder(const QMessageSortOrder &other) - + Constructs a copy of \a other. */ /*! \fn QMessageSortOrder::~QMessageSortOrder() - + Destroys the sort order. */ @@ -101,40 +102,40 @@ QTM_BEGIN_NAMESPACE \internal \fn QMessageSortOrder::operator=(const QMessageSortOrder& other) */ - + /*! \fn QMessageSortOrder::isEmpty() const - + Returns true if the sort order remains empty after default construction; otherwise returns false. */ /*! \fn QMessageSortOrder::isSupported() const - + Returns true if the sort order is supported on the current platform; otherwise returns false. */ /*! \fn QMessageSortOrder::operator+(const QMessageSortOrder& other) const - - Returns a sort order that which is the result of concatenating the vaue of this sort order and the value + + Returns a sort order that which is the result of concatenating the vaue of this sort order and the value of sort order \a other. This function determines sorting precedence. - - On the Windows Mobile platform bySubject() and byReceptionTimeStamp() sort orders can not + + On the Windows Mobile platform bySubject() and byReceptionTimeStamp() sort orders can not be combined with each other. */ /*! \fn QMessageSortOrder::operator+=(const QMessageSortOrder& other) - + Appends the value of the sort order \a other with the value of this sort order and assigns the result to this sort order. This function determines sorting precedence. - On the Windows Mobile platform bySubject() and byReceptionTimeStamp() sort orders can not + On the Windows Mobile platform bySubject() and byReceptionTimeStamp() sort orders can not be combined with each other. */ @@ -153,7 +154,7 @@ bool QMessageSortOrder::operator!=(const QMessageSortOrder& other) const /*! \fn QMessageSortOrder::byType(Qt::SortOrder order) - + Returns a sort order that sorts messages by their message type, according to \a order. \sa QMessage::type() @@ -161,9 +162,9 @@ bool QMessageSortOrder::operator!=(const QMessageSortOrder& other) const /*! \fn QMessageSortOrder::bySender(Qt::SortOrder order) - + Returns a sort order that sorts messages by the address from which they were sent, according to \a order. - + Not supported on the Windows mobile and desktop platforms. \sa QMessage::from() @@ -171,17 +172,17 @@ bool QMessageSortOrder::operator!=(const QMessageSortOrder& other) const /*! \fn QMessageSortOrder::byRecipients(Qt::SortOrder order) - + Returns a sort order that sorts messages by the addresses to which they were sent, according to \a order. Not supported on the Windows mobile and desktop platforms. - + \sa QMessage::to() */ /*! \fn QMessageSortOrder::bySubject(Qt::SortOrder order) - + Returns a sort order that sorts messages by their subject, according to \a order. \sa QMessage::subject() @@ -189,17 +190,17 @@ bool QMessageSortOrder::operator!=(const QMessageSortOrder& other) const /*! \fn QMessageSortOrder::byTimeStamp(Qt::SortOrder order) - + Returns a sort order that sorts messages by their origination timestamp, according to \a order. Not supported on the Windows mobile platform. - + \sa QMessage::date(), byReceptionTimeStamp() */ /*! \fn QMessageSortOrder::byReceptionTimeStamp(Qt::SortOrder order) - + Returns a sort order that sorts messages by their reception timestamp, according to \a order. \sa QMessage::receivedDate() @@ -207,7 +208,7 @@ bool QMessageSortOrder::operator!=(const QMessageSortOrder& other) const /*! \fn QMessageSortOrder::byStatus(QMessage::Status flag, Qt::SortOrder order) - + Returns a sort order that sorts messages by their status value \a flag, according to \a order. \sa QMessage::status() @@ -215,7 +216,7 @@ bool QMessageSortOrder::operator!=(const QMessageSortOrder& other) const /*! \fn QMessageSortOrder::byPriority(Qt::SortOrder order) - + Returns a sort order that sorts messages by their priority, according to \a order. \sa QMessage::priority() @@ -223,11 +224,11 @@ bool QMessageSortOrder::operator!=(const QMessageSortOrder& other) const /*! \fn QMessageSortOrder::bySize(Qt::SortOrder order) - + Returns a sort order that sorts messages by their size, according to \a order. Not supported on the Windows mobile platform. - + \sa QMessage::size() */ |