[pulseview.git] / pv / view / cursor.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_CURSOR_HPP
#define PULSEVIEW_PV_VIEW_CURSOR_HPP

#include "timemarker.hpp"

#include <memory>

#include <QSizeF>

class QPainter;

namespace pv {
namespace view {

class Cursor : public TimeMarker
{
	Q_OBJECT

public:
	static const QColor FillColour;

public:
	/**
	 * Constructor.
	 * @param view A reference to the view that owns this cursor pair.
	 * @param time The time to set the flag to.
	 */
	Cursor(View &view, double time);

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

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

	/**
	 * Gets the marker label rectangle.
	 * @param rect The rectangle of the ruler client area.
	 * @return Returns the label rectangle.
	 */
	QRectF label_rect(const QRectF &rect) const;

private:
	std::shared_ptr<Cursor> get_other_cursor() const;
};

} // namespace view
} // namespace pv

#endif // PULSEVIEW_PV_VIEW_CURSOR_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, 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_CURSOR_HPP
	22	#define PULSEVIEW_PV_VIEW_CURSOR_HPP
	23
	24	#include "timemarker.hpp"
	25
	26	#include <memory>
	27
	28	#include <QSizeF>
	29
	30	class QPainter;
	31
	32	namespace pv {
	33	namespace view {
	34
	35	class Cursor : public TimeMarker
	36	{
	37	Q_OBJECT
	38
	39	public:
	40	static const QColor FillColour;
	41
	42	public:
	43	/**
	44	* Constructor.
	45	* @param view A reference to the view that owns this cursor pair.
	46	* @param time The time to set the flag to.
	47	*/
	48	Cursor(View &view, double time);
	49
	50	public:
	51	/**
	52	* Returns true if the item is visible and enabled.
	53	*/
	54	bool enabled() const;
	55
	56	/**
	57	* Gets the text to show in the marker.
	58	*/
	59	QString get_text() const;
	60
	61	/**
	62	* Gets the marker label rectangle.
	63	* @param rect The rectangle of the ruler client area.
	64	* @return Returns the label rectangle.
	65	*/
	66	QRectF label_rect(const QRectF &rect) const;
	67
	68	private:
	69	std::shared_ptr<Cursor> get_other_cursor() const;
	70	};
	71
	72	} // namespace view
	73	} // namespace pv
	74
	75	#endif // PULSEVIEW_PV_VIEW_CURSOR_HPP