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