hi::v1::spacer_widget Class Reference

#include <hikogui/widgets/spacer_widget.hpp>

Inheritance diagram for hi::v1::spacer_widget:

Public Types
using	super = widget

Public Member Functions
	spacer_widget (widget *parent) noexcept
generator< widget const & >	children (bool include_invisible) const noexcept override
	Get a list of child widgets.
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.
hitbox	hitbox_test (point2i position) const noexcept override
	Find the widget that is under the mouse cursor.
Public Member Functions inherited from hi::v1::widget
	widget (widget *parent) noexcept
	widget (const widget &)=delete
widget &	operator= (const widget &)=delete
	widget (widget &&)=delete
widget &	operator= (widget &&)=delete
generator< widget & >	children (bool include_invisible) noexcept
virtual hitbox	hitbox_test_from_parent (point2i position) const noexcept
	Call hitbox_test from a parent widget.
virtual hitbox	hitbox_test_from_parent (point2i position, hitbox sibling_hitbox) const noexcept
	Call hitbox_test from a parent widget.
virtual bool	accepts_keyboard_focus (keyboard_focus_group group) const noexcept
	Check if the widget will accept keyboard focus.
widget_layout const &	layout () const noexcept
	Get the current layout for this widget.
virtual bool	process_event (gui_event const &event) const noexcept
virtual void	request_redraw () const noexcept
	Request the widget to be redrawn on the next frame.
virtual bool	handle_event (gui_event const &event) noexcept
	Handle command.
virtual bool	handle_event_recursive (gui_event const &event, std::vector< widget_id > const &reject_list=std::vector< widget_id >{}) noexcept
	Handle command recursive.
virtual widget_id	find_next_widget (widget_id current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept
	Find the next widget that handles keyboard focus.
widget_id	find_first_widget (keyboard_focus_group group) const noexcept
widget_id	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::aarectanglei 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_id >	parent_chain () const noexcept
	Get a list of parents of a given widget.
virtual gui_window *	window () const noexcept
virtual hi::theme const &	theme () const noexcept
virtual 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 color	label_color () const noexcept
Public Member Functions inherited from std::enable_shared_from_this< widget >
T	enable_shared_from_this (T... args)
T	operator= (T... args)
T	shared_from_this (T... args)
T	~enable_shared_from_this (T... args)

Additional Inherited Members
Data Fields inherited from hi::v1::widget
widget *	parent = nullptr
	Pointer to the parent widget.
widget_id	id = {}
	The numeric identifier of a widget.
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 = 0
	The draw layer of the widget.
int	logical_layer = 0
	The logical layer of the widget.
observer< extent2i >	minimum = extent2i{}
	The minimum size this widget is allowed to be.
observer< extent2i >	maximum = extent2i::large()
	The maximum size this widget is allowed to be.

Detailed Description

This GUI widget is used as a spacer between other widget for layout purposes.

Member Function Documentation

children()

generator< widget const & > hi::v1::spacer_widget::children ( bool include_invisible ) const

inlineoverridevirtualnoexcept

Get a list of child widgets.

Reimplemented from hi::v1::widget.

draw()

void hi::v1::spacer_widget::draw ( draw_context const & context )

inlineoverridevirtualnoexcept

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.

Reimplemented from hi::v1::widget.

hitbox_test()

hitbox hi::v1::spacer_widget::hitbox_test ( point2i position ) const

inlineoverridevirtualnoexcept

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.

Reimplemented from hi::v1::widget.

set_layout()

void hi::v1::spacer_widget::set_layout ( widget_layout const & context )

inlineoverridevirtualnoexcept

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.

Reimplemented from hi::v1::widget.

update_constraints()

box_constraints hi::v1::spacer_widget::update_constraints ( )

inlineoverridevirtualnoexcept

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().

Reimplemented from hi::v1::widget.

---

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

• hikogui/src/hikogui/widgets/spacer_widget.hpp