view_tree.h

/*
**  UICore
**  Copyright (c) 1997-2015 The UICore Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries UICore may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/

#pragma once

#include "../View/view.h"
#include "../Events/activation_change_event.h"

namespace uicore
{
    class DisplayWindow;
    typedef std::shared_ptr<DisplayWindow> DisplayWindowPtr;
    class Canvas;
    class ViewTreeImpl;

    class ViewTree
    {
    public:
        ViewTree();
        virtual ~ViewTree();

        View *focus_view() const;

        virtual DisplayWindowPtr display_window() = 0;

        virtual CanvasPtr canvas() const = 0;

        const std::shared_ptr<View> &root_view() const;

        void set_root_view(std::shared_ptr<View> root_view);

        void add_child(const std::shared_ptr<View> &view)
        {
            root_view()->add_child(view);
        }

        template<typename T, typename... Types>
        std::shared_ptr<T> add_child(Types &&... args)
        {
            auto child = std::make_shared<T>(std::forward<Types>(args)...);
            add_child(child);
            return child;
        }

        std::shared_ptr<View> add_child()
        {
            return add_child<View>();
        }

    protected:
        void set_focus_view(View *view);

        void render(const CanvasPtr &canvas, const Rectf &margin_box);

        void dispatch_activation_change(ActivationChangeType type);

        virtual void set_needs_render() = 0;

        virtual Pointf client_to_screen_pos(const Pointf &pos) = 0;

        virtual Pointf screen_to_client_pos(const Pointf &pos) = 0;

    private:
        ViewTree(const ViewTree &) = delete;
        ViewTree &operator=(const ViewTree &) = delete;

        std::unique_ptr<ViewTreeImpl> impl;

        friend class View;
        friend class ViewImpl;
        friend class ViewController;
        friend class PositionedLayout;
    };
}