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

akonadi

  • Akonadi
  • EntityMimeTypeFilterModel
Public Member Functions | Protected Member Functions | List of all members
Akonadi::EntityMimeTypeFilterModel Class Reference

#include <entitymimetypefiltermodel.h>

Inherits QSortFilterProxyModel.

Public Member Functions

 EntityMimeTypeFilterModel (QObject *parent=0)
 
virtual ~EntityMimeTypeFilterModel ()
 
void addMimeTypeExclusionFilter (const QString &mimeType)
 
void addMimeTypeExclusionFilters (const QStringList &mimeTypes)
 
void addMimeTypeInclusionFilter (const QString &mimeType)
 
void addMimeTypeInclusionFilters (const QStringList &mimeTypes)
 
virtual bool canFetchMore (const QModelIndex &parent) const
 
void clearFilters ()
 
virtual int columnCount (const QModelIndex &parent=QModelIndex()) const
 
virtual bool hasChildren (const QModelIndex &parent=QModelIndex()) const
 
virtual QVariant headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
 
virtual QModelIndexList match (const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags(Qt::MatchStartsWith|Qt::MatchWrap)) const
 
QStringList mimeTypeExclusionFilters () const
 
QStringList mimeTypeInclusionFilters () const
 
void setHeaderGroup (EntityTreeModel::HeaderGroup headerGroup)
 

Protected Member Functions

virtual bool filterAcceptsColumn (int sourceColumn, const QModelIndex &sourceParent) const
 
virtual bool filterAcceptsRow (int sourceRow, const QModelIndex &sourceParent) const
 

Detailed Description

A proxy model that filters entities by mime type.

This class can be used on top of an EntityTreeModel to exclude entities by mimetype or to include only certain mimetypes.

Akonadi::EntityTreeModel *model = new Akonadi::EntityTreeModel( this );
Akonadi::EntityMimeTypeFilterModel *proxy = new Akonadi::EntityMimeTypeFilterModel();
proxy->addMimeTypeInclusionFilter( "message/rfc822" );
proxy->setSourceModel( model );
Akonadi::EntityTreeView *view = new Akonadi::EntityTreeView( this );
view->setModel( proxy );
Akonadi::EntityMimeTypeFilterModel
A proxy model that filters entities by mime type.
Definition: entitymimetypefiltermodel.h:62
Akonadi::EntityMimeTypeFilterModel::addMimeTypeInclusionFilter
void addMimeTypeInclusionFilter(const QString &mimeType)
Add mime type to be shown by the filter.
Definition: entitymimetypefiltermodel.cpp:85
Akonadi::EntityTreeModel
A model for collections and items together.
Definition: entitytreemodel.h:319
Akonadi::EntityTreeView
A view to show an item/collection tree provided by an EntityTreeModel.
Definition: entitytreeview.h:72
Akonadi::EntityTreeView::setModel
virtual void setModel(QAbstractItemModel *model)
Definition: entitytreeview.cpp:209
  • If a mimetype is in both the exclusion list and the inclusion list, it is excluded.
  • If the mimeTypeInclusionFilter is empty, all mimetypes are accepted (except if they are in the exclusion filter of course).
Author
Bruno Virlet bruno.nosp@m..vir.nosp@m.let@g.nosp@m.mail.nosp@m..com
Stephen Kelly steve.nosp@m.ire@.nosp@m.gmail.nosp@m..com
Since
4.4

Definition at line 61 of file entitymimetypefiltermodel.h.

Constructor & Destructor Documentation

◆ EntityMimeTypeFilterModel()

EntityMimeTypeFilterModel::EntityMimeTypeFilterModel ( QObject *  parent = 0)
explicit

Creates a new entity mime type filter model.

Parameters
parentThe parent object.

Definition at line 60 of file entitymimetypefiltermodel.cpp.

◆ ~EntityMimeTypeFilterModel()

EntityMimeTypeFilterModel::~EntityMimeTypeFilterModel ( )
virtual

Destroys the entity mime type filter model.

Definition at line 66 of file entitymimetypefiltermodel.cpp.

Member Function Documentation

◆ addMimeTypeExclusionFilter()

void EntityMimeTypeFilterModel::addMimeTypeExclusionFilter ( const QString &  mimeType)

