[pulseview.git] / pv / globalsettings.hpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2017 Soeren Apel <soeren@apelpie.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef PULSEVIEW_GLOBALSETTINGS_HPP
#define PULSEVIEW_GLOBALSETTINGS_HPP

#include <functional>
#include <map>

#include <glib.h>

#include <QSettings>
#include <QString>
#include <QVariant>

using std::function;
using std::map;
using std::multimap;

namespace pv {

class GlobalSettings : public QSettings
{
	Q_OBJECT

public:
	static const QString Key_View_ZoomToFitDuringAcq;
	static const QString Key_View_ZoomToFitAfterAcq;
	static const QString Key_View_ColouredBG;
	static const QString Key_View_StickyScrolling;
	static const QString Key_View_ShowSamplingPoints;
	static const QString Key_View_ShowAnalogMinorGrid;
	static const QString Key_View_DefaultDivHeight;
	static const QString Key_Dec_InitialStateConfigurable;

public:
	GlobalSettings();

	void set_defaults_where_needed();

	static void register_change_handler(const QString key,
		function<void(QVariant)> cb);

	void setValue(const QString& key, const QVariant& value);

	/**
	 * Begins the tracking of changes. All changes will
	 * be recorded until stop_tracking() is called.
	 * The change tracking is global and doesn't support nesting.
	 */
	void start_tracking();

	/**
	 * Ends the tracking of changes without any changes to the settings.
	 */
	void stop_tracking();

	/**
	 * Ends the tracking of changes, undoing the changes since the
	 * change tracking began.
	 */
	void undo_tracked_changes();

	static void store_gvariant(QSettings &settings, GVariant *v);

	static GVariant* restore_gvariant(QSettings &settings);

private:
	static multimap< QString, function<void(QVariant)> > callbacks_;

	static bool tracking_;
	static map<QString, QVariant> tracked_changes_;
};

} // namespace pv

#endif // PULSEVIEW_GLOBALSETTINGS_HPP
Commit	Line	Data
	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_DefaultDivHeight;
	50	static const QString Key_Dec_InitialStateConfigurable;
	51
	52	public:
	53	GlobalSettings();
	54
	55	void set_defaults_where_needed();
	56
	57	static void register_change_handler(const QString key,
	58	function<void(QVariant)> cb);
	59
	60	void setValue(const QString& key, const QVariant& value);
	61
	62	/**
	63	* Begins the tracking of changes. All changes will
	64	* be recorded until stop_tracking() is called.
	65	* The change tracking is global and doesn't support nesting.
	66	*/
	67	void start_tracking();
	68
	69	/**
	70	* Ends the tracking of changes without any changes to the settings.
	71	*/
	72	void stop_tracking();
	73
	74	/**
	75	* Ends the tracking of changes, undoing the changes since the
	76	* change tracking began.
	77	*/
	78	void undo_tracked_changes();
	79
	80	static void store_gvariant(QSettings &settings, GVariant *v);
	81
	82	static GVariant* restore_gvariant(QSettings &settings);
	83
	84	private:
	85	static multimap< QString, function<void(QVariant)> > callbacks_;
	86
	87	static bool tracking_;
	88	static map<QString, QVariant> tracked_changes_;
	89	};
	90
	91	} // namespace pv
	92
	93	#endif // PULSEVIEW_GLOBALSETTINGS_HPP