Base class for creating containers with one or two scrollbar(s). More...

#include <scrollbar_container.hpp>

Inheritance diagram for gui2::scrollbar_container:

Public Types
enum	scrollbar_mode { ALWAYS_VISIBLE , ALWAYS_INVISIBLE , AUTO_VISIBLE , AUTO_VISIBLE_FIRST_RUN }
	The way to handle the showing or hiding of the scrollbar. More...

Public Types inherited from gui2::widget
enum class	visibility { visible , hidden , invisible }
	Visibility settings done by the user. More...

enum class	redraw_action { full , partly , none }
	Visibility set by the engine. More...

enum class	debug_border { none , outline , fill }

Public Types inherited from gui2::event::dispatcher
enum	event_queue_type { pre = 1 , child = 2 , post = 4 }

enum	queue_position { front_pre_child , back_pre_child , front_child , back_child , front_post_child , back_post_child }
	The position where to add a new callback in the signal handler. More...

enum class	mouse_behavior { all , hit , none }
	The behavior of the mouse events. More...

Public Member Functions
	scrollbar_container (const implementation::builder_scrollbar_container &builder, const std::string &control_type)

virtual	~scrollbar_container ()

virtual void	layout_initialize (const bool full_initialization) override
	See widget::layout_initialize. More...

virtual void	request_reduce_height (const unsigned maximum_height) override
	See widget::request_reduce_height. More...

virtual void	request_reduce_width (const unsigned maximum_width) override
	See widget::request_reduce_width. More...

virtual bool	can_wrap () const override
	See widget::can_wrap. More...

virtual void	place (const point &origin, const point &size) override
	See widget::place. More...

virtual void	set_origin (const point &origin) override
	See widget::set_origin. More...

virtual void	set_visible_rectangle (const SDL_Rect &rectangle) override
	See widget::set_visible_rectangle. More...

virtual bool	get_active () const override
	See styled_widget::get_active. More...

virtual unsigned	get_state () const override
	See styled_widget::get_state. More...

virtual widget *	find_at (const point &coordinate, const bool must_be_active) override
	See widget::find_at. More...

virtual const widget *	find_at (const point &coordinate, const bool must_be_active) const override
	See widget::find_at. More...

widget *	find (const std::string_view id, const bool must_be_active) override
	See widget::find. More...

const widget *	find (const std::string_view id, const bool must_be_active) const override
	See widget::find. More...

bool	disable_click_dismiss () const override
	See widget::disable_click_dismiss. More...

virtual iteration::walker_ptr	create_walker () override
	See widget::create_walker. More...

void	set_vertical_scrollbar_mode (const scrollbar_mode scrollbar_mode)

scrollbar_mode	get_vertical_scrollbar_mode () const

void	set_horizontal_scrollbar_mode (const scrollbar_mode scrollbar_mode)

scrollbar_mode	get_horizontal_scrollbar_mode () const

grid *	content_grid ()

const grid *	content_grid () const

const SDL_Rect &	content_visible_area () const

bool	vertical_scrollbar_at_end ()

unsigned	get_vertical_scrollbar_item_position () const
	Returns current position of the vertical scrollbar. More...

void	set_vertical_scrollbar_item_position (const unsigned position)
	Move the vertical scrollbar to a position. More...

unsigned	get_horizontal_scrollbar_item_position () const
	Returns current position of the horizontal scrollbar. More...

void	set_horizontal_scrollbar_item_position (const unsigned position)
	Move the horizontal scrollbar to a position. More...

void	scroll_vertical_scrollbar (const scrollbar_base::scroll_mode scroll)
	Scrolls the vertical scrollbar. More...

void	scroll_horizontal_scrollbar (const scrollbar_base::scroll_mode scroll)
	Scrolls the horizontal scrollbar. More...

void	scroll_vertical_scrollbar_by (const int pixels)
	Scrolls the vertical scrollbar by pixel. More...

void	scroll_horizontal_scrollbar_by (const int pixels)
	Scrolls the horizontal scrollbar by pixel. More...

void	vertical_scrollbar_moved ()
	Callback when the scrollbar moves (NOTE maybe only one callback needed). More...

void	horizontal_scrollbar_moved ()

void	move_viewport (const int pixels_x, const int pixels_y)
	To be called after the scollbar moves manually (by pixel) to move the viewport. More...

scrollbar_base *	horizontal_scrollbar ()

scrollbar_base *	vertical_scrollbar ()

grid *	get_horizontal_scrollbar_grid ()

grid *	get_vertical_scrollbar_grid ()

Public Member Functions inherited from gui2::container_base
	container_base (const implementation::builder_styled_widget &builder, const std::string &control_type)

virtual SDL_Rect	get_client_rect () const
	Returns the client rect. More...

void	reduce_width (const unsigned maximum_width)
	Tries to reduce the width of a container. More...

virtual void	demand_reduce_width (const unsigned maximum_width) override
	See widget::demand_reduce_width. More...

void	reduce_height (const unsigned maximum_height)
	Tries to reduce the height of a container. More...

virtual void	demand_reduce_height (const unsigned maximum_height) override
	See widget::demand_reduce_height. More...

virtual bool	has_widget (const widget &widget) const override
	See widget::has_widget. More...

virtual void	set_active (const bool active) override
	See styled_widget::set_active. More...

void	init_grid (const builder_grid &grid_builder)
	Initializes and builds the grid. More...

grid::iterator	begin ()

grid::iterator	end ()

unsigned	add_row (const unsigned count=1)

void	set_rows (const unsigned rows)

unsigned int	get_rows () const

void	set_cols (const unsigned cols)

unsigned int	get_cols () const

void	set_rows_cols (const unsigned rows, const unsigned cols)

void	set_child (std::unique_ptr< widget > widget, const unsigned row, const unsigned col, const unsigned flags, const unsigned border_size)

void	set_row_grow_factor (const unsigned row, const unsigned factor)

void	set_column_grow_factor (const unsigned column, const unsigned factor)

const grid &	get_grid () const

grid &	get_grid ()

Public Member Functions inherited from gui2::styled_widget
	styled_widget (const implementation::builder_styled_widget &builder, const std::string &control_type)
	Constructor. More...

virtual void	set_members (const widget_item &data)
	Sets the members of the styled_widget. More...

bool	disable_click_dismiss () const override
	See widget::disable_click_dismiss. More...

point	get_config_minimum_size () const
	Gets the minimum size as defined in the config. More...

point	get_config_default_size () const
	Gets the default size as defined in the config. More...

point	get_config_maximum_size () const
	Gets the best size as defined in the config. More...

virtual unsigned	get_characters_per_line () const
	Returns the number of characters per line. More...

virtual bool	get_link_aware () const
	Returns whether the label should be link_aware, in in rendering and in searching for links with get_link. More...

virtual color_t	get_link_color () const
	Returns the color string to be used with links. More...

widget *	find (const std::string_view id, const bool must_be_active) override
	See widget::find. More...

const widget *	find (const std::string_view id, const bool must_be_active) const override
	See widget::find. More...

bool	get_use_tooltip_on_label_overflow () const

void	set_use_tooltip_on_label_overflow (const bool use_tooltip=true)

const t_string &	get_label () const

virtual void	set_label (const t_string &text)

virtual void	set_use_markup (bool use_markup)

bool	get_use_markup () const

const t_string &	tooltip () const

void	set_tooltip (const t_string &tooltip)

const t_string &	help_message () const

void	set_help_message (const t_string &help_message)

std::vector< canvas > &	get_canvases ()

canvas &	get_canvas (const unsigned index)

virtual void	set_text_alignment (const PangoAlignment text_alignment)

PangoAlignment	get_text_alignment () const

void	set_text_ellipse_mode (const PangoEllipsizeMode ellipse_mode)

PangoEllipsizeMode	get_text_ellipse_mode () const
	Get the text's ellipsize mode. More...

void	set_text_maximum_width (int max_width)
	Set how wide the text can become. More...

Public Member Functions inherited from gui2::widget
	widget (const widget &)=delete

