2 * This file is part of the PulseView project.
4 * Copyright (C) 2013 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, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef PULSEVIEW_PV_VIEWITEM_HPP
22 #define PULSEVIEW_PV_VIEWITEM_HPP
28 #include "viewitempaintparams.hpp"
44 class ViewItem : public QObject
49 static const QSizeF LabelPadding;
50 static const int HighlightRadius;
57 * Returns true if the item is visible and enabled.
59 virtual bool enabled() const = 0;
62 * Returns true if the item has been selected by the user.
64 bool selected() const;
67 * Selects or deselects the signal.
69 virtual void select(bool select = true);
72 * Returns true if the item may be dragged/moved.
74 virtual bool is_draggable() const;
77 * Returns true if the item is being dragged.
79 bool dragging() const;
82 * Sets this item into the dragged state.
87 * Sets this item into the un-dragged state.
89 virtual void drag_release();
92 * Drags the item to a delta relative to the drag point.
93 * @param delta the offset from the drag point.
95 virtual void drag_by(const QPoint &delta) = 0;
99 * @param rect the rectangle of the widget area.
101 virtual QPoint point(const QRect &rect) const = 0;
104 * Computes the outline rectangle of a label.
105 * @param rect the rectangle of the header area.
106 * @return Returns the rectangle of the signal label.
107 * @remarks The default implementation returns an empty rectangle.
109 virtual QRectF label_rect(const QRectF &rect) const;
112 * Computes the outline rectangle of the viewport hit-box.
113 * @param rect the rectangle of the viewport area.
114 * @return Returns the rectangle of the hit-box.
115 * @remarks The default implementation returns an empty hit-box.
117 virtual QRectF hit_box_rect(const ViewItemPaintParams &pp) const;
120 * Paints the signal label.
121 * @param p the QPainter to paint into.
122 * @param rect the rectangle of the header area.
123 * @param hover true if the label is being hovered over by the mouse.
125 virtual void paint_label(QPainter &p, const QRect &rect, bool hover);
128 * Paints the background layer of the item with a QPainter
129 * @param p the QPainter to paint into.
130 * @param pp the painting parameters object to paint with.
132 virtual void paint_back(QPainter &p, const ViewItemPaintParams &pp);
135 * Paints the mid-layer of the item with a QPainter
136 * @param p the QPainter to paint into.
137 * @param pp the painting parameters object to paint with.
139 virtual void paint_mid(QPainter &p, const ViewItemPaintParams &pp);
142 * Paints the foreground layer of the item with a QPainter
143 * @param p the QPainter to paint into.
144 * @param pp the painting parameters object to paint with.
146 virtual void paint_fore(QPainter &p, const ViewItemPaintParams &pp);
150 * Gets the text colour.
151 * @remarks This colour is computed by comparing the lightness
152 * of the trace colour against a threshold to determine whether
153 * white or black would be more visible.
155 static QColor select_text_colour(QColor background);
158 virtual QMenu* create_context_menu(QWidget *parent);
160 virtual pv::widgets::Popup* create_popup(QWidget *parent);
162 virtual void delete_pressed();
165 static QPen highlight_pen();
168 QWidget *context_parent_;
178 #endif // PULSEVIEW_PV_VIEWITEM_HPP