Base class for a scroll bar. More...

#include <scrollbar.hpp>

Inheritance diagram for gui2::scrollbar_base:

Public Types
enum	scroll_mode { BEGIN , ITEM_BACKWARDS , HALF_JUMP_BACKWARDS , JUMP_BACKWARDS , END , ITEM_FORWARD , HALF_JUMP_FORWARD , JUMP_FORWARD }
	scroll 'step size'. More...

enum	state_t { ENABLED , DISABLED , PRESSED , FOCUSED }
	Possible states of the widget. 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_base (const implementation::builder_styled_widget &builder, const std::string &control_type)

void	scroll (const scroll_mode scroll)
	Sets the item position. More...

void	scroll_by (const int pixels)

bool	at_begin () const
	Is the positioner at the beginning of the scrollbar? More...

bool	at_end () const
	Is the positioner at the and of the scrollbar? More...

bool	all_items_visible () const
	Are all items visible? More...

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

virtual void	set_active (const bool active) override
	See styled_widget::set_active. 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...

void	set_item_count (const unsigned item_count)

unsigned	get_item_count () const

void	set_item_position (const unsigned item_position)
	Note the position isn't guaranteed to be the wanted position the step size is honored. More...

unsigned	get_item_position () const

unsigned	get_visible_items () const

void	set_visible_items (const unsigned visible_items)

unsigned	get_step_size () const

void	set_step_size (const unsigned step_size)

float	get_pixels_per_step () const

unsigned	get_positioner_offset () const

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

virtual iteration::walker_ptr	create_walker () override
	See widget::create_walker. 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...

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

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

virtual void	request_reduce_height (const unsigned maximum_height) override
	See widget::request_reduce_height. 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	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...

virtual const std::string &	get_control_type () const =0
	Returns the type of this styled_widget. 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 ()

virtual void	demand_reduce_width (const unsigned maximum_width)
	Tries to reduce the width of a widget. More...

virtual void	demand_reduce_height (const unsigned maximum_height)
	Tries to reduce the height of a widget. More...

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 bool	can_wrap () const
	Can the widget wrap. More...

virtual void	set_origin (const point &origin)
	Sets the origin of the 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...

virtual void	layout_children ()
	Allows a widget to update its children. 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...

virtual void	set_visible_rectangle (const SDL_Rect &rectangle)
	Sets the visible rectangle for a 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)

virtual bool	has_widget (const widget &widget) const
	Does the widget contain the widget. More...

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)

Protected Member Functions
void	finalize_setup ()

unsigned	get_positioner_length () const

point	get_mouse_position_last_move () const

virtual void	update_canvas () override
	See styled_widget::update_canvas. More...

virtual void	child_callback_positioner_moved ()
	Callback for subclasses to get notified about positioner movement. More...

Protected Member Functions inherited from gui2::styled_widget
virtual point	calculate_best_size () const override
	See widget::calculate_best_size. More...

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)

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 Member Functions
void	set_state (const state_t state)

virtual unsigned	get_length () const =0
	Get the length of the scrollbar. More...

virtual unsigned	minimum_positioner_length () const =0
	The minimum length of the positioner. More...

virtual unsigned	maximum_positioner_length () const =0
	The maximum length of the positioner. More...

virtual unsigned	offset_before () const =0
	The number of pixels we can't use since they're used for borders. More...

virtual unsigned	offset_after () const =0
	The number of pixels we can't use since they're used for borders. More...

virtual bool	on_positioner (const point &coordinate) const =0
	Is the coordinate on the positioner? More...

virtual int	on_bar (const point &coordinate) const =0
	Is the coordinate on the bar? More...

virtual bool	in_orthogonal_range (const point &coordinate) const =0
	Is the coordinate in the bar's orthogonal range? More...

virtual int	get_length_difference (const point &original, const point &current) const =0
	Gets the relevant difference in between the two positions. More...

void	recalculate ()
	Updates the scrollbar. More...

void	recalculate_positioner ()
	Updates the positioner. More...

virtual void	move_positioner (const int distance)
	Moves the positioner. More...

