[pulseview.git] / pv / prop / property.hpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
 *
 * 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_PV_PROP_PROPERTY_HPP
#define PULSEVIEW_PV_PROP_PROPERTY_HPP

#include <glib.h>
// Suppress warnings due to use of deprecated std::auto_ptr<> by glibmm.
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
#include <glibmm.h>
G_GNUC_END_IGNORE_DEPRECATIONS

#include <functional>

#include <QString>
#include <QWidget>

using std::function;

class QWidget;

namespace pv {
namespace prop {

class Property : public QObject
{
	Q_OBJECT;

public:
	typedef function<Glib::VariantBase ()> Getter;
	typedef function<void (Glib::VariantBase)> Setter;

protected:
	Property(QString name, QString desc, Getter getter, Setter setter);

public:
	const QString& name() const;
	const QString& desc() const;

	virtual QWidget* get_widget(QWidget *parent,
		bool auto_commit = false) = 0;
	virtual bool labeled_widget() const;

	virtual void commit() = 0;

protected:
	const Getter getter_;
	const Setter setter_;

private:
	QString name_;
	QString desc_;
};

}  // namespace prop
}  // namespace pv

#endif // PULSEVIEW_PV_PROP_PROPERTY_HPP
Commit	Line	Data
	1	/*
	2	* This file is part of the PulseView project.
	3	*
	4	* Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
	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_PV_PROP_PROPERTY_HPP
	21	#define PULSEVIEW_PV_PROP_PROPERTY_HPP
	22
	23	#include <glib.h>
	24	// Suppress warnings due to use of deprecated std::auto_ptr<> by glibmm.
	25	G_GNUC_BEGIN_IGNORE_DEPRECATIONS
	26	#include <glibmm.h>
	27	G_GNUC_END_IGNORE_DEPRECATIONS
	28
	29	#include <functional>
	30
	31	#include <QString>
	32	#include <QWidget>
	33
	34	using std::function;
	35
	36	class QWidget;
	37
	38	namespace pv {
	39	namespace prop {
	40
	41	class Property : public QObject
	42	{
	43	Q_OBJECT;
	44
	45	public:
	46	typedef function<Glib::VariantBase ()> Getter;
	47	typedef function<void (Glib::VariantBase)> Setter;
	48
	49	protected:
	50	Property(QString name, QString desc, Getter getter, Setter setter);
	51
	52	public:
	53	const QString& name() const;
	54	const QString& desc() const;
	55
	56	virtual QWidget* get_widget(QWidget *parent,
	57	bool auto_commit = false) = 0;
	58	virtual bool labeled_widget() const;
	59
	60	virtual void commit() = 0;
	61
	62	protected:
	63	const Getter getter_;
	64	const Setter setter_;
	65
	66	private:
	67	QString name_;
	68	QString desc_;
	69	};
	70
	71	} // namespace prop
	72	} // namespace pv
	73
	74	#endif // PULSEVIEW_PV_PROP_PROPERTY_HPP