[pulseview.git] / pv / view / viewport.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_VIEWS_TRACEVIEW_VIEWPORT_HPP
#define PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEWPORT_HPP

#include <boost/optional.hpp>

#include <QTimer>
#include <QTouchEvent>

#include "pv/util.hpp"
#include "viewwidget.hpp"

class QPainter;
class QPaintEvent;
class Session;

namespace pv {
namespace views {
namespace TraceView {

class View;

class Viewport : public ViewWidget
{
	Q_OBJECT

public:
	explicit Viewport(View &parent);

private:
	/**
	 * Indicates when a view item is being hovered over.
	 * @param item The item that is being hovered over, or @c nullptr
	 * if no view item is being hovered over.
	 */
	void item_hover(const std::shared_ptr<ViewItem> &item);

	/**
	 * Gets the first view item which has a hit-box that contains @c pt .
	 * @param pt the point to search with.
	 * @return the view item that has been found, or and empty
	 *   @c shared_ptr if no item was found.
	 */
	std::shared_ptr<ViewItem> get_mouse_over_item(const QPoint &pt);

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

	/**
	 * Drag the background by the delta offset.
	 * @param delta the drag offset in pixels.
	 */
	void drag_by(const QPoint &delta);

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

	/**
	 * Gets the items in the view widget.
	 */
	std::vector< std::shared_ptr<ViewItem> > items();

	/**
	 * Handles touch begin update and end events.
	 * @param e the event that triggered this handler.
	 */
	bool touch_event(QTouchEvent *event);

private:
	void paintEvent(QPaintEvent *event);

	void mouseDoubleClickEvent(QMouseEvent *event);
	void wheelEvent(QWheelEvent *event);

private:
	boost::optional<pv::util::Timestamp> drag_offset_;
	int drag_v_offset_;

	double pinch_offset0_;
	double pinch_offset1_;
	bool pinch_zoom_active_;
};

} // namespace TraceView
} // namespace views
} // namespace pv

#endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEWPORT_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_VIEWS_TRACEVIEW_VIEWPORT_HPP
	21	#define PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEWPORT_HPP
	22
	23	#include <boost/optional.hpp>
	24
	25	#include <QTimer>
	26	#include <QTouchEvent>
	27
	28	#include "pv/util.hpp"
	29	#include "viewwidget.hpp"
	30
	31	class QPainter;
	32	class QPaintEvent;
	33	class Session;
	34
	35	namespace pv {
	36	namespace views {
	37	namespace TraceView {
	38
	39	class View;
	40
	41	class Viewport : public ViewWidget
	42	{
	43	Q_OBJECT
	44
	45	public:
	46	explicit Viewport(View &parent);
	47
	48	private:
	49	/**
	50	* Indicates when a view item is being hovered over.
	51	* @param item The item that is being hovered over, or @c nullptr
	52	* if no view item is being hovered over.
	53	*/
	54	void item_hover(const std::shared_ptr<ViewItem> &item);
	55
	56	/**
	57	* Gets the first view item which has a hit-box that contains @c pt .
	58	* @param pt the point to search with.
	59	* @return the view item that has been found, or and empty
	60	* @c shared_ptr if no item was found.
	61	*/
	62	std::shared_ptr<ViewItem> get_mouse_over_item(const QPoint &pt);
	63
	64	/**
	65	* Sets this item into the dragged state.
	66	*/
	67	void drag();
	68
	69	/**
	70	* Drag the background by the delta offset.
	71	* @param delta the drag offset in pixels.
	72	*/
	73	void drag_by(const QPoint &delta);
	74
	75	/**
	76	* Sets this item into the un-dragged state.
	77	*/
	78	void drag_release();
	79
	80	/**
	81	* Gets the items in the view widget.
	82	*/
	83	std::vector< std::shared_ptr<ViewItem> > items();
	84
	85	/**
	86	* Handles touch begin update and end events.
	87	* @param e the event that triggered this handler.
	88	*/
	89	bool touch_event(QTouchEvent *event);
	90
	91	private:
	92	void paintEvent(QPaintEvent *event);
	93
	94	void mouseDoubleClickEvent(QMouseEvent *event);
	95	void wheelEvent(QWheelEvent *event);
	96
	97	private:
	98	boost::optional<pv::util::Timestamp> drag_offset_;
	99	int drag_v_offset_;
	100
	101	double pinch_offset0_;
	102	double pinch_offset1_;
	103	bool pinch_zoom_active_;
	104	};
	105
	106	} // namespace TraceView
	107	} // namespace views
	108	} // namespace pv
	109
	110	#endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEWPORT_HPP