Tie the "sticky scrolling" setting in with the settings mgmt
[pulseview.git] / pv / globalsettings.hpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2017 Soeren Apel <soeren@apelpie.net>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef PULSEVIEW_GLOBALSETTINGS_HPP
21 #define PULSEVIEW_GLOBALSETTINGS_HPP
22
23 #include <functional>
24 #include <map>
25
26 #include <QSettings>
27 #include <QString>
28 #include <QVariant>
29
30 namespace pv {
31
32 class GlobalSettings : public QSettings
33 {
34         Q_OBJECT
35
36 public:
37         static const QString Key_View_AlwaysZoomToFit;
38         static const QString Key_View_ColouredBG;
39         static const QString Key_View_StickyScrolling;
40
41 public:
42         GlobalSettings();
43
44         static void register_change_handler(const QString key,
45                 std::function<void(QVariant)> cb);
46
47         void setValue(const QString& key, const QVariant& value);
48
49         /**
50          * Begins the tracking of changes. All changes will
51          * be recorded until stop_tracking() is called.
52          * The change tracking is global and doesn't support nesting.
53          */
54         void start_tracking();
55
56         /**
57          * Ends the tracking of changes without any changes to the settings.
58          */
59         void stop_tracking();
60
61         /**
62          * Ends the tracking of changes, undoing the changes since the
63          * change tracking began.
64          */
65         void undo_tracked_changes();
66
67 private:
68         static std::multimap< QString, std::function<void(QVariant)> > callbacks_;
69
70         static bool tracking_;
71         static std::map<QString, QVariant> tracked_changes_;
72 };
73
74 } // namespace pv
75
76 #endif // PULSEVIEW_GLOBALSETTINGS_HPP