tracetreeitemowner.hpp

Go to the documentation of this file.

/*
 * 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_TRACETREEITEMOWNER_HPP
#define PULSEVIEW_PV_VIEW_TRACETREEITEMOWNER_HPP

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

namespace pv {

class Session;

namespace view {

class TraceTreeItem;
class View;

class TraceTreeItemOwner : public ViewItemOwner
{
public:
    virtual pv::view::View* view() = 0;

    virtual const pv::view::View* view() const = 0;

    virtual int owner_visual_v_offset() const = 0;

    virtual pv::Session& session() = 0;

    virtual const pv::Session& session() const = 0;

    virtual unsigned int depth() const = 0;

    virtual const item_list& child_items() const;

    std::vector< std::shared_ptr<TraceTreeItem> >
    trace_tree_child_items() const;

    void clear_child_items();

    void add_child_item(std::shared_ptr<TraceTreeItem> item);

    void remove_child_item(std::shared_ptr<TraceTreeItem> item);

    virtual void restack_items();

    std::pair<int, int> v_extents() const;

    /*
     * Reassigns background color states to all its children, thereby
     * providing them with alternating backgrounds.
     * @param next_bgcolour_state First brightness state to use.
     * @return The next brightness state to use.
     */
    bool reassign_bgcolour_states(bool next_bgcolour_state);

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

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

} // view
} // pv

#endif // PULSEVIEW_PV_VIEW_TRACETREEITEMOWNER_HPP