grid_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 "../GUI/module.hpp"
#include "../layout/grid_layout.hpp"
#include "../log.hpp"
#include <memory>
 
namespace hi { inline namespace v1 {
 
template<fixed_string Name = "">
class grid_widget : public widget {
public:
    using super = widget;
    constexpr static auto prefix = Name / "grid";
 
    ~grid_widget() {};
 
    grid_widget(widget *parent) noexcept : widget(parent)
    {
        hi_axiom(loop::main().on_thread());
 
        if (parent) {
            semantic_layer = parent->semantic_layer;
        }
    }
 
    template<typename Widget, typename... Args>
    Widget&
    make_widget(std::size_t first_column, std::size_t first_row, std::size_t last_column, std::size_t last_row, Args&&...args)
    {
        hi_axiom(first_column < last_column);
        hi_axiom(first_row < last_row);
        auto tmp = std::make_unique<Widget>(this, std::forward<Args>(args)...);
        return static_cast<Widget&>(add_widget(first_column, first_row, last_column, last_row, std::move(tmp)));
    }
 
    template<typename Widget, typename... Args>
    Widget& make_widget(std::size_t column, std::size_t row, Args&&...args)
    {
        return make_widget<Widget>(column, row, column + 1, row + 1, std::forward<Args>(args)...);
    }
 
    template<typename Widget, typename... Args>
    Widget& make_widget(std::string_view address, Args&&...args)
    {
        hilet[column_first, row_first, column_last, row_last] = parse_spreadsheet_range(address);
        return make_widget<Widget>(column_first, row_first, column_last, row_last, std::forward<Args>(args)...);
    }
 
    [[nodiscard]] generator<widget const&> children(bool include_invisible) const noexcept override
    {
        for (hilet& cell : _grid) {
            co_yield *cell.value;
        }
    }
 
    [[nodiscard]] box_constraints update_constraints() noexcept override
    {
        for (auto& cell : _grid) {
            cell.set_constraints(cell.value->update_constraints());
        }
 
        return _grid.constraints(os_settings::left_to_right());
    }
 
    void set_layout(widget_layout const& context) noexcept override
    {
        if (compare_store(layout, context)) {
            _grid.set_layout(context.shape, theme<prefix>.cap_height(this));
        }
 
        for (hilet& cell : _grid) {
            cell.value->set_layout(context.transform(cell.shape, 0.0f));
        }
    }
 
    void draw(widget_draw_context& context) noexcept override
    {
        // Don't check for overlap, since children can have overlays.
        if (*mode > widget_mode::invisible) {
            for (hilet& cell : _grid) {
                cell.value->draw(context);
            }
        }
    }
 
    [[nodiscard]] hitbox hitbox_test(point2i position) const noexcept override
    {
        hi_axiom(loop::main().on_thread());
 
        if (*mode >= widget_mode::partial) {
            auto r = hitbox{};
            for (hilet& cell : _grid) {
                r = cell.value->hitbox_test_from_parent(position, r);
            }
            return r;
        } else {
            return {};
        }
    }
 
private:
    grid_layout<std::unique_ptr<widget>> _grid;
 
    /* Add a widget to the grid.
     */
    widget& add_widget(
        std::size_t first_column,
        std::size_t first_row,
        std::size_t last_column,
        std::size_t last_row,
        std::unique_ptr<widget> child_widget) noexcept
    {
        hi_axiom(loop::main().on_thread());
        hi_axiom(first_column < last_column);
        hi_axiom(first_row < last_row);
 
        if (_grid.cell_in_use(first_column, first_row, last_column, last_row)) {
            hi_log_fatal("cell ({},{}) of grid_widget is already in use", first_column, first_row);
        }
 
        auto& ref = *child_widget;
        _grid.add_cell(first_column, first_row, last_column, last_row, std::move(child_widget));
        hi_log_info("grid_widget::add_widget({}, {}, {}, {})", first_column, first_row, last_column, last_row);
 
        ++global_counter<"grid_widget:add_widget:constrain">;
        process_event({gui_event_type::window_reconstrain});
        return ref;
    }
};
 
}} // namespace hi::v1