MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

QMessageFolder Class Reference

The QMessageFolder class provides an interface for folders containing messages in the messaging store. More...

 #include <QMessageFolder>

This class was introduced in Qt Mobility 1.0.

Public Functions

QMessageFolder ()
QMessageFolder ( const QMessageFolderId & id )
QMessageFolder ( const QMessageFolder & other )
virtual ~QMessageFolder ()
QMessageFolderId id () const
QString name () const
QMessageAccountId parentAccountId () const
QMessageFolderId parentFolderId () const
QString path () const

Detailed Description

The QMessageFolder class provides an interface for folders containing messages in the messaging store.

QMessageFolder represents a folder of messages, either fully or partially stored in the messaging store. A QMessageFolder object has an optional parent of the same type, allowing folders to be arranged in tree structures. Messages may be associated with folders, allowing for simple classification and access by their parentFolderId property.

See also QMessage and QMessageStore::folder().

Member Function Documentation

QMessageFolder::QMessageFolder ()

Constructor that creates an empty and invalid QMessageFolder. An empty folder is one which has no path, no parent folder and no parent account. An invalid folder does not exist in the database and has an invalid id.

QMessageFolder::QMessageFolder ( const QMessageFolderId & id )

Constructor that creates a QMessageFolder by loading the data from the messaging store as specified by the QMessageFolderId id. If the folder does not exist in the messaging store, then this constructor will create an empty and invalid QMessageFolder.

This function was introduced in Qt Mobility 1.0.

QMessageFolder::QMessageFolder ( const QMessageFolder & other )

Constructs a copy of other.

This function was introduced in Qt Mobility 1.0.

QMessageFolder::~QMessageFolder () [virtual]

Destroys the QMessageFolder object.

QMessageFolderId QMessageFolder::id () const

Returns the identifier of the QMessageFolder object. A QMessageFolder with an invalid identifier does not yet exist in the messaging store.

This function was introduced in Qt Mobility 1.0.

QString QMessageFolder::name () const

Returns the display name of the folder suitable for viewing in a user interface. This is typically the same as, or a simplification of the path() for the folder.

This function was introduced in Qt Mobility 1.0.

QMessageAccountId QMessageFolder::parentAccountId () const

Returns the identifier of the parent account of the folder. If the folder is not linked to an account an invalid identifier is returned.

This function was introduced in Qt Mobility 1.0.

QMessageFolderId QMessageFolder::parentFolderId () const

Returns the identifier of the parent folder. This folder is a root folder if the parent identifier is invalid.

This function was introduced in Qt Mobility 1.0.

QString QMessageFolder::path () const

Returns the path of the folder.

This function was introduced in Qt Mobility 1.0.