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