Home · All Classes · All Functions ·

QMessageFolderOrdering Class Reference

The QMessageFolderOrdering class defines the parameters used for sorting a subset of queried folders from the messaging store. More...

    #include <QMessageFolderOrdering>

This class is under development and is subject to change.


Public Functions

QMessageFolderOrdering ()
QMessageFolderOrdering ( const QMessageFolderOrdering & other )
virtual ~QMessageFolderOrdering ()
bool isEmpty () const
bool isSupported () const
QMessageFolderOrdering operator+ ( const QMessageFolderOrdering & other ) const
QMessageFolderOrdering & operator+= ( const QMessageFolderOrdering & other )

Static Public Members

QMessageFolderOrdering byDisplayName ( Qt::SortOrder order = Qt::AscendingOrder )
QMessageFolderOrdering byPath ( Qt::SortOrder order = Qt::AscendingOrder )

Detailed Description

The QMessageFolderOrdering class defines the parameters used for sorting a subset of queried folders from the messaging store.

A QMessageFolderOrdering is composed of a folder property to sort and a sort order. The QMessageFolderOrdering class is used in conjunction with the QMessageStore::queryFolders() function to sort folder results according to the criteria defined by the ordering.

See also QMessageStore and QMessageFolderFilter.


Member Function Documentation

QMessageFolderOrdering::QMessageFolderOrdering ()

Create a QMessageFolderOrdering with specifying matching parameters.

A default-constructed ordering (one for which isEmpty() returns true) sorts no folders.

The result of combining an empty ordering with a non-empty ordering is the same as the original non-empty ordering.

The result of combining two empty keys is an empty ordering.

QMessageFolderOrdering::QMessageFolderOrdering ( const QMessageFolderOrdering & other )

Constructs a copy of other.

QMessageFolderOrdering::~QMessageFolderOrdering ()   [virtual]

Destroys the ordering.

QMessageFolderOrdering QMessageFolderOrdering::byDisplayName ( Qt::SortOrder order = Qt::AscendingOrder )   [static]

Returns an ordering that sorts folders by display name, according to order.

See also QMessageFolder::displayName().

QMessageFolderOrdering QMessageFolderOrdering::byPath ( Qt::SortOrder order = Qt::AscendingOrder )   [static]

Returns an ordering that sorts messages by path according to order.

See also QMessageFolder::path().

bool QMessageFolderOrdering::isEmpty () const

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

bool QMessageFolderOrdering::isSupported () const

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

QMessageFolderOrdering QMessageFolderOrdering::operator+ ( const QMessageFolderOrdering & other ) const

Returns an ordering that which is the result of concatenating the vaue of this ordering and the value of other.

This function determines sorting precedence.

QMessageFolderOrdering & QMessageFolderOrdering::operator+= ( const QMessageFolderOrdering & other )

Appends the value of the ordering other with the value of this ordering and assigns the result to this ordering.

This function determines sorting precedence.


Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt Mobility Project 1.0.0 (Technology Preview)