pv/view/marginwidget.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_MARGINWIDGET_H
  22 #define PULSEVIEW_PV_MARGINWIDGET_H
  23
  24 #include <memory>
  25
  26 #include <QPoint>
  27 #include <QWidget>
  28
  29 namespace pv {
  30 namespace view {
  31
  32 class View;
  33 class ViewItem;
  34
  35 class MarginWidget : public QWidget
  36 {
  37         Q_OBJECT
  38
  39 public:
  40         MarginWidget(pv::view::View &parent);
  41
  42         /**
  43          * The extended area that the margin widget would like to be sized to.
  44          * @remarks This area is the area specified by sizeHint, extended by
  45          * the area to overlap the viewport.
  46          */
  47         virtual QSize extended_size_hint() const = 0;
  48
  49 protected:
  50         /**
  51          * Gets the items in the margin widget.
  52          */
  53         virtual std::vector< std::shared_ptr<pv::view::ViewItem> > items() = 0;
  54
  55         /**
  56          * Gets the first view item which has a label that contains @c pt .
  57          * @param pt the point to search with.
  58          * @return the view item that has been found, or and empty
  59          *   @c shared_ptr if no item was found.
  60          */
  61         virtual std::shared_ptr<pv::view::ViewItem> get_mouse_over_item(
  62                 const QPoint &pt) = 0;
  63
  64         /**
  65          * Shows the popup of a the specified @c ViewItem .
  66          * @param item The item to show the popup for.
  67          */
  68         void show_popup(const std::shared_ptr<ViewItem> &item);
  69
  70         /**
  71          * Returns true if the selection of row items allows dragging.
  72          * @return Returns true if the drag is acceptable.
  73          */
  74         virtual bool accept_drag() const = 0;
  75
  76         /**
  77          * Drag the dragging items by the delta offset.
  78          * @param delta the drag offset in pixels.
  79          */
  80         virtual void drag_items(const QPoint &delta) = 0;
  81
  82         /**
  83          * Handles left mouse button press events.
  84          * @param event the mouse event that triggered this handler.
  85          */
  86         void mouse_left_press_event(QMouseEvent *event);
  87
  88         /**
  89          * Handles left mouse button release events.
  90          * @param event the mouse event that triggered this handler.
  91          */
  92         void mouse_left_release_event(QMouseEvent *event);
  93
  94 protected:
  95         void mousePressEvent(QMouseEvent * event);
  96         void mouseReleaseEvent(QMouseEvent *event);
  97         void mouseMoveEvent(QMouseEvent *event);
  98
  99         void leaveEvent(QEvent *event);
 100
 101         virtual void contextMenuEvent(QContextMenuEvent *event);
 102
 103         virtual void keyPressEvent(QKeyEvent *e);
 104
 105 public Q_SLOTS:
 106         void clear_selection();
 107
 108 Q_SIGNALS:
 109         void selection_changed();
 110
 111 protected:
 112         pv::view::View &view_;
 113         QPoint mouse_point_;
 114         QPoint mouse_down_point_;
 115         std::shared_ptr<ViewItem> mouse_down_item_;
 116         bool dragging_;
 117 };
 118
 119 } // namespace view
 120 } // namespace pv
 121
 122 #endif // PULSEVIEW_PV_MARGINWIDGET_H