1/*
2 Copyright (C) 2010 Klarälvdalens Datakonsult AB,
3 a KDAB Group company, info@kdab.net,
4 author Stephen Kelly <stephen@kdab.com>
5
6 This library is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Library General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or (at your
9 option) any later version.
10
11 This library is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
14 License for more details.
15
16 You should have received a copy of the GNU Library General Public License
17 along with this library; see the file COPYING.LIB. If not, write to the
18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 02110-1301, USA.
20*/
21
22#ifndef KVIEWSTATEMAINTAINER_H
23#define KVIEWSTATEMAINTAINER_H
24
25#include "kdeui_export.h"
26
27#include <QtGui/QItemSelectionModel>
28#include <QtGui/QAbstractItemView>
29
30#include "kconfiggroup.h"
31#include "ksharedconfig.h"
32
33class KViewStateMaintainerBasePrivate;
34
35class KDEUI_EXPORT KViewStateMaintainerBase : public QObject
36{
37 Q_OBJECT
38public:
39 KViewStateMaintainerBase(KConfigGroup configGroup, QObject* parent = 0);
40 ~KViewStateMaintainerBase();
41
42 void setSelectionModel(QItemSelectionModel *selectionModel);
43 QItemSelectionModel *selectionModel() const;
44
45 void setView(QAbstractItemView *view);
46 QAbstractItemView *view() const;
47
48 virtual void saveState() = 0;
49 virtual void restoreState() = 0;
50
51protected:
52 KConfigGroup configGroup() const;
53
54private:
55 Q_DECLARE_PRIVATE(KViewStateMaintainerBase)
56 KViewStateMaintainerBasePrivate * const d_ptr;
57
58 Q_PRIVATE_SLOT( d_func(), void _k_modelAboutToBeReset() )
59 Q_PRIVATE_SLOT( d_func(), void _k_modelReset() )
60};
61
62/**
63 * @brief Encapsulates the maintenance of state between resets of QAbstractItemModel
64 *
65 * @code
66 * m_collectionViewStateMaintainer = new KViewStateMaintainer<Akonadi::ETMViewStateSaver>(KGlobal::config()->group("collectionView"));
67 * m_collectionViewStateMaintainer->setView(m_collectionView);
68 *
69 * m_collectionCheckStateMaintainer = new KViewStateMaintainer<Akonadi::ETMViewStateSaver>(KGlobal::config()->group("collectionCheckState"));
70 * m_collectionCheckStateMaintainer->setSelectionModel(m_checkableProxy->selectionModel());
71 * @endcode
72 *
73 * @see KViewStateSaver
74 */
75template<typename StateSaver>
76class KViewStateMaintainer : public KViewStateMaintainerBase
77{
78 typedef StateSaver StateRestorer;
79public:
80 KViewStateMaintainer(KConfigGroup configGroup, QObject* parent = 0)
81 : KViewStateMaintainerBase(configGroup, parent)
82 {
83
84 }
85
86 /* reimp */ void saveState()
87 {
88 StateSaver saver;
89 saver.setView(view());
90 saver.setSelectionModel(selectionModel());
91 KConfigGroup cfg = configGroup();
92 saver.saveState(cfg);
93 cfg.sync();
94 }
95
96 /* reimp */ void restoreState()
97 {
98 StateRestorer *restorer = new StateRestorer;
99 restorer->setView(view());
100 restorer->setSelectionModel(selectionModel());
101 restorer->restoreState(configGroup());
102 }
103
104};
105
106#endif
107