#include <hikogui/widgets/radio_button_widget.hpp>

Inheritance diagram for hi::v1::radio_button_widget:

Public Types
using	super = abstract_button_widget

using	delegate_type = typename super::delegate_type

Public Types inherited from hi::v1::abstract_button_widget
using	super = widget

using	delegate_type = button_delegate

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::abstract_button_widget
	abstract_button_widget (widget *parent, std::shared_ptr< delegate_type > delegate) noexcept

button_state	state () const noexcept
	Get the current state of the button.

Public Member Functions inherited from hi::v1::widget
	widget (widget *parent) noexcept

	widget (const widget &)=delete

widget &	operator= (const widget &)=delete

	widget (widget &&)=delete

widget &	operator= (widget &&)=delete

virtual hitbox	hitbox_test_from_parent (point3 position) const noexcept
	Call hitbox_test from a parent widget.

virtual hitbox	hitbox_test_from_parent (point3 position, hitbox sibling_hitbox) const noexcept
	Call hitbox_test from a parent widget.

widget_constraints const &	constraints () const noexcept

widget_layout const &	layout () const noexcept
	Get the current layout for this widget.

virtual bool	process_event (gui_event const &event) const noexcept

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 const * > const &reject_list=std::vector< widget const * >{}) noexcept
	Handle command recursive.

virtual widget const *	find_next_widget (widget const *current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept
	Find the next widget that handles keyboard focus.

widget const *	find_first_widget (keyboard_focus_group group) const noexcept

widget const *	find_last_widget (keyboard_focus_group group) const noexcept

bool	is_first (keyboard_focus_group group) const noexcept
	Is this widget the first widget in the parent container.

bool	is_last (keyboard_focus_group group) const noexcept
	Is this widget the last widget in the parent container.

virtual void	scroll_to_show (hi::aarectangle rectangle) noexcept
	Scroll to show the given rectangle on the window.

void	scroll_to_show () noexcept
	Scroll to show the important part of the widget.

std::vector< widget const * >	parent_chain () const noexcept
	Get a list of parents of a given widget.

virtual color	foreground_color () const noexcept

virtual color	focus_color () const noexcept

virtual color	accent_color () const noexcept

virtual color	label_color () const noexcept

Additional Inherited Members
Data Fields inherited from hi::v1::abstract_button_widget
std::shared_ptr< delegate_type >	delegate
	The delegate that controls the button widget.

observer< label >	on_label = tr("on")
	The label to show when the button is in the 'on' state.

observer< label >	off_label = tr("off")
	The label to show when the button is in the 'off' state.

observer< label >	other_label = tr("other")
	The label to show when the button is in the 'other' state.

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

observer< semantic_text_style >	text_style = semantic_text_style::label
	The text style to button's label.

notifier< void()>	pressed

Data Fields inherited from hi::v1::widget
widget *	parent
	Pointer to the parent widget.

std::string	id
	A name of widget, should be unique between siblings.

observer< widget_mode >	mode = widget_mode::enabled
	The widget mode.

observer< bool >	hover = false
	Mouse cursor is hovering over the widget.

observer< bool >	focus = false
	The widget has keyboard focus.

int	semantic_layer
	The draw layer of the widget.

int	logical_layer
	The logical layer of the widget.

Detailed Description

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;
 
    window->content().make_widget<radio_button_widget>("B1", value, 1, tr("one"));
    window->content().make_widget<radio_button_widget>("B2", value, 2, tr("two"));
    window->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]

hi::v1::radio_button_widget::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 `semantic_text_style`. 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<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::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 `semantic_text_style`. 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.

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

hikogui/src/hikogui/widgets/radio_button_widget.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ radio_button_widget() [1/2]

◆ radio_button_widget() [2/2]