#include <hikogui/widgets/abstract_button_widget.hpp>

Inheritance diagram for hi::v1::abstract_button_widget:

Public Types
using	super = widget

using	delegate_type = button_delegate

Public Member Functions
	abstract_button_widget (gui_window &window, 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 (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.

virtual widget_constraints const &	set_constraints () noexcept=0
	Update the constraints of the widget.

widget_constraints const &	constraints () const noexcept

virtual void	set_layout (widget_layout const &layout) noexcept=0
	Update the internal layout of the widget.

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

virtual void	draw (draw_context const &context) noexcept=0
	Draw the 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.

template<fixed_string SourceFile, int SourceLine, fixed_string Fmt, typename... Args>
void	request_reconstrain (Args &&...args) const noexcept
	Request the window to be reconstrain on the next frame.

template<fixed_string SourceFile, int SourceLine, fixed_string Fmt, typename... Args>
void	request_resize (Args &&...args) const noexcept
	Request the window to be resize based on the preferred size of the widgets.

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

Data Fields
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
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.

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

Base class for implementing button widgets.

Member Function Documentation

◆ state()

button_state hi::v1::abstract_button_widget::state ( ) const

inlinenoexcept

Get the current state of the button.

Returns: The state of the button: on / off / other.

Field Documentation

◆ alignment

observer<alignment> hi::v1::abstract_button_widget::alignment

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

◆ delegate

std::shared_ptr<delegate_type> hi::v1::abstract_button_widget::delegate

The delegate that controls the button widget.

◆ off_label

observer<label> hi::v1::abstract_button_widget::off_label = tr("off")

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

◆ on_label

observer<label> hi::v1::abstract_button_widget::on_label = tr("on")

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

◆ other_label

observer<label> hi::v1::abstract_button_widget::other_label = tr("other")

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

◆ text_style

observer<semantic_text_style> hi::v1::abstract_button_widget::text_style = semantic_text_style::label

The text style to button's label.

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

hikogui/src/hikogui/widgets/abstract_button_widget.hpp

Public Types

Public Member Functions

Data Fields