pv/view/tracetreeitemowner.hpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2014 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_VIEWS_TRACEVIEW_TRACETREEITEMOWNER_HPP
  22 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACETREEITEMOWNER_HPP
  23
  24 #include "viewitemowner.hpp"
  25 #include "tracetreeitem.hpp"
  26
  27 namespace pv {
  28
  29 class Session;
  30
  31 namespace views {
  32 namespace TraceView {
  33
  34 class TraceTreeItem;
  35 class View;
  36
  37 class TraceTreeItemOwner : public ViewItemOwner
  38 {
  39 public:
  40         /**
  41          * Returns the view of the owner.
  42          */
  43         virtual View* view() = 0;
  44
  45         /**
  46          * Returns the view of the owner.
  47          */
  48         virtual const View* view() const = 0;
  49
  50         virtual int owner_visual_v_offset() const = 0;
  51
  52         /**
  53          * Returns the session of the owner.
  54          */
  55         virtual Session& session() = 0;
  56
  57         /**
  58          * Returns the session of the owner.
  59          */
  60         virtual const Session& session() const = 0;
  61
  62         /**
  63          * Returns the number of nested parents that this row item owner has.
  64          */
  65         virtual unsigned int depth() const = 0;
  66
  67         /**
  68          * Returns a list of row items owned by this object.
  69          */
  70         virtual const item_list& child_items() const;
  71
  72         /**
  73          * Returns a list of row items owned by this object.
  74          */
  75         std::vector< std::shared_ptr<TraceTreeItem> >
  76         trace_tree_child_items() const;
  77
  78         /**
  79          * Clears the list of child items.
  80          */
  81         void clear_child_items();
  82
  83         /**
  84          * Adds a child item to this object.
  85          */
  86         void add_child_item(std::shared_ptr<TraceTreeItem> item);
  87
  88         /**
  89          * Removes a child item from this object.
  90          */
  91         void remove_child_item(std::shared_ptr<TraceTreeItem> item);
  92
  93         virtual void restack_items();
  94
  95         /**
  96          * Computes the vertical extents of the contents of this row item owner.
  97          * @return A pair containing the minimum and maximum y-values.
  98          */
  99         std::pair<int, int> v_extents() const;
 100
 101         /*
 102          * Reassigns background color states to all its children, thereby
 103          * providing them with alternating backgrounds.
 104          * @param next_bgcolour_state First brightness state to use.
 105          * @return The next brightness state to use.
 106          */
 107         bool reassign_bgcolour_states(bool next_bgcolour_state);
 108
 109 public:
 110         virtual void row_item_appearance_changed(bool label, bool content) = 0;
 111
 112         virtual void extents_changed(bool horz, bool vert) = 0;
 113 };
 114
 115 } // namespace TraceView
 116 } // namespace views
 117 } // namespace pv
 118
 119 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACETREEITEMOWNER_HPP