v1::selection_widget Class Reference

#include <hikogui/widgets/selection_widget.hpp>

Inheritance diagram for v1::selection_widget:

Public Types
using	super = widget
using	delegate_type = selection_delegate

Public Member Functions
	selection_widget (gui_window &window, widget *parent, std::weak_ptr< delegate_type > delegate) noexcept
	Construct a selection widget with a delegate.
template<typename OptionList , typename Value , typename... Args> requires (not std::is_convertible_v<Value, weak_or_unique_ptr<delegate_type>>)
	selection_widget (gui_window &window, widget *parent, OptionList &&option_list, Value &&value, Args &&...args) noexcept
	Construct a selection widget which will monitor an option list and a value.
Public Member Functions inherited from v1::widget
	widget (gui_window &window, widget *parent) noexcept
	widget (const widget &)=delete
widget &	operator= (const widget &)=delete
	widget (widget &&)=delete
widget &	operator= (widget &&)=delete
bool	is_gui_thread () const noexcept
hi::theme const &	theme () const noexcept
	Get the theme.
hi::font_book &	font_book () const noexcept
	Get the font book.
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 void	request_redraw () const noexcept
	Request the widget to be redrawn on the next frame.
void	request_relayout () const noexcept
	Request the window to be relayout on the next frame.
void	request_reconstrain () const noexcept
	Request the window to be reconstrain on the next frame.
void	request_resize () const noexcept
	Request the window to be resize based on the preferred size of the widgets.
virtual bool	handle_event (std::vector< command > const &commands) noexcept
virtual bool	handle_command_recursive (command command, std::vector< widget const * > const &reject_list=std::vector< widget const * >{}) noexcept
	Handle command recursive.
virtual bool	handle_event (keyboard_event const &event) noexcept
	Handle keyboard event.
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	background_color () const noexcept
virtual color	foreground_color () const noexcept
virtual color	accent_color () const noexcept
virtual color	label_color () const noexcept

Data Fields
observable< label >	unknown_label
Data Fields inherited from v1::widget
gui_window &	window
	Convenient reference to the Window.
widget *const	parent
	Pointer to the parent widget.
std::string	id
	A name of widget, should be unique between siblings.
observable< bool >	enabled = true
	The widget is enabled.
observable< bool >	visible = true
	The widget is visible.
observable< bool >	hover = false
	Mouse cursor is hovering over the widget.
observable< 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.

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, tr("one")},
        {2, tr("two")},
        {3, tr("three")}
    };
 
    observable<int> value = 0;
    window->content().make_widget<selection_widget>("A2", option_list, value);

Constructor & Destructor Documentation

selection_widget() [1/2]

v1::selection_widget::selection_widget ( gui_window & window, widget * parent, std::weak_ptr< delegate_type > delegate )

noexcept

Construct a selection widget with a delegate.

Parameters

window	The window the selection widget will be displayed on.
parent	The owner of the selection widget.
delegate	The delegate which will control the selection widget.

selection_widget() [2/2]

template<typename OptionList , typename Value , typename... Args>
requires (not std::is_convertible_v<Value, weak_or_unique_ptr<delegate_type>>)

v1::selection_widget::selection_widget ( gui_window & window, widget * parent, OptionList && option_list, Value && value, Args &&... args )

inlinenoexcept

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

Template Parameters

Value

The type of value. Must be convertible to std::size_t.

Parameters

window	The window the selection widget will be displayed on.
parent	The owner of the selection widget.
option_list	An vector or an observable vector of pairs of keys and labels. The keys are of the same type as the value. The labels are of type label.
value	The value or observable value to monitor.

---

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

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