|  | Home |

# QMailFilterMessageSet Class Reference

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

        #include <QMailFilterMessageSet>

This class is under development and is subject to change.

Inherits QMailMessageSet.

- List of all members, including inherited members

## Public Functions

| QMailFilterMessageSet ( QMailMessageSetContainer * container, const QMailMessageKey & key, const QString & name, bool minimalUpdates = true )
virtual void | setDisplayName ( const QString & name )
virtual void | setMessageKey ( const QMailMessageKey & key )
virtual void | setUpdatesMinimized ( bool set )
virtual bool | updatesMinimized () const

## Reimplemented Public Functions

virtual QString | displayName () const
virtual QMailMessageKey | messageKey () const

- 5 public functions inherited from QMailMessageSet
- 29 public functions inherited from QObject
- 10 public functions inherited from QMailMessageSetContainer

### Additional Inherited Members

- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 1 signal inherited from QObject
- 1 public type inherited from QObject
- 4 static public members inherited from QObject
- 1 protected function inherited from QMailMessageSet
- 7 protected functions inherited from QObject
- 1 protected function inherited from QMailMessageSetContainer
- 2 protected variables inherited from QObject

## 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]`

Reimplemented from QMailMessageSet::displayName().

Returns the name of this message set for display purposes.

See also setDisplayName().

### QMailMessageKey QMailFilterMessageSet::messageKey () const `[virtual]`

Reimplemented from QMailMessageSet::messageKey().

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

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().