Add mime type to be excluded by the filter.

Parameters
mimeTypeA mime type to be excluded.

Definition at line 92 of file entitymimetypefiltermodel.cpp.

◆ addMimeTypeExclusionFilters()

void EntityMimeTypeFilterModel::addMimeTypeExclusionFilters ( const QStringList &  mimeTypes)

Add mimetypes to filter out.

Parameters
mimeTypesA list to exclude from the model.

Definition at line 78 of file entitymimetypefiltermodel.cpp.

◆ addMimeTypeInclusionFilter()

void EntityMimeTypeFilterModel::addMimeTypeInclusionFilter ( const QString &  mimeType)

Add mime type to be shown by the filter.

Parameters
mimeTypeA mime type to be shown.

Definition at line 85 of file entitymimetypefiltermodel.cpp.

◆ addMimeTypeInclusionFilters()

void EntityMimeTypeFilterModel::addMimeTypeInclusionFilters ( const QStringList &  mimeTypes)

Add mime types to be shown by the filter.

Parameters
mimeTypesA list of mime types to be included.

Definition at line 71 of file entitymimetypefiltermodel.cpp.

◆ canFetchMore()

bool EntityMimeTypeFilterModel::canFetchMore ( const QModelIndex &  parent) const
virtual

Definition at line 272 of file entitymimetypefiltermodel.cpp.

◆ clearFilters()

void EntityMimeTypeFilterModel::clearFilters ( )

Clear all mime type filters.

Definition at line 144 of file entitymimetypefiltermodel.cpp.

◆ columnCount()

int EntityMimeTypeFilterModel::columnCount ( const QModelIndex &  parent = QModelIndex()) const
virtual

Definition at line 220 of file entitymimetypefiltermodel.cpp.

◆ filterAcceptsColumn()

bool EntityMimeTypeFilterModel::filterAcceptsColumn ( int  sourceColumn,
const QModelIndex &  sourceParent 
) const
protectedvirtual

Definition at line 99 of file entitymimetypefiltermodel.cpp.

◆ filterAcceptsRow()

bool EntityMimeTypeFilterModel::filterAcceptsRow ( int  sourceRow,
const QModelIndex &  sourceParent 
) const
protectedvirtual

Definition at line 107 of file entitymimetypefiltermodel.cpp.

◆ hasChildren()

bool EntityMimeTypeFilterModel::hasChildren ( const QModelIndex &  parent = QModelIndex()) const
virtual

Definition at line 236 of file entitymimetypefiltermodel.cpp.

◆ headerData()

QVariant EntityMimeTypeFilterModel::headerData ( int  section,
Qt::Orientation  orientation,
int  role = Qt::DisplayRole 
) const
virtual

Definition at line 158 of file entitymimetypefiltermodel.cpp.

◆ match()

QModelIndexList EntityMimeTypeFilterModel::match ( const QModelIndex &  start,
int  role,
const QVariant &  value,
int  hits = 1,
Qt::MatchFlags  flags = Qt::MatchFlags(Qt::MatchStartsWith | Qt::MatchWrap) 
) const
virtual

Definition at line 169 of file entitymimetypefiltermodel.cpp.

◆ mimeTypeExclusionFilters()

QStringList EntityMimeTypeFilterModel::mimeTypeExclusionFilters ( ) const

Returns the list of mime type exclusion filters.

Definition at line 138 of file entitymimetypefiltermodel.cpp.

◆ mimeTypeInclusionFilters()

QStringList EntityMimeTypeFilterModel::mimeTypeInclusionFilters ( ) const

Returns the list of mime type inclusion filters.

Definition at line 132 of file entitymimetypefiltermodel.cpp.

◆ setHeaderGroup()

void EntityMimeTypeFilterModel::setHeaderGroup ( EntityTreeModel::HeaderGroup  headerGroup)

Sets the header set of the filter model.

Parameters
headerGroupthe header to set.
See also
EntityTreeModel::HeaderGroup

Definition at line 152 of file entitymimetypefiltermodel.cpp.


The documentation for this class was generated from the following files:
  • entitymimetypefiltermodel.h
  • entitymimetypefiltermodel.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.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.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 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