hi::v1::selection_widget Class Reference

#include <hikogui/widgets/selection_widget.hpp>

Inheritance diagram for hi::v1::selection_widget:

Data Structures
struct	attributes_type

Public Types
using	super = widget
using	delegate_type = selection_delegate

Public Member Functions
	selection_widget (attributes_type attributes, std::shared_ptr< delegate_type > delegate) noexcept
	Construct a selection widget with a delegate.
template<incompatible_with< attributes_type > Value, forward_of< observer< std::vector< std::pair< observer_decay_t< Value >, label > > > > OptionList, selection_widget_attribute... Attributes> requires requires { make_default_delegate(std::forward<Value>(value), std::forward<OptionList>(option_list)); attributes_type{std::forward<Attributes>(attributes)...}; }
	selection_widget (Value &&value, OptionList &&option_list, Attributes &&...attributes) noexcept
	Construct a selection widget which will monitor an option list and a value.
Public Member Functions inherited from hi::v1::widget
	widget () noexcept
	Constructor for creating sub views.
	widget (const widget &)=delete
widget &	operator= (const widget &)=delete
	widget (widget &&)=delete
widget &	operator= (widget &&)=delete
generator< widget_intf & >	children (bool include_invisible) noexcept override
	Get a list of child widgets.
hitbox	hitbox_test (point2 position) const noexcept override
	Find the widget that is under the mouse cursor.
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.
bool	accepts_keyboard_focus (keyboard_focus_group group) const noexcept override
	Check if the widget will accept keyboard focus.
box_constraints	update_constraints () noexcept override
	Update the constraints of the widget.
void	set_layout (widget_layout const &context) noexcept override
	Update the internal layout of the widget.
void	draw (draw_context const &context) noexcept override
	Draw the widget.
bool	process_event (gui_event const &event) const noexcept override
	Send a event to the window.
void	request_redraw () const noexcept override
	Request the widget to be redrawn on the next frame.
bool	handle_event (gui_event const &event) noexcept override
	Handle command.
bool	handle_event_recursive (gui_event const &event, std::vector< widget_id > const &reject_list=std::vector< widget_id >{}) noexcept override
	Handle command recursive.
virtual widget_id	find_next_widget (widget_id current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept override
	Find the next widget that handles keyboard focus.
void	scroll_to_show (hi::aarectangle rectangle) noexcept override
	Scroll to show the given rectangle on the window.
hi::theme const &	theme () const noexcept
gfx_surface const *	surface () const noexcept
virtual color	background_color () const noexcept
virtual color	foreground_color () const noexcept
virtual color	accent_color () const noexcept
virtual generator< widget_intf const & >	children (bool include_invisible=true) const noexcept final
	Get a list of child widgets.
void	scroll_to_show () noexcept
	Scroll to show the important part of the widget.
Public Member Functions inherited from hi::v1::widget_intf
widget_intf *	parent () const noexcept
	Pointer to the parent widget.
virtual void	set_parent (widget_intf *new_parent) noexcept
	Set the parent widget.
template<forward_of< void()> Func>
callback< void()>	subscribe (Func &&func, callback_flags flags=callback_flags::synchronous) noexcept
	Subscribe a callback to be called when an action is completed by the widget.
auto	operator co_await () const noexcept
	Await until an action is completed by the widget.
size_t	layer () const noexcept
void	set_layer (size_t new_layer) noexcept
widget_mode	mode () const noexcept
void	set_mode (widget_mode new_mode) noexcept
widget_value	value () const noexcept
void	set_value (widget_value new_value) noexcept
widget_phase	phase () const noexcept
void	set_pressed (bool pressed) noexcept
void	set_hover (bool hover) noexcept
void	set_active (bool active) noexcept
bool	focus () const noexcept
void	set_focus (bool new_focus) noexcept
widget_layout const &	layout () const noexcept
	Get the current layout for this widget.
std::vector< widget_id >	parent_chain () const noexcept
	Get a list of parents of a given widget.
void	scroll_to_show () noexcept
	Scroll to show the important part of the widget.

Static Public Member Functions
template<typename... Args> requires requires { make_shared_ctad<default_selection_delegate>(std::forward<Args>(args)...); }
static std::shared_ptr< delegate_type >	make_default_delegate (Args &&...args)

Data Fields
attributes_type	attributes
std::shared_ptr< delegate_type >	delegate
Data Fields inherited from hi::v1::widget
observer< extent2 >	minimum = extent2{}
	The minimum size this widget is allowed to be.
observer< extent2 >	maximum = extent2::large()
	The maximum size this widget is allowed to be.
Data Fields inherited from hi::v1::widget_intf
widget_id	id = {}
	The numeric identifier of a widget.
hi::style	style = {}
	The style of this widget.
gui_window *	window = nullptr
notifier< void()>	notifier
	Notifier which is called after an action is completed by a widget.
observer< widget_state >	state
	The current state 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.

The following example creates a selection widget with three options. which will monitor and modify value to display the options from the option_list. At application startup, value is zero and none of the options is selected:

    auto option_list = std::vector<std::pair<int, label>>{{1, txt("one")}, {2, txt("two")}, {3, txt("three")}};
 
    observer<int> value = 0;
    widget->content().emplace<selection_widget>("A2", value, option_list);

Constructor & Destructor Documentation

selection_widget() [1/2]

hi::v1::selection_widget::selection_widget ( attributes_type attributes, std::shared_ptr< delegate_type > delegate )

inlinenoexcept

Construct a selection widget with a delegate.

Parameters

parent	The owner of the selection widget.
delegate	The delegate which will control the selection widget.

selection_widget() [2/2]

template<incompatible_with< attributes_type > Value, forward_of< observer< std::vector< std::pair< observer_decay_t< Value >, label > > > > OptionList, selection_widget_attribute... Attributes>
requires requires { make_default_delegate(std::forward<Value>(value), std::forward<OptionList>(option_list)); attributes_type{std::forward<Attributes>(attributes)...}; }

hi::v1::selection_widget::selection_widget ( Value && value, OptionList && option_list, Attributes &&... attributes )

inlinenoexcept

Construct a selection widget which will monitor an option list and a value.

Parameters

parent	The owner of the selection widget.
value	The value or observer value to monitor.
option_list	An vector or an observer vector of pairs of keys and labels. The keys are of the same type as the value. The labels are of type label.
attributes	Different attributes used to configure the label's on the selection box: a label, alignment. If an label is passed it is used as the label to show in the off-state.

---

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

• hikogui/src/hikogui/widgets/selection_widget.hpp