hi::v1::radio_button_widget< Name > Class Template Reference

#include <hikogui/widgets/radio_button_widget.hpp>

Inheritance diagram for hi::v1::radio_button_widget< Name >:

Public Types
using	super = widget
using	delegate_type = radio_button_delegate
Public Types inherited from hi::v1::widget
using	callback_token = notifier<void()>::callback_token
using	awaiter_type = notifier<void()>::awaiter_type

Public Member Functions
	radio_button_widget (widget *parent, std::shared_ptr< delegate_type > delegate, button_widget_attribute auto &&...attributes) noexcept
	Construct a radio button widget.
template<different_from< std::shared_ptr< delegate_type > > Value, forward_of< observer< observer_decay_t< Value > > > OnValue, button_widget_attribute... Attributes> requires requires { make_default_radio_button_delegate(hi_forward(value), hi_forward(on_value)); }
	radio_button_widget (widget *parent, Value &&value, OnValue &&on_value, Attributes &&...attributes) noexcept
	Construct a radio button widget with a default button delegate.
Public Member Functions inherited from hi::v1::widget
	widget (widget *parent) noexcept
	widget (widget const &)=delete
	widget (widget &&)=delete
widget &	operator= (widget &&)=delete
widget &	operator= (widget const &)=delete
generator< widget & >	children (bool include_invisible) noexcept
virtual hitbox	hitbox_test_from_parent (point2 position) const noexcept
	Call hitbox_test from a parent widget.
virtual hitbox	hitbox_test_from_parent (point2 position, hitbox sibling_hitbox) const noexcept
	Call hitbox_test from a parent widget.
void	reset_layout (gfx_surface *new_surface, float new_scale) noexcept
	Reset the layout.
virtual void	layout () noexcept
virtual sub_theme_selector_type	sub_theme_selector () const noexcept
virtual bool	process_event (gui_event const &event) const noexcept
virtual void	request_redraw () const noexcept
	Request the widget to be redrawn on the next frame.
virtual bool	handle_event_recursive (gui_event const &event, std::vector< widget_id > const &reject_list=std::vector< widget_id >{}) noexcept
	Handle command recursive.
virtual widget_id	find_next_widget (widget_id current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept
	Find the next widget that handles keyboard focus.
widget_id	find_first_widget (keyboard_focus_group group) const noexcept
widget_id	find_last_widget (keyboard_focus_group group) const noexcept
bool	is_first (keyboard_focus_group group) const noexcept
bool	is_last (keyboard_focus_group group) const noexcept
virtual void	scroll_to_show (hi::aarectangle rectangle) noexcept
	Scroll to show the given rectangle on the window.
std::vector< widget_id >	parent_chain () const noexcept
	Get a list of parents of a given widget.
virtual bool	is_tab_button () const noexcept
	Check if this widget is a tab-button.
template<forward_of< void()> Callback>
callback_token	subscribe (Callback &&callback, callback_flags flags=callback_flags::synchronous) const noexcept
awaiter_type	operator co_await () const noexcept

Data Fields
std::shared_ptr< delegate_type >	delegate
	The delegate that controls the button widget.
observer< label >	label = tr("<not set>")
	The label to show when the button is in the 'on' state.
observer< hi::alignment >	alignment = alignment::top_left()
	The alignment of the button and on/off/other label.
Data Fields inherited from hi::v1::widget
widget_id	id = {}
	The numeric identifier of a widget.
widget *	parent = nullptr
	Pointer to the parent widget.
gfx_surface *	surface = nullptr
	The surface this widget is drawn on.
observer< widget_mode >	mode = widget_mode::enabled
	The widget mode.
observer< bool >	hover = false
	Mouse cursor is hovering over the widget.
observer< bool >	clicked = false
	The widget is being clicked by the mouse.
observer< bool >	focus = false
	The widget has keyboard focus.
observer< widget_state >	state = widget_state::off
	The state of the widget.
size_t	semantic_layer = 0_uz
	The draw layer of the widget.
grid_cell	cell

Static Public Attributes
static constexpr auto	prefix = Name / "radio"

Detailed Description

template<fixed_string Name = "">
class hi::v1::radio_button_widget< Name >

A graphical control element that allows the user to choose only one of a predefined set of mutually exclusive options.

A radio-button has two different states with different visual representation:

• on: The radio button shows a solid circle inside it
• other: The radio button shows empty.

Each time a user activates the radio-button it switches its state to 'on'.

A radio button cannot itself switch state to 'other', this state may be caused by external factors. The canonical example is another radio button in a set, which is configured with a different on_value.

In the following example we create three radio button widgets on the window which observes the same value. Each radio button is configured with a different on_value: 1, 2 and 3. Initially the value is 0, and therefor none of the radio buttons is selected when the application is started.

    observer<int> value = 0;
 
    widget.content().make_widget<radio_button_widget<>>("B1", value, 1, tr("one"));
    widget.content().make_widget<radio_button_widget<>>("B2", value, 2, tr("two"));
    widget.content().make_widget<radio_button_widget<>>("B3", value, 3, tr("three"));

Note

Unlike some other GUI toolkits a radio button is a singular widget. Multiple radio buttons may share a delegate or an observer which allows radio buttons to act as a set.

Constructor & Destructor Documentation

radio_button_widget() [1/2]

template<fixed_string Name = "">

hi::v1::radio_button_widget< Name >::radio_button_widget ( widget * parent, std::shared_ptr< delegate_type > delegate, button_widget_attribute auto &&... attributes )

inlinenoexcept

Construct a radio button widget.

Parameters

parent	The parent widget that owns this radio button widget.
delegate	The delegate to use to manage the state of the radio button.
attributes	Different attributes used to configure the label's on the radio button: a label, alignment or text_theme. If one label is passed it will be shown in all states. If two labels are passed the first label is shown in on-state and the second for off-state.

radio_button_widget() [2/2]

template<fixed_string Name = "">

template<different_from< std::shared_ptr< delegate_type > > Value, forward_of< observer< observer_decay_t< Value > > > OnValue, button_widget_attribute... Attributes>
requires requires { make_default_radio_button_delegate(hi_forward(value), hi_forward(on_value)); }

hi::v1::radio_button_widget< Name >::radio_button_widget ( widget * parent, Value && value, OnValue && on_value, Attributes &&... attributes )

inlinenoexcept

Construct a radio button widget with a default button delegate.

Parameters

parent	The parent widget that owns this radio button widget.
value	The value or observer value which represents the state of the radio button.
on_value	An optional on-value. This value is used to determine which value yields an 'on' state.
attributes	Different attributes used to configure the label's on the radio button: a label, alignment or text_theme. If one label is passed it will be shown in all states. If two labels are passed the first label is shown in on-state and the second for off-state.

Field Documentation

alignment

template<fixed_string Name = "">

observer<hi::alignment> hi::v1::radio_button_widget< Name >::alignment = alignment::top_left()

The alignment of the button and on/off/other label.

delegate

template<fixed_string Name = "">

std::shared_ptr<delegate_type> hi::v1::radio_button_widget< Name >::delegate

The delegate that controls the button widget.

label

template<fixed_string Name = "">

observer<label> hi::v1::radio_button_widget< Name >::label = tr("<not set>")

The label to show when the button is in the 'on' state.

---

The documentation for this class was generated from the following file:

• hikogui/src/hikogui/widgets/radio_button_widget.hpp