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_H
22 #define PULSEVIEW_PV_VIEWITEM_H
28 #include "viewitempaintparams.hpp"
42 class ViewItem : public QObject
47 static const QSizeF LabelPadding;
48 static const int HighlightRadius;
55 * Returns true if the item is visible and enabled.
57 virtual bool enabled() const = 0;
60 * Returns true if the item has been selected by the user.
62 bool selected() const;
65 * Selects or deselects the signal.
67 void select(bool select = true);
70 * Returns true if the item is being dragged.
72 bool dragging() const;
75 * Sets this item into the dragged state.
80 * Sets this item into the un-dragged state.
85 * Drags the item to a delta relative to the drag point.
86 * @param delta the offset from the drag point.
88 virtual void drag_by(const QPoint &delta) = 0;
92 * @param rect the rectangle of the widget area.
94 virtual QPoint point(const QRect &rect) const = 0;
97 * Computes the outline rectangle of a label.
98 * @param rect the rectangle of the header area.
99 * @return Returns the rectangle of the signal label.
101 virtual QRectF label_rect(const QRectF &rect) const = 0;
104 * Paints the signal label.
105 * @param p the QPainter to paint into.
106 * @param rect the rectangle of the header area.
107 * @param hover true if the label is being hovered over by the mouse.
109 virtual void paint_label(QPainter &p, const QRect &rect, bool hover) = 0;
112 * Paints the background layer of the item with a QPainter
113 * @param p the QPainter to paint into.
114 * @param pp the painting parameters object to paint with.
116 virtual void paint_back(QPainter &p, const ViewItemPaintParams &pp);
119 * Paints the mid-layer of the item with a QPainter
120 * @param p the QPainter to paint into.
121 * @param pp the painting parameters object to paint with.
123 virtual void paint_mid(QPainter &p, const ViewItemPaintParams &pp);
126 * Paints the foreground layer of the item with a QPainter
127 * @param p the QPainter to paint into.
128 * @param pp the painting parameters object to paint with.
130 virtual void paint_fore(QPainter &p, const ViewItemPaintParams &pp);
134 * Gets the text colour.
135 * @remarks This colour is computed by comparing the lightness
136 * of the trace colour against a threshold to determine whether
137 * white or black would be more visible.
139 static QColor select_text_colour(QColor background);
142 virtual QMenu* create_context_menu(QWidget *parent);
144 virtual pv::widgets::Popup* create_popup(QWidget *parent) = 0;
146 virtual void delete_pressed();
149 static QPen highlight_pen();
152 QWidget *context_parent_;
162 #endif // PULSEVIEW_PV_VIEWITEM_H