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