scroll_widget.hpp

Go to the documentation of this file.

// Copyright Take Vos 2021-2022.
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)

 
#pragma once
 
#include "widget.hpp"
#include "scroll_bar_widget.hpp"
#include "scroll_aperture_widget.hpp"
#include "../geometry/geometry.hpp"
#include "../layout/layout.hpp"
#include "../macros.hpp"
#include <coroutine>
 
hi_export_module(hikogui.widgets.scroll_widget);
 
hi_export namespace hi {
inline namespace v1 {

template<axis Axis = axis::both>
class scroll_widget : public widget {
public:
    using super = widget;
    using horizontal_scroll_bar_type = scroll_bar_widget<axis::horizontal>;
    using vertical_scroll_bar_type = scroll_bar_widget<axis::vertical>;
 
    constexpr static hi::axis axis = Axis;
 
    ~scroll_widget() {}

    scroll_widget() noexcept : super()
    {
        hi_axiom(loop::main().on_thread());
 
        auto aperture = std::make_unique<scroll_aperture_widget>();
        aperture->set_parent(this);
 
        auto horizontal_scroll_bar =
            std::make_unique<horizontal_scroll_bar_type>(aperture->content_width, aperture->aperture_width, aperture->offset_x);
        horizontal_scroll_bar->set_parent(this);
 
        auto vertical_scroll_bar =
            std::make_unique<vertical_scroll_bar_type>(aperture->content_height, aperture->aperture_height, aperture->offset_y);
        vertical_scroll_bar->set_parent(this);
 
        if (to_bool(axis & axis::horizontal)) {
            minimum->width() = 0;
        } else {
            horizontal_scroll_bar->set_mode(widget_mode::collapse);
        }
 
        if (to_bool(axis & axis::vertical)) {
            minimum->height() = 0;
        } else {
            vertical_scroll_bar->set_mode(widget_mode::collapse);
        }
 
        _aperture = aperture.get();
        _horizontal_scroll_bar = horizontal_scroll_bar.get();
        _vertical_scroll_bar = vertical_scroll_bar.get();
 
        _grid.add_cell(0, 0, std::move(aperture));
        _grid.add_cell(1, 0, std::move(vertical_scroll_bar));
        _grid.add_cell(0, 1, std::move(horizontal_scroll_bar));
    }

    template<typename Widget, typename... Args>
    Widget& emplace(Args&&... args) noexcept
    {
        return _aperture->emplace<Widget>(std::forward<Args>(args)...);
    }

    [[nodiscard]] generator<widget_intf&> children(bool include_invisible) noexcept override
    {
        co_yield *_aperture;
        co_yield *_vertical_scroll_bar;
        co_yield *_horizontal_scroll_bar;
    }
 
    [[nodiscard]] box_constraints update_constraints() noexcept override
    {
        _layout = {};
 
        for (auto& cell : _grid) {
            cell.set_constraints(cell.value->update_constraints());
        }
        auto grid_constraints = _grid.constraints(os_settings::left_to_right());
        return grid_constraints.constrain(*minimum, *maximum);
    }
 
    void set_layout(widget_layout const& context) noexcept override
    {
        if (compare_store(_layout, context)) {
            _grid.set_layout(context.shape, theme().baseline_adjustment());
        }
 
        for (auto const& cell : _grid) {
            auto shape = cell.shape;
 
            if (cell.value.get() == _aperture) {
                // This is the content. Move the content slightly when the scroll-bars aren't visible.
                // The grid cells are always ordered in row-major.
                // This the vertical scroll bar is _grid[1] and the horizontal scroll bar is _grid[2].
                if (not _vertical_scroll_bar->visible()) {
                    shape.rectangle = aarectangle{0, shape.y(), _layout.width(), shape.height()};
                }
                if (not _horizontal_scroll_bar->visible()) {
                    shape.rectangle = aarectangle{shape.x(), 0, shape.width(), _layout.height()};
                }
            }
 
            cell.value->set_layout(context.transform(shape, transform_command::level));
        }
    }
 
    void draw(draw_context const& context) noexcept override
    {
        if (mode() > widget_mode::invisible) {
            for (auto const& cell : _grid) {
                cell.value->draw(context);
            }
        }
    }
 
    [[nodiscard]] hitbox hitbox_test(point2 position) const noexcept override
    {
        hi_axiom(loop::main().on_thread());
 
        if (mode() >= widget_mode::partial) {
            auto r = _aperture->hitbox_test_from_parent(position);
            r = _horizontal_scroll_bar->hitbox_test_from_parent(position, r);
            r = _vertical_scroll_bar->hitbox_test_from_parent(position, r);
 
            if (layout().contains(position)) {
                r = std::max(r, hitbox{id, _layout.elevation});
            }
            return r;
 
        } else {
            return {};
        }
    }
    // @endprivatesection
private:
    grid_layout<std::unique_ptr<widget>> _grid;
 
    scroll_aperture_widget* _aperture;
    horizontal_scroll_bar_type* _horizontal_scroll_bar;
    vertical_scroll_bar_type* _vertical_scroll_bar;
};

using vertical_scroll_widget = scroll_widget<axis::vertical>;

using horizontal_scroll_widget = scroll_widget<axis::horizontal>;
 
} // namespace v1
} // namespace hi::v1