hi::v1::scroll_bar_widget< Axis > Class Template Reference

#include <hikogui/widgets/scroll_bar_widget.hpp>

Inheritance diagram for hi::v1::scroll_bar_widget< Axis >:

Public Types
using	super = widget

Public Member Functions
	scroll_bar_widget (gui_window &window, widget *parent, forward_of< observer< float > > auto &&content, forward_of< observer< float > > auto &&aperture, forward_of< observer< float > > auto &&offset) noexcept
widget_constraints const &	set_constraints () noexcept override
	Update the constraints of the widget.
void	set_layout (widget_layout const &layout) noexcept override
	Update the internal layout of the widget.
void	draw (draw_context const &context) noexcept override
	Draw the widget.
hitbox	hitbox_test (point3 position) const noexcept override
	Find the widget that is under the mouse cursor.
bool	handle_event (gui_event const &event) noexcept
	Handle command.
bool	accepts_keyboard_focus (keyboard_focus_group group) const noexcept override
	Check if the widget will accept keyboard focus.
color	background_color () const noexcept override
color	foreground_color () const noexcept override
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.
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.
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	focus_color () const noexcept
virtual color	accent_color () const noexcept
virtual color	label_color () const noexcept

Data Fields
observer< float >	offset
observer< float >	aperture
observer< float >	content
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.

Static Public Attributes
static constexpr hi::axis	axis = Axis

Detailed Description

template<axis Axis>
class hi::v1::scroll_bar_widget< Axis >

Scroll bar widget This widget is used in a pair of a vertical and horizontal scrollbar as a child of the scroll_widget.

The vertical and horizontal scrollbar are displayed next to the scroll_aperture_widget and controls what part of the content is displayed in the aperture.

Template Parameters

Axis	which axis (horizontal or vertical) this scroll bar is used for.

Member Function Documentation

accepts_keyboard_focus()

template<axis Axis>

bool hi::v1::scroll_bar_widget< Axis >::accepts_keyboard_focus ( keyboard_focus_group group ) const

inlineoverridevirtualnoexcept

Check if the widget will accept keyboard focus.

Reimplemented from hi::v1::widget.

background_color()

template<axis Axis>

color hi::v1::scroll_bar_widget< Axis >::background_color ( ) const

inlineoverridevirtualnoexcept

Reimplemented from hi::v1::widget.

draw()

template<axis Axis>

void hi::v1::scroll_bar_widget< Axis >::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.

Implements hi::v1::widget.

foreground_color()

template<axis Axis>

color hi::v1::scroll_bar_widget< Axis >::foreground_color ( ) const

inlineoverridevirtualnoexcept

Reimplemented from hi::v1::widget.

handle_event()

template<axis Axis>

bool hi::v1::scroll_bar_widget< Axis >::handle_event ( gui_event const & event )

inlinevirtualnoexcept

Handle command.

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

Reimplemented from hi::v1::widget.

hitbox_test()

template<axis Axis>

hitbox hi::v1::scroll_bar_widget< Axis >::hitbox_test ( point3 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_constraints()

template<axis Axis>

widget_constraints const & hi::v1::scroll_bar_widget< Axis >::set_constraints ( )

inlineoverridevirtualnoexcept

Update the constraints of the widget.

Typically the implementation of this function starts with recursively calling set_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().

Implements hi::v1::widget.

set_layout()

template<axis Axis>

void hi::v1::scroll_bar_widget< Axis >::set_layout ( widget_layout const & layout )

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

layout

The layout for this child.

Implements hi::v1::widget.

---

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

• hikogui/src/hikogui/widgets/scroll_bar_widget.hpp