widget &	operator= (const widget &)=delete

	widget ()

	widget (const builder_widget &builder)
	Constructor. More...

virtual	~widget () override

void	set_id (const std::string &id)

const std::string &	id () const

window *	get_window ()
	Get the parent window. More...

const window *	get_window () const
	The constant version of get_window. More...

grid *	get_parent_grid ()
	Get the parent grid. More...

const grid *	get_parent_grid () const

void	set_parent (widget *parent)

widget *	parent ()

point	get_best_size () const
	Gets the best size for the widget. More...

virtual bool	can_mouse_focus () const
	Whether the mouse move/click event go 'through' this widget. More...

virtual void	set_size (const point &size)
	Sets the size of the widget. More...

virtual void	move (const int x_offset, const int y_offset)
	Moves a widget. More...

virtual void	set_horizontal_alignment (const std::string &alignment)
	Sets the horizontal alignment of the widget within its parent grid. More...

virtual void	set_vertical_alignment (const std::string &alignment)
	Sets the horizontal alignment of the widget within its parent grid. More...

point	get_origin () const
	Returns the screen origin of the widget. More...

point	get_size () const
	Returns the size of the widget. More...

rect	get_rectangle () const
	Gets the bounding rectangle of the widget on the screen. More...

int	get_x () const

int	get_y () const

unsigned	get_width () const

unsigned	get_height () const

void	set_linked_group (const std::string &linked_group)

std::string	get_linked_group () const

SDL_Rect	calculate_blitting_rectangle () const
	Calculates the blitting rectangle of the widget. More...

SDL_Rect	calculate_clipping_rectangle () const
	Calculates the clipping rectangle of the widget. More...

bool	draw_background ()
	Draws the background of a widget. More...

void	draw_children ()
	Draws the children of a widget. More...

bool	draw_foreground ()
	Draws the foreground of the widget. More...

SDL_Rect	get_dirty_rectangle () const
	Gets the dirty rectangle of the widget. More...

void	queue_redraw ()
	Indicates that this widget should be redrawn. More...

void	queue_redraw (const rect &region)
	Indicate that specific region of the screen should be redrawn. More...

void	set_visible (const visibility visible)

visibility	get_visible () const

void	set_visible (bool visible)
	Sets widget to visible if visible is true, else invisible. More...

void	set_hidden (bool hidden)
	Sets widget to visible if hidden is true, else hidden. More...

redraw_action	get_drawing_action () const

void	set_debug_border_mode (const debug_border debug_border_mode)

void	set_debug_border_color (const color_t debug_border_color)

template<class T >
T *	find_widget (const std::string_view id, const bool must_be_active, const bool must_exist)
	Gets a widget with the wanted id. More...

template<class T >
const T *	find_widget (const std::string_view id, const bool must_be_active, const bool must_exist) const

template<class T >
T &	find_widget (const std::string_view id, const bool must_be_active=false)
	Gets a widget with the wanted id. More...

template<class T >
const T &	find_widget (const std::string_view id, const bool must_be_active=false) const

Public Member Functions inherited from gui2::event_executor
	event_executor ()

virtual	~event_executor ()

void	set_wants_mouse_hover (const bool hover=true)

bool	wants_mouse_hover () const

void	set_wants_mouse_left_double_click (const bool click=true)

bool	wants_mouse_left_double_click () const

void	set_wants_mouse_middle_double_click (const bool click=true)

bool	wants_mouse_middle_double_click () const

event_executor &	set_wants_mouse_right_double_click (const bool click=true)

bool	wants_mouse_right_double_click () const

Public Member Functions inherited from gui2::event::dispatcher
	dispatcher ()

virtual	~dispatcher ()

void	connect ()
	Connects the dispatcher to the event handler. More...

void	disconnect ()
	Disconnects the dispatcher from the event handler. More...

bool	is_connected () const
	Return whether the dispatcher is currently connected. More...

bool	has_event (const ui_event event, const event_queue_type event_type)

bool	fire (const ui_event event, widget &target)
	Fires an event which has no extra parameters. More...

bool	fire (const ui_event event, widget &target, const point &coordinate)
	Fires an event which takes a coordinate parameter. More...

bool	fire (const ui_event event, widget &target, const SDL_Keycode key, const SDL_Keymod modifier, const std::string &unicode)
	Fires an event which takes keyboard parameters. More...

bool	fire (const ui_event event, widget &target, const point &pos, const point &distance)
	Fires an event which takes touch-motion parameters. More...

bool	fire (const ui_event event, widget &target, const point &center, float dTheta, float dDist, uint8_t numFingers)
	Fires an event which takes touch-gesture parameters. More...

bool	fire (const ui_event event, widget &target, void *)
	Fires an event which takes notification parameters. More...

bool	fire (const ui_event event, widget &target, const message &msg)
	Fires an event which takes message parameters. More...

bool	fire (const ui_event event, widget &target, const SDL_Event &sdlevent)
	Fires an event that's a raw SDL event. More...

bool	fire (const ui_event event, widget &target, const std::string &text, int32_t start, int32_t len)
	Fires an event which takes text input parameters. More...

template<ui_event E, typename F >
void	connect_signal (const F &func, const queue_position position=back_child)
	Adds a callback to the appropriate queue based on event type. More...

template<ui_event E, typename F >
void	disconnect_signal (const F &func, const queue_position position=back_child)
	Removes a callback from the appropriate queue based on event type. More...

void	capture_mouse ()
	Captures the mouse. More...

void	release_mouse ()
	Releases the mouse capture. More...

void	set_mouse_behavior (const mouse_behavior mouse_behavior)

mouse_behavior	get_mouse_behavior () const

void	set_want_keyboard_input (const bool want_keyboard_input)

bool	get_want_keyboard_input () const

void	register_hotkey (const hotkey::HOTKEY_COMMAND id, const hotkey_function &function)
	Registers a hotkey. More...

bool	execute_hotkey (const hotkey::HOTKEY_COMMAND id)
	Executes a hotkey. More...

Public Member Functions inherited from enable_lua_ptr< widget >
	enable_lua_ptr (widget *tp)

Static Public Member Functions
static const std::string &	type ()
	Static type getter that does not rely on the widget being constructed. More...

Protected Member Functions
virtual point	calculate_best_size () const override
	See widget::calculate_best_size. More...

void	show_content_rect (const SDL_Rect &rect)
	Shows a certain part of the content. More...

void	set_scrollbar_button_status ()
	Sets the status of the scrollbar buttons. More...

bool	content_resize_request (const bool force_sizing=false)
	Notification if the content of a child needs a resize. More...

bool	content_resize_request (const int width_modification, const int height_modification, const int width_modification_pos=-1, const int height_modification_pos=-1)
	Request from the content to modify the size of the container. More...

virtual void	handle_key_home (SDL_Keymod modifier, bool &handled)
	Home key pressed. More...

virtual void	handle_key_end (SDL_Keymod modifier, bool &handled)
	End key pressed. More...

virtual void	handle_key_page_up (SDL_Keymod modifier, bool &handled)
	Page up key pressed. More...

virtual void	handle_key_page_down (SDL_Keymod modifier, bool &handled)
	Page down key pressed. More...

virtual void	handle_key_up_arrow (SDL_Keymod modifier, bool &handled)
	Up arrow key pressed. More...

virtual void	handle_key_down_arrow (SDL_Keymod modifier, bool &handled)
	Down arrow key pressed. More...

virtual void	handle_key_left_arrow (SDL_Keymod modifier, bool &handled)
	Left arrow key pressed. More...

virtual void	handle_key_right_arrow (SDL_Keymod modifier, bool &handled)
	Right arrow key pressed. More...

void	finalize_setup ()
	The builder needs to call us so we do our setup. More...

Protected Member Functions inherited from gui2::styled_widget
resolution_definition_ptr	get_config ()

resolution_definition_const_ptr	get_config () const

template<typename T >
std::shared_ptr< const typename T::resolution >	cast_config_to () const
	Casts the current resolution definition config to the respective type of a derived widget. More...

