#include <hikogui/widgets/scroll_widget.hpp>

Inheritance diagram for v1::scroll_widget< Axis, ControlsWindow >:

Public Types
using	super = widget

using	delegate_type = scroll_delegate<Axis, ControlsWindow>

Public Member Functions
	scroll_widget (gui_window &window, widget *parent, std::weak_ptr< delegate_type > delegate={}) noexcept
	Constructs an empty scroll widget.

template<typename Widget , typename... Args>
Widget &	make_widget (Args &&...args) noexcept
	Add a content widget directly to this scroll widget.

Public Member Functions inherited from 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 bool	accepts_keyboard_focus (keyboard_focus_group group) const noexcept
	Check if the widget will accept keyboard focus.

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.

void	request_reconstrain () const noexcept
	Request the window to be reconstrain on the next frame.

void	request_resize () const noexcept
	Request the window to be resize based on the preferred size of the widgets.

virtual bool	handle_event (command command) noexcept
	Handle command.

virtual bool	handle_event (std::vector< command > const &commands) noexcept

virtual bool	handle_command_recursive (command command, std::vector< widget const * > const &reject_list=std::vector< widget const * >{}) noexcept
	Handle command recursive.

virtual bool	handle_event (mouse_event const &event) noexcept

virtual bool	handle_event (keyboard_event const &event) noexcept
	Handle keyboard event.

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

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

static constexpr bool	controls_window = ControlsWindow

Additional Inherited Members
Data Fields inherited from 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.

observable< bool >	enabled = true
	The widget is enabled.

observable< bool >	visible = true
	The widget is visible.

observable< bool >	hover = false
	Mouse cursor is hovering over the widget.

observable< 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

template<axis Axis = axis::both, bool ControlsWindow = false>
class v1::scroll_widget< Axis, ControlsWindow >

The scroll widget allows a content widget to be shown in less space than is required.

The user can then show the part of the content widget by using the scroll-bar widgets which are provided by the scroll widget.

The size of the scroll widget is based on the widget::minimum_size(), widget::preferred_size() and widget::maximum_size() of the content widget together with the space needed for the scrollbars.

In the directions that are allowed for scrolling the minimum size of the scroll widget is adjusted to be much smaller, up to the smallest size of the scroll-bar widget in that direction.

Scroll-bars are automatically added when the actual size of the scroll widget is smaller than the content, this will happen even if the template parameters given did not allow scrolling in that direction. This is useful behavior when the scroll widget is part of an overlay widget which was unable to size to the minimum size requested.

Template Parameters

Axis	the axis that the content may be scrolled. Allowed values are `axis::horizontal`, `axis::vertical` or `axis::both`.
ControlsWindow	If set to true, when the content changes size the window gets a signal to resize to its preferred size.

Constructor & Destructor Documentation

◆ scroll_widget()

template<axis Axis = axis::both, bool ControlsWindow = false>

v1::scroll_widget< Axis, ControlsWindow >::scroll_widget	(	gui_window &	window,
		widget *	parent,
		std::weak_ptr< delegate_type >	delegate = {} )

inlinenoexcept

Constructs an empty scroll widget.

Parameters

window	The window.
parent	The parent widget.
delegate	An optional delegate can be used to populate the scroll widget during initialization.

Member Function Documentation

◆ make_widget()

template<axis Axis = axis::both, bool ControlsWindow = false>

template<typename Widget , typename... Args>

Widget & v1::scroll_widget< Axis, ControlsWindow >::make_widget ( Args &&... args )

inlinenoexcept

Add a content widget directly to this scroll widget.

This widget is added as the content widget.

Precondition: No content widgets have been added before.

Template Parameters

Widget The type of the widget to be constructed.

Parameters

args	The arguments passed to the constructor of the widget.

Returns: A reference to the widget that was created.

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

hikogui/src/hikogui/widgets/scroll_delegate.hpp
hikogui/src/hikogui/widgets/scroll_widget.hpp

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ scroll_widget()

Member Function Documentation

◆ make_widget()