QMailFolderMessageSet Class Reference
[QtMessagingModule]

Detailed Description

The QMailFolderMessageSet class represents a set of messages corresponding to the content of a QMailFolder.

QMailFolderMessageSet provides a representation for a named subset of messages, specified by their parent QMailFolder.

If the QMailFolderMessageSet is hierarchical(), then any folders contained by the parent QMailFolder will automatically be managed as child QMailFolderMessageSets of the parent QMailFolderMessageSet.

Member Function Documentation

QMailFolderMessageSet::QMailFolderMessageSet ( QMailMessageSetContainer * container, const QMailFolderId & folderId, bool hierarchical = true )

Constructs a QMailFolderMessageSet within the parent container container, whose message set is defined by the content of the QMailFolder identified by folderId. If hierarchical is true, the message set will automatically maintain a set of child QMailFolderMessageSets corresponding to QMailFolders whose parentId is folderId.

QMailMessageKey QMailFolderMessageSet::contentKey ( const QMailFolderId & id, bool descendants )   [static]

Returns the message key that defines the content of a QMailFolderMessageSet for the folder identified by id. If descendants is true, then the result is the key that defines the descendantMessageKey() content.

void QMailFolderMessageSet::createChild ( const QMailFolderId & childId )   [virtual protected]

Creates a message set object for the folder identified by childId, and appends it to this object.

Override this function to specialize the type created for child nodes.

QMailMessageKey QMailFolderMessageSet::descendantsMessageKey () const   [virtual]

Returns the QMailMessageKey that selects the messages beneath the configured folder in the hierarchy.

Reimplemented from QMailMessageSet.

QString QMailFolderMessageSet::displayName () const   [virtual]

Returns the display name of the folder that this message set represents.

Reimplemented from QMailMessageSet.

See also QMailFolder::displayName().

QMailFolderId QMailFolderMessageSet::folderId () const

Returns the identifier of the QMailFolder associated with this message set.

bool QMailFolderMessageSet::hierarchical () const

Returns true if this message set automatically maintains a hierarchy of child folder message sets.

QMailMessageKey QMailFolderMessageSet::messageKey () const   [virtual]

Returns the QMailMessageKey that selects the messages contained by the configured folder.

Reimplemented from QMailMessageSet.