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