2 * This file is part of the PulseView project.
4 * Copyright (C) 2014 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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
21 #ifndef PULSEVIEW_PV_VIEW_ROWITEMOWNER_H
22 #define PULSEVIEW_PV_VIEW_ROWITEMOWNER_H
27 #include "rowitemiterator.hpp"
41 typedef std::vector< std::shared_ptr<RowItem> > item_list;
42 typedef RowItemIterator<RowItemOwner, RowItem> iterator;
43 typedef RowItemIterator<const RowItemOwner, RowItem> const_iterator;
47 * Returns the session of the onwer.
49 virtual pv::Session& session() = 0;
52 * Returns the session of the owner.
54 virtual const pv::Session& session() const = 0;
57 * Returns the view of the owner.
59 virtual pv::view::View* view() = 0;
62 * Returns the view of the owner.
64 virtual const pv::view::View* view() const = 0;
66 virtual int owner_visual_v_offset() const = 0;
69 * Returns the number of nested parents that this row item owner has.
71 virtual unsigned int depth() const = 0;
74 * Returns a list of row items owned by this object.
76 virtual item_list& child_items();
79 * Returns a list of row items owned by this object.
81 virtual const item_list& child_items() const;
84 * Clears the list of child items.
86 void clear_child_items();
89 * Adds a child item to this object.
91 void add_child_item(std::shared_ptr<RowItem> item);
94 * Removes a child item from this object.
96 void remove_child_item(std::shared_ptr<RowItem> item);
99 * Returns a depth-first iterator at the beginning of the child RowItem
105 * Returns a depth-first iterator at the end of the child RowItem tree.
110 * Returns a constant depth-first iterator at the beginning of the
111 * child RowItem tree.
113 const_iterator begin() const;
116 * Returns a constant depth-first iterator at the end of the child
119 const_iterator end() const;
122 * Computes the vertical extents of the contents of this row item owner.
123 * @return A pair containing the minimum and maximum y-values.
125 std::pair<int, int> v_extents() const;
127 virtual void restack_items();
130 virtual void appearance_changed(bool label, bool content) = 0;
132 virtual void extents_changed(bool horz, bool vert) = 0;
141 #endif // PULSEVIEW_PV_VIEW_ROWITEMOWNER_H