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, see <http://www.gnu.org/licenses/>.
20 #ifndef PULSEVIEW_PV_VIEWITEM_HPP
21 #define PULSEVIEW_PV_VIEWITEM_HPP
28 #include "viewitempaintparams.hpp"
45 class ViewItem : public QObject
50 static const QSizeF LabelPadding;
51 static const int HighlightRadius;
58 * Returns true if the item is visible and enabled.
60 virtual bool enabled() const = 0;
63 * Returns true if the item may be selected.
65 virtual bool is_selectable(QPoint pos) const;
68 * Returns true if the item has been selected by the user.
70 bool selected() const;
73 * Selects or deselects the signal.
75 virtual void select(bool select = true);
78 * Returns true if the item may be dragged/moved.
80 virtual bool is_draggable() const;
83 * Returns true if the item is being dragged.
85 bool dragging() const;
88 * Sets this item into the dragged state.
93 * Sets this item into the un-dragged state.
95 virtual void drag_release();
98 * Drags the item to a delta relative to the drag point.
99 * @param delta the offset from the drag point.
101 virtual void drag_by(const QPoint &delta) = 0;
104 * Get the drag point.
105 * @param rect the rectangle of the widget area.
107 virtual QPoint drag_point(const QRect &rect) const = 0;
110 * Computes the outline rectangle of a label.
111 * @param rect the rectangle of the header area.
112 * @return Returns the rectangle of the signal label.
113 * @remarks The default implementation returns an empty rectangle.
115 virtual QRectF label_rect(const QRectF &rect) const;
118 * Computes the outline rectangle of the viewport hit-box.
119 * @param rect the rectangle of the viewport area.
120 * @return Returns the rectangle of the hit-box.
121 * @remarks The default implementation returns an empty hit-box.
123 virtual QRectF hit_box_rect(const ViewItemPaintParams &pp) const;
126 * Paints the signal label.
127 * @param p the QPainter to paint into.
128 * @param rect the rectangle of the header area.
129 * @param hover true if the label is being hovered over by the mouse.
131 virtual void paint_label(QPainter &p, const QRect &rect, bool hover);
134 * Paints the background layer of the item with a QPainter
135 * @param p the QPainter to paint into.
136 * @param pp the painting parameters object to paint with.
138 virtual void paint_back(QPainter &p, ViewItemPaintParams &pp);
141 * Paints the mid-layer of the item with a QPainter
142 * @param p the QPainter to paint into.
143 * @param pp the painting parameters object to paint with.
145 virtual void paint_mid(QPainter &p, ViewItemPaintParams &pp);
148 * Paints the foreground layer of the item with a QPainter
149 * @param p the QPainter to paint into.
150 * @param pp the painting parameters object to paint with.
152 virtual void paint_fore(QPainter &p, ViewItemPaintParams &pp);
156 * Gets the text color.
157 * @remarks This color is computed by comparing the lightness
158 * of the trace color against a threshold to determine whether
159 * white or black would be more visible.
161 static QColor select_text_color(QColor background);
164 virtual QMenu* create_header_context_menu(QWidget *parent);
166 virtual QMenu* create_view_context_menu(QWidget *parent, QPoint &click_pos);
168 virtual pv::widgets::Popup* create_popup(QWidget *parent);
170 virtual void delete_pressed();
173 static QPen highlight_pen();
176 QWidget *context_parent_;
187 #endif // PULSEVIEW_PV_VIEWITEM_HPP