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