void	set_config (resolution_definition_ptr config)

virtual void	update_canvas ()
	Updates the canvas(ses). More...

unsigned int	get_text_font_size () const
	Resolves and returns the text_font_size. More...

int	get_text_maximum_width () const
	Returns the maximum width available for the text. More...

int	get_text_maximum_height () const
	Returns the maximum height available for the text. More...

virtual bool	impl_draw_background () override
	See widget::impl_draw_background. More...

virtual bool	impl_draw_foreground () override
	See widget::impl_draw_foreground. More...

std::string	get_label_token (const point &position, const char *delimiters=" \n\r\t") const
	Exposes font::pango_text::get_token, for the text label of this styled_widget. More...

std::string	get_label_link (const point &position) const

Protected Member Functions inherited from gui2::widget
void	set_layout_size (const point &size)

const point &	layout_size () const

void	clear_layout_size ()
	Throws away layout_size_. More...

Private Types
enum	state_t { ENABLED , DISABLED }
	Possible states of the widget. More...

Private Member Functions
bool	content_resize_width (const int width_modification, const int width_modification_pos)
	Helper for content_resize_request. More...

bool	content_resize_height (const int height_modification, const int width_modification_pos)
	Helper for content_resize_request. More...

virtual void	finalize_subclass ()
	Function for the subclasses to do their setup. More...

virtual void	layout_children () override
	See widget::layout_children. More...

virtual void	impl_draw_children () override
	See widget::impl_draw_children. More...

virtual void	set_content_size (const point &origin, const point &size)
	Sets the size of the content grid. More...

void	scrollbar_moved ()
	Helper function which needs to be called after the scollbar moves by item. More...

virtual const std::string &	get_control_type () const override
	See styled_widget::get_control_type. More...

void	signal_handler_sdl_key_down (const event::ui_event event, bool &handled, const SDL_Keycode key, SDL_Keymod modifier)

void	signal_handler_sdl_wheel_up (const event::ui_event event, bool &handled)

void	signal_handler_sdl_wheel_down (const event::ui_event event, bool &handled)

void	signal_handler_sdl_wheel_left (const event::ui_event event, bool &handled)

void	signal_handler_sdl_wheel_right (const event::ui_event event, bool &handled)

void	signal_handler_sdl_touch_motion (const event::ui_event event, bool &handled, const point &position, const point &distance)

Private Attributes
state_t	state_
	Current state of the widget. More...

scrollbar_mode	vertical_scrollbar_mode_
	The mode of how to show the scrollbar. More...

scrollbar_mode	horizontal_scrollbar_mode_

grid *	vertical_scrollbar_grid_
	These are valid after finalize_setup(). More...

grid *	horizontal_scrollbar_grid_

scrollbar_base *	vertical_scrollbar_
	These are valid after finalize_setup(). More...

scrollbar_base *	horizontal_scrollbar_

std::unique_ptr< grid >	content_grid_
	The grid that holds the content. More...

spacer *	content_
	Dummy spacer to hold the contents location. More...

SDL_Rect	content_visible_area_
	Cache for the visible area for the content. More...

Friends
class	debug_layout_graph

struct	implementation::builder_scroll_label

struct	implementation::builder_scrollbar_panel

class	listbox

class	tree_view

struct	scrollbar_container_implementation

Detailed Description

Base class for creating containers with one or two scrollbar(s).

For now users can't instantiate this class directly and needs to use small wrapper classes. Maybe in the future users can use the class directly.

Todo:: events are not yet send to the content grid.

Definition at line 41 of file scrollbar_container.hpp.

Member Enumeration Documentation

◆ scrollbar_mode

enum gui2::scrollbar_container::scrollbar_mode

The way to handle the showing or hiding of the scrollbar.

Enumerator
ALWAYS_VISIBLE	The scrollbar is always shown, whether needed or not.
ALWAYS_INVISIBLE	The scrollbar is never shown even notwhen needed. There's also no space reserved for the scrollbar.
AUTO_VISIBLE	The scrollbar is shown when the number of items is larger as the visible items. The space for the scrollbar is always reserved, just in case it's needed after the initial sizing (due to adding items).
AUTO_VISIBLE_FIRST_RUN	Like AUTO_VISIBLE, but when not needed upon the initial layout phase, the bars are not shown and no space is reserved for them. (The algorithm hides them by default.

Definition at line 59 of file scrollbar_container.hpp.

◆ state_t

enum gui2::scrollbar_container::state_t

private

Possible states of the widget.

Note the order of the states must be the same as defined in settings.hpp.

Enumerator
ENABLED
DISABLED

Definition at line 475 of file scrollbar_container.hpp.

Constructor & Destructor Documentation

◆ scrollbar_container()

gui2::scrollbar_container::scrollbar_container	(	const implementation::builder_scrollbar_container &	builder,
		const std::string &	control_type
	)

explicit

Definition at line 71 of file scrollbar_container.cpp.

References gui2::event::dispatcher::back_post_child, signal_handler_sdl_key_down(), signal_handler_sdl_touch_motion(), signal_handler_sdl_wheel_down(), signal_handler_sdl_wheel_left(), signal_handler_sdl_wheel_right(), and signal_handler_sdl_wheel_up().

◆ ~scrollbar_container()

virtual gui2::scrollbar_container::~scrollbar_container ( )

inlinevirtual

Definition at line 54 of file scrollbar_container.hpp.

Member Function Documentation

◆ calculate_best_size()

point gui2::scrollbar_container::calculate_best_size ( ) const

overrideprotectedvirtual

See widget::calculate_best_size.

Reimplemented from gui2::container_base.

Reimplemented in gui2::scroll_text, and gui2::listbox.

Definition at line 290 of file scrollbar_container.cpp.

References content_grid_, DBG_GUI_L, gui2::widget::get_best_size(), gui2::widget::get_visible(), horizontal_scrollbar_grid_, gui2::widget::invisible, gui2::log_gui_layout, LOG_HEADER, log_scope2, LOG_SCOPE_HEADER, draw::point(), and vertical_scrollbar_grid_.

Referenced by gui2::listbox::calculate_best_size(), and gui2::scroll_text::calculate_best_size().

◆ can_wrap()

bool gui2::scrollbar_container::can_wrap ( ) const

overridevirtual

See widget::can_wrap.

Note: This function is called before the object is finalized.

Reimplemented from gui2::container_base.

Reimplemented in gui2::scroll_text, and gui2::scroll_label.

Definition at line 285 of file scrollbar_container.cpp.

References content_grid_.

◆ content_grid() [1/2]

grid* gui2::scrollbar_container::content_grid ( )

inline

Definition at line 164 of file scrollbar_container.hpp.

References content_grid_.

Referenced by gui2::tree_view_node::add_child_impl(), gui2::iteration::scrollbar_container::at_end(), gui2::tree_view::clear(), gui2::tree_view::finalize_setup(), gui2::iteration::scrollbar_container::get(), gui2::scroll_label::get_internal_label(), gui2::scroll_text::get_internal_text_box(), gui2::tree_view::layout_children(), gui2::iteration::scrollbar_container::next(), gui2::tree_view_node::replace_children(), gui2::listbox::resize_content(), gui2::tree_view::resize_content(), gui2::listbox::set_content_size(), and gui2::listbox::update_layout().

◆ content_grid() [2/2]

const grid* gui2::scrollbar_container::content_grid ( ) const

inline

Definition at line 169 of file scrollbar_container.hpp.

References content_grid_.

◆ content_resize_height()

bool gui2::scrollbar_container::content_resize_height	(	const int	height_modification,
		const int	width_modification_pos
	)

private

Helper for content_resize_request.

Handle the height modification.

Definition at line 691 of file scrollbar_container.cpp.

References gui2::adjust_scrollbar_mode(), ALWAYS_INVISIBLE, AUTO_VISIBLE_FIRST_RUN, content_, content_grid_, DBG_GUI_L, gui2::widget::get_height(), gui2::widget::get_visible(), gui2::widget::get_window(), gui2::window::invalidate_layout(), gui2::widget::invisible, LOG_HEADER, vertical_scrollbar_, vertical_scrollbar_grid_, and vertical_scrollbar_mode_.

Referenced by content_resize_request().

◆ content_resize_request() [1/2]

bool gui2::scrollbar_container::content_resize_request ( const bool force_sizing = false )

protected

Notification if the content of a child needs a resize.

When a resize is required the container first can try to handle it itself. If it can't honor the request the function will call window::invalidate_layout().

Note: Calling this function on a widget with size == (0, 0) results false but doesn't call invalidate_layout, the engine expects to be in build up phase with the layout already invalidated.

Parameters

force_sizing If the contents fit do we want to force a resize? This is needed in the MP lobby since items might not be properly placed yet. (The listboxes with the player info need it.)

Returns: True if the resize is handled, false otherwise.

Todo:: Try to handle AUTO_VISIBLE_FIRST_RUN here as well.

Handling it here makes the code a bit more complex but allows to not reserve space for scrollbars, which will look nicer in the MP lobby. But the extra complexity is no 1.8 material.

Definition at line 524 of file scrollbar_container.cpp.

References ALWAYS_INVISIBLE, AUTO_VISIBLE_FIRST_RUN, content_, content_grid_, DBG_GUI_L, gui2::event::dispatcher::fire(), gui2::widget::get_origin(), gui2::widget::get_size(), gui2::widget::get_visible(), horizontal_scrollbar_grid_, horizontal_scrollbar_mode_, gui2::widget::invisible, LOG_HEADER, place(), draw::point(), gui2::event::REQUEST_PLACEMENT, utf8::size(), vertical_scrollbar_grid_, and vertical_scrollbar_mode_.

Referenced by gui2::listbox::resize_content(), gui2::tree_view::resize_content(), gui2::scroll_label::set_label(), gui2::scroll_text::set_label(), gui2::listbox::set_row_shown(), and gui2::listbox::update_content_size().

◆ content_resize_request() [2/2]

bool gui2::scrollbar_container::content_resize_request	(	const int	width_modification,
		const int	height_modification,
		const int	width_modification_pos = `-1`,
		const int	height_modification_pos = `-1`
	)

protected

Request from the content to modify the size of the container.

When the wanted resize fails the function will call window::invalidate_layout().

Note: Calling this function on a widget with size == (0, 0) results false but doesn't call invalidate_layout, the engine expects to be in build up phase with the layout already invalidated.; If window::get_need_layout() is true the function returns false and doesn't try to fit the contents since a layout phase will be triggered anyway.; This function might replace the content_resize_request above.

Parameters

width_modification	The wanted modification to the width: negative values reduce width. zero leave width as is. positive values increase width.
height_modification	The wanted modification to the height: negative values reduce height. zero leave height as is. positive values increase height.
width_modification_pos	The position where the additional content was inserted/removed, defaults to -1 which means 'at end'
height_modification_pos	The position where the additional content was inserted/removed, defaults to -1 which means 'at end'

Returns: True is wanted modification is accepted false otherwise.

Definition at line 604 of file scrollbar_container.cpp.

References content_, content_grid_, content_resize_height(), content_resize_width(), DBG_GUI_L, gui2::window::get_need_layout(), gui2::widget::get_size(), gui2::widget::get_window(), LOG_HEADER, draw::point(), scrollbar_moved(), and set_scrollbar_button_status().

◆ content_resize_width()

bool gui2::scrollbar_container::content_resize_width	(	const int	width_modification,
		const int	width_modification_pos
	)

private

Helper for content_resize_request.

Handle the width modification.

Definition at line 645 of file scrollbar_container.cpp.

References gui2::adjust_scrollbar_mode(), ALWAYS_INVISIBLE, AUTO_VISIBLE_FIRST_RUN, content_, content_grid_, DBG_GUI_L, gui2::widget::get_visible(), gui2::widget::get_width(), gui2::widget::get_window(), horizontal_scrollbar_, horizontal_scrollbar_grid_, horizontal_scrollbar_mode_, gui2::window::invalidate_layout(), gui2::widget::invisible, and LOG_HEADER.

Referenced by content_resize_request().

◆ content_visible_area()

const SDL_Rect& gui2::scrollbar_container::content_visible_area ( ) const

inline

Definition at line 174 of file scrollbar_container.hpp.

References content_visible_area_.

Referenced by gui2::tree_view::handle_up_down_arrow(), gui2::listbox::list_item_clicked(), gui2::listbox::place(), gui2::scroll_text::place(), gui2::listbox::set_row_shown(), gui2::listbox::update_content_size(), and gui2::listbox::update_visible_area_on_key_event().

◆ create_walker()

iteration::walker_ptr gui2::scrollbar_container::create_walker ( )

overridevirtual

See widget::create_walker.

Reimplemented from gui2::container_base.

Definition at line 519 of file scrollbar_container.cpp.

◆ disable_click_dismiss()

bool gui2::scrollbar_container::disable_click_dismiss ( ) const

overridevirtual

See widget::disable_click_dismiss.

Reimplemented from gui2::container_base.

Definition at line 513 of file scrollbar_container.cpp.

References content_grid_, and gui2::container_base::disable_click_dismiss().

◆ finalize_setup()

void gui2::scrollbar_container::finalize_setup ( )

protected

The builder needs to call us so we do our setup.

Definition at line 737 of file scrollbar_container.cpp.

References gui2::button::connect_click_handler(), gui2::event::connect_signal_notify_modified(), content_, content_grid_, finalize_subclass(), gui2::widget::find_widget(), gui2::container_base::get_grid(), horizontal_scrollbar_, horizontal_scrollbar_grid_, horizontal_scrollbar_moved(), scroll_horizontal_scrollbar(), scroll_vertical_scrollbar(), vertical_scrollbar_, vertical_scrollbar_grid_, and vertical_scrollbar_moved().

Referenced by gui2::tree_view::finalize_setup(), and gui2::listbox::listbox().

◆ finalize_subclass()

virtual void gui2::scrollbar_container::finalize_subclass ( )

inlineprivatevirtual

Function for the subclasses to do their setup.

This function is called at the end of finalize_setup().

Reimplemented in gui2::scroll_text, and gui2::scroll_label.

Definition at line 520 of file scrollbar_container.hpp.

Referenced by finalize_setup().

◆ find() [1/2]

const widget * gui2::scrollbar_container::find	(	const std::string_view	id,
		const bool	must_be_active
	)		const

overridevirtual

See widget::find.

Reimplemented from gui2::container_base.

Definition at line 508 of file scrollbar_container.cpp.

◆ find() [2/2]

widget * gui2::scrollbar_container::find	(	const std::string_view	id,
		const bool	must_be_active
	)

overridevirtual

See widget::find.

Reimplemented from gui2::container_base.

Definition at line 503 of file scrollbar_container.cpp.

Referenced by gui2::dialogs::end_credits::pre_show().

◆ find_at() [1/2]

const widget * gui2::scrollbar_container::find_at	(	const point &	coordinate,
		const bool	must_be_active
	)		const

overridevirtual

See widget::find_at.

Reimplemented from gui2::container_base.

Definition at line 493 of file scrollbar_container.cpp.

References gui2::widget::find_at(), and w.

◆ find_at() [2/2]

widget * gui2::scrollbar_container::find_at	(	const point &	coordinate,
		const bool	must_be_active
	)

overridevirtual

See widget::find_at.

Reimplemented from gui2::container_base.

Definition at line 483 of file scrollbar_container.cpp.

References gui2::widget::find_at(), and w.

◆ get_active()

bool gui2::scrollbar_container::get_active ( ) const

overridevirtual

See styled_widget::get_active.

Implements gui2::styled_widget.

Reimplemented in gui2::scrollbar_panel, gui2::scroll_text, and gui2::scroll_label.

Definition at line 473 of file scrollbar_container.cpp.

References DISABLED, and state_.

◆ get_control_type()

const std::string & gui2::scrollbar_container::get_control_type ( ) const

overrideprivatevirtual

See styled_widget::get_control_type.

Implements gui2::styled_widget.

Reimplemented in gui2::tree_view, gui2::scrollbar_panel, gui2::scroll_text, gui2::scroll_label, and gui2::listbox.

Definition at line 1110 of file scrollbar_container.cpp.

References type().

◆ get_horizontal_scrollbar_grid()

grid* gui2::scrollbar_container::get_horizontal_scrollbar_grid ( )

inline

Definition at line 579 of file scrollbar_container.hpp.

References horizontal_scrollbar_grid_.

Referenced by gui2::scroll_text::set_max_size().

◆ get_horizontal_scrollbar_item_position()

unsigned gui2::scrollbar_container::get_horizontal_scrollbar_item_position ( ) const

Returns current position of the horizontal scrollbar.

Definition at line 943 of file scrollbar_container.cpp.

References gui2::scrollbar_base::get_item_position(), and horizontal_scrollbar_.

Referenced by gui2::listbox::place().

◆ get_horizontal_scrollbar_mode()

scrollbar_mode gui2::scrollbar_container::get_horizontal_scrollbar_mode ( ) const

inline

Definition at line 159 of file scrollbar_container.hpp.

References horizontal_scrollbar_mode_.

◆ get_state()

unsigned gui2::scrollbar_container::get_state ( ) const

overridevirtual

See styled_widget::get_state.

Implements gui2::styled_widget.

Reimplemented in gui2::scrollbar_panel, gui2::scroll_text, and gui2::scroll_label.

Definition at line 478 of file scrollbar_container.cpp.

References state_.

◆ get_vertical_scrollbar_grid()

grid* gui2::scrollbar_container::get_vertical_scrollbar_grid ( )

inline

Definition at line 584 of file scrollbar_container.hpp.

References vertical_scrollbar_grid_.

Referenced by gui2::scroll_text::set_max_size().

◆ get_vertical_scrollbar_item_position()

unsigned gui2::scrollbar_container::get_vertical_scrollbar_item_position ( ) const

Returns current position of the vertical scrollbar.

Definition at line 928 of file scrollbar_container.cpp.

References gui2::scrollbar_base::get_item_position(), and vertical_scrollbar_.

Referenced by gui2::chatbox::append_to_chatbox(), gui2::listbox::place(), gui2::dialogs::end_credits::update(), and gui2::lobby_player_list_helper::update().

◆ get_vertical_scrollbar_mode()

scrollbar_mode gui2::scrollbar_container::get_vertical_scrollbar_mode ( ) const

inline

Definition at line 151 of file scrollbar_container.hpp.

References vertical_scrollbar_mode_.

◆ handle_key_down_arrow()

void gui2::scrollbar_container::handle_key_down_arrow	(	SDL_Keymod	modifier,
		bool &	handled
	)

protectedvirtual

Down arrow key pressed.

Parameters

modifier	The SDL keyboard modifier when the key was pressed.
handled	If the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Reimplemented in gui2::tree_view, and gui2::listbox.

Definition at line 1042 of file scrollbar_container.cpp.

References gui2::scrollbar_base::ITEM_FORWARD, gui2::scrollbar_base::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by gui2::tree_view::handle_key_down_arrow(), and signal_handler_sdl_key_down().

◆ handle_key_end()

void gui2::scrollbar_container::handle_key_end	(	SDL_Keymod	modifier,
		bool &	handled
	)

protectedvirtual

End key pressed.

Parameters

modifier	The SDL keyboard modifier when the key was pressed.
handled	If the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Definition at line 1001 of file scrollbar_container.cpp.

References gui2::scrollbar_base::END, gui2::scrollbar_base::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by signal_handler_sdl_key_down().

◆ handle_key_home()

void gui2::scrollbar_container::handle_key_home	(	SDL_Keymod	modifier,
		bool &	handled
	)

protectedvirtual

Home key pressed.

Parameters

modifier	The SDL keyboard modifier when the key was pressed.
handled	If the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Definition at line 990 of file scrollbar_container.cpp.

References gui2::scrollbar_base::BEGIN, horizontal_scrollbar_, gui2::scrollbar_base::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by signal_handler_sdl_key_down().

◆ handle_key_left_arrow()

void gui2::scrollbar_container::handle_key_left_arrow	(	SDL_Keymod	modifier,
		bool &	handled
	)

protectedvirtual

Left arrow key pressed.

Parameters

modifier	The SDL keyboard modifier when the key was pressed.
handled	If the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Reimplemented in gui2::tree_view, and gui2::listbox.

Definition at line 1052 of file scrollbar_container.cpp.

References horizontal_scrollbar_, gui2::scrollbar_base::ITEM_BACKWARDS, gui2::scrollbar_base::scroll(), and scrollbar_moved().

Referenced by gui2::listbox::handle_key_left_arrow(), gui2::tree_view::handle_key_left_arrow(), gui2::listbox::handle_key_right_arrow(), and signal_handler_sdl_key_down().

◆ handle_key_page_down()

void gui2::scrollbar_container::handle_key_page_down	(	SDL_Keymod	modifier,
		bool &	handled
	)

protectedvirtual

Page down key pressed.

Parameters

modifier	The SDL keyboard modifier when the key was pressed.
handled	If the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Definition at line 1021 of file scrollbar_container.cpp.

References gui2::scrollbar_base::JUMP_FORWARD, gui2::scrollbar_base::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by signal_handler_sdl_key_down().

◆ handle_key_page_up()

void gui2::scrollbar_container::handle_key_page_up	(	SDL_Keymod	modifier,
		bool &	handled
	)

protectedvirtual

Page up key pressed.

Parameters

modifier	The SDL keyboard modifier when the key was pressed.
handled	If the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Definition at line 1011 of file scrollbar_container.cpp.

References gui2::scrollbar_base::JUMP_BACKWARDS, gui2::scrollbar_base::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by signal_handler_sdl_key_down().

◆ handle_key_right_arrow()

void gui2::scrollbar_container::handle_key_right_arrow	(	SDL_Keymod	modifier,
		bool &	handled
	)

protectedvirtual

Right arrow key pressed.

Parameters

modifier	The SDL keyboard modifier when the key was pressed.
handled	If the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Reimplemented in gui2::tree_view, and gui2::listbox.

Definition at line 1062 of file scrollbar_container.cpp.

References horizontal_scrollbar_, gui2::scrollbar_base::ITEM_FORWARD, gui2::scrollbar_base::scroll(), and scrollbar_moved().

Referenced by gui2::tree_view::handle_key_right_arrow(), and signal_handler_sdl_key_down().

◆ handle_key_up_arrow()

void gui2::scrollbar_container::handle_key_up_arrow	(	SDL_Keymod	modifier,
		bool &	handled
	)

protectedvirtual

Up arrow key pressed.

Parameters

modifier	The SDL keyboard modifier when the key was pressed.
handled	If the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Reimplemented in gui2::tree_view, and gui2::listbox.

Definition at line 1032 of file scrollbar_container.cpp.

References gui2::scrollbar_base::ITEM_BACKWARDS, gui2::scrollbar_base::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by gui2::listbox::handle_key_down_arrow(), gui2::listbox::handle_key_up_arrow(), gui2::tree_view::handle_key_up_arrow(), and signal_handler_sdl_key_down().

◆ horizontal_scrollbar()

scrollbar_base* gui2::scrollbar_container::horizontal_scrollbar ( )

inline

Definition at line 569 of file scrollbar_container.hpp.

References horizontal_scrollbar_.

Referenced by gui2::scroll_text::get_horizontal_position().

◆ horizontal_scrollbar_moved()

void gui2::scrollbar_container::horizontal_scrollbar_moved ( )

inline

Definition at line 249 of file scrollbar_container.hpp.

References scrollbar_moved().

Referenced by finalize_setup(), gui2::tree_view::layout_children(), and gui2::tree_view::resize_content().

◆ impl_draw_children()

void gui2::scrollbar_container::impl_draw_children ( )

overrideprivatevirtual

See widget::impl_draw_children.

Reimplemented from gui2::container_base.

Definition at line 804 of file scrollbar_container.cpp.

References content_grid_, gui2::widget::get_visible(), gui2::container_base::impl_draw_children(), and gui2::widget::visible.

◆ layout_children()

void gui2::scrollbar_container::layout_children ( )

overrideprivatevirtual

See widget::layout_children.

Reimplemented from gui2::container_base.

Reimplemented in gui2::tree_view.

Definition at line 814 of file scrollbar_container.cpp.

References content_grid_, and gui2::container_base::layout_children().

◆ layout_initialize()

void gui2::scrollbar_container::layout_initialize ( const bool full_initialization )

overridevirtual

See widget::layout_initialize.

Reimplemented from gui2::container_base.

Definition at line 114 of file scrollbar_container.cpp.

References ALWAYS_VISIBLE, AUTO_VISIBLE, content_grid_, gui2::widget::hidden, horizontal_scrollbar_grid_, horizontal_scrollbar_mode_, gui2::widget::invisible, gui2::container_base::layout_initialize(), gui2::widget::set_visible(), vertical_scrollbar_grid_, vertical_scrollbar_mode_, and gui2::widget::visible.

Referenced by gui2::tree_view_node::add_child_impl(), and gui2::tree_view_node::replace_children().

◆ move_viewport()

void gui2::scrollbar_container::move_viewport	(	const int	pixels_x,
		const int	pixels_y
	)

To be called after the scollbar moves manually (by pixel) to move the viewport.

Shifts the viewport origin pixels_x left and pixels_y right.

Definition at line 1089 of file scrollbar_container.cpp.

References content_, content_grid_, content_visible_area_, gui2::widget::get_x(), gui2::widget::get_y(), gui2::widget::queue_redraw(), and set_scrollbar_button_status().

Referenced by scroll_horizontal_scrollbar_by(), scroll_vertical_scrollbar_by(), and scrollbar_moved().

◆ place()

void gui2::scrollbar_container::place	(	const point &	origin,
		const point &	size
	)

overridevirtual

See widget::place.

Reimplemented from gui2::container_base.

Reimplemented in gui2::scroll_text, and gui2::listbox.

Definition at line 401 of file scrollbar_container.cpp.

References content_, content_grid_, content_visible_area_, gui2::widget::get_height(), gui2::widget::get_origin(), gui2::widget::get_rectangle(), gui2::widget::get_width(), horizontal_scrollbar_, horizontal_scrollbar_grid_, horizontal_scrollbar_mode_, gui2::container_base::place(), set_content_size(), set_scrollbar_button_status(), gui2::set_scrollbar_mode(), utf8::size(), vertical_scrollbar_, vertical_scrollbar_grid_, and vertical_scrollbar_mode_.

Referenced by content_resize_request(), gui2::listbox::place(), gui2::scroll_text::place(), and gui2::scroll_label::set_label().

◆ request_reduce_height()

void gui2::scrollbar_container::request_reduce_height ( const unsigned maximum_height )

overridevirtual

See widget::request_reduce_height.

Todo:: Evaluate whether sizing hints are required.

Reimplemented from gui2::container_base.

Definition at line 155 of file scrollbar_container.cpp.

References ALWAYS_INVISIBLE, content_grid_, DBG_GUI_L, gui2::widget::get_best_size(), gui2::widget::get_visible(), horizontal_scrollbar_grid_, gui2::widget::invisible, LOG_HEADER, gui2::widget::set_layout_size(), gui2::widget::set_visible(), utf8::size(), vertical_scrollbar_grid_, vertical_scrollbar_mode_, and gui2::widget::visible.

◆ request_reduce_width()

void gui2::scrollbar_container::request_reduce_width ( const unsigned maximum_width )

overridevirtual

◆ scroll_horizontal_scrollbar()

void gui2::scrollbar_container::scroll_horizontal_scrollbar ( const scrollbar_base::scroll_mode scroll )

Scrolls the horizontal scrollbar.

Parameters

scroll The position to scroll to.

Definition at line 966 of file scrollbar_container.cpp.

References horizontal_scrollbar_, gui2::scrollbar_base::scroll(), and scrollbar_moved().

Referenced by finalize_setup(), and gui2::scroll_text::place().

◆ scroll_horizontal_scrollbar_by()

void gui2::scrollbar_container::scroll_horizontal_scrollbar_by ( const int pixels )

Scrolls the horizontal scrollbar by pixel.

Parameters

pixels The number of pixels the bar scrolls by.

Definition at line 982 of file scrollbar_container.cpp.

References horizontal_scrollbar_, move_viewport(), and gui2::scrollbar_base::scroll_by().

Referenced by gui2::scroll_text::place().

◆ scroll_vertical_scrollbar()

void gui2::scrollbar_container::scroll_vertical_scrollbar ( const scrollbar_base::scroll_mode scroll )

Scrolls the vertical scrollbar.

Parameters

scroll The position to scroll to.

Definition at line 958 of file scrollbar_container.cpp.

References gui2::scrollbar_base::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by gui2::chatbox::append_to_chatbox(), finalize_setup(), gui2::dialogs::lua_interpreter::view::pg_down(), gui2::dialogs::lua_interpreter::view::pg_up(), gui2::scroll_text::place(), gui2::dialogs::chat_log::model::populate_chat_message_list(), gui2::dialogs::formula_debugger::pre_show(), gui2::dialogs::help_browser::show_topic(), and gui2::dialogs::lua_interpreter::view::update_contents().

◆ scroll_vertical_scrollbar_by()

void gui2::scrollbar_container::scroll_vertical_scrollbar_by ( const int pixels )

Scrolls the vertical scrollbar by pixel.

Parameters

pixels The number of pixels the bar scrolls by.

Definition at line 974 of file scrollbar_container.cpp.

References move_viewport(), gui2::scrollbar_base::scroll_by(), and vertical_scrollbar_.

Referenced by gui2::scroll_text::place().

◆ scrollbar_moved()

void gui2::scrollbar_container::scrollbar_moved ( )

private

Helper function which needs to be called after the scollbar moves by item.

Definition at line 1072 of file scrollbar_container.cpp.

References ALWAYS_INVISIBLE, gui2::scrollbar_base::get_item_position(), gui2::scrollbar_base::get_step_size(), horizontal_scrollbar_, horizontal_scrollbar_mode_, move_viewport(), vertical_scrollbar_, and vertical_scrollbar_mode_.

Referenced by content_resize_request(), handle_key_down_arrow(), handle_key_end(), handle_key_home(), handle_key_left_arrow(), handle_key_page_down(), handle_key_page_up(), handle_key_right_arrow(), handle_key_up_arrow(), horizontal_scrollbar_moved(), scroll_horizontal_scrollbar(), scroll_vertical_scrollbar(), set_horizontal_scrollbar_item_position(), set_vertical_scrollbar_item_position(), show_content_rect(), signal_handler_sdl_touch_motion(), signal_handler_sdl_wheel_down(), signal_handler_sdl_wheel_left(), signal_handler_sdl_wheel_right(), signal_handler_sdl_wheel_up(), and vertical_scrollbar_moved().

◆ set_content_size()

void gui2::scrollbar_container::set_content_size	(	const point &	origin,
		const point &	size
	)

privatevirtual

Sets the size of the content grid.

This function normally just updates the content grid but can be overridden by a subclass.

Parameters

origin	The origin for the content.
size	The size of the content.

Reimplemented in gui2::listbox.

Definition at line 823 of file scrollbar_container.cpp.

References content_grid_, and utf8::size().

Referenced by place().

◆ set_horizontal_scrollbar_item_position()

void gui2::scrollbar_container::set_horizontal_scrollbar_item_position ( const unsigned position )

Move the horizontal scrollbar to a position.

Parameters

position The position to scroll to.

Definition at line 950 of file scrollbar_container.cpp.

References horizontal_scrollbar_, scrollbar_moved(), and gui2::scrollbar_base::set_item_position().

Referenced by gui2::listbox::place().

◆ set_horizontal_scrollbar_mode()

void gui2::scrollbar_container::set_horizontal_scrollbar_mode ( const scrollbar_mode scrollbar_mode )

Note: shouldn't be called after being shown in a dialog.

Definition at line 797 of file scrollbar_container.cpp.

References horizontal_scrollbar_mode_.

◆ set_origin()

void gui2::scrollbar_container::set_origin ( const point & origin )

overridevirtual

See widget::set_origin.

Reimplemented from gui2::container_base.

Definition at line 446 of file scrollbar_container.cpp.

References content_, content_grid_, content_visible_area_, gui2::widget::get_origin(), and gui2::container_base::set_origin().

◆ set_scrollbar_button_status()

void gui2::scrollbar_container::set_scrollbar_button_status ( )

protected

Sets the status of the scrollbar buttons.

This is needed after the scrollbar moves so the status of the buttons will be active or inactive as needed.

Todo:: scrollbar visibility.

Todo:: scrollbar visibility.

Definition at line 872 of file scrollbar_container.cpp.

References gui2::scrollbar_base::all_items_visible(), gui2::scrollbar_base::at_begin(), gui2::scrollbar_base::at_end(), gui2::widget::find_widget(), horizontal_scrollbar_, horizontal_scrollbar_grid_, gui2::button::set_active(), gui2::scrollbar_base::set_active(), vertical_scrollbar_, and vertical_scrollbar_grid_.

Referenced by content_resize_request(), move_viewport(), and place().

◆ set_vertical_scrollbar_item_position()

void gui2::scrollbar_container::set_vertical_scrollbar_item_position ( const unsigned position )

Move the vertical scrollbar to a position.

Parameters

position The position to scroll to.

Definition at line 935 of file scrollbar_container.cpp.

References scrollbar_moved(), gui2::scrollbar_base::set_item_position(), and vertical_scrollbar_.

Referenced by gui2::chatbox::append_to_chatbox(), gui2::listbox::place(), gui2::dialogs::end_credits::update(), and gui2::lobby_player_list_helper::update().

◆ set_vertical_scrollbar_mode()

void gui2::scrollbar_container::set_vertical_scrollbar_mode ( const scrollbar_mode scrollbar_mode )

Note: shouldn't be called after being shown in a dialog.

Definition at line 790 of file scrollbar_container.cpp.

References vertical_scrollbar_mode_.

Referenced by gui2::dialogs::lua_interpreter::view::bind().

◆ set_visible_rectangle()

void gui2::scrollbar_container::set_visible_rectangle ( const SDL_Rect & rectangle )

overridevirtual

See widget::set_visible_rectangle.

Reimplemented from gui2::container_base.

Definition at line 462 of file scrollbar_container.cpp.

References gui2::container_base::set_visible_rectangle().

◆ show_content_rect()

void gui2::scrollbar_container::show_content_rect ( const SDL_Rect & rect )

protected

Shows a certain part of the content.

When the part to be shown is bigger as the visible viewport the top left of the wanted rect will be the top left of the viewport.

Parameters

rect	The rect which should be visible.

Definition at line 828 of file scrollbar_container.cpp.

References content_, gui2::widget::get_height(), gui2::scrollbar_base::get_item_position(), gui2::widget::get_width(), gui2::widget::get_x(), gui2::widget::get_y(), horizontal_scrollbar_, scrollbar_moved(), gui2::scrollbar_base::set_item_position(), and vertical_scrollbar_.

Referenced by gui2::tree_view::handle_up_down_arrow(), gui2::listbox::list_item_clicked(), gui2::listbox::place(), and gui2::listbox::update_visible_area_on_key_event().

◆ signal_handler_sdl_key_down()

void gui2::scrollbar_container::signal_handler_sdl_key_down	(	const event::ui_event	event,
		bool &	handled,
		const SDL_Keycode	key,
		SDL_Keymod	modifier
	)

private

Definition at line 1115 of file scrollbar_container.cpp.

References DBG_GUI_E, handle_key_down_arrow(), handle_key_end(), handle_key_home(), handle_key_left_arrow(), handle_key_page_down(), handle_key_page_up(), handle_key_right_arrow(), handle_key_up_arrow(), and LOG_HEADER.

Referenced by scrollbar_container().

◆ signal_handler_sdl_touch_motion()

void gui2::scrollbar_container::signal_handler_sdl_touch_motion	(	const event::ui_event	event,
		bool &	handled,
		const point &	position,
		const point &	distance
	)

private

Definition at line 1211 of file scrollbar_container.cpp.

References DBG_GUI_E, gui2::widget::get_visible(), horizontal_scrollbar_, horizontal_scrollbar_grid_, LOG_HEADER, gui2::scrollbar_base::scroll_by(), scrollbar_moved(), vertical_scrollbar_, vertical_scrollbar_grid_, and gui2::widget::visible.

Referenced by scrollbar_container().

◆ signal_handler_sdl_wheel_down()

void gui2::scrollbar_container::signal_handler_sdl_wheel_down	(	const event::ui_event	event,
		bool &	handled
	)

private

Definition at line 1171 of file scrollbar_container.cpp.

References DBG_GUI_E, gui2::widget::get_visible(), gui2::scrollbar_base::HALF_JUMP_FORWARD, LOG_HEADER, gui2::scrollbar_base::scroll(), scrollbar_moved(), vertical_scrollbar_, vertical_scrollbar_grid_, and gui2::widget::visible.

Referenced by scrollbar_container().

◆ signal_handler_sdl_wheel_left()

void gui2::scrollbar_container::signal_handler_sdl_wheel_left	(	const event::ui_event	event,
		bool &	handled
	)

private

Definition at line 1184 of file scrollbar_container.cpp.

References DBG_GUI_E, gui2::widget::get_visible(), gui2::scrollbar_base::HALF_JUMP_BACKWARDS, horizontal_scrollbar_, horizontal_scrollbar_grid_, LOG_HEADER, gui2::scrollbar_base::scroll(), scrollbar_moved(), and gui2::widget::visible.

Referenced by scrollbar_container().

◆ signal_handler_sdl_wheel_right()

void gui2::scrollbar_container::signal_handler_sdl_wheel_right	(	const event::ui_event	event,
		bool &	handled
	)

private

Definition at line 1197 of file scrollbar_container.cpp.

References DBG_GUI_E, gui2::widget::get_visible(), gui2::scrollbar_base::HALF_JUMP_FORWARD, horizontal_scrollbar_, horizontal_scrollbar_grid_, LOG_HEADER, gui2::scrollbar_base::scroll(), scrollbar_moved(), and gui2::widget::visible.

Referenced by scrollbar_container().

◆ signal_handler_sdl_wheel_up()

void gui2::scrollbar_container::signal_handler_sdl_wheel_up	(	const event::ui_event	event,
		bool &	handled
	)

private

Definition at line 1158 of file scrollbar_container.cpp.

References DBG_GUI_E, gui2::widget::get_visible(), gui2::scrollbar_base::HALF_JUMP_BACKWARDS, LOG_HEADER, gui2::scrollbar_base::scroll(), scrollbar_moved(), vertical_scrollbar_, vertical_scrollbar_grid_, and gui2::widget::visible.

Referenced by scrollbar_container().

◆ type()

const std::string & gui2::scrollbar_container::type ( )

static

Static type getter that does not rely on the widget being constructed.

Definition at line 1104 of file scrollbar_container.cpp.

Referenced by get_control_type().

◆ vertical_scrollbar()

scrollbar_base* gui2::scrollbar_container::vertical_scrollbar ( )

inline

Definition at line 574 of file scrollbar_container.hpp.

References vertical_scrollbar_.

Referenced by gui2::scroll_text::get_vertical_position(), and gui2::dialogs::drop_down_menu::mouse_up_callback().

◆ vertical_scrollbar_at_end()

bool gui2::scrollbar_container::vertical_scrollbar_at_end ( )

Definition at line 921 of file scrollbar_container.cpp.

References gui2::scrollbar_base::at_end(), and vertical_scrollbar_.

Referenced by gui2::chatbox::append_to_chatbox().

◆ vertical_scrollbar_moved()

void gui2::scrollbar_container::vertical_scrollbar_moved ( )

inline

Callback when the scrollbar moves (NOTE maybe only one callback needed).

Maybe also make protected or private and add a friend.

Definition at line 244 of file scrollbar_container.hpp.

References scrollbar_moved().

Referenced by finalize_setup().

Friends And Related Function Documentation

◆ debug_layout_graph

friend class debug_layout_graph

friend

Definition at line 43 of file scrollbar_container.hpp.

◆ implementation::builder_scroll_label

friend struct implementation::builder_scroll_label

friend

Definition at line 45 of file scrollbar_container.hpp.

◆ implementation::builder_scrollbar_panel

friend struct implementation::builder_scrollbar_panel

friend

Definition at line 46 of file scrollbar_container.hpp.

◆ listbox

friend class listbox

friend

Definition at line 47 of file scrollbar_container.hpp.

◆ scrollbar_container_implementation

friend struct scrollbar_container_implementation

friend

Definition at line 49 of file scrollbar_container.hpp.

◆ tree_view

friend class tree_view

friend

Definition at line 48 of file scrollbar_container.hpp.

Member Data Documentation

◆ content_

spacer* gui2::scrollbar_container::content_

private

Dummy spacer to hold the contents location.

Definition at line 506 of file scrollbar_container.hpp.

Referenced by content_resize_height(), content_resize_request(), content_resize_width(), finalize_setup(), gui2::scrollbar_container_implementation::find_at(), move_viewport(), place(), set_origin(), and show_content_rect().

◆ content_grid_

std::unique_ptr<grid> gui2::scrollbar_container::content_grid_

private

◆ content_visible_area_

SDL_Rect gui2::scrollbar_container::content_visible_area_

private

Cache for the visible area for the content.

The visible area for the content needs to be updated when scrolling.

Definition at line 513 of file scrollbar_container.hpp.

Referenced by content_visible_area(), gui2::tree_view::layout_children(), move_viewport(), place(), set_origin(), and gui2::listbox::update_layout().

◆ horizontal_scrollbar_

scrollbar_base * gui2::scrollbar_container::horizontal_scrollbar_

private

Definition at line 500 of file scrollbar_container.hpp.

Referenced by content_resize_width(), finalize_setup(), get_horizontal_scrollbar_item_position(), handle_key_home(), handle_key_left_arrow(), handle_key_right_arrow(), horizontal_scrollbar(), place(), scroll_horizontal_scrollbar(), scroll_horizontal_scrollbar_by(), scrollbar_moved(), set_horizontal_scrollbar_item_position(), set_scrollbar_button_status(), show_content_rect(), signal_handler_sdl_touch_motion(), signal_handler_sdl_wheel_left(), and signal_handler_sdl_wheel_right().

◆ horizontal_scrollbar_grid_

grid * gui2::scrollbar_container::horizontal_scrollbar_grid_

private

Definition at line 497 of file scrollbar_container.hpp.

Referenced by calculate_best_size(), content_resize_request(), content_resize_width(), finalize_setup(), get_horizontal_scrollbar_grid(), layout_initialize(), place(), request_reduce_height(), request_reduce_width(), set_scrollbar_button_status(), signal_handler_sdl_touch_motion(), signal_handler_sdl_wheel_left(), and signal_handler_sdl_wheel_right().

◆ horizontal_scrollbar_mode_

scrollbar_mode gui2::scrollbar_container::horizontal_scrollbar_mode_

private

Definition at line 494 of file scrollbar_container.hpp.

Referenced by content_resize_request(), content_resize_width(), get_horizontal_scrollbar_mode(), layout_initialize(), place(), request_reduce_width(), scrollbar_moved(), and set_horizontal_scrollbar_mode().

◆ state_

state_t gui2::scrollbar_container::state_

private

Current state of the widget.

The state of the widget determines what to render and how the widget reacts to certain 'events'.

Definition at line 486 of file scrollbar_container.hpp.

Referenced by get_active(), and get_state().

◆ vertical_scrollbar_

scrollbar_base* gui2::scrollbar_container::vertical_scrollbar_

private

◆ vertical_scrollbar_grid_

grid* gui2::scrollbar_container::vertical_scrollbar_grid_

private

These are valid after finalize_setup().

Definition at line 497 of file scrollbar_container.hpp.

Referenced by calculate_best_size(), content_resize_height(), content_resize_request(), finalize_setup(), get_vertical_scrollbar_grid(), layout_initialize(), place(), request_reduce_height(), request_reduce_width(), set_scrollbar_button_status(), signal_handler_sdl_touch_motion(), signal_handler_sdl_wheel_down(), and signal_handler_sdl_wheel_up().

◆ vertical_scrollbar_mode_

scrollbar_mode gui2::scrollbar_container::vertical_scrollbar_mode_

private

The mode of how to show the scrollbar.

This value should only be modified before showing, doing it while showing results in UB.

Definition at line 494 of file scrollbar_container.hpp.

Referenced by content_resize_height(), content_resize_request(), get_vertical_scrollbar_mode(), layout_initialize(), place(), request_reduce_height(), scrollbar_moved(), and set_vertical_scrollbar_mode().

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

gui/widgets/scrollbar_container.hpp
gui/widgets/scrollbar_container.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ scrollbar_mode

◆ state_t

Constructor & Destructor Documentation

◆ scrollbar_container()

◆ ~scrollbar_container()

Member Function Documentation

◆ calculate_best_size()

◆ can_wrap()

◆ content_grid() [1/2]

◆ content_grid() [2/2]

◆ content_resize_height()

◆ content_resize_request() [1/2]

◆ content_resize_request() [2/2]

◆ content_resize_width()

◆ content_visible_area()

◆ create_walker()

◆ disable_click_dismiss()

◆ finalize_setup()

◆ finalize_subclass()

◆ find() [1/2]

◆ find() [2/2]

◆ find_at() [1/2]

◆ find_at() [2/2]

◆ get_active()

◆ get_control_type()

◆ get_horizontal_scrollbar_grid()

◆ get_horizontal_scrollbar_item_position()

◆ get_horizontal_scrollbar_mode()

◆ get_state()

◆ get_vertical_scrollbar_grid()

◆ get_vertical_scrollbar_item_position()

◆ get_vertical_scrollbar_mode()

◆ handle_key_down_arrow()

◆ handle_key_end()

◆ handle_key_home()

◆ handle_key_left_arrow()

◆ handle_key_page_down()

◆ handle_key_page_up()

◆ handle_key_right_arrow()

◆ handle_key_up_arrow()

◆ horizontal_scrollbar()

◆ horizontal_scrollbar_moved()

◆ impl_draw_children()

◆ layout_children()

◆ layout_initialize()

◆ move_viewport()

◆ place()

◆ request_reduce_height()

◆ request_reduce_width()

◆ scroll_horizontal_scrollbar()

◆ scroll_horizontal_scrollbar_by()

◆ scroll_vertical_scrollbar()

◆ scroll_vertical_scrollbar_by()

◆ scrollbar_moved()

◆ set_content_size()

◆ set_horizontal_scrollbar_item_position()

◆ set_horizontal_scrollbar_mode()

◆ set_origin()

◆ set_scrollbar_button_status()

◆ set_vertical_scrollbar_item_position()

◆ set_vertical_scrollbar_mode()

◆ set_visible_rectangle()

◆ show_content_rect()

◆ signal_handler_sdl_key_down()

◆ signal_handler_sdl_touch_motion()

◆ signal_handler_sdl_wheel_down()

◆ signal_handler_sdl_wheel_left()

◆ signal_handler_sdl_wheel_right()

◆ signal_handler_sdl_wheel_up()

◆ type()