HikoGUI
A low latency retained GUI
Loading...
Searching...
No Matches
toolbar_button_widget.hpp
Go to the documentation of this file.
1// Copyright Take Vos 2021-2022.
2// Distributed under the Boost Software License, Version 1.0.
3// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
4
9#pragma once
10
12
13namespace hi { inline namespace v1 {
14
19template<fixed_string Name = "">
20class toolbar_button_widget final : public abstract_button_widget<Name / "toolbar-button"> {
21public:
22 using super = abstract_button_widget<Name / "toolbar-button">;
23 using delegate_type = typename super::delegate_type;
24 constexpr static auto prefix = super::prefix;
25
29 button_widget_attribute auto&&...attributes) noexcept :
31 {
32 this->alignment = alignment::middle_left();
33 this->set_attributes<0>(hi_forward(attributes)...);
34 }
35
36 toolbar_button_widget(widget *parent, button_widget_attribute auto&&...attributes) noexcept :
37 toolbar_button_widget(parent, std::make_shared<button_delegate>(), hi_forward(attributes)...)
38 {
39 }
40
42 [[nodiscard]] box_constraints update_constraints() noexcept override
43 {
44 _label_constraints = super::update_constraints();
45
46 // On left side a check mark, on right side short-cut. Around the label extra margin.
47 hilet spacing = theme<prefix>.spacing_horizontal(this);
48 hilet extra_size = extent2i{spacing * 2, spacing * 2};
49
50 auto constraints = _label_constraints + extra_size;
51 constraints.margins = 0;
52 return constraints;
53 }
54
55 void set_layout(widget_layout const& context) noexcept override
56 {
57 if (compare_store(this->layout, context)) {
58 hilet spacing = theme<prefix>.spacing_horizontal(this);
59 hilet label_rectangle = aarectanglei{spacing, 0, context.width() - spacing * 2, context.height()};
60 this->_on_label_shape = this->_off_label_shape = this->_other_label_shape =
61 box_shape{_label_constraints, label_rectangle, theme<prefix>.cap_height(this)};
62 }
63 super::set_layout(context);
64 }
65
66 void draw(widget_draw_context const& context) noexcept override
67 {
68 if (*this->mode > widget_mode::invisible and overlaps(context, this->layout)) {
69 draw_toolbar_button(context);
70 this->draw_button(context);
71 }
72 }
73
74 [[nodiscard]] bool accepts_keyboard_focus(keyboard_focus_group group) const noexcept override
75 {
76 return *this->mode >= widget_mode::partial and to_bool(group & hi::keyboard_focus_group::toolbar);
77 }
78 // @endprivatesection
79private:
80 box_constraints _label_constraints;
81
82 void draw_toolbar_button(widget_draw_context const& context) noexcept
83 {
84 context.draw_box(
85 this->layout,
86 this->layout.rectangle(),
87 theme<prefix>.background_color(this),
88 theme<prefix>.border_color(this),
89 theme<prefix>.border_width(this),
91 }
92};
93
94}} // namespace hi::v1
Defines abstract_button_widget.
#define hilet
Invariant should be the default for variables.
Definition utility.hpp:23
#define hi_forward(x)
Forward a value, based on the decltype of the value.
Definition utility.hpp:29
@ partial
A widget is partially enabled.
@ invisible
The widget is invisible.
DOXYGEN BUG.
Definition algorithm.hpp:13
geometry/margins.hpp
Definition cache.hpp:11
@ inside
The border is drawn inside the edge of a quad.
bool compare_store(T &lhs, U &&rhs) noexcept
Compare then store if there was a change.
Definition utility.hpp:212
Definition widget.hpp:26
widget * parent
Pointer to the parent widget.
Definition widget.hpp:40
observer< widget_mode > mode
The widget mode.
Definition widget.hpp:53
Draw context for drawing using the HikoGUI shaders.
Definition widget_draw_context.hpp:204
The layout of a widget.
Definition widget_layout.hpp:37
2D constraints.
Definition box_constraints.hpp:22
Definition box_shape.hpp:15
Base class for implementing button widgets.
Definition abstract_button_widget.hpp:33
observer< hi::alignment > alignment
The alignment of the button and on/off/other label.
Definition abstract_button_widget.hpp:58
std::shared_ptr< delegate_type > delegate
The delegate that controls the button widget.
Definition abstract_button_widget.hpp:42
A button delegate controls the state of a button widget.
Definition button_delegate.hpp:23
A momentary button used as a child in the toolbar.
Definition toolbar_button_widget.hpp:20
T move(T... args)