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 int HighlightRadius;
54 * Returns true if the item is visible and enabled.
56 virtual bool enabled() const = 0;
59 * Returns true if the item has been selected by the user.
61 bool selected() const;
64 * Selects or deselects the signal.
66 void select(bool select = true);
69 * Returns true if the item is being dragged.
71 bool dragging() const;
74 * Retunrns the current drag point.
76 QPoint drag_point() const;
79 * Sets this item into the dragged state.
84 * Sets this item into the un-dragged state.
91 virtual QPoint point() const = 0;
94 * Computes the outline rectangle of a label.
95 * @param rect the rectangle of the header area.
96 * @return Returns the rectangle of the signal label.
98 virtual QRectF label_rect(const QRectF &rect) const = 0;
101 * Paints the background layer of the item with a QPainter
102 * @param p the QPainter to paint into.
103 * @param pp the painting parameters object to paint with.
105 virtual void paint_back(QPainter &p, const ViewItemPaintParams &pp);
108 * Paints the mid-layer of the item with a QPainter
109 * @param p the QPainter to paint into.
110 * @param pp the painting parameters object to paint with.
112 virtual void paint_mid(QPainter &p, const ViewItemPaintParams &pp);
115 * Paints the foreground layer of the item with a QPainter
116 * @param p the QPainter to paint into.
117 * @param pp the painting parameters object to paint with.
119 virtual void paint_fore(QPainter &p, const ViewItemPaintParams &pp);
123 * Gets the text colour.
124 * @remarks This colour is computed by comparing the lightness
125 * of the trace colour against a threshold to determine whether
126 * white or black would be more visible.
128 static QColor select_text_colour(QColor background);
131 virtual QMenu* create_context_menu(QWidget *parent);
133 virtual pv::widgets::Popup* create_popup(QWidget *parent) = 0;
135 virtual void delete_pressed();
138 static QPen highlight_pen();
141 QWidget *context_parent_;
151 #endif // PULSEVIEW_PV_VIEWITEM_H