Akonadi::CollectionFilterProxyModel Class Reference
#include <collectionfilterproxymodel.h>
Inherits QSortFilterProxyModel.
Public Member Functions | |
CollectionFilterProxyModel (QObject *parent=0) | |
virtual | ~CollectionFilterProxyModel () |
void | addMimeTypeFilter (const QString &mimeType) |
void | addMimeTypeFilters (const QStringList &mimeTypes) |
void | clearFilters () |
virtual Qt::ItemFlags | flags (const QModelIndex &index) const |
QStringList | mimeTypeFilters () const |
void | setExcludeVirtualCollections (bool exclude) |
Protected Member Functions | |
virtual bool | filterAcceptsRow (int sourceRow, const QModelIndex &sourceParent) const |
Detailed Description
A proxy model that filters collections by mime type.
This class can be used on top of a CollectionModel to filter out all collections that doesn't match a given mime type.
For instance, a mail application will use addMimeType( "message/rfc822" ) to only show collections containing mail.
Akonadi::CollectionModel *model = new Akonadi::CollectionModel( this ); Akonadi::CollectionFilterProxyModel *proxy = new Akonadi::CollectionFilterProxyModel(); proxy->addMimeTypeFilter( "message/rfc822" ); proxy->setSourceModel( model ); QTreeView *view = new QTreeView( this ); view->setModel( proxy );
Constructor & Destructor Documentation
Akonadi::CollectionFilterProxyModel::CollectionFilterProxyModel | ( | QObject * | parent = 0 | ) | [explicit] |
Creates a new collection proxy filter model.
- Parameters:
-
parent The parent object.
virtual Akonadi::CollectionFilterProxyModel::~CollectionFilterProxyModel | ( | ) | [virtual] |
Destroys the collection proxy filter model.
Member Function Documentation
void Akonadi::CollectionFilterProxyModel::addMimeTypeFilter | ( | const QString & | mimeType | ) |
Adds a mime type to be shown by the filter.
- Parameters:
-
mimeType A mime type to be shown.
void Akonadi::CollectionFilterProxyModel::addMimeTypeFilters | ( | const QStringList & | mimeTypes | ) |
Adds a list of mime types to be shown by the filter.
- Parameters:
-
mimeTypes A list of mime types to be shown.
void Akonadi::CollectionFilterProxyModel::clearFilters | ( | ) |
Clears all mime type filters.
QStringList Akonadi::CollectionFilterProxyModel::mimeTypeFilters | ( | ) | const |
Returns the list of mime type filters.
void Akonadi::CollectionFilterProxyModel::setExcludeVirtualCollections | ( | bool | exclude | ) |
Sets whether we want virtual collections to be filtered or not.
By default, virtual collections are accepted.
- Parameters:
-
exclude If true, virtual collections aren't accepted.
- Since:
- 4.7
The documentation for this class was generated from the following file: