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