• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.11.3 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • CollectionFilterProxyModel
Public Member Functions | Protected Member Functions | List of all members
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 );
*
*
Author
Bruno Virlet bruno.nosp@m..vir.nosp@m.let@g.nosp@m.mail.nosp@m..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
parentThe parent object.

Definition at line 116 of file collectionfilterproxymodel.cpp.

CollectionFilterProxyModel::~CollectionFilterProxyModel ( )
virtual

Destroys the collection proxy filter model.

Definition at line 122 of file collectionfilterproxymodel.cpp.

Member Function Documentation

void CollectionFilterProxyModel::addMimeTypeFilter ( const QString &  mimeType)

Adds a mime type to be shown by the filter.

Parameters
mimeTypeA mime type to be shown.

Definition at line 134 of file collectionfilterproxymodel.cpp.

void CollectionFilterProxyModel::addMimeTypeFilters ( const QStringList &  mimeTypes)

Adds a list of mime types to be shown by the filter.

Parameters
mimeTypesA list of mime types to be shown.

Definition at line 127 of file collectionfilterproxymodel.cpp.

void CollectionFilterProxyModel::clearFilters ( )

Clears all mime type filters.

Definition at line 150 of file collectionfilterproxymodel.cpp.

QStringList CollectionFilterProxyModel::mimeTypeFilters ( ) const

Returns the list of mime type filters.

Definition at line 145 of file collectionfilterproxymodel.cpp.

void CollectionFilterProxyModel::setExcludeVirtualCollections ( bool  exclude)

Sets whether we want virtual collections to be filtered or not.

By default, virtual collections are accepted.

Parameters
excludeIf true, virtual collections aren't accepted.
Since
4.7

Definition at line 156 of file collectionfilterproxymodel.cpp.


The documentation for this class was generated from the following files:
  • collectionfilterproxymodel.h
  • collectionfilterproxymodel.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Nov 26 2013 09:03:22 by doxygen 1.8.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs-4.11.3 API Reference

Skip menu "kdepimlibs-4.11.3 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal