#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 (widget *parent, forward_of< observer< int > > auto &&content, forward_of< observer< int > > auto &&aperture, forward_of< observer< int > > auto &&offset) noexcept

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.

bool	visible () const noexcept

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.

bool	handle_event (gui_event const &event) noexcept override
	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 (widget *parent) noexcept

	widget (const widget &)=delete

widget &	operator= (const widget &)=delete

	widget (widget &&)=delete

widget &	operator= (widget &&)=delete

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

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.

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_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	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)

Data Fields
observer< int >	offset

observer< int >	aperture

observer< int >	content

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.

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.

Reimplemented from 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 )

inlineoverridevirtualnoexcept

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

template<axis Axis>

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

template<axis Axis>

box_constraints hi::v1::scroll_bar_widget< Axis >::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/scroll_bar_widget.hpp

Public Types

Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Member Function Documentation

◆ accepts_keyboard_focus()

◆ background_color()

◆ draw()

◆ foreground_color()

◆ handle_event()

◆ hitbox_test()

◆ set_layout()

◆ update_constraints()