[pulseview.git] / pv / view / selectableitem.hpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2013 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#ifndef PULSEVIEW_PV_SELECTABLEITEM_H
#define PULSEVIEW_PV_SELECTABLEITEM_H

#include <list>

#include <QPen>

class QAction;
class QMenu;
class QWidget;

namespace pv {

namespace widgets {
class Popup;
}

namespace view {

class SelectableItem : public QObject
{
	Q_OBJECT

private:
	static const int HighlightRadius;

public:
	SelectableItem();

public:
	/**
	 * Returns true if the item is visible and enabled.
	 */
	virtual bool enabled() const = 0;

	/**
	 * Returns true if the item has been selected by the user.
	 */
	bool selected() const;

	/**
	 * Selects or deselects the signal.
	 */
	void select(bool select = true);

	/**
	 * Returns true if the item is being dragged.
	 */
	bool dragging() const;

	/**
	 * Retunrns the current drag point.
	 */
	QPoint drag_point() const;

	/**
	 * Sets this item into the dragged state.
	 */
	void drag();

	/**
	 * Sets this item into the un-dragged state.
	 */
	void drag_release();

	/**
	 * Get the drag point.
	 */
	virtual QPoint point() const = 0;

public:
	/**
	 * Gets the text colour.
	 * @remarks This colour is computed by comparing the lightness
	 * of the trace colour against a threshold to determine whether
	 * white or black would be more visible.
	 */
	static QColor select_text_colour(QColor background);

public:
	virtual QMenu* create_context_menu(QWidget *parent);

	virtual pv::widgets::Popup* create_popup(QWidget *parent) = 0;

	virtual void delete_pressed();

protected:
	static QPen highlight_pen();

protected:
	QWidget *context_parent_;

private:
	bool selected_;
	QPoint drag_point_;
};

} // namespace view
} // namespace pv

#endif // PULSEVIEW_PV_SELECTABLEITEM_H
Commit	Line	Data
	1	/*
	2	* This file is part of the PulseView project.
	3	*
	4	* Copyright (C) 2013 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, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	#ifndef PULSEVIEW_PV_SELECTABLEITEM_H
	22	#define PULSEVIEW_PV_SELECTABLEITEM_H
	23
	24	#include <list>
	25
	26	#include <QPen>
	27
	28	class QAction;
	29	class QMenu;
	30	class QWidget;
	31
	32	namespace pv {
	33
	34	namespace widgets {
	35	class Popup;
	36	}
	37
	38	namespace view {
	39
	40	class SelectableItem : public QObject
	41	{
	42	Q_OBJECT
	43
	44	private:
	45	static const int HighlightRadius;
	46
	47	public:
	48	SelectableItem();
	49
	50	public:
	51	/**
	52	* Returns true if the item is visible and enabled.
	53	*/
	54	virtual bool enabled() const = 0;
	55
	56	/**
	57	* Returns true if the item has been selected by the user.
	58	*/
	59	bool selected() const;
	60
	61	/**
	62	* Selects or deselects the signal.
	63	*/
	64	void select(bool select = true);
	65
	66	/**
	67	* Returns true if the item is being dragged.
	68	*/
	69	bool dragging() const;
	70
	71	/**
	72	* Retunrns the current drag point.
	73	*/
	74	QPoint drag_point() const;
	75
	76	/**
	77	* Sets this item into the dragged state.
	78	*/
	79	void drag();
	80
	81	/**
	82	* Sets this item into the un-dragged state.
	83	*/
	84	void drag_release();
	85
	86	/**
	87	* Get the drag point.
	88	*/
	89	virtual QPoint point() const = 0;
	90
	91	public:
	92	/**
	93	* Gets the text colour.
	94	* @remarks This colour is computed by comparing the lightness
	95	* of the trace colour against a threshold to determine whether
	96	* white or black would be more visible.
	97	*/
	98	static QColor select_text_colour(QColor background);
	99
	100	public:
	101	virtual QMenu* create_context_menu(QWidget *parent);
	102
	103	virtual pv::widgets::Popup* create_popup(QWidget *parent) = 0;
	104
	105	virtual void delete_pressed();
	106
	107	protected:
	108	static QPen highlight_pen();
	109
	110	protected:
	111	QWidget *context_parent_;
	112
	113	private:
	114	bool selected_;
	115	QPoint drag_point_;
	116	};
	117
	118	} // namespace view
	119	} // namespace pv
	120
	121	#endif // PULSEVIEW_PV_SELECTABLEITEM_H