[pulseview.git] / pv / view / ruler.h

/*
 * 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.h"

namespace pv {
namespace view {

class Ruler : public MarginWidget
{
	Q_OBJECT

private:
	static const int RulerHeight;
	static const int MinorTickSubdivision;
	static const int ScaleUnits[3];

	static const int HoverArrowSize;

public:
	Ruler(View &parent);

	/**
	 * Find a tick spacing and number formatting that does not cause
	 * the values to collide.
	 * @param p A QPainter used to determine the needed space for the values.
	 * @param scale A pv::view::View's scale.
	 * @param offset A pv::view::View's offset.
	 *
	 * @return The tick period to use in 'first' and the prefix in 'second'.
	 */
	static std::pair<double, unsigned int> calculate_tick_spacing(
		QPainter& p, double scale, double offset);

public:
	QSize sizeHint() const;

private:
	void paintEvent(QPaintEvent *event);

private:
	/**
	 * Draw a hover arrow under the cursor position.
	 */
	void draw_hover_mark(QPainter &p);

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.h"
	27
	28	namespace pv {
	29	namespace view {
	30
	31	class Ruler : public MarginWidget
	32	{
	33	Q_OBJECT
	34
	35	private:
	36	static const int RulerHeight;
	37	static const int MinorTickSubdivision;
	38	static const int ScaleUnits[3];
	39
	40	static const int HoverArrowSize;
	41
	42	public:
	43	Ruler(View &parent);
	44
	45	/**
	46	* Find a tick spacing and number formatting that does not cause
	47	* the values to collide.
	48	* @param p A QPainter used to determine the needed space for the values.
	49	* @param scale A pv::view::View's scale.
	50	* @param offset A pv::view::View's offset.
	51	*
	52	* @return The tick period to use in 'first' and the prefix in 'second'.
	53	*/
	54	static std::pair<double, unsigned int> calculate_tick_spacing(
	55	QPainter& p, double scale, double offset);
	56
	57	public:
	58	QSize sizeHint() const;
	59
	60	private:
	61	void paintEvent(QPaintEvent *event);
	62
	63	private:
	64	/**
	65	* Draw a hover arrow under the cursor position.
	66	*/
	67	void draw_hover_mark(QPainter &p);
	68
	69	private Q_SLOTS:
	70	void hover_point_changed();
	71	};
	72
	73	} // namespace view
	74	} // namespace pv
	75
	76	#endif // PULSEVIEW_PV_VIEW_RULER_H