QMailFilterMessageSet Class Reference
[QtMessagingModule]

Detailed Description

The QMailFilterMessageSet class represents a set of messages selected by a pre-determined filter criteria.

QMailFilterMessageSet provides a representation for a named subset of messages, specified by a set of criteria encoded into a QMailMessageKey object. The properties of the QMailFilterMessageSet are mutable and can be changed after construction.

Member Function Documentation

QMailFilterMessageSet::QMailFilterMessageSet ( QMailMessageSetContainer * container, const QMailMessageKey & key, const QString & name, bool minimalUpdates = true )

Constructs a QMailFilterMessageSet within the parent container container, named name, whose message set is specified by the filter key, and with update minimization set to minimalUpdates.

See also setUpdatesMinimized().

QString QMailFilterMessageSet::displayName () const   [virtual]

Returns the name of this message set for display purposes.

Reimplemented from QMailMessageSet.

See also setDisplayName().

QMailMessageKey QMailFilterMessageSet::messageKey () const   [virtual]

Returns the QMailMessageKey that selects the messages represented by this message set.

Reimplemented from QMailMessageSet.

See also setMessageKey().

void QMailFilterMessageSet::setDisplayName ( const QString & name )   [virtual]

Sets the name of this message set for display purposes to name.

See also displayName().

void QMailFilterMessageSet::setMessageKey ( const QMailMessageKey & key )   [virtual]

Sets the QMailMessageKey that selects the messages represented by this message set to key.

See also messageKey().

void QMailFilterMessageSet::setUpdatesMinimized ( bool set )   [virtual]

Sets update minimization to set.

If update minimization is set to true, the QMailFilterMessageSet will only emit the update() signal when the list of messages matching the filter key actually changes. If update minimization is false, the update() signal will also be spuriously emitted; depending on the handling of that signal, this strategy may consume significantly less resources than are required to ensure minimal updates are emitted.

See also updatesMinimized().

bool QMailFilterMessageSet::updatesMinimized () const   [virtual]

Returns true if this message set has update minimization enabled; otherwise returns false;

See also setUpdatesMinimized().