pv/view/viewitem.hpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2013 Joel Holdsworth <joel@airwebreathe.org.uk>
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 #ifndef PULSEVIEW_PV_VIEWITEM_HPP
  22 #define PULSEVIEW_PV_VIEWITEM_HPP
  23
  24 #include <list>
  25
  26 #include <QPen>
  27
  28 #include "viewitempaintparams.hpp"
  29
  30 class QAction;
  31 class QMenu;
  32 class QWidget;
  33
  34 namespace pv {
  35
  36 namespace widgets {
  37 class Popup;
  38 }
  39
  40 namespace view {
  41
  42 class ViewItem : public QObject
  43 {
  44         Q_OBJECT
  45
  46 public:
  47         static const QSizeF LabelPadding;
  48         static const int HighlightRadius;
  49
  50 public:
  51         ViewItem();
  52
  53 public:
  54         /**
  55          * Returns true if the item is visible and enabled.
  56          */
  57         virtual bool enabled() const = 0;
  58
  59         /**
  60          * Returns true if the item has been selected by the user.
  61          */
  62         bool selected() const;
  63
  64         /**
  65          * Selects or deselects the signal.
  66          */
  67         void select(bool select = true);
  68
  69         /**
  70          * Returns true if the item is being dragged.
  71          */
  72         bool dragging() const;
  73
  74         /**
  75          * Sets this item into the dragged state.
  76          */
  77         void drag();
  78
  79         /**
  80          * Sets this item into the un-dragged state.
  81          */
  82         void drag_release();
  83
  84         /**
  85          * Drags the item to a delta relative to the drag point.
  86          * @param delta the offset from the drag point.
  87          */
  88         virtual void drag_by(const QPoint &delta) = 0;
  89
  90         /**
  91          * Get the drag point.
  92          * @param rect the rectangle of the widget area.
  93          */
  94         virtual QPoint point(const QRect &rect) const = 0;
  95
  96         /**
  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.
 100          */
 101         virtual QRectF label_rect(const QRectF &rect) const = 0;
 102
 103         /**
 104          * Computes the outline rectangle of the viewport hit-box.
 105          * @param rect the rectangle of the viewport area.
 106          * @return Returns the rectangle of the hit-box.
 107          * @remarks The default implementation returns an empty hit-box.
 108          */
 109         virtual QRectF hit_box_rect(const QRectF &rect) const;
 110
 111         /**
 112          * Paints the signal label.
 113          * @param p the QPainter to paint into.
 114          * @param rect the rectangle of the header area.
 115          * @param hover true if the label is being hovered over by the mouse.
 116          */
 117         virtual void paint_label(QPainter &p, const QRect &rect, bool hover) = 0;
 118
 119         /**
 120          * Paints the background layer of the item with a QPainter
 121          * @param p the QPainter to paint into.
 122          * @param pp the painting parameters object to paint with.
 123          **/
 124         virtual void paint_back(QPainter &p, const ViewItemPaintParams &pp);
 125
 126         /**
 127          * Paints the mid-layer of the item with a QPainter
 128          * @param p the QPainter to paint into.
 129          * @param pp the painting parameters object to paint with.
 130          **/
 131         virtual void paint_mid(QPainter &p, const ViewItemPaintParams &pp);
 132
 133         /**
 134          * Paints the foreground 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.
 137          **/
 138         virtual void paint_fore(QPainter &p, const ViewItemPaintParams &pp);
 139
 140 public:
 141         /**
 142          * Gets the text colour.
 143          * @remarks This colour is computed by comparing the lightness
 144          * of the trace colour against a threshold to determine whether
 145          * white or black would be more visible.
 146          */
 147         static QColor select_text_colour(QColor background);
 148
 149 public:
 150         virtual QMenu* create_context_menu(QWidget *parent);
 151
 152         virtual pv::widgets::Popup* create_popup(QWidget *parent) = 0;
 153
 154         virtual void delete_pressed();
 155
 156 protected:
 157         static QPen highlight_pen();
 158
 159 protected:
 160         QWidget *context_parent_;
 161         QPoint drag_point_;
 162
 163 private:
 164         bool selected_;
 165 };
 166
 167 } // namespace view
 168 } // namespace pv
 169
 170 #endif // PULSEVIEW_PV_VIEWITEM_HPP