void	signal_handler_mouse_enter (const event::ui_event event, bool &handled, bool &halt)

void	signal_handler_mouse_motion (const event::ui_event event, bool &handled, bool &halt, const point &coordinate)

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

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

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

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

unsigned	item_count_
	The number of items the scrollbar 'holds'. More...

unsigned	item_position_
	The item the positioner is at, starts at 0. More...

unsigned	visible_items_
	The number of items which can be shown at the same time. More...

unsigned	step_size_
	Number of items moved when scrolling. More...

float	pixels_per_step_
	Number of pixels per step. More...

point	mouse_
	The position the mouse was at the last movement. More...

unsigned	positioner_offset_
	The start offset of the positioner. More...

unsigned	positioner_length_
	The current length of the positioner. More...

Friends
class	slider

Detailed Description

Base class for a scroll bar.

class will be subclassed for the horizontal and vertical scroll bar. It might be subclassed for a slider class.

To make this class generic we talk a lot about offset and length and use pure virtual functions. The classes implementing us can use the heights or widths, whichever is applicable.

The NOTIFY_MODIFIED event is send when the position of scrollbar is changed.

Common signal handlers:

connect_signal_notify_modified

Definition at line 38 of file scrollbar.hpp.

Member Enumeration Documentation

◆ scroll_mode

enum gui2::scrollbar_base::scroll_mode

scroll 'step size'.

When scrolling we always scroll a 'fixed' amount, these are the parameters for these amounts.

Enumerator
BEGIN	Go to begin position.
ITEM_BACKWARDS	Go one item towards the begin.
HALF_JUMP_BACKWARDS	Go half the visible items towards the begin.
JUMP_BACKWARDS	Go the visible items towards the begin.
END	Go to the end position.
ITEM_FORWARD	Go one item towards the end.
HALF_JUMP_FORWARD	Go half the visible items towards the end.
JUMP_FORWARD

Definition at line 52 of file scrollbar.hpp.

◆ state_t

enum gui2::scrollbar_base::state_t

Possible states of the widget.

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

Enumerator
ENABLED
DISABLED
PRESSED
FOCUSED

Definition at line 118 of file scrollbar.hpp.

Constructor & Destructor Documentation

◆ scrollbar_base()

gui2::scrollbar_base::scrollbar_base	(	const implementation::builder_styled_widget &	builder,
		const std::string &	control_type
	)

Definition at line 31 of file scrollbar.cpp.

References signal_handler_left_button_down(), signal_handler_left_button_up(), signal_handler_mouse_enter(), signal_handler_mouse_leave(), and signal_handler_mouse_motion().

Member Function Documentation

◆ all_items_visible()

bool gui2::scrollbar_base::all_items_visible ( ) const

inline

Are all items visible?

Definition at line 92 of file scrollbar.hpp.

References item_count_, and visible_items_.

Referenced by set_item_position(), and gui2::scrollbar_container::set_scrollbar_button_status().

◆ at_begin()

bool gui2::scrollbar_base::at_begin ( ) const

inline

Is the positioner at the beginning of the scrollbar?

Definition at line 76 of file scrollbar.hpp.

References item_position_.

Referenced by gui2::scrollbar_container::set_scrollbar_button_status().

◆ at_end()

bool gui2::scrollbar_base::at_end ( ) const

inline

Is the positioner at the and of the scrollbar?

Note both begin and end might be true at the same time.

Definition at line 86 of file scrollbar.hpp.

References item_count_, item_position_, and visible_items_.

Referenced by gui2::scrollbar_container::set_scrollbar_button_status(), and gui2::scrollbar_container::vertical_scrollbar_at_end().

◆ child_callback_positioner_moved()

virtual void gui2::scrollbar_base::child_callback_positioner_moved ( )

inlineprotectedvirtual

Callback for subclasses to get notified about positioner movement.

Todo:: This is a kind of hack due to the fact there's no simple callback slot mechanism. See whether we can implement a generic way to attach callback which would remove quite some extra code.

Definition at line 211 of file scrollbar.hpp.

Referenced by move_positioner().

◆ finalize_setup()

void gui2::scrollbar_base::finalize_setup ( )

protected

Definition at line 57 of file scrollbar.cpp.

References gui2::styled_widget::get_canvases(), offset_after(), and offset_before().

◆ get_active()

bool gui2::scrollbar_base::get_active ( ) const

overridevirtual

See styled_widget::get_active.

Implements gui2::styled_widget.

Definition at line 142 of file scrollbar.cpp.

References DISABLED, and state_.

Referenced by set_active().

◆ get_item_count()

unsigned gui2::scrollbar_base::get_item_count ( ) const

inline

Definition at line 132 of file scrollbar.hpp.

References item_count_.

Referenced by gui2::adjust_scrollbar_mode().

◆ get_item_position()

unsigned gui2::scrollbar_base::get_item_position ( ) const

inline

Definition at line 142 of file scrollbar.hpp.

References item_position_.

Referenced by gui2::adjust_scrollbar_mode(), gui2::scrollbar_container::get_horizontal_scrollbar_item_position(), gui2::scrollbar_container::get_vertical_scrollbar_item_position(), gui2::scrollbar_container::scrollbar_moved(), and gui2::scrollbar_container::show_content_rect().

◆ get_length()

virtual unsigned gui2::scrollbar_base::get_length ( ) const

privatepure virtual

Get the length of the scrollbar.

Implemented in gui2::vertical_scrollbar, and gui2::horizontal_scrollbar.

Referenced by move_positioner(), and recalculate().

◆ get_length_difference()

virtual int gui2::scrollbar_base::get_length_difference	(	const point &	original,
		const point &	current
	)		const

privatepure virtual

Gets the relevant difference in between the two positions.

This function is used to determine how much the positioner needs to be moved.

Implemented in gui2::vertical_scrollbar, and gui2::horizontal_scrollbar.

Referenced by signal_handler_mouse_motion().

◆ get_mouse_position_last_move()

point gui2::scrollbar_base::get_mouse_position_last_move ( ) const

inlineprotected

Definition at line 192 of file scrollbar.hpp.

References mouse_.

◆ get_pixels_per_step()

float gui2::scrollbar_base::get_pixels_per_step ( ) const

inline

Definition at line 174 of file scrollbar.hpp.

References pixels_per_step_.

◆ get_positioner_length()

unsigned gui2::scrollbar_base::get_positioner_length ( ) const

inlineprotected

Definition at line 187 of file scrollbar.hpp.

References positioner_length_.

Referenced by gui2::horizontal_scrollbar::on_bar(), gui2::vertical_scrollbar::on_bar(), gui2::horizontal_scrollbar::on_positioner(), and gui2::vertical_scrollbar::on_positioner().

◆ get_positioner_offset()

unsigned gui2::scrollbar_base::get_positioner_offset ( ) const

inline

Definition at line 179 of file scrollbar.hpp.

References positioner_offset_.

Referenced by gui2::scroll_text::get_horizontal_position(), gui2::scroll_text::get_vertical_position(), gui2::horizontal_scrollbar::on_bar(), gui2::vertical_scrollbar::on_bar(), gui2::horizontal_scrollbar::on_positioner(), and gui2::vertical_scrollbar::on_positioner().

◆ get_state()

unsigned gui2::scrollbar_base::get_state ( ) const

overridevirtual

See styled_widget::get_state.

Implements gui2::styled_widget.

Definition at line 147 of file scrollbar.cpp.

References state_.

Referenced by gui2::dialogs::drop_down_menu::mouse_up_callback().

◆ get_step_size()

unsigned gui2::scrollbar_base::get_step_size ( ) const

inline

Definition at line 158 of file scrollbar.hpp.

References step_size_.

Referenced by gui2::scrollbar_container::scrollbar_moved().

◆ get_visible_items()

unsigned gui2::scrollbar_base::get_visible_items ( ) const

inline

Definition at line 147 of file scrollbar.hpp.

References visible_items_.

◆ in_orthogonal_range()

virtual bool gui2::scrollbar_base::in_orthogonal_range ( const point & coordinate ) const

