MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

QMessageFolderSortOrder Class Reference

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

 #include <QMessageFolderSortOrder>

This class was introduced in Qt Mobility 1.0.

Public Functions

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

Static Public Members

QMessageFolderSortOrder byName ( Qt::SortOrder order = Qt::AscendingOrder )
QMessageFolderSortOrder byPath ( Qt::SortOrder order = Qt::AscendingOrder )

Detailed Description

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

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

See also QMessageManager and QMessageFolderFilter.

Member Function Documentation

QMessageFolderSortOrder::QMessageFolderSortOrder ()

Create a QMessageFolderSortOrder with specifying matching parameters.

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

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.

QMessageFolderSortOrder::QMessageFolderSortOrder ( const QMessageFolderSortOrder & other )

Constructs a copy of other.

This function was introduced in Qt Mobility 1.0.

QMessageFolderSortOrder::~QMessageFolderSortOrder () [virtual]

Destroys the sort order.

QMessageFolderSortOrder QMessageFolderSortOrder::byName ( Qt::SortOrder order = Qt::AscendingOrder ) [static]

Returns a sort order that sorts folders by display name, according to order.

This function was introduced in Qt Mobility 1.0.

See also QMessageFolder::name().

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

Returns a sort order that sorts messages by path according to order.

This function was introduced in Qt Mobility 1.0.

See also QMessageFolder::path().

bool QMessageFolderSortOrder::isEmpty () const

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

This function was introduced in Qt Mobility 1.0.

bool QMessageFolderSortOrder::isSupported () const

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

This function was introduced in Qt Mobility 1.0.

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

Returns a sort order that which is the result of concatenating the vaue of this sort order and the value of other.

This function determines sorting precedence.

This function was introduced in Qt Mobility 1.0.

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

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

This function determines sorting precedence.

This function was introduced in Qt Mobility 1.0.