[pulseview.git] / pv / view / rowitemowner.h

/*
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#ifndef PULSEVIEW_PV_VIEW_ROWITEMOWNER_H
#define PULSEVIEW_PV_VIEW_ROWITEMOWNER_H

#include <memory>
#include <vector>

namespace pv {

class SigSession;

namespace view {

class RowItem;
class View;

class RowItemOwner
{
public:
	/**
	 * Returns the session of the onwer.
	 */
	virtual pv::SigSession& session() = 0;

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

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

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

	virtual int owner_v_offset() const = 0;

	/**
	 * Returns a list of row items owned by this object.
	 */
	virtual const std::vector< std::shared_ptr<RowItem> >&
		child_items() const;

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

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

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

	virtual void update_viewport() = 0;

private:
	std::vector< std::shared_ptr<RowItem> > _items;
};

} // view
} // pv

#endif // PULSEVIEW_PV_VIEW_ROWITEMOWNER_H
Commit	Line	Data
18f7104f JH	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_VIEW_ROWITEMOWNER_H
	22	#define PULSEVIEW_PV_VIEW_ROWITEMOWNER_H
	23
	24	#include <memory>
	25	#include <vector>
	26
	27	namespace pv {
	28
	29	class SigSession;
	30
	31	namespace view {
	32
	33	class RowItem;
	34	class View;
	35
	36	class RowItemOwner
	37	{
	38	public:
	39	/**
	40	* Returns the session of the onwer.
	41	*/
	42	virtual pv::SigSession& session() = 0;
	43
	44	/**
	45	* Returns the session of the owner.
	46	*/
	47	virtual const pv::SigSession& session() const = 0;
	48
	49	/**
	50	* Returns the view of the owner.
	51	*/
	52	virtual pv::view::View* view() = 0;
	53
	54	/**
	55	* Returns the view of the owner.
	56	*/
	57	virtual const pv::view::View* view() const = 0;
	58
	59	virtual int owner_v_offset() const = 0;
	60
	61	/**
	62	* Returns a list of row items owned by this object.
	63	*/
68b21a71 JH	64	virtual const std::vector< std::shared_ptr<RowItem> >&
	65	child_items() const;
	66
	67	/**
	68	* Clears the list of child items.
	69	*/
	70	void clear_child_items();
	71
	72	/**
	73	* Adds a child item to this object.
	74	*/
	75	void add_child_item(std::shared_ptr<RowItem> item);
	76
	77	/**
	78	* Removes a child item from this object.
	79	*/
	80	void remove_child_item(std::shared_ptr<RowItem> item);
18f7104f	81
18f7104f	82	virtual void update_viewport() = 0;
68b21a71 JH	83
	84	private:
	85	std::vector< std::shared_ptr<RowItem> > _items;
18f7104f JH	86	};
	87
	88	} // view
	89	} // pv
	90
	91	#endif // PULSEVIEW_PV_VIEW_ROWITEMOWNER_H