privatepure virtual

Is the coordinate in the bar's orthogonal range?

Parameters

coordinate Coordinate to test whether it's in-range.

Returns: Whether the location is in the bar's. orthogonal range.

Implemented in gui2::vertical_scrollbar, and gui2::horizontal_scrollbar.

Referenced by signal_handler_mouse_motion().

◆ maximum_positioner_length()

virtual unsigned gui2::scrollbar_base::maximum_positioner_length ( ) const

privatepure virtual

The maximum length of the positioner.

Implemented in gui2::vertical_scrollbar, and gui2::horizontal_scrollbar.

Referenced by move_positioner(), recalculate(), and recalculate_positioner().

◆ minimum_positioner_length()

virtual unsigned gui2::scrollbar_base::minimum_positioner_length ( ) const

privatepure virtual

The minimum length of the positioner.

Implemented in gui2::vertical_scrollbar, and gui2::horizontal_scrollbar.

Referenced by move_positioner(), recalculate(), and recalculate_positioner().

◆ move_positioner()

void gui2::scrollbar_base::move_positioner ( const int distance )

privatevirtual

Moves the positioner.

Parameters

distance The distance moved, negative to begin, positive to end.

Definition at line 283 of file scrollbar.cpp.

References child_callback_positioner_moved(), gui2::event::dispatcher::fire(), get_length(), item_count_, item_position_, maximum_positioner_length(), minimum_positioner_length(), gui2::event::NOTIFY_MODIFIED, offset_after(), offset_before(), pixels_per_step_, PLAIN_LOG, positioner_length_, positioner_offset_, step_size_, update_canvas(), and visible_items_.

Referenced by scroll_by(), and signal_handler_mouse_motion().

◆ offset_after()

virtual unsigned gui2::scrollbar_base::offset_after ( ) const

privatepure virtual

The number of pixels we can't use since they're used for borders.

These are the pixels after the widget (right side if horizontal, bottom side if vertical).

Implemented in gui2::vertical_scrollbar, and gui2::horizontal_scrollbar.

Referenced by finalize_setup(), move_positioner(), and recalculate().

◆ offset_before()

virtual unsigned gui2::scrollbar_base::offset_before ( ) const

privatepure virtual

The number of pixels we can't use since they're used for borders.

These are the pixels before the widget (left side if horizontal, top side if vertical).

Implemented in gui2::vertical_scrollbar, and gui2::horizontal_scrollbar.

Referenced by finalize_setup(), move_positioner(), and recalculate().

◆ on_bar()

virtual int gui2::scrollbar_base::on_bar ( const point & coordinate ) const

privatepure virtual

Is the coordinate on the bar?

Parameters

coordinate Coordinate to test whether it's on the bar.

Returns: Whether the location on the bar is.

Return values

-1	Coordinate is on the bar before positioner.
0	Coordinate is not on the bar.
1	Coordinate is on the bar after the positioner.

Implemented in gui2::vertical_scrollbar, and gui2::horizontal_scrollbar.

Referenced by signal_handler_left_button_down().

◆ on_positioner()

virtual bool gui2::scrollbar_base::on_positioner ( const point & coordinate ) const

privatepure virtual

Is the coordinate on the positioner?

Parameters

coordinate Coordinate to test whether it's on the positioner.

Returns: Whether the location on the positioner is.

Implemented in gui2::vertical_scrollbar, and gui2::horizontal_scrollbar.

Referenced by signal_handler_left_button_down(), signal_handler_left_button_up(), and signal_handler_mouse_motion().

◆ place()

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

overridevirtual

See widget::place.

Reimplemented from gui2::styled_widget.

Definition at line 127 of file scrollbar.cpp.

References gui2::styled_widget::place(), recalculate(), and utf8::size().

◆ recalculate()

void gui2::scrollbar_base::recalculate ( )

private

Updates the scrollbar.

Needs to be called when something changes eg number of items or available size. It can only be called once we have a size otherwise we can't calculate a thing.

