1/*
2 Copyright (c) 2009 Kevin Ottens <ervin@kde.org>
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_STATISTICSPROXYMODEL_H
21#define AKONADI_STATISTICSPROXYMODEL_H
22
23#include "akonadi_export.h"
24
25#include <QSortFilterProxyModel>
26
27namespace Akonadi {
28
29/**
30 * @short A proxy model that exposes collection statistics through extra columns.
31 *
32 * This class can be used on top of an EntityTreeModel to display extra columns
33 * summarizing statistics of collections.
34 *
35 * @code
36 *
37 * Akonadi::EntityTreeModel *model = new Akonadi::EntityTreeModel( ... );
38 *
39 * Akonadi::StatisticsProxyModel *proxy = new Akonadi::StatisticsProxyModel();
40 * proxy->setSourceModel( model );
41 *
42 * Akonadi::EntityTreeView *view = new Akonadi::EntityTreeView( this );
43 * view->setModel( proxy );
44 *
45 * @endcode
46 *
47 * @author Kevin Ottens <ervin@kde.org>
48 * @since 4.4
49 * @deprecated use the one in kdepim, which is much faster
50 */
51class AKONADI_DEPRECATED_EXPORT StatisticsProxyModel : public QSortFilterProxyModel
52{
53 Q_OBJECT
54
55public:
56 /**
57 * Creates a new statistics proxy model.
58 *
59 * @param parent The parent object.
60 */
61 explicit StatisticsProxyModel(QObject *parent = 0);
62
63 /**
64 * Destroys the statistics proxy model.
65 */
66 virtual ~StatisticsProxyModel();
67
68 /**
69 * @param enable Display tooltips
70 */
71 void setToolTipEnabled(bool enable);
72
73 /**
74 * Return true if we display tooltips, otherwise false
75 */
76 bool isToolTipEnabled() const;
77
78 /**
79 * @param enable Display extra statistics columns
80 */
81 void setExtraColumnsEnabled(bool enable);
82
83 /**
84 * Return true if we display extra statistics columns, otherwise false
85 */
86 bool isExtraColumnsEnabled() const;
87
88 virtual QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const;
89 virtual QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const;
90 virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const;
91 virtual Qt::ItemFlags flags(const QModelIndex &index) const;
92 virtual int columnCount(const QModelIndex &parent = QModelIndex()) const;
93
94 virtual QModelIndexList match(const QModelIndex &start, int role, const QVariant &value, int hits = 1,
95 Qt::MatchFlags flags = Qt::MatchFlags(Qt::MatchStartsWith | Qt::MatchWrap)) const;
96
97 virtual void setSourceModel(QAbstractItemModel *sourceModel);
98 virtual void connectNotify(const char *signal);
99
100private:
101 //@cond PRIVATE
102 class Private;
103 Private *const d;
104
105 Q_PRIVATE_SLOT(d, void proxyDataChanged(QModelIndex, QModelIndex))
106 Q_PRIVATE_SLOT(d, void sourceLayoutAboutToBeChanged())
107 Q_PRIVATE_SLOT(d, void sourceLayoutChanged())
108 //@endcond
109};
110
111}
112
113#endif
114