pv/views/trace/tracegroup.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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef PULSEVIEW_PV_VIEWS_TRACE_TRACEGROUP_HPP
  21 #define PULSEVIEW_PV_VIEWS_TRACE_TRACEGROUP_HPP
  22
  23 #include "tracetreeitem.hpp"
  24 #include "tracetreeitemowner.hpp"
  25
  26 using std::pair;
  27
  28 namespace pv {
  29 namespace views {
  30 namespace trace {
  31
  32 class TraceGroup : public TraceTreeItem, public TraceTreeItemOwner
  33 {
  34         Q_OBJECT
  35
  36 private:
  37         static const int Padding;
  38         static const int Width;
  39         static const int LineThickness;
  40         static const QColor LineColor;
  41
  42 public:
  43         /**
  44          * Virtual destructor
  45          */
  46         virtual ~TraceGroup();
  47
  48         /**
  49          * Returns true if the item is visible and enabled.
  50          */
  51         bool enabled() const;
  52
  53         /**
  54          * Returns the session of the onwer.
  55          */
  56         pv::Session& session();
  57
  58         /**
  59          * Returns the session of the onwer.
  60          */
  61         const pv::Session& session() const;
  62
  63         /**
  64          * Returns the view of the owner.
  65          */
  66         virtual View* view();
  67
  68         /**
  69          * Returns the view of the owner.
  70          */
  71         virtual const View* view() const;
  72
  73         /**
  74          * Computes the vertical extents of the contents of this row item.
  75          * @return A pair containing the minimum and maximum y-values.
  76          */
  77         pair<int, int> v_extents() const;
  78
  79         /**
  80          * Paints the signal label.
  81          * @param p the QPainter to paint into.
  82          * @param right the x-coordinate of the right edge of the header
  83          *      area.
  84          * @param hover true if the label is being hovered over by the mouse.
  85          */
  86         void paint_label(QPainter &p, const QRect &rect, bool hover);
  87
  88         /**
  89          * Computes the outline rectangle of a label.
  90          * @param rect the rectangle of the header area.
  91          * @return Returns the rectangle of the signal label.
  92          */
  93         QRectF label_rect(const QRectF &rect) const;
  94
  95         /**
  96          * Determines if a point is in the header label rect.
  97          * @param left the x-coordinate of the left edge of the header
  98          *      area.
  99          * @param right the x-coordinate of the right edge of the header
 100          *      area.
 101          * @param point the point to test.
 102          */
 103         bool pt_in_label_rect(int left, int right, const QPoint &point);
 104
 105         QMenu* create_header_context_menu(QWidget *parent);
 106
 107         pv::widgets::Popup* create_popup(QWidget *parent);
 108
 109         /**
 110          * Returns the total vertical offset of this trace and all it's owners
 111          */
 112         int owner_visual_v_offset() const;
 113
 114         /**
 115          * Returns the number of nested parents that this row item owner has.
 116          */
 117         unsigned int depth() const;
 118
 119         void ungroup();
 120
 121 public:
 122         void row_item_appearance_changed(bool label, bool content);
 123
 124         void extents_changed(bool horz, bool vert);
 125
 126 private Q_SLOTS:
 127         void on_ungroup();
 128 };
 129
 130 } // namespace trace
 131 } // namespace views
 132 } // namespace pv
 133
 134 #endif // PULSEVIEW_PV_VIEWS_TRACE_TRACEGROUP_HPP