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_HPP
  22 #define PULSEVIEW_PV_MARGINWIDGET_HPP
  23
  24 #include <memory>
  25
  26 #include <QPoint>
  27
  28 #include "viewwidget.hpp"
  29
  30 namespace pv {
  31 namespace view {
  32
  33 class ViewItem;
  34
  35 class MarginWidget : public ViewWidget
  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          * Indicates the event an a view item has been clicked.
  52          * @param item the view item that has been clicked.
  53          */
  54         virtual void item_clicked(
  55                 const std::shared_ptr<pv::view::ViewItem> &item);
  56
  57         /**
  58          * Shows the popup of a the specified @c ViewItem .
  59          * @param item The item to show the popup for.
  60          */
  61         void show_popup(const std::shared_ptr<ViewItem> &item);
  62
  63 protected:
  64         virtual void contextMenuEvent(QContextMenuEvent *event);
  65
  66         virtual void keyPressEvent(QKeyEvent *event);
  67 };
  68
  69 } // namespace view
  70 } // namespace pv
  71
  72 #endif // PULSEVIEW_PV_MARGINWIDGET_HPP