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

akonadi

  • akonadi
entitymimetypefiltermodel.cpp
1 /*
2  Copyright (c) 2007 Bruno Virlet <bruno.virlet@gmail.com>
3  Copyright (c) 2009 Stephen Kelly <steveire@gmail.com>
4 
5 
6  This library is free software; you can redistribute it and/or modify it
7  under the terms of the GNU Library General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or (at your
9  option) any later version.
10 
11  This library is distributed in the hope that it will be useful, but WITHOUT
12  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
14  License for more details.
15 
16  You should have received a copy of the GNU Library General Public License
17  along with this library; see the file COPYING.LIB. If not, write to the
18  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19  02110-1301, USA.
20 */
21 
22 #include "entitymimetypefiltermodel.h"
23 
24 #include "entitytreemodel.h"
25 #include "mimetypechecker.h"
26 
27 #include <kdebug.h>
28 #include <kmimetype.h>
29 
30 #include <QtCore/QString>
31 #include <QtCore/QStringList>
32 
33 using namespace Akonadi;
34 
35 namespace Akonadi {
39 class EntityMimeTypeFilterModelPrivate
40 {
41  public:
42  EntityMimeTypeFilterModelPrivate( EntityMimeTypeFilterModel *parent )
43  : q_ptr( parent ),
44  m_headerGroup( EntityTreeModel::EntityTreeHeaders )
45  {
46  }
47 
48  Q_DECLARE_PUBLIC( EntityMimeTypeFilterModel )
49  EntityMimeTypeFilterModel *q_ptr;
50 
51  QStringList includedMimeTypes;
52  QStringList excludedMimeTypes;
53 
54  QPersistentModelIndex m_rootIndex;
55 
56  EntityTreeModel::HeaderGroup m_headerGroup;
57 };
58 
59 }
60 
61 EntityMimeTypeFilterModel::EntityMimeTypeFilterModel( QObject *parent )
62  : QSortFilterProxyModel( parent ),
63  d_ptr( new EntityMimeTypeFilterModelPrivate( this ) )
64 {
65 }
66 
67 EntityMimeTypeFilterModel::~EntityMimeTypeFilterModel()
68 {
69  delete d_ptr;
70 }
71 
72 void EntityMimeTypeFilterModel::addMimeTypeInclusionFilters(const QStringList &typeList)
73 {
74  Q_D( EntityMimeTypeFilterModel );
75  d->includedMimeTypes << typeList;
76  invalidateFilter();
77 }
78 
79 void EntityMimeTypeFilterModel::addMimeTypeExclusionFilters(const QStringList &typeList)
80 {
81  Q_D( EntityMimeTypeFilterModel );
82  d->excludedMimeTypes << typeList;
83  invalidateFilter();
84 }
85 
86 void EntityMimeTypeFilterModel::addMimeTypeInclusionFilter(const QString &type)
87 {
88  Q_D( EntityMimeTypeFilterModel );
89  d->includedMimeTypes << type;
90  invalidateFilter();
91 }
92 
93 void EntityMimeTypeFilterModel::addMimeTypeExclusionFilter(const QString &type)
94 {
95  Q_D( EntityMimeTypeFilterModel );
96  d->excludedMimeTypes << type;
97  invalidateFilter();
98 }
99 
100 bool EntityMimeTypeFilterModel::filterAcceptsColumn( int sourceColumn, const QModelIndex &sourceParent ) const
101 {
102  if ( sourceColumn >= columnCount( mapFromSource( sourceParent ) ) ) {
103  return false;
104  }
105  return QSortFilterProxyModel::filterAcceptsColumn( sourceColumn, sourceParent );
106 }
107 
108 bool EntityMimeTypeFilterModel::filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent) const
109 {
110  Q_D( const EntityMimeTypeFilterModel );
111  const QModelIndex idx = sourceModel()->index( sourceRow, 0, sourceParent );
112 
113  const Akonadi::Item item = idx.data( EntityTreeModel::ItemRole ).value<Akonadi::Item>();
114 
115  if ( item.isValid() && !item.hasPayload() ) {
116  kDebug() << "Item " << item.id() << " doesn't have payload";
117  return false;
118  }
119 
120  const QString rowMimetype = idx.data( EntityTreeModel::MimeTypeRole ).toString();
121 
122  if ( d->excludedMimeTypes.contains( rowMimetype ) ) {
123  return false;
124  }
125  if ( d->includedMimeTypes.isEmpty() ||
126  d->includedMimeTypes.contains( rowMimetype ) ) {
127  return true;
128  }
129 
130  return false;
131 }
132 
133 QStringList EntityMimeTypeFilterModel::mimeTypeInclusionFilters() const
134 {
135  Q_D( const EntityMimeTypeFilterModel );
136  return d->includedMimeTypes;
137 }
138 
139 QStringList EntityMimeTypeFilterModel::mimeTypeExclusionFilters() const
140 {
141  Q_D( const EntityMimeTypeFilterModel );
142  return d->excludedMimeTypes;
143 }
144 
145 void EntityMimeTypeFilterModel::clearFilters()
146 {
147  Q_D( EntityMimeTypeFilterModel );
148  d->includedMimeTypes.clear();
149  d->excludedMimeTypes.clear();
150  invalidateFilter();
151 }
152 
153 void EntityMimeTypeFilterModel::setHeaderGroup(EntityTreeModel::HeaderGroup headerGroup)
154 {
155  Q_D( EntityMimeTypeFilterModel );
156  d->m_headerGroup = headerGroup;
157 }
158 
159 QVariant EntityMimeTypeFilterModel::headerData(int section, Qt::Orientation orientation, int role ) const
160 {
161  if ( !sourceModel() ) {
162  return QVariant();
163  }
164 
165  Q_D( const EntityMimeTypeFilterModel );
166  role += ( EntityTreeModel::TerminalUserRole * d->m_headerGroup );
167  return sourceModel()->headerData( section, orientation, role );
168 }
169 
170 QModelIndexList EntityMimeTypeFilterModel::match( const QModelIndex& start, int role, const QVariant& value, int hits, Qt::MatchFlags flags ) const
171 {
172  if ( !sourceModel() ) {
173  return QModelIndexList();
174  }
175 
176  if ( EntityTreeModel::AmazingCompletionRole != role ) {
177  if ( role < Qt::UserRole ) {
178  return QSortFilterProxyModel::match( start, role, value, hits, flags );
179  }
180 
181  QModelIndexList list;
182  QModelIndex proxyIndex;
183  foreach ( const QModelIndex &idx, sourceModel()->match( mapToSource( start ), role, value, hits, flags ) ) {
184  proxyIndex = mapFromSource( idx );
185  if ( proxyIndex.isValid() ) {
186  list << proxyIndex;
187  }
188  }
189 
190  return list;
191  }
192  // We match everything in the source model because sorting will change what we should show.
193  const int allHits = -1;
194 
195  QModelIndexList proxyList;
196  QMap<int, QModelIndex> proxyMap;
197  const QModelIndexList sourceList = sourceModel()->match( mapToSource( start ), role, value, allHits, flags );
198  QModelIndexList::const_iterator it;
199  const QModelIndexList::const_iterator begin = sourceList.constBegin();
200  const QModelIndexList::const_iterator end = sourceList.constEnd();
201  QModelIndex proxyIndex;
202  for ( it = begin; it != end; ++it ) {
203  proxyIndex = mapFromSource( *it );
204 
205  // Any filtered indexes will be invalid when mapped.
206  if ( !proxyIndex.isValid() ) {
207  continue;
208  }
209 
210  // Inserting in a QMap gives us sorting by key for free.
211  proxyMap.insert( proxyIndex.row(), proxyIndex );
212  }
213 
214  if ( hits == -1 ) {
215  return proxyMap.values();
216  }
217 
218  return proxyMap.values().mid( 0, hits );
219 }
220 
221 int EntityMimeTypeFilterModel::columnCount(const QModelIndex &parent) const
222 {
223  Q_D( const EntityMimeTypeFilterModel );
224 
225  if ( !sourceModel() ) {
226  return 0;
227  }
228 
229  const QVariant value = sourceModel()->data( mapToSource( parent ), EntityTreeModel::ColumnCountRole + ( EntityTreeModel::TerminalUserRole * d->m_headerGroup ) );
230  if ( !value.isValid() ) {
231  return 0;
232  }
233 
234  return value.toInt();
235 }
236 
237 bool EntityMimeTypeFilterModel::hasChildren(const QModelIndex &parent) const
238 {
239  if ( !sourceModel() ) {
240  return false;
241  }
242 
243  // QSortFilterProxyModel implementation is buggy in that it emits rowsAboutToBeInserted etc
244  // only after the source model has emitted rowsInserted, instead of emitting it when the
245  // source model emits rowsAboutToBeInserted. That means that the source and the proxy are out
246  // of sync around the time of insertions, so we can't use the optimization below.
247  return rowCount( parent ) > 0;
248 #if 0
249 
250  if ( !parent.isValid() ) {
251  return sourceModel()->hasChildren( parent );
252  }
253 
254  Q_D( const EntityMimeTypeFilterModel );
255  if ( EntityTreeModel::ItemListHeaders == d->m_headerGroup ) {
256  return false;
257  }
258 
259  if ( EntityTreeModel::CollectionTreeHeaders == d->m_headerGroup ) {
260  QModelIndex childIndex = parent.child( 0, 0 );
261  while ( childIndex.isValid() ) {
262  Collection col = childIndex.data( EntityTreeModel::CollectionRole ).value<Collection>();
263  if ( col.isValid() ) {
264  return true;
265  }
266  childIndex = childIndex.sibling( childIndex.row() + 1, childIndex.column() );
267  }
268  }
269  return false;
270 #endif
271 }
272 
273 bool EntityMimeTypeFilterModel::canFetchMore( const QModelIndex &parent ) const
274 {
275  Q_D( const EntityMimeTypeFilterModel );
276  if ( EntityTreeModel::CollectionTreeHeaders == d->m_headerGroup ) {
277  return false;
278  }
279  return QSortFilterProxyModel::canFetchMore( parent );
280 }
281 
282 
Akonadi::EntityMimeTypeFilterModel::addMimeTypeExclusionFilter
void addMimeTypeExclusionFilter(const QString &mimeType)
Add mime type to be excluded by the filter.
Definition: entitymimetypefiltermodel.cpp:93
Akonadi::EntityTreeModel::TerminalUserRole
Last role for user extensions. Don&#39;t use a role beyond this or headerData will break.
Definition: entitytreemodel.h:354
Akonadi::EntityMimeTypeFilterModel::addMimeTypeInclusionFilters
void addMimeTypeInclusionFilters(const QStringList &mimeTypes)
Add mime types to be shown by the filter.
Definition: entitymimetypefiltermodel.cpp:72
Akonadi::Collection
Represents a collection of PIM items.
Definition: collection.h:75
Akonadi::EntityMimeTypeFilterModel::mimeTypeInclusionFilters
QStringList mimeTypeInclusionFilters() const
Returns the list of mime type inclusion filters.
Definition: entitymimetypefiltermodel.cpp:133
Akonadi::EntityMimeTypeFilterModel
A proxy model that filters entities by mime type.
Definition: entitymimetypefiltermodel.h:61
Akonadi::EntityTreeModel::CollectionTreeHeaders
Header information for a collection-only tree.
Definition: entitytreemodel.h:383
Akonadi::EntityTreeModel::HeaderGroup
HeaderGroup
Describes what header information the model shall return.
Definition: entitytreemodel.h:381
Akonadi::EntityMimeTypeFilterModel::addMimeTypeExclusionFilters
void addMimeTypeExclusionFilters(const QStringList &mimeTypes)
Add mimetypes to filter out.
Definition: entitymimetypefiltermodel.cpp:79
Akonadi::EntityTreeModel::AmazingCompletionRole
Role used to implement amazing completion.
Definition: entitytreemodel.h:339
Akonadi::EntityTreeModel::CollectionRole
The collection.
Definition: entitytreemodel.h:335
Akonadi::EntityMimeTypeFilterModel::mimeTypeExclusionFilters
QStringList mimeTypeExclusionFilters() const
Returns the list of mime type exclusion filters.
Definition: entitymimetypefiltermodel.cpp:139
Akonadi::EntityTreeModel::ItemListHeaders
Header information for a list of items.
Definition: entitytreemodel.h:384
Akonadi::EntityMimeTypeFilterModel::setHeaderGroup
void setHeaderGroup(EntityTreeModel::HeaderGroup headerGroup)
Sets the header set of the filter model.
Definition: entitymimetypefiltermodel.cpp:153
Akonadi::EntityTreeModel::MimeTypeRole
The mimetype of the entity.
Definition: entitytreemodel.h:332
Akonadi::EntityTreeModel::ItemRole
The Item.
Definition: entitytreemodel.h:331
Akonadi::EntityTreeModel
A model for collections and items together.
Definition: entitytreemodel.h:317
Akonadi::EntityMimeTypeFilterModel::clearFilters
void clearFilters()
Clear all mime type filters.
Definition: entitymimetypefiltermodel.cpp:145
Akonadi::EntityTreeModel::ColumnCountRole
Definition: entitytreemodel.h:341
Akonadi::Entity::isValid
bool isValid() const
Returns whether the entity is valid.
Definition: entity.cpp:97
Akonadi::EntityMimeTypeFilterModel::~EntityMimeTypeFilterModel
virtual ~EntityMimeTypeFilterModel()
Destroys the entity mime type filter model.
Definition: entitymimetypefiltermodel.cpp:67
Akonadi::EntityMimeTypeFilterModel::addMimeTypeInclusionFilter
void addMimeTypeInclusionFilter(const QString &mimeType)
Add mime type to be shown by the filter.
Definition: entitymimetypefiltermodel.cpp:86
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Nov 26 2013 09:03:17 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