Akonadi::CollectionFilterProxyModel Class Reference

A proxy model that filters collections by mime type. More...

#include <collectionfilterproxymodel.h>

Inherits QSortFilterProxyModel.

List of all members.

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
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 );

Author:

Bruno Virlet <bruno.virlet@gmail.com>

Definition at line 54 of file collectionfilterproxymodel.h.

---

Constructor & Destructor Documentation

CollectionFilterProxyModel::CollectionFilterProxyModel

(

QObject *

parent = 0

)

[explicit]

Creates a new collection proxy filter model.

Parameters:

parent

The parent object.

Definition at line 104 of file collectionfilterproxymodel.cpp.

CollectionFilterProxyModel::~CollectionFilterProxyModel

(

)

[virtual]

Destroys the collection proxy filter model.

Definition at line 110 of file collectionfilterproxymodel.cpp.

---

Member Function Documentation

void CollectionFilterProxyModel::addMimeTypeFilter

(

const QString &

mimeType

)

Add mime type to be shown by the filter.

Parameters:

mimeType

A mime type to be shown.

Definition at line 122 of file collectionfilterproxymodel.cpp.

void CollectionFilterProxyModel::addMimeTypeFilters

(

const QStringList &

mimeTypes

)

Add mime types to be shown by the filter.

Parameters:

mimeTypes

A list of mime types to be shown.

Definition at line 115 of file collectionfilterproxymodel.cpp.

void CollectionFilterProxyModel::clearFilters

(

)

Clear all mime type filters.

Definition at line 138 of file collectionfilterproxymodel.cpp.

QStringList CollectionFilterProxyModel::mimeTypeFilters

(

)

const

Returns the list of mime type filters.

Definition at line 133 of file collectionfilterproxymodel.cpp.

---

The documentation for this class was generated from the following files:

• collectionfilterproxymodel.h
• collectionfilterproxymodel.cpp