hi::v1::with_label_widget< ButtonWidget > Class Template Reference

#include <hikogui/widgets/with_label_widget.hpp>

Inheritance diagram for hi::v1::with_label_widget< ButtonWidget >:

Data Structures
struct	attributes_type

Public Types
using	super = widget
using	button_widget_type = ButtonWidget
using	button_attributes_type = button_widget_type::attributes_type
using	delegate_type = button_widget_type::delegate_type

Public Member Functions
	hi_call_right_arguments (static, make_attributes, attributes_type)
	with_label_widget (attributes_type attributes, std::shared_ptr< delegate_type > delegate) noexcept
template<typename... Args> requires (num_default_delegate_arguments<Args...>() != 0)
	with_label_widget (Args &&... args)
	Construct a widget with a label.
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
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.
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	focus_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>
static consteval size_t	num_default_delegate_arguments () noexcept
template<size_t N, typename... Args>
static auto	make_default_delegate (Args &&... args)

Data Fields
attributes_type	attributes
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

template<std::derived_from< widget > ButtonWidget>
class hi::v1::with_label_widget< ButtonWidget >

Add labels to a button.

Constructor & Destructor Documentation

with_label_widget()

template<std::derived_from< widget > ButtonWidget>

template<typename... Args>
requires (num_default_delegate_arguments<Args...>() != 0)

hi::v1::with_label_widget< ButtonWidget >::with_label_widget ( Args &&... args )

inline

Construct a widget with a label.

Parameters

parent	The parent widget that owns this toggle widget.
args	The arguments to the default button delegate of the embedded widget followed by arguments to attributes_type

---

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

• hikogui/src/hikogui/widgets/with_label_widget.hpp