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_H
  22 #define PULSEVIEW_PV_VIEWITEM_H
  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          * Retunrns the current drag point.
  76          */
  77         QPoint drag_point() const;
  78
  79         /**
  80          * Sets this item into the dragged state.
  81          */
  82         void drag();
  83
  84         /**
  85          * Sets this item into the un-dragged state.
  86          */
  87         void drag_release();
  88
  89         /**
  90          * Get the drag point.
  91          */
  92         virtual QPoint point() const = 0;
  93
  94         /**
  95          * Computes the outline rectangle of a label.
  96          * @param rect the rectangle of the header area.
  97          * @return Returns the rectangle of the signal label.
  98          */
  99         virtual QRectF label_rect(const QRectF &rect) const = 0;
 100
 101         /**
 102          * Paints the signal label.
 103          * @param p the QPainter to paint into.
 104          * @param rect the rectangle of the header area.
 105          * @param hover true if the label is being hovered over by the mouse.
 106          */
 107         virtual void paint_label(QPainter &p, const QRect &rect, bool hover) = 0;
 108
 109         /**
 110          * Paints the background layer of the item with a QPainter
 111          * @param p the QPainter to paint into.
 112          * @param pp the painting parameters object to paint with.
 113          **/
 114         virtual void paint_back(QPainter &p, const ViewItemPaintParams &pp);
 115
 116         /**
 117          * Paints the mid-layer of the item with a QPainter
 118          * @param p the QPainter to paint into.
 119          * @param pp the painting parameters object to paint with.
 120          **/
 121         virtual void paint_mid(QPainter &p, const ViewItemPaintParams &pp);
 122
 123         /**
 124          * Paints the foreground layer of the item with a QPainter
 125          * @param p the QPainter to paint into.
 126          * @param pp the painting parameters object to paint with.
 127          **/
 128         virtual void paint_fore(QPainter &p, const ViewItemPaintParams &pp);
 129
 130 public:
 131         /**
 132          * Gets the text colour.
 133          * @remarks This colour is computed by comparing the lightness
 134          * of the trace colour against a threshold to determine whether
 135          * white or black would be more visible.
 136          */
 137         static QColor select_text_colour(QColor background);
 138
 139 public:
 140         virtual QMenu* create_context_menu(QWidget *parent);
 141
 142         virtual pv::widgets::Popup* create_popup(QWidget *parent) = 0;
 143
 144         virtual void delete_pressed();
 145
 146 protected:
 147         static QPen highlight_pen();
 148
 149 protected:
 150         QWidget *context_parent_;
 151
 152 private:
 153         bool selected_;
 154         QPoint drag_point_;
 155 };
 156
 157 } // namespace view
 158 } // namespace pv
 159
 160 #endif // PULSEVIEW_PV_VIEWITEM_H