Todo:: In the MP lobby it can happen that a listbox has first zero items, then gets filled and since there are no visible items the second assert after this block will be triggered. Use this ugly hack to avoid that case. (This hack also added the gui/widgets/window.hpp include.)

Definition at line 197 of file scrollbar.cpp.

References ERR_GUI_G, get_length(), gui2::widget::get_window(), gui2::window::invalidate_layout(), item_count_, item_position_, LOG_HEADER, maximum_positioner_length(), minimum_positioner_length(), offset_after(), offset_before(), pixels_per_step_, PLAIN_LOG, positioner_length_, positioner_offset_, recalculate_positioner(), set_item_position(), step_size_, update_canvas(), and visible_items_.

Referenced by place(), set_item_count(), set_step_size(), and set_visible_items().

◆ recalculate_positioner()

void gui2::scrollbar_base::recalculate_positioner ( )

private

Updates the positioner.

This is a helper for recalculate().

Definition at line 269 of file scrollbar.cpp.

References maximum_positioner_length(), minimum_positioner_length(), and positioner_length_.

Referenced by recalculate().

◆ scroll()

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

Sets the item position.

We scroll a predefined step.

Parameters

scroll 'step size' to scroll.

Definition at line 71 of file scrollbar.cpp.

References BEGIN, END, gui2::event::dispatcher::fire(), HALF_JUMP_BACKWARDS, HALF_JUMP_FORWARD, ITEM_BACKWARDS, item_count_, ITEM_FORWARD, item_position_, JUMP_BACKWARDS, JUMP_FORWARD, gui2::event::NOTIFY_MODIFIED, set_item_position(), and visible_items_.

◆ scroll_by()

void gui2::scrollbar_base::scroll_by ( const int pixels )

Definition at line 66 of file scrollbar.cpp.

References move_positioner(), and pixels_per_step_.

Referenced by gui2::scrollbar_container::scroll_horizontal_scrollbar_by(), gui2::scrollbar_container::scroll_vertical_scrollbar_by(), and gui2::scrollbar_container::signal_handler_sdl_touch_motion().

◆ set_active()

void gui2::scrollbar_base::set_active ( const bool active )

overridevirtual

See styled_widget::set_active.

Implements gui2::styled_widget.

Definition at line 135 of file scrollbar.cpp.

References DISABLED, ENABLED, get_active(), and set_state().

Referenced by gui2::scrollbar_container::set_scrollbar_button_status().

◆ set_item_count()

void gui2::scrollbar_base::set_item_count ( const unsigned item_count )

inline

Definition at line 127 of file scrollbar.hpp.

References item_count_, and recalculate().

Referenced by gui2::adjust_scrollbar_mode(), and gui2::set_scrollbar_mode().

◆ set_item_position()

void gui2::scrollbar_base::set_item_position ( const unsigned item_position )

Note the position isn't guaranteed to be the wanted position the step size is honored.

The value will be rouded down.

Definition at line 152 of file scrollbar.cpp.

References all_items_visible(), gui2::event::dispatcher::fire(), item_count_, item_position_, gui2::event::NOTIFY_MODIFIED, pixels_per_step_, positioner_offset_, step_size_, update_canvas(), and visible_items_.

Referenced by gui2::adjust_scrollbar_mode(), recalculate(), scroll(), gui2::scrollbar_container::set_horizontal_scrollbar_item_position(), gui2::scrollbar_container::set_vertical_scrollbar_item_position(), and gui2::scrollbar_container::show_content_rect().

◆ set_state()

void gui2::scrollbar_base::set_state ( const state_t state )

private

Definition at line 189 of file scrollbar.cpp.

References gui2::widget::queue_redraw(), and state_.

Referenced by set_active(), signal_handler_left_button_down(), signal_handler_left_button_up(), signal_handler_mouse_leave(), and signal_handler_mouse_motion().

◆ set_step_size()

void gui2::scrollbar_base::set_step_size ( const unsigned step_size )

inline

Definition at line 163 of file scrollbar.hpp.

References recalculate(), and step_size_.

◆ set_visible_items()

void gui2::scrollbar_base::set_visible_items ( const unsigned visible_items )

