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 "../layout/layout.hpp"
#include "../geometry/geometry.hpp"
#include "../observer/observer.hpp"
#include "../time/time.hpp"
#include "../settings/settings.hpp"
#include "../numeric/numeric.hpp"
#include "../GUI/GUI.hpp"
#include "../macros.hpp"
#include <memory>
#include <vector>
#include <string>
#include <ranges>
 
hi_export_module(hikogui.widgets.widget);
 
hi_export namespace hi { inline namespace v1 {
 
class widget : public widget_intf {
public:
    observer<extent2> minimum = extent2{};
 
    observer<extent2> maximum = extent2::large();
 
    explicit widget(widget_intf const* parent) noexcept : widget_intf(parent)
    {
    }
 
    explicit widget() noexcept : widget_intf(nullptr)
    {
    }
 
    virtual ~widget() {}
    widget(const widget&) = delete;
    widget& operator=(const widget&) = delete;
    widget(widget&&) = delete;
    widget& operator=(widget&&) = delete;
 
    using widget_intf::children;
    [[nodiscard]] generator<widget_intf&> children(bool include_invisible) noexcept override
    {
        co_return;
    }
 
    [[nodiscard]] hitbox hitbox_test(point2 position) const noexcept override
    {
        return {};
    }
 
    [[nodiscard]] virtual hitbox hitbox_test_from_parent(point2 position) const noexcept
    {
        return hitbox_test(_layout.from_parent * position);
    }
 
    [[nodiscard]] virtual hitbox hitbox_test_from_parent(point2 position, hitbox sibling_hitbox) const noexcept
    {
        return std::max(sibling_hitbox, hitbox_test(_layout.from_parent * position));
    }
 
    [[nodiscard]] bool accepts_keyboard_focus(keyboard_focus_group group) const noexcept override
    {
        hi_axiom(loop::main().on_thread());
        return false;
    }
 
    [[nodiscard]] box_constraints update_constraints() noexcept override
    {
        _layout = {};
        return {*minimum, *minimum, *maximum};
    }
 
    void set_layout(widget_layout const& context) noexcept override
    {
        _layout = context;
    }
 
    void draw(draw_context const& context) noexcept override {}
 
    bool process_event(gui_event const& event) const noexcept override
    {
        if (parent != nullptr) {
            return parent->process_event(event);
        } else {
            return true;
        }
    }
 
    void request_redraw() const noexcept override
    {
        process_event({gui_event_type::window_redraw, layout().clipping_rectangle_on_window()});
    }
 
    bool handle_event(gui_event const& event) noexcept override
    {
        hi_axiom(loop::main().on_thread());
 
        switch (event.type()) {
        case gui_event_type::keyboard_enter:
            set_focus(true);
            this->scroll_to_show();
            return true;
 
        case gui_event_type::keyboard_exit:
            set_focus(false);
            return true;
 
        case gui_event_type::mouse_enter:
            set_hover(true);
            return true;
 
        case gui_event_type::mouse_exit:
            set_hover(false);
            return true;
 
        case gui_event_type::window_activate:
            set_active(true);
            // All widgets need the active value set.
            return false;
 
        case gui_event_type::window_deactivate:
            set_active(false);
            // All widgets need the active value unset.
            return false;
 
        case gui_event_type::gui_activate_stay:
            process_event(gui_event_type::gui_activate);
            if (accepts_keyboard_focus(keyboard_focus_group::menu)) {
                // By going forward and backward we select the current parent,
                // the widget that opened the menu-stack. 
                process_event(gui_event_type::gui_widget_next);
                process_event(gui_event_type::gui_widget_prev);
            }
            return true;
 
        case gui_event_type::gui_activate_next:
            process_event(gui_event_type::gui_activate);
            return process_event(gui_event_type::gui_widget_next);
 
        case gui_event_type::gui_widget_next:
            process_event(
                gui_event::window_set_keyboard_target(id, keyboard_focus_group::normal, keyboard_focus_direction::forward));
            return true;
 
        case gui_event_type::gui_widget_prev:
            process_event(
                gui_event::window_set_keyboard_target(id, keyboard_focus_group::normal, keyboard_focus_direction::backward));
            return true;
 
        case gui_event_type::gui_menu_next:
            if (mode() >= widget_mode::partial and accepts_keyboard_focus(keyboard_focus_group::menu)) {
                process_event(
                    gui_event::window_set_keyboard_target(id, keyboard_focus_group::menu, keyboard_focus_direction::forward));
                return true;
            }
            break;
 
        case gui_event_type::gui_menu_prev:
            if (mode() >= widget_mode::partial and accepts_keyboard_focus(keyboard_focus_group::menu)) {
                process_event(
                    gui_event::window_set_keyboard_target(id, keyboard_focus_group::menu, keyboard_focus_direction::backward));
                return true;
            }
            break;
 
        case gui_event_type::gui_toolbar_next:
            if (mode() >= widget_mode::partial and accepts_keyboard_focus(keyboard_focus_group::toolbar)) {
                process_event(
                    gui_event::window_set_keyboard_target(id, keyboard_focus_group::toolbar, keyboard_focus_direction::forward));
                return true;
            }
            break;
 
        case gui_event_type::gui_toolbar_prev:
            if (mode() >= widget_mode::partial and accepts_keyboard_focus(keyboard_focus_group::toolbar)) {
                process_event(
                    gui_event::window_set_keyboard_target(id, keyboard_focus_group::toolbar, keyboard_focus_direction::backward));
                return true;
            }
            break;
 
        default:;
        }
 
        return false;
    }
 
    bool handle_event_recursive(
        gui_event const& event,
        std::vector<widget_id> const& reject_list = std::vector<widget_id>{}) noexcept override
    {
        hi_axiom(loop::main().on_thread());
 
        auto handled = false;
 
        for (auto& child : this->children(false)) {
            handled |= child.handle_event_recursive(event, reject_list);
        }
 
        if (!std::ranges::any_of(reject_list, [&](auto const& x) {
                return x == id;
            })) {
            handled |= handle_event(event);
        }
 
        return handled;
    }
 
    [[nodiscard]] virtual widget_id find_next_widget(
        widget_id current_keyboard_widget,
        keyboard_focus_group group,
        keyboard_focus_direction direction) const noexcept override
    {
        hi_axiom(loop::main().on_thread());
 
        auto found = false;
 
        if (current_keyboard_widget == 0 and accepts_keyboard_focus(group)) {
            // If there was no current_keyboard_widget, then return this if it accepts focus.
            return id;
 
        } else if (current_keyboard_widget == id) {
            found = true;
        }
 
        auto children_ = std::vector<widget_intf const *>{};
        for (auto& child : children(false)) {
            children_.push_back(std::addressof(child));
        }
 
        if (direction == keyboard_focus_direction::backward) {
            std::reverse(begin(children_), end(children_));
        }
 
        for (auto *child : children_) {
            hi_axiom_not_null(child);
 
            if (found) {
                // Find the first focus accepting widget.
                if (auto tmp = child->find_next_widget({}, group, direction); tmp != 0) {
                    return tmp;
                }
 
            } else {
                auto tmp = child->find_next_widget(current_keyboard_widget, group, direction);
                if (tmp == current_keyboard_widget) {
                    // The current widget was found, but no next widget available in the child.
                    // Try the first widget that does accept keyboard focus.
                    found = true;
 
                } else if (tmp != 0) {
                    // Return the next widget that was found in the child-widget.
                    return tmp;
                }
            }
        }
 
        if (found) {
            // Either:
            // 1. current_keyboard_widget was nullptr; this widget, nor its child widgets accept focus.
            // 2. current_keyboard_wigget was this; none of the child widgets accept focus.
            // 3. current_keyboard_widget is a child; none of the following widgets accept focus.
            return current_keyboard_widget;
        }
 
        return {};
    }
 
    using widget_intf::scroll_to_show;
    void scroll_to_show(hi::aarectangle rectangle) noexcept override
    {
        hi_axiom(loop::main().on_thread());
 
        if (parent) {
            parent->scroll_to_show(_layout.to_parent * rectangle);
        }
    }
 
    void set_window(gui_window *window) noexcept override
    {
        if (parent) {
            return parent->set_window(window);
        } else {
            return;
        }
    }
 
    [[nodiscard]] gui_window *window() const noexcept override
    {
        if (parent) {
            return parent->window();
        } else {
            return nullptr;
        }
    }
 
    [[nodiscard]] hi::theme const& theme() const noexcept
    {
        auto const w = window();
        hi_assert_not_null(w);
        return w->theme;
    }
 
    [[nodiscard]] gfx_surface const *surface() const noexcept
    {
        if (auto w = window()) {
            return w->surface.get();
        } else {
            return nullptr;
        }
    }
 
    [[nodiscard]] virtual color background_color() const noexcept
    {
        if (mode() >= widget_mode::partial) {
            if (phase() == widget_phase::hover) {
                return theme().color(semantic_color::fill, _layout.layer + 1);
            } else {
                return theme().color(semantic_color::fill, _layout.layer);
            }
        } else {
            return theme().color(semantic_color::fill, _layout.layer - 1);
        }
    }
 
    [[nodiscard]] virtual color foreground_color() const noexcept
    {
        if (mode() >= widget_mode::partial) {
            if (phase() == widget_phase::hover) {
                return theme().color(semantic_color::border, _layout.layer + 1);
            } else {
                return theme().color(semantic_color::border, _layout.layer);
            }
        } else {
            return theme().color(semantic_color::border, _layout.layer - 1);
        }
    }
 
    [[nodiscard]] virtual color focus_color() const noexcept
    {
        if (mode() >= widget_mode::partial) {
            if (focus()) {
                return theme().color(semantic_color::accent);
            } else if (phase() == widget_phase::hover) {
                return theme().color(semantic_color::border, _layout.layer + 1);
            } else {
                return theme().color(semantic_color::border, _layout.layer);
            }
        } else {
            return theme().color(semantic_color::border, _layout.layer - 1);
        }
    }
 
    [[nodiscard]] virtual color accent_color() const noexcept
    {
        if (mode() >= widget_mode::partial) {
            return theme().color(semantic_color::accent);
        } else {
            return theme().color(semantic_color::border, _layout.layer - 1);
        }
    }
 
    [[nodiscard]] virtual color label_color() const noexcept
    {
        if (mode() >= widget_mode::partial) {
            return theme().text_style(semantic_text_style::label)->color;
        } else {
            return theme().color(semantic_color::border, _layout.layer - 1);
        }
    }
 
protected:
    [[nodiscard]] aarectangle make_overlay_rectangle(aarectangle requested_rectangle) const noexcept
    {
        hi_axiom(loop::main().on_thread());
 
        // Move the request_rectangle to window coordinates.
        auto const requested_window_rectangle = translate2{layout().clipping_rectangle_on_window()} * requested_rectangle;
        auto const window_bounds = aarectangle{layout().window_size} - theme().margin<float>();
        auto const response_window_rectangle = fit(window_bounds, requested_window_rectangle);
        return layout().from_window * response_window_rectangle;
    }
};
 
}} // namespace hi::v1