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