inline

Definition at line 152 of file scrollbar.hpp.

References recalculate(), and visible_items_.

Referenced by gui2::adjust_scrollbar_mode(), and gui2::set_scrollbar_mode().

◆ signal_handler_left_button_down()

void gui2::scrollbar_base::signal_handler_left_button_down	(	const event::ui_event	event,
		bool &	handled
	)

private

Definition at line 403 of file scrollbar.cpp.

References DBG_GUI_E, gui2::get_mouse_position(), gui2::widget::get_window(), gui2::widget::get_x(), gui2::widget::get_y(), HALF_JUMP_BACKWARDS, HALF_JUMP_FORWARD, LOG_HEADER, mouse_, gui2::window::mouse_capture(), on_bar(), on_positioner(), PRESSED, scroll(), and set_state().

Referenced by scrollbar_base().

◆ signal_handler_left_button_up()

void gui2::scrollbar_base::signal_handler_left_button_up	(	const event::ui_event	event,
		bool &	handled
	)

private

Definition at line 434 of file scrollbar.cpp.

References DBG_GUI_E, ENABLED, FOCUSED, gui2::get_mouse_position(), gui2::widget::get_window(), gui2::widget::get_x(), gui2::widget::get_y(), LOG_HEADER, gui2::window::mouse_capture(), on_positioner(), PRESSED, set_state(), and state_.

Referenced by scrollbar_base().

◆ signal_handler_mouse_enter()

void gui2::scrollbar_base::signal_handler_mouse_enter	(	const event::ui_event	event,
		bool &	handled,
		bool &	halt
	)

private

Definition at line 335 of file scrollbar.cpp.

References DBG_GUI_E, gui2::get_mouse_position(), LOG_HEADER, and signal_handler_mouse_motion().

Referenced by scrollbar_base().

◆ signal_handler_mouse_leave()

void gui2::scrollbar_base::signal_handler_mouse_leave	(	const event::ui_event	event,
		bool &	handled
	)

private

Definition at line 391 of file scrollbar.cpp.

References DBG_GUI_E, ENABLED, FOCUSED, LOG_HEADER, set_state(), and state_.

Referenced by scrollbar_base().

◆ signal_handler_mouse_motion()

void gui2::scrollbar_base::signal_handler_mouse_motion	(	const event::ui_event	event,
		bool &	handled,
		bool &	halt,
		const point &	coordinate
	)

private

Definition at line 345 of file scrollbar.cpp.

References DBG_GUI_E, DISABLED, ENABLED, FOCUSED, get_length_difference(), gui2::widget::get_x(), gui2::widget::get_y(), in_orthogonal_range(), LOG_HEADER, mouse_, move_positioner(), on_positioner(), PRESSED, set_state(), and state_.

Referenced by scrollbar_base(), and signal_handler_mouse_enter().

◆ update_canvas()

void gui2::scrollbar_base::update_canvas ( )

overrideprotectedvirtual

See styled_widget::update_canvas.

After a recalculation the canvasses also need to be updated.

Reimplemented from gui2::styled_widget.

Definition at line 179 of file scrollbar.cpp.

References gui2::styled_widget::get_canvases(), positioner_length_, positioner_offset_, and gui2::widget::queue_redraw().

Referenced by move_positioner(), recalculate(), and set_item_position().

Friends And Related Function Documentation

◆ slider

friend class slider

friend

Todo:: Abstract the code so this friend is no longer needed.

Definition at line 41 of file scrollbar.hpp.

Member Data Documentation

◆ item_count_

unsigned gui2::scrollbar_base::item_count_

private

The number of items the scrollbar 'holds'.

Definition at line 226 of file scrollbar.hpp.

Referenced by all_items_visible(), at_end(), get_item_count(), move_positioner(), recalculate(), scroll(), set_item_count(), and set_item_position().

◆ item_position_

unsigned gui2::scrollbar_base::item_position_

private

The item the positioner is at, starts at 0.

Definition at line 229 of file scrollbar.hpp.

