[pulseview.git] / pv / view / timemarker.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_MARKER_H
#define PULSEVIEW_PV_VIEW_MARKER_H

#include <QColor>
#include <QDoubleSpinBox>
#include <QObject>
#include <QRectF>
#include <QWidgetAction>

#include "timeitem.hpp"

class QPainter;
class QRect;

namespace pv {
namespace view {

class View;

class TimeMarker : public TimeItem
{
	Q_OBJECT

public:
	static const int ArrowSize;

protected:
	/**
	 * Constructor.
	 * @param view A reference to the view that owns this marker.
	 * @param colour A reference to the colour of this cursor.
	 * @param time The time to set the flag to.
	 */
	TimeMarker(View &view, const QColor &colour, double time);

public:
	/**
	 * Gets the time of the marker.
	 */
	double time() const;

	/**
	 * Sets the time of the marker.
	 */
	void set_time(double time);

	float get_x() const;

	/**
	 * Gets the drag point of the row item.
	 */
	QPoint point() const;

	/**
	 * Computes the outline rectangle of a label.
	 * @param rect the rectangle of the header area.
	 * @return Returns the rectangle of the signal label.
	 */
	QRectF label_rect(const QRectF &rect) const;

	/**
	 * Gets the text to show in the marker.
	 */
	virtual QString get_text() const = 0;

	/**
	 * Paints the marker's label to the ruler.
	 * @param p The painter to draw with.
	 * @param rect The rectangle of the ruler client area.
	 * @param hover true if the label is being hovered over by the mouse.
	 */
	void paint_label(QPainter &p, const QRect &rect, bool hover);

	/**
	 * Paints the foreground layer of the item with a QPainter
	 * @param p the QPainter to paint into.
	 * @param pp the painting parameters object to paint with.
	 **/
	void paint_fore(QPainter &p, const ViewItemPaintParams &pp);

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

private Q_SLOTS:
	void on_value_changed(double value);

protected:
	const QColor &colour_;

	double time_;

	QSizeF text_size_;

	QWidgetAction *value_action_;
	QDoubleSpinBox *value_widget_;
	bool updating_value_widget_;
};

} // namespace view
} // namespace pv

#endif // PULSEVIEW_PV_VIEW_MARKER_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_MARKER_H
	22	#define PULSEVIEW_PV_VIEW_MARKER_H
	23
	24	#include <QColor>
	25	#include <QDoubleSpinBox>
	26	#include <QObject>
	27	#include <QRectF>
	28	#include <QWidgetAction>
	29
	30	#include "timeitem.hpp"
	31
	32	class QPainter;
	33	class QRect;
	34
	35	namespace pv {
	36	namespace view {
	37
	38	class View;
	39
	40	class TimeMarker : public TimeItem
	41	{
	42	Q_OBJECT
	43
	44	public:
	45	static const int ArrowSize;
	46
	47	protected:
	48	/**
	49	* Constructor.
	50	* @param view A reference to the view that owns this marker.
	51	* @param colour A reference to the colour of this cursor.
	52	* @param time The time to set the flag to.
	53	*/
	54	TimeMarker(View &view, const QColor &colour, double time);
	55
	56	public:
	57	/**
	58	* Gets the time of the marker.
	59	*/
	60	double time() const;
	61
	62	/**
	63	* Sets the time of the marker.
	64	*/
	65	void set_time(double time);
	66
	67	float get_x() const;
	68
	69	/**
	70	* Gets the drag point of the row item.
	71	*/
	72	QPoint point() const;
	73
	74	/**
	75	* Computes the outline rectangle of a label.
	76	* @param rect the rectangle of the header area.
	77	* @return Returns the rectangle of the signal label.
	78	*/
	79	QRectF label_rect(const QRectF &rect) const;
	80
	81	/**
	82	* Gets the text to show in the marker.
	83	*/
	84	virtual QString get_text() const = 0;
	85
	86	/**
	87	* Paints the marker's label to the ruler.
	88	* @param p The painter to draw with.
	89	* @param rect The rectangle of the ruler client area.
	90	* @param hover true if the label is being hovered over by the mouse.
	91	*/
	92	void paint_label(QPainter &p, const QRect &rect, bool hover);
	93
	94	/**
	95	* Paints the foreground layer of the item with a QPainter
	96	* @param p the QPainter to paint into.
	97	* @param pp the painting parameters object to paint with.
	98	**/
	99	void paint_fore(QPainter &p, const ViewItemPaintParams &pp);
	100
	101	virtual pv::widgets::Popup* create_popup(QWidget *parent);
	102
	103	private Q_SLOTS:
	104	void on_value_changed(double value);
	105
	106	protected:
	107	const QColor &colour_;
	108
	109	double time_;
	110
	111	QSizeF text_size_;
	112
	113	QWidgetAction *value_action_;
	114	QDoubleSpinBox *value_widget_;
	115	bool updating_value_widget_;
	116	};
	117
	118	} // namespace view
	119	} // namespace pv
	120
	121	#endif // PULSEVIEW_PV_VIEW_MARKER_H