pv/view/viewwidget.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_VIEWWIDGET_H
  22 #define PULSEVIEW_PV_VIEWWIDGET_H
  23
  24 #include <memory>
  25
  26 #include <QWidget>
  27
  28 class QTouchEvent;
  29
  30 namespace pv {
  31 namespace view {
  32
  33 class View;
  34 class ViewItem;
  35
  36 class ViewWidget : public QWidget
  37 {
  38         Q_OBJECT
  39
  40 protected:
  41         ViewWidget(View &parent);
  42
  43         /**
  44          * Indicates the event an a view item has been clicked.
  45          * @param item the view item that has been clicked.
  46          * @remarks the default implementation does nothing.
  47          */
  48         virtual void item_clicked(
  49                 const std::shared_ptr<pv::view::ViewItem> &item);
  50
  51         /**
  52          * Returns true if the selection of row items allows dragging.
  53          * @return Returns true if the drag is acceptable.
  54          */
  55         bool accept_drag() const;
  56
  57         /**
  58          * Returns true if the mouse button is down.
  59          */
  60         bool mouse_down() const;
  61
  62         /**
  63          * Drag the dragging items by the delta offset.
  64          * @param delta the drag offset in pixels.
  65          */
  66         void drag_items(const QPoint &delta);
  67
  68         /**
  69          * Sets this item into the dragged state.
  70          */
  71         virtual void drag();
  72
  73         /**
  74          * Drag the background by the delta offset.
  75          * @param delta the drag offset in pixels.
  76          * @remarks The default implementation does nothing.
  77          */
  78         virtual void drag_by(const QPoint &delta);
  79
  80         /**
  81          * Sets this item into the un-dragged state.
  82          */
  83         virtual void drag_release();
  84
  85         /**
  86          * Gets the items in the view widget.
  87          */
  88         virtual std::vector< std::shared_ptr<pv::view::ViewItem> > items() = 0;
  89
  90         /**
  91          * Gets the first view item which has a hit-box that contains @c pt .
  92          * @param pt the point to search with.
  93          * @return the view item that has been found, or and empty
  94          *   @c shared_ptr if no item was found.
  95          */
  96         virtual std::shared_ptr<pv::view::ViewItem> get_mouse_over_item(
  97                 const QPoint &pt) = 0;
  98
  99         /**
 100          * Handles left mouse button press events.
 101          * @param event the mouse event that triggered this handler.
 102          */
 103         void mouse_left_press_event(QMouseEvent *event);
 104
 105         /**
 106          * Handles left mouse button release events.
 107          * @param event the mouse event that triggered this handler.
 108          */
 109         void mouse_left_release_event(QMouseEvent *event);
 110
 111         /**
 112          * Handles touch begin update and end events.
 113          * @param e the event that triggered this handler.
 114          */
 115         virtual bool touch_event(QTouchEvent *e);
 116
 117 protected:
 118         bool event(QEvent *event);
 119
 120         void mousePressEvent(QMouseEvent * event);
 121         void mouseReleaseEvent(QMouseEvent *event);
 122         void mouseMoveEvent(QMouseEvent *event);
 123
 124         void leaveEvent(QEvent *event);
 125
 126 public Q_SLOTS:
 127         void clear_selection();
 128
 129 Q_SIGNALS:
 130         void selection_changed();
 131
 132 protected:
 133         pv::view::View &view_;
 134         QPoint mouse_point_;
 135         QPoint mouse_down_point_;
 136         std::shared_ptr<ViewItem> mouse_down_item_;
 137         bool item_dragging_;
 138 };
 139
 140 } // namespace view
 141 } // namespace pv
 142
 143 #endif // PULSEVIEW_PV_VIEWWIDGET_H