Referenced by at_begin(), at_end(), get_item_position(), move_positioner(), recalculate(), scroll(), and set_item_position().

◆ mouse_

point gui2::scrollbar_base::mouse_

private

The position the mouse was at the last movement.

This is used during dragging the positioner.

Definition at line 261 of file scrollbar.hpp.

Referenced by get_mouse_position_last_move(), signal_handler_left_button_down(), and signal_handler_mouse_motion().

◆ pixels_per_step_

float gui2::scrollbar_base::pixels_per_step_

private

Number of pixels per step.

The number of pixels the positioner needs to move to go to the next step. Note if there is too little space it can happen 1 pixel does more than 1 step.

Definition at line 254 of file scrollbar.hpp.

Referenced by get_pixels_per_step(), move_positioner(), recalculate(), scroll_by(), and set_item_position().

◆ positioner_length_

unsigned gui2::scrollbar_base::positioner_length_

private

The current length of the positioner.

Definition at line 271 of file scrollbar.hpp.

Referenced by get_positioner_length(), move_positioner(), recalculate(), recalculate_positioner(), and update_canvas().

◆ positioner_offset_

unsigned gui2::scrollbar_base::positioner_offset_

private

The start offset of the positioner.

This takes the offset before in consideration.

Definition at line 268 of file scrollbar.hpp.

Referenced by get_positioner_offset(), move_positioner(), recalculate(), set_item_position(), and update_canvas().

◆ state_

state_t gui2::scrollbar_base::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 223 of file scrollbar.hpp.

Referenced by get_active(), get_state(), set_state(), signal_handler_left_button_up(), signal_handler_mouse_leave(), and signal_handler_mouse_motion().

◆ step_size_

unsigned gui2::scrollbar_base::step_size_

private

Number of items moved when scrolling.

The step size is the minimum number of items we scroll through when we move. Normally this value is 1, we can move per item. But for example sliders want for example to move per 5 items.

Definition at line 245 of file scrollbar.hpp.

Referenced by get_step_size(), move_positioner(), recalculate(), set_item_position(), and set_step_size().

◆ visible_items_

unsigned gui2::scrollbar_base::visible_items_

private

The number of items which can be shown at the same time.

As long as all items are visible we don't need to scroll.

Definition at line 236 of file scrollbar.hpp.

Referenced by all_items_visible(), at_end(), get_visible_items(), move_positioner(), recalculate(), scroll(), set_item_position(), and set_visible_items().

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

gui/widgets/scrollbar.hpp
gui/widgets/scrollbar.cpp

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ scroll_mode

◆ state_t

Constructor & Destructor Documentation

◆ scrollbar_base()

Member Function Documentation

◆ all_items_visible()

◆ at_begin()

◆ at_end()

◆ child_callback_positioner_moved()

◆ finalize_setup()

◆ get_active()

◆ get_item_count()

◆ get_item_position()

◆ get_length()

◆ get_length_difference()

◆ get_mouse_position_last_move()

◆ get_pixels_per_step()

◆ get_positioner_length()

◆ get_positioner_offset()

◆ get_state()

◆ get_step_size()

◆ get_visible_items()

◆ in_orthogonal_range()

◆ maximum_positioner_length()

◆ minimum_positioner_length()

◆ move_positioner()

◆ offset_after()

◆ offset_before()

◆ on_bar()

◆ on_positioner()

◆ place()

◆ recalculate()

◆ recalculate_positioner()

◆ scroll()

◆ scroll_by()

◆ set_active()

◆ set_item_count()

◆ set_item_position()

◆ set_state()

◆ set_step_size()

◆ set_visible_items()

◆ signal_handler_left_button_down()

◆ signal_handler_left_button_up()

◆ signal_handler_mouse_enter()

◆ signal_handler_mouse_leave()

◆ signal_handler_mouse_motion()

◆ update_canvas()

Friends And Related Function Documentation

◆ slider

Member Data Documentation

◆ item_count_

◆ item_position_

◆ mouse_

◆ pixels_per_step_

◆ positioner_length_

◆ positioner_offset_

◆ state_

◆ step_size_

◆ visible_items_