Inheritance diagram for hi::v1::widget_intf:

Public Member Functions
	widget_intf (widget_intf const *parent) noexcept

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

virtual void	set_window (gui_window *window) noexcept=0
	Set the window for this tree of widgets.

virtual gui_window *	window () const noexcept=0
	Get the window that the widget is owned by.

virtual generator< widget_intf & >	children (bool include_invisible) noexcept=0
	Get a list of child widgets.

virtual generator< widget_intf const & >	children (bool include_invisible) const noexcept final
	Get a list of child widgets.

virtual box_constraints	update_constraints () noexcept=0
	Update the constraints of the widget.

virtual void	set_layout (widget_layout const &context) 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 hitbox	hitbox_test (point2 position) const noexcept=0
	Find the widget that is under the mouse cursor.

virtual bool	accepts_keyboard_focus (keyboard_focus_group group) const noexcept=0
	Check if the widget will accept keyboard focus.

virtual void	request_redraw () const noexcept=0
	Request the widget to be redrawn on the next frame.

virtual bool	process_event (gui_event const &event) const noexcept=0
	Send a event to the window.

virtual bool	handle_event (gui_event const &event) noexcept=0
	Handle command.

virtual bool	handle_event_recursive (gui_event const &event, std::vector< widget_id > const &reject_list=std::vector< widget_id >{}) noexcept=0
	Handle command recursive.

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

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

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

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

Data Fields
widget_id	id = {}
	The numeric identifier of a widget.

widget_intf *	parent = nullptr
	Pointer to the parent widget.

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.

Member Function Documentation

◆ accepts_keyboard_focus()

virtual bool hi::v1::widget_intf::accepts_keyboard_focus ( keyboard_focus_group group ) const

pure virtualnoexcept

Check if the widget will accept keyboard focus.

Implemented in hi::v1::scroll_bar_widget< Axis >, and hi::v1::widget.

◆ children() [1/2]

virtual generator< widget_intf const & > hi::v1::widget_intf::children ( bool include_invisible ) const

inlinefinalvirtualnoexcept

Get a list of child widgets.

Reimplemented in hi::v1::widget.

◆ children() [2/2]

virtual generator< widget_intf & > hi::v1::widget_intf::children ( bool include_invisible )

pure virtualnoexcept

Get a list of child widgets.

Implemented in hi::v1::spacer_widget, hi::v1::widget, and hi::v1::widget.

◆ draw()

virtual void hi::v1::widget_intf::draw ( draw_context const & context )

pure virtualnoexcept

Draw the widget.

This function is called by the window (optionally) on every frame. It should recursively call this function on every visible child. This function is only called when updateLayout() has returned true.

The overriding function should call the base class's draw(), the place where the call this function will determine the order of the vertices into each buffer. This is important when needing to do the painters algorithm for alpha-compositing. However the pipelines are always drawn in the same order.

Parameters

context The context to where the widget will draw.

Implemented in hi::v1::scroll_bar_widget< Axis >, hi::v1::spacer_widget, and hi::v1::widget.

◆ find_next_widget()

virtual widget_id hi::v1::widget_intf::find_next_widget	(	widget_id	current_keyboard_widget,
		keyboard_focus_group	group,
		keyboard_focus_direction	direction ) const

pure virtualnoexcept

Find the next widget that handles keyboard focus.

This recursively looks for the current keyboard widget, then returns the next (or previous) widget that returns true from accepts_keyboard_focus().

Parameters

current_keyboard_widget	The widget that currently has focus; or nullptr to get the first widget that accepts focus.
group	The group to which the widget must belong.
direction	The direction in which to walk the widget tree.

Returns: A pointer to the next widget.

Return values

current_keyboard_widget	When current_keyboard_widget was found but no next widget that accepts keyboard focus was found.
nullptr	When current_keyboard_widget is not found in this widget.

Implemented in hi::v1::widget.

◆ handle_event()

virtual bool hi::v1::widget_intf::handle_event ( gui_event const & event )

pure virtualnoexcept

Handle command.

If a widget does not fully handle a command it should pass the command to the super class' handle_event().

Implemented in hi::v1::scroll_bar_widget< Axis >, and hi::v1::widget.

◆ handle_event_recursive()

virtual bool hi::v1::widget_intf::handle_event_recursive	(	gui_event const &	event,
		std::vector< widget_id > const &	reject_list = std::vector< widget_id >{} )

pure virtualnoexcept

Handle command recursive.

Handle a command and pass it to each child.

Parameters

event	The command to handle by this widget.
reject_list	The widgets that should ignore this command

Returns: True when the command was handled by this widget or recursed child.

Implemented in hi::v1::widget.

◆ hitbox_test()

virtual hitbox hi::v1::widget_intf::hitbox_test ( point2 position ) const

pure virtualnoexcept

Find the widget that is under the mouse cursor.

This function will recursively test with visual child widgets, when widgets overlap on the screen the hitbox object with the highest elevation is returned.

Parameters

