1/*
2 Copyright (c) 2011 Christian Mollekopf <chrigi_1@fastmail.fm>
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_TRASHFILTERPROXYMODEL_H
21#define AKONADI_TRASHFILTERPROXYMODEL_H
22
23#include "akonadi_export.h"
24
25#include <krecursivefilterproxymodel.h>
26
27namespace Akonadi
28{
29
30/**
31 * @short Filter model which hides/shows entites marked as trash
32 *
33 * Filter model which either hides all entities marked as trash, or the ones not marked.
34 * Subentities of collections marked as trash are also shown in the trash.
35 *
36 * The Base model must be an EntityTreeModel and the EntityDeletedAttribute must be available.
37 *
38 * Example:
39 *
40 * @code
41 *
42 * ChangeRecorder *monitor = new Akonadi::ChangeRecorder( this );
43 * monitor->itemFetchScope().fetchAttribute<Akonadi::EntityDisplayAttribute>(true);
44 *
45 * Akonadi::EntityTreeModel *sourcemodel = new Akonadi::EntityTreeModel(monitor, this);
46 *
47 * TrashFilterProxyModel *model = new TrashFilterProxyModel(this);
48 * model->setDynamicSortFilter(true);
49 * model->setSourceModel(sourcemodel);
50 *
51 * @endcode
52 *
53 * @author Christian Mollekopf <chrigi_1@fastmail.fm>
54 * @since 4.8
55 */
56class AKONADI_EXPORT TrashFilterProxyModel : public KRecursiveFilterProxyModel
57{
58 Q_OBJECT
59
60public:
61 explicit TrashFilterProxyModel(QObject *parent = 0);
62 virtual ~TrashFilterProxyModel();
63
64 void showTrash(bool enable);
65 bool trashIsShown() const;
66
67protected:
68 /**
69 * Sort filter criterias, according to how expensive the operation is
70 */
71 virtual bool acceptRow(int sourceRow, const QModelIndex &sourceParent) const;
72
73private:
74 //@cond PRIVATE
75 class TrashFilterProxyModelPrivate;
76 TrashFilterProxyModelPrivate *const d_ptr;
77 Q_DECLARE_PRIVATE(TrashFilterProxyModel)
78 //@endcond
79};
80
81}
82
83#endif
84