Akonadi

collectionfilterproxymodel.h
1 /*
2  Copyright (c) 2007 Bruno Virlet <[email protected]>
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 #ifndef AKONADI_COLLECTIONFILTERPROXYMODEL_H
21 #define AKONADI_COLLECTIONFILTERPROXYMODEL_H
22 
23 #include "akonadicore_export.h"
24 #include <QSortFilterProxyModel>
25 
26 namespace Akonadi
27 {
28 
29 class CollectionModel;
30 
55 class AKONADICORE_EXPORT CollectionFilterProxyModel : public QSortFilterProxyModel
56 {
57  Q_OBJECT
58 
59 public:
65  explicit CollectionFilterProxyModel(QObject *parent = nullptr);
66 
70  ~CollectionFilterProxyModel() override;
71 
77  void addMimeTypeFilters(const QStringList &mimeTypes);
78 
84  void addMimeTypeFilter(const QString &mimeType);
85 
89  Q_REQUIRED_RESULT QStringList mimeTypeFilters() const;
90 
99  void setExcludeVirtualCollections(bool exclude);
100  /*
101  * @since 4.12
102  */
103  Q_REQUIRED_RESULT bool excludeVirtualCollections() const;
104 
108  void clearFilters();
109 
110  Q_REQUIRED_RESULT Qt::ItemFlags flags(const QModelIndex &index) const override;
111 
112 protected:
113  bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const override;
114 
115 private:
116  //@cond PRIVATE
117  class Private;
118  Private *const d;
119  //@endcond
120 };
121 
122 }
123 
124 #endif
A proxy model that filters collections by mime type.
Helper integration between Akonadi and Qt.
typedef ItemFlags
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat May 30 2020 22:46:07 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.