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

akonadi

  • akonadi
collectionfilterproxymodel.cpp
1 /*
2  Copyright (c) 2007 Bruno Virlet <bruno.virlet@gmail.com>
3 
4  This library is free software; you can redistribute it and/or modify it
5  under the terms of the GNU Library General Public License as published by
6  the Free Software Foundation; either version 2 of the License, or (at your
7  option) any later version.
8 
9  This library is distributed in the hope that it will be useful, but WITHOUT
10  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12  License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to the
16  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  02110-1301, USA.
18 */
19 
20 #include "collectionfilterproxymodel.h"
21 
22 #include "collectionmodel.h"
23 #include "mimetypechecker.h"
24 
25 #include <kdebug.h>
26 
27 #include <QtCore/QString>
28 #include <QtCore/QStringList>
29 
30 using namespace Akonadi;
31 
35 class CollectionFilterProxyModel::Private
36 {
37  public:
38  Private( CollectionFilterProxyModel *parent )
39  : mParent( parent ), mExcludeVirtualCollections( false )
40  {
41  mimeChecker.addWantedMimeType( QLatin1String( "text/uri-list" ) );
42  }
43 
44  bool collectionAccepted( const QModelIndex &index, bool checkResourceVisibility = true );
45 
46  QVector< QModelIndex > acceptedResources;
47  CollectionFilterProxyModel *mParent;
48  MimeTypeChecker mimeChecker;
49  bool mExcludeVirtualCollections;
50 };
51 
52 bool CollectionFilterProxyModel::Private::collectionAccepted( const QModelIndex &index, bool checkResourceVisibility )
53 {
54  // Retrieve supported mimetypes
55  const Collection collection = mParent->sourceModel()->data( index, CollectionModel::CollectionRole ).value<Collection>();
56 
57  if ( !collection.isValid() ) {
58  return false;
59  }
60 
61  if ( collection.isVirtual() && mExcludeVirtualCollections ) {
62  return false;
63  }
64 
65  // If this collection directly contains one valid mimetype, it is accepted
66  if ( mimeChecker.isWantedCollection( collection ) ) {
67  // The folder will be accepted, but we need to make sure the resource is visible too.
68  if ( checkResourceVisibility ) {
69 
70  // find the resource
71  QModelIndex resource = index;
72  while ( resource.parent().isValid() ) {
73  resource = resource.parent();
74  }
75 
76  // See if that resource is visible, if not, invalidate the filter.
77  if ( resource != index && !acceptedResources.contains( resource ) ) {
78  kDebug() << "We got a new collection:" << mParent->sourceModel()->data( index ).toString()
79  << "but the resource is not visible:" << mParent->sourceModel()->data( resource ).toString();
80  acceptedResources.clear();
81  // defer reset, the model might still be supplying new items at this point which crashs
82  mParent->invalidateFilter();
83  return true;
84  }
85  }
86 
87  // Keep track of all the resources that are visible.
88  if ( !index.parent().isValid() ) {
89  acceptedResources.append( index );
90  }
91 
92  return true;
93  }
94 
95  // If this collection has a child which contains valid mimetypes, it is accepted
96  QModelIndex childIndex = index.child( 0, 0 );
97  while ( childIndex.isValid() ) {
98  if ( collectionAccepted( childIndex, false /* don't check visibility of the parent, as we are checking the child now */ ) ) {
99 
100  // Keep track of all the resources that are visible.
101  if ( !index.parent().isValid() ) {
102  acceptedResources.append( index );
103  }
104 
105  return true;
106  }
107  childIndex = childIndex.sibling( childIndex.row() + 1, 0 );
108  }
109 
110  // Or else, no reason to keep this collection.
111  return false;
112 }
113 
114 CollectionFilterProxyModel::CollectionFilterProxyModel( QObject *parent )
115  : QSortFilterProxyModel( parent ),
116  d( new Private( this ) )
117 {
118 }
119 
120 CollectionFilterProxyModel::~CollectionFilterProxyModel()
121 {
122  delete d;
123 }
124 
125 void CollectionFilterProxyModel::addMimeTypeFilters(const QStringList &typeList)
126 {
127  QStringList mimeTypes = d->mimeChecker.wantedMimeTypes() + typeList;
128  d->mimeChecker.setWantedMimeTypes( mimeTypes );
129  invalidateFilter();
130 }
131 
132 void CollectionFilterProxyModel::addMimeTypeFilter(const QString &type)
133 {
134  d->mimeChecker.addWantedMimeType( type );
135  invalidateFilter();
136 }
137 
138 bool CollectionFilterProxyModel::filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent) const
139 {
140  return d->collectionAccepted( sourceModel()->index( sourceRow, 0, sourceParent ) );
141 }
142 
143 QStringList CollectionFilterProxyModel::mimeTypeFilters() const
144 {
145  return d->mimeChecker.wantedMimeTypes();
146 }
147 
148 void CollectionFilterProxyModel::clearFilters()
149 {
150  d->mimeChecker = MimeTypeChecker();
151  invalidateFilter();
152 }
153 
154 void CollectionFilterProxyModel::setExcludeVirtualCollections( bool exclude )
155 {
156  if ( exclude != d->mExcludeVirtualCollections ) {
157  d->mExcludeVirtualCollections = exclude;
158  invalidateFilter();
159  }
160 }
161 
162 bool CollectionFilterProxyModel::excludeVirtualCollections() const
163 {
164  return d->mExcludeVirtualCollections;
165 }
166 
167 Qt::ItemFlags CollectionFilterProxyModel::flags( const QModelIndex& index ) const
168 {
169  if ( !index.isValid() ) {
170  // Don't crash
171  return 0;
172  }
173 
174  const Collection collection = sourceModel()->data( mapToSource( index ), CollectionModel::CollectionRole ).value<Collection>();
175 
176  // If this collection directly contains one valid mimetype, it is accepted
177  if ( d->mimeChecker.isWantedCollection( collection ) ) {
178  return QSortFilterProxyModel::flags( index );
179  } else {
180  return QSortFilterProxyModel::flags( index ) & ~( Qt::ItemIsSelectable );
181  }
182 }
183 
Akonadi::CollectionFilterProxyModel
A proxy model that filters collections by mime type.
Definition: collectionfilterproxymodel.h:54
Akonadi::Collection
Represents a collection of PIM items.
Definition: collection.h:75
Akonadi::MimeTypeChecker
Helper for checking MIME types of Collections and Items.
Definition: mimetypechecker.h:109
Akonadi::CollectionFilterProxyModel::addMimeTypeFilters
void addMimeTypeFilters(const QStringList &mimeTypes)
Adds a list of mime types to be shown by the filter.
Definition: collectionfilterproxymodel.cpp:125
Akonadi::CollectionFilterProxyModel::CollectionFilterProxyModel
CollectionFilterProxyModel(QObject *parent=0)
Creates a new collection proxy filter model.
Definition: collectionfilterproxymodel.cpp:114
Akonadi::CollectionFilterProxyModel::mimeTypeFilters
QStringList mimeTypeFilters() const
Returns the list of mime type filters.
Definition: collectionfilterproxymodel.cpp:143
Akonadi::CollectionFilterProxyModel::setExcludeVirtualCollections
void setExcludeVirtualCollections(bool exclude)
Sets whether we want virtual collections to be filtered or not.
Definition: collectionfilterproxymodel.cpp:154
Akonadi::CollectionModel::CollectionRole
The actual collection object.
Definition: collectionmodel.h:66
Akonadi::CollectionFilterProxyModel::addMimeTypeFilter
void addMimeTypeFilter(const QString &mimeType)
Adds a mime type to be shown by the filter.
Definition: collectionfilterproxymodel.cpp:132
Akonadi::CollectionFilterProxyModel::clearFilters
void clearFilters()
Clears all mime type filters.
Definition: collectionfilterproxymodel.cpp:148
Akonadi::Collection::parent
AKONADI_DEPRECATED Id parent() const
Returns the identifier of the parent collection.
Definition: collection.cpp:129
Akonadi::Entity::isValid
bool isValid() const
Returns whether the entity is valid.
Definition: entity.cpp:97
Akonadi::CollectionFilterProxyModel::~CollectionFilterProxyModel
virtual ~CollectionFilterProxyModel()
Destroys the collection proxy filter model.
Definition: collectionfilterproxymodel.cpp:120
Akonadi::Collection::isVirtual
bool isVirtual() const
Returns whether the collection is virtual, for example a search collection.
Definition: collection.cpp:261
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Mon Jul 21 2014 08:03:51 by doxygen 1.8.6 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.13.3 API Reference

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