position The coordinate of the mouse local to the widget.

Returns: A hit_box object with the cursor-type and a reference to the widget.

Implemented in hi::v1::scroll_bar_widget< Axis >, hi::v1::spacer_widget, and hi::v1::widget.

◆ layout()

widget_layout const & hi::v1::widget_intf::layout ( ) const

inlinenoexcept

Get the current layout for this widget.

◆ operator co_await()

auto hi::v1::widget_intf::operator co_await ( ) const

inlinenoexcept

Await until an action is completed by the widget.

◆ parent_chain()

std::vector< widget_id > hi::v1::widget_intf::parent_chain ( ) const

inlinenoexcept

Get a list of parents of a given widget.

The chain includes the given widget.

◆ process_event()

virtual bool hi::v1::widget_intf::process_event ( gui_event const & event ) const

pure virtualnoexcept

Send a event to the window.

Implemented in hi::v1::widget.

◆ request_redraw()

virtual void hi::v1::widget_intf::request_redraw ( ) const

pure virtualnoexcept

Request the widget to be redrawn on the next frame.

Implemented in hi::v1::toolbar_tab_button_widget, and hi::v1::widget.

◆ scroll_to_show() [1/2]

void hi::v1::widget_intf::scroll_to_show ( )

inlinenoexcept

Scroll to show the important part of the widget.

◆ scroll_to_show() [2/2]

virtual void hi::v1::widget_intf::scroll_to_show ( hi::aarectangle rectangle )

pure virtualnoexcept

Scroll to show the given rectangle on the window.

This will call parents, until all parents have scrolled the rectangle to be shown on the window.

Parameters

rectangle The rectangle in window coordinates.

Implemented in hi::v1::widget, and hi::v1::widget.

◆ set_layout()

virtual void hi::v1::widget_intf::set_layout ( widget_layout const & context )

pure virtualnoexcept

Update the internal layout of the widget.

This function is called when the size of this widget must change, or if any of the widget request a re-layout.

This function may be used for expensive calculations, such as geometry calculations, which should only be done when the data or sizes change; it should cache these calculations.

Postcondition: This function will change what is returned by widget::size() and the transformation matrices.

Parameters

context The layout for this child.

Implemented in hi::v1::scroll_bar_widget< Axis >, hi::v1::spacer_widget, and hi::v1::widget.

◆ set_window()

virtual void hi::v1::widget_intf::set_window ( gui_window * window )

pure virtualnoexcept

Set the window for this tree of widgets.

Parameters

window A pointer to the window that will own this tree of widgets. or nullptr if the window must be removed.

Implemented in hi::v1::widget.

◆ subscribe()

template<forward_of< void()> Func>

callback< void()> hi::v1::widget_intf::subscribe	(	Func &&	func,
		callback_flags	flags = callback_flags::synchronous )

inlinenoexcept

Subscribe a callback to be called when an action is completed by the widget.

◆ update_constraints()

virtual box_constraints hi::v1::widget_intf::update_constraints ( )

pure virtualnoexcept

Update the constraints of the widget.

Typically the implementation of this function starts with recursively calling update_constraints() on its children.

If the container, due to a change in constraints, wants the window to resize to the minimum size it should call request_resize().

Postcondition: This function will change what is returned by widget::minimum_size(), widget::preferred_size() and widget::maximum_size().

Implemented in hi::v1::scroll_bar_widget< Axis >, hi::v1::spacer_widget, and hi::v1::widget.

◆ window()

virtual gui_window * hi::v1::widget_intf::window ( ) const

pure virtualnoexcept

Get the window that the widget is owned by.

Returns: window The window that owns this tree of widgets. Or nullptr if this tree of widgets is not owned by a window.

Implemented in hi::v1::widget.

Field Documentation

◆ id

widget_id hi::v1::widget_intf::id = {}

The numeric identifier of a widget.

Note: This is a uint32_t equal to the operating system's accessibility identifier.

◆ notifier

notifier<void()> hi::v1::widget_intf::notifier

Notifier which is called after an action is completed by a widget.

◆ parent

widget_intf* hi::v1::widget_intf::parent = nullptr

Pointer to the parent widget.

May be a nullptr only when this is the top level widget.

◆ state

observer<widget_state> hi::v1::widget_intf::state

The current state of the widget.

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

hikogui/src/hikogui/GUI/widget_intf.hpp

Public Member Functions

Data Fields

Member Function Documentation

◆ accepts_keyboard_focus()

◆ children() [1/2]

◆ children() [2/2]

◆ draw()

◆ find_next_widget()

◆ handle_event()

◆ handle_event_recursive()

◆ hitbox_test()

◆ layout()

◆ operator co_await()

◆ parent_chain()

◆ process_event()

◆ request_redraw()

◆ scroll_to_show() [1/2]

◆ scroll_to_show() [2/2]

◆ set_layout()

◆ set_window()

◆ subscribe()

◆ update_constraints()

◆ window()

Field Documentation

◆ id

◆ notifier

◆ parent

◆ state