201c5e20a9fc23f95b72f0d2f0cf2b546f9cee0c
[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 <glib.h>
27
28 #include <QSettings>
29 #include <QString>
30 #include <QVariant>
31
32 using std::function;
33 using std::map;
34 using std::multimap;
35
36 namespace pv {
37
38 class GlobalSettings : public QSettings
39 {
40         Q_OBJECT
41
42 public:
43         static const QString Key_View_ZoomToFitDuringAcq;
44         static const QString Key_View_ZoomToFitAfterAcq;
45         static const QString Key_View_ColouredBG;
46         static const QString Key_View_StickyScrolling;
47         static const QString Key_View_ShowSamplingPoints;
48         static const QString Key_View_ShowAnalogMinorGrid;
49         static const QString Key_View_ShowConversionThresholds;
50         static const QString Key_View_DefaultDivHeight;
51         static const QString Key_View_DefaultLogicHeight;
52         static const QString Key_Dec_InitialStateConfigurable;
53
54 public:
55         GlobalSettings();
56
57         void set_defaults_where_needed();
58
59         static void register_change_handler(const QString key,
60                 function<void(QVariant)> cb);
61
62         void setValue(const QString& key, const QVariant& value);
63
64         /**
65          * Begins the tracking of changes. All changes will
66          * be recorded until stop_tracking() is called.
67          * The change tracking is global and doesn't support nesting.
68          */
69         void start_tracking();
70
71         /**
72          * Ends the tracking of changes without any changes to the settings.
73          */
74         void stop_tracking();
75
76         /**
77          * Ends the tracking of changes, undoing the changes since the
78          * change tracking began.
79          */
80         void undo_tracked_changes();
81
82         static void store_gvariant(QSettings &settings, GVariant *v);
83
84         static GVariant* restore_gvariant(QSettings &settings);
85
86 private:
87         static multimap< QString, function<void(QVariant)> > callbacks_;
88
89         static bool tracking_;
90         static map<QString, QVariant> tracked_changes_;
91 };
92
93 } // namespace pv
94
95 #endif // PULSEVIEW_GLOBALSETTINGS_HPP