[pulseview.git] / pv / view / cursorpair.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_VIEW_CURSORPAIR_H
#define PULSEVIEW_PV_VIEW_CURSORPAIR_H

#include "cursor.hpp"

#include <memory>

#include <QPainter>

class QPainter;

namespace pv {
namespace view {

class CursorPair : public TimeItem
{
private:
	static const int DeltaPadding;
	static const QColor ViewportFillColour;

public:
	/**
	 * Constructor.
	 * @param view A reference to the view that owns this cursor pair.
	 */
	CursorPair(View &view);

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

	/**
	 * Returns a pointer to the first cursor.
	 */
	std::shared_ptr<Cursor> first() const;

	/**
	 * Returns a pointer to the second cursor.
	 */
	std::shared_ptr<Cursor> second() const;

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

	float get_x() const;

	QPoint point(const QRect &rect) const;

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

public:
	QRectF label_rect(const QRectF &rect) const;

	/**
	 * 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 background 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_back(QPainter &p, const ViewItemPaintParams &pp);

	/**
	 * Constructs the string to display.
	 */
	QString format_string();

	void compute_text_size(QPainter &p);

	std::pair<float, float> get_cursor_offsets() const;

private:
	std::shared_ptr<Cursor> first_, second_;

	QSizeF text_size_;
};

} // namespace view
} // namespace pv

#endif // PULSEVIEW_PV_VIEW_CURSORPAIR_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_VIEW_CURSORPAIR_H
	22	#define PULSEVIEW_PV_VIEW_CURSORPAIR_H
	23
	24	#include "cursor.hpp"
	25
	26	#include <memory>
	27
	28	#include <QPainter>
	29
	30	class QPainter;
	31
	32	namespace pv {
	33	namespace view {
	34
	35	class CursorPair : public TimeItem
	36	{
	37	private:
	38	static const int DeltaPadding;
	39	static const QColor ViewportFillColour;
	40
	41	public:
	42	/**
	43	* Constructor.
	44	* @param view A reference to the view that owns this cursor pair.
	45	*/
	46	CursorPair(View &view);
	47
	48	public:
	49	/**
	50	* Returns true if the item is visible and enabled.
	51	*/
	52	bool enabled() const;
	53
	54	/**
	55	* Returns a pointer to the first cursor.
	56	*/
	57	std::shared_ptr<Cursor> first() const;
	58
	59	/**
	60	* Returns a pointer to the second cursor.
	61	*/
	62	std::shared_ptr<Cursor> second() const;
	63
	64	/**
	65	* Sets the time of the marker.
	66	*/
	67	void set_time(double time);
	68
	69	float get_x() const;
	70
	71	QPoint point(const QRect &rect) const;
	72
	73	pv::widgets::Popup* create_popup(QWidget *parent);
	74
	75	public:
	76	QRectF label_rect(const QRectF &rect) const;
	77
	78	/**
	79	* Paints the marker's label to the ruler.
	80	* @param p The painter to draw with.
	81	* @param rect The rectangle of the ruler client area.
	82	* @param hover true if the label is being hovered over by the mouse.
	83	*/
	84	void paint_label(QPainter &p, const QRect &rect, bool hover);
	85
	86	/**
	87	* Paints the background layer of the item with a QPainter
	88	* @param p the QPainter to paint into.
	89	* @param pp the painting parameters object to paint with.
	90	**/
	91	void paint_back(QPainter &p, const ViewItemPaintParams &pp);
	92
	93	/**
	94	* Constructs the string to display.
	95	*/
	96	QString format_string();
	97
	98	void compute_text_size(QPainter &p);
	99
	100	std::pair<float, float> get_cursor_offsets() const;
	101
	102	private:
	103	std::shared_ptr<Cursor> first_, second_;
	104
	105	QSizeF text_size_;
	106	};
	107
	108	} // namespace view
	109	} // namespace pv
	110
	111	#endif // PULSEVIEW_PV_VIEW_CURSORPAIR_H