widget.hpp

Go to the documentation of this file.

// Copyright Take Vos 2019-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 "../GFX/draw_context.hpp"
#include "../GUI/theme.hpp"
#include "../GUI/hitbox.hpp"
#include "../GUI/keyboard_focus_direction.hpp"
#include "../GUI/keyboard_focus_group.hpp"
#include "../GUI/gui_event.hpp"
#include "../geometry/extent.hpp"
#include "../geometry/axis_aligned_rectangle.hpp"
#include "../geometry/transform.hpp"
#include "../observer.hpp"
#include "../chrono.hpp"
#include "../generator.hpp"
#include "widget_constraints.hpp"
#include "widget_layout.hpp"
#include "widget_mode.hpp"
#include <memory>
#include <vector>
#include <string>
#include <ranges>
 
namespace hi { inline namespace v1 {
class gui_window;
class font_book;
 
class widget {
public:
    gui_window& window;
 
    widget *const parent;
 
    std::string id;
 
    observer<widget_mode> mode = widget_mode::enabled;
 
    observer<bool> hover = false;
 
    observer<bool> focus = false;
 
    int semantic_layer;
 
    int logical_layer;
 
    widget(gui_window& window, widget *parent) noexcept;
 
    virtual ~widget();
    widget(const widget&) = delete;
    widget& operator=(const widget&) = delete;
    widget(widget&&) = delete;
    widget& operator=(widget&&) = delete;
 
    [[nodiscard]] bool is_gui_thread() const noexcept;
 
    hi::theme const& theme() const noexcept;
 
    hi::font_book& font_book() const noexcept;
 
    [[nodiscard]] virtual hitbox hitbox_test(point3 position) const noexcept
    {
        return {};
    }
 
    [[nodiscard]] virtual hitbox hitbox_test_from_parent(point3 position) const noexcept
    {
        return hitbox_test(_layout.from_parent * position);
    }
 
    [[nodiscard]] virtual hitbox hitbox_test_from_parent(point3 position, hitbox sibling_hitbox) const noexcept
    {
        return std::max(sibling_hitbox, hitbox_test(_layout.from_parent * position));
    }
 
    [[nodiscard]] virtual bool accepts_keyboard_focus(keyboard_focus_group group) const noexcept
    {
        hi_axiom(is_gui_thread());
        return false;
    }
 
    virtual widget_constraints const& set_constraints() noexcept = 0;
 
    widget_constraints const& constraints() const noexcept
    {
        return _constraints;
    }
 
    virtual void set_layout(widget_layout const& layout) noexcept = 0;
 
    widget_layout const& layout() const noexcept
    {
        return _layout;
    }
 
    virtual void draw(draw_context const& context) noexcept = 0;
 
    virtual void request_redraw() const noexcept;
 
    void request_relayout() const noexcept;
 
    template<fixed_string SourceFile, int SourceLine, fixed_string Fmt, typename... Args>
    void request_reconstrain(Args&&...args) const noexcept
    {
        constexpr auto FmtPlus = fixed_string{"request_reconstrain:"} + Fmt;
 
        log_global.add<global_state_type::log_info, SourceFile, SourceLine, FmtPlus>(std::forward<Args>(args)...);
        _request_reconstrain();
    }
 
#define hi_request_reconstrain(fmt, ...) \
    hi_format_check(fmt __VA_OPT__(, ) __VA_ARGS__); \
    this->request_reconstrain<__FILE__, __LINE__, fmt>(__VA_ARGS__)
 
    template<fixed_string SourceFile, int SourceLine, fixed_string Fmt, typename... Args>
    void request_resize(Args&&...args) const noexcept
    {
        constexpr auto FmtPlus = fixed_string{"request_resize:"} + Fmt;
 
        log_global.add<global_state_type::log_info, SourceFile, SourceLine, FmtPlus>(std::forward<Args>(args)...);
        _request_resize();
    }
 
#define hi_request_resize(fmt, ...) \
    hi_format_check(fmt __VA_OPT__(, ) __VA_ARGS__); \
    this->request_resize<__FILE__, __LINE__, fmt>(__VA_ARGS__)
 
    virtual bool handle_event(gui_event const& event) noexcept;
 
    virtual bool handle_event_recursive(
        gui_event const& event,
        std::vector<widget const *> const& reject_list = std::vector<widget const *>{}) noexcept;
 
    [[nodiscard]] virtual widget const *find_next_widget(
        widget const *current_keyboard_widget,
        keyboard_focus_group group,
        keyboard_focus_direction direction) const noexcept;
 
    [[nodiscard]] widget const *find_first_widget(keyboard_focus_group group) const noexcept;
 
    [[nodiscard]] widget const *find_last_widget(keyboard_focus_group group) const noexcept;
 
    [[nodiscard]] bool is_first(keyboard_focus_group group) const noexcept;
 
    [[nodiscard]] bool is_last(keyboard_focus_group group) const noexcept;
 
    virtual void scroll_to_show(hi::aarectangle rectangle) noexcept;
 
    void scroll_to_show() noexcept
    {
        scroll_to_show(layout().rectangle());
    }
 
    [[nodiscard]] std::vector<widget const *> parent_chain() const noexcept;
 
    virtual [[nodiscard]] color background_color() const noexcept;
 
    virtual [[nodiscard]] color foreground_color() const noexcept;
 
    virtual [[nodiscard]] color focus_color() const noexcept;
 
    virtual [[nodiscard]] color accent_color() const noexcept;
 
    virtual [[nodiscard]] color label_color() const noexcept;
 
protected:
    widget_constraints _constraints;
    widget_layout _layout;
 
    decltype(mode)::callback_token _mode_cbt;
 
    [[nodiscard]] virtual generator<widget *> children() const noexcept
    {
        co_return;
    }
 
    [[nodiscard]] aarectangle make_overlay_rectangle(aarectangle requested_rectangle) const noexcept;
 
private:
    void _request_reconstrain() const noexcept;
    void _request_resize() const noexcept;
};
 
}} // namespace hi::v1