2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
20 #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_MARKER_HPP
21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_MARKER_HPP
24 #include <QDoubleSpinBox>
27 #include <QWidgetAction>
29 #include "timeitem.hpp"
36 class TimestampSpinBox;
45 * The TimeMarker class represents items on the @ref Ruler that highlight a
46 * single point in time to the user. Aside from this, it is generic in nature.
48 class TimeMarker : public TimeItem
53 static const int ArrowSize;
58 * @param view A reference to the view that owns this marker.
59 * @param colour A reference to the colour of this cursor.
60 * @param time The time to set the flag to.
62 TimeMarker(View &view, const QColor &colour, const pv::util::Timestamp& time);
66 * Gets the time of the marker.
68 const pv::util::Timestamp& time() const;
71 * Sets the time of the marker.
73 void set_time(const pv::util::Timestamp& time) override;
75 float get_x() const override;
78 * Gets the arrow-tip point of the time marker.
79 * @param rect the rectangle of the ruler area.
81 QPoint drag_point(const QRect &rect) const override;
84 * Computes the outline rectangle of a label.
85 * @param rect the rectangle of the header area.
86 * @return Returns the rectangle of the signal label.
88 QRectF label_rect(const QRectF &rect) const override;
91 * Computes the outline rectangle of the viewport hit-box.
92 * @param rect the rectangle of the viewport area.
93 * @return Returns the rectangle of the hit-box.
95 QRectF hit_box_rect(const ViewItemPaintParams &pp) const override;
98 * Gets the text to show in the marker.
100 virtual QString get_text() const = 0;
103 * Paints the marker's label to the ruler.
104 * @param p The painter to draw with.
105 * @param rect The rectangle of the ruler client area.
106 * @param hover true if the label is being hovered over by the mouse.
108 void paint_label(QPainter &p, const QRect &rect, bool hover) override;
111 * Paints the foreground layer of the item with a QPainter
112 * @param p the QPainter to paint into.
113 * @param pp the painting parameters object to paint with.
115 void paint_fore(QPainter &p, ViewItemPaintParams &pp) override;
117 virtual pv::widgets::Popup* create_popup(QWidget *parent) override;
120 void on_value_changed(const pv::util::Timestamp& value);
123 const QColor &colour_;
125 pv::util::Timestamp time_;
129 QWidgetAction *value_action_;
130 pv::widgets::TimestampSpinBox *value_widget_;
131 bool updating_value_widget_;
138 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_MARKER_HPP