[pulseview.git] / pv / views / trace / tracetreeitemowner.hpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2014 Joel Holdsworth <joel@airwebreathe.org.uk>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACETREEITEMOWNER_HPP
#define PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACETREEITEMOWNER_HPP

#include "viewitemowner.hpp"
#include "tracetreeitem.hpp"

using std::pair;
using std::shared_ptr;
using std::vector;

namespace pv {

class Session;

namespace views {
namespace trace {

class TraceTreeItem;
class View;

class TraceTreeItemOwner : public ViewItemOwner
{
public:
	/**
	 * Returns the view of the owner.
	 */
	virtual View* view() = 0;

	/**
	 * Returns the view of the owner.
	 */
	virtual const View* view() const = 0;

	virtual int owner_visual_v_offset() const = 0;

	/**
	 * Returns the session of the owner.
	 */
	virtual Session& session() = 0;

	/**
	 * Returns the session of the owner.
	 */
	virtual const Session& session() const = 0;

	/**
	 * Returns the number of nested parents that this row item owner has.
	 */
	virtual unsigned int depth() const = 0;

	/**
	 * Returns a list of row items owned by this object.
	 */
	virtual const item_list& child_items() const;

	/**
	 * Returns a list of row items owned by this object.
	 */
	vector< shared_ptr<TraceTreeItem> > trace_tree_child_items() const;

	/**
	 * Clears the list of child items.
	 */
	void clear_child_items();

	/**
	 * Adds a child item to this object.
	 */
	void add_child_item(shared_ptr<TraceTreeItem> item);

	/**
	 * Removes a child item from this object.
	 */
	void remove_child_item(shared_ptr<TraceTreeItem> item);

	virtual void restack_items();

	/**
	 * Computes the vertical extents of the contents of this row item owner.
	 * @return A pair containing the minimum and maximum y-values.
	 */
	pair<int, int> v_extents() const;

public:
	virtual void row_item_appearance_changed(bool label, bool content) = 0;

	virtual void extents_changed(bool horz, bool vert) = 0;
};

} // namespace trace
} // namespace views
} // namespace pv

#endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACETREEITEMOWNER_HPP
Commit	Line	Data
	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	using std::pair;
	27	using std::shared_ptr;
	28	using std::vector;
	29
	30	namespace pv {
	31
	32	class Session;
	33
	34	namespace views {
	35	namespace trace {
	36
	37	class TraceTreeItem;
	38	class View;
	39
	40	class TraceTreeItemOwner : public ViewItemOwner
	41	{
	42	public:
	43	/**
	44	* Returns the view of the owner.
	45	*/
	46	virtual View* view() = 0;
	47
	48	/**
	49	* Returns the view of the owner.
	50	*/
	51	virtual const View* view() const = 0;
	52
	53	virtual int owner_visual_v_offset() const = 0;
	54
	55	/**
	56	* Returns the session of the owner.
	57	*/
	58	virtual Session& session() = 0;
	59
	60	/**
	61	* Returns the session of the owner.
	62	*/
	63	virtual const Session& session() const = 0;
	64
	65	/**
	66	* Returns the number of nested parents that this row item owner has.
	67	*/
	68	virtual unsigned int depth() const = 0;
	69
	70	/**
	71	* Returns a list of row items owned by this object.
	72	*/
	73	virtual const item_list& child_items() const;
	74
	75	/**
	76	* Returns a list of row items owned by this object.
	77	*/
	78	vector< shared_ptr<TraceTreeItem> > trace_tree_child_items() const;
	79
	80	/**
	81	* Clears the list of child items.
	82	*/
	83	void clear_child_items();
	84
	85	/**
	86	* Adds a child item to this object.
	87	*/
	88	void add_child_item(shared_ptr<TraceTreeItem> item);
	89
	90	/**
	91	* Removes a child item from this object.
	92	*/
	93	void remove_child_item(shared_ptr<TraceTreeItem> item);
	94
	95	virtual void restack_items();
	96
	97	/**
	98	* Computes the vertical extents of the contents of this row item owner.
	99	* @return A pair containing the minimum and maximum y-values.
	100	*/
	101	pair<int, int> v_extents() const;
	102
	103	public:
	104	virtual void row_item_appearance_changed(bool label, bool content) = 0;
	105
	106	virtual void extents_changed(bool horz, bool vert) = 0;
	107	};
	108
	109	} // namespace trace
	110	} // namespace views
	111	} // namespace pv
	112
	113	#endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACETREEITEMOWNER_HPP