[pulseview.git] / pv / view / ruler.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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#ifndef PULSEVIEW_PV_VIEW_RULER_H
#define PULSEVIEW_PV_VIEW_RULER_H

#include <memory>

#include "marginwidget.hpp"

namespace pv {
namespace view {

class TimeItem;
class ViewItem;

class Ruler : public MarginWidget
{
	Q_OBJECT

private:

	/// Height of the ruler in multipes of the text height
	static const float RulerHeight;

	static const int MinorTickSubdivision;

	/// Height of the hover arrow in multiples of the text height
	static const float HoverArrowSize;

public:
	Ruler(View &parent);

public:
	QSize sizeHint() const;

	/**
	 * The extended area that the header widget would like to be sized to.
	 * @remarks This area is the area specified by sizeHint, extended by
	 * the area to overlap the viewport.
	 */
	QSize extended_size_hint() const;

private:
	/**
	 * Gets the time items.
	 */
	std::vector< std::shared_ptr<pv::view::ViewItem> > items();

	/**
	 * Gets the first view item which has a label 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<pv::view::ViewItem> get_mouse_over_item(
		const QPoint &pt);

private:
	void paintEvent(QPaintEvent *event);

	void mouseDoubleClickEvent(QMouseEvent *e);

private:
	/**
	 * Draw a hover arrow under the cursor position.
	 * @param p The painter to draw into.
	 * @param text_height The height of a single text ascent.
	 */
	void draw_hover_mark(QPainter &p, int text_height);

	int calculate_text_height() const;

private Q_SLOTS:
	void hover_point_changed();
};

} // namespace view
} // namespace pv

#endif // PULSEVIEW_PV_VIEW_RULER_H
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, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	#ifndef PULSEVIEW_PV_VIEW_RULER_H
	22	#define PULSEVIEW_PV_VIEW_RULER_H
	23
	24	#include <memory>
	25
	26	#include "marginwidget.hpp"
	27
	28	namespace pv {
	29	namespace view {
	30
	31	class TimeItem;
	32	class ViewItem;
	33
	34	class Ruler : public MarginWidget
	35	{
	36	Q_OBJECT
	37
	38	private:
	39
	40	/// Height of the ruler in multipes of the text height
	41	static const float RulerHeight;
	42
	43	static const int MinorTickSubdivision;
	44
	45	/// Height of the hover arrow in multiples of the text height
	46	static const float HoverArrowSize;
	47
	48	public:
	49	Ruler(View &parent);
	50
	51	public:
	52	QSize sizeHint() const;
	53
	54	/**
	55	* The extended area that the header widget would like to be sized to.
	56	* @remarks This area is the area specified by sizeHint, extended by
	57	* the area to overlap the viewport.
	58	*/
	59	QSize extended_size_hint() const;
	60
	61	private:
	62	/**
	63	* Gets the time items.
	64	*/
	65	std::vector< std::shared_ptr<pv::view::ViewItem> > items();
	66
	67	/**
	68	* Gets the first view item which has a label that contains @c pt .
	69	* @param pt the point to search with.
	70	* @return the view item that has been found, or and empty
	71	* @c shared_ptr if no item was found.
	72	*/
	73	std::shared_ptr<pv::view::ViewItem> get_mouse_over_item(
	74	const QPoint &pt);
	75
	76	private:
	77	void paintEvent(QPaintEvent *event);
	78
	79	void mouseDoubleClickEvent(QMouseEvent *e);
	80
	81	private:
	82	/**
	83	* Draw a hover arrow under the cursor position.
	84	* @param p The painter to draw into.
	85	* @param text_height The height of a single text ascent.
	86	*/
	87	void draw_hover_mark(QPainter &p, int text_height);
	88
	89	int calculate_text_height() const;
	90
	91	private Q_SLOTS:
	92	void hover_point_changed();
	93	};
	94
	95	} // namespace view
	96	} // namespace pv
	97
	98	#endif // PULSEVIEW_PV_VIEW_RULER_H