Base class for a scroll bar. More...

#include <slider_base.hpp>

Inheritance diagram for gui2::slider_base:

Classes
struct	slider_position_t
	Helper container for the slider's current position. More...

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 , COUNT }
	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
	slider_base (const implementation::builder_styled_widget &builder, const std::string &control_type)

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

void	finalize_setup ()

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

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
bool	at_begin () const
	Is the positioner at the beginning of the slider? More...

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

void	update_slider_position (slider_position_t &pos)

void	slider_set_item_last (const unsigned item_last)

unsigned	slider_get_item_count () const

unsigned	slider_get_item_last () const

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

unsigned	get_slider_position () const

unsigned	get_positioner_offset () const

unsigned	get_positioner_length () 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...

virtual int	jump_size () const

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

int	available_length () const

int	max_offset () const

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

virtual int	positioner_length () const =0
	Updates the positioner. More...

void	recalculate_positioner ()

void	move_positioner (int offset)
	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...

int	item_last_
	one less than the number items the slider 'holds'. More...

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

point	drag_initial_mouse_
	The position the mouse was when draggin the slider was started. More...

int	drag_initial_offset_
	The offset in pixels the slider was when dragging the positioner was started. More...

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

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

bool	snap_
	Whether the slider should 'snap' into its supported values or not. More...

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 slider is changed.

Common signal handlers:

connect_signal_notify_modified

Definition at line 38 of file slider_base.hpp.

Member Enumeration Documentation

◆ scroll_mode

enum gui2::slider_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	Go the visible items towards the end.

Definition at line 49 of file slider_base.hpp.

◆ state_t

enum gui2::slider_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
COUNT

Definition at line 119 of file slider_base.hpp.

Constructor & Destructor Documentation

◆ slider_base()

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

Definition at line 43 of file slider_base.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

◆ at_begin()

bool gui2::slider_base::at_begin ( ) const

inlineprotected

Is the positioner at the beginning of the slider?

Definition at line 78 of file slider_base.hpp.

References item_position_.

◆ at_end()

bool gui2::slider_base::at_end ( ) const

inlineprotected

Is the positioner at the and of the slider?

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

Definition at line 88 of file slider_base.hpp.

References item_last_, and item_position_.

◆ available_length()

int gui2::slider_base::available_length ( ) const

inlineprivate

Definition at line 231 of file slider_base.hpp.

References get_length(), offset_after(), and offset_before().

Referenced by max_offset(), and recalculate().

◆ child_callback_positioner_moved()

virtual void gui2::slider_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.

Reimplemented in gui2::slider.

Definition at line 175 of file slider_base.hpp.

Referenced by update_slider_position().

◆ finalize_setup()

void gui2::slider_base::finalize_setup ( )

Definition at line 326 of file slider_base.cpp.

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

◆ get_active()

bool gui2::slider_base::get_active ( ) const

overridevirtual

See styled_widget::get_active.

Implements gui2::styled_widget.

Definition at line 123 of file slider_base.cpp.

References DISABLED, and state_.

Referenced by set_active().

◆ get_length()

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

privatepure virtual

Get the length of the slider.

Implemented in gui2::slider.

Referenced by available_length(), and recalculate().

◆ get_length_difference()

virtual int gui2::slider_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::slider.

Referenced by signal_handler_mouse_motion().

◆ get_positioner_length()

unsigned gui2::slider_base::get_positioner_length ( ) const

inlineprotected

Definition at line 156 of file slider_base.hpp.

References positioner_length_.

Referenced by gui2::slider::on_bar(), and gui2::slider::on_positioner().

◆ get_positioner_offset()

unsigned gui2::slider_base::get_positioner_offset ( ) const

inlineprotected

Definition at line 151 of file slider_base.hpp.

References positioner_offset_.

Referenced by gui2::slider::on_bar(), and gui2::slider::on_positioner().

◆ get_slider_position()

unsigned gui2::slider_base::get_slider_position ( ) const

inlineprotected

Definition at line 146 of file slider_base.hpp.

References item_position_.

Referenced by gui2::slider::get_value(), and gui2::slider::get_value_label().

◆ get_state()

unsigned gui2::slider_base::get_state ( ) const

overridevirtual

See styled_widget::get_state.

Implements gui2::styled_widget.

Definition at line 128 of file slider_base.cpp.

References state_.

◆ jump_size()

virtual int gui2::slider_base::jump_size ( ) const

inlineprotectedvirtual

Definition at line 179 of file slider_base.hpp.

Referenced by scroll().

◆ max_offset()

int gui2::slider_base::max_offset ( ) const

inlineprivate

Definition at line 236 of file slider_base.hpp.

References available_length(), and positioner_length().

Referenced by move_positioner(), and set_slider_position().

◆ move_positioner()

void gui2::slider_base::move_positioner ( int offset )

private

Moves the positioner.

Parameters

offset The new offset in pixels of the positioner;

Definition at line 177 of file slider_base.cpp.

References gui2::slider_base::slider_position_t::max_offset, max_offset(), gui2::slider_base::slider_position_t::offset, offset_before(), positioner_offset_, update_canvas(), and update_slider_position().

Referenced by signal_handler_mouse_motion().

◆ offset_after()

virtual unsigned gui2::slider_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::slider.

Referenced by available_length(), and finalize_setup().

◆ offset_before()

virtual unsigned gui2::slider_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::slider.

Referenced by available_length(), finalize_setup(), move_positioner(), set_slider_position(), and signal_handler_left_button_down().

◆ on_bar()

virtual int gui2::slider_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::slider.

Referenced by signal_handler_left_button_down().

◆ on_positioner()

virtual bool gui2::slider_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::slider.

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

◆ place()

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

overridevirtual

See widget::place.

Reimplemented from gui2::styled_widget.

Definition at line 108 of file slider_base.cpp.

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

◆ positioner_length()

virtual int gui2::slider_base::positioner_length ( ) const

privatepure virtual

Updates the positioner.

This is a helper for recalculate().

Implemented in gui2::slider.

Referenced by max_offset(), and recalculate_positioner().

◆ recalculate()

void gui2::slider_base::recalculate ( )

private

Updates the slider.

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.

Definition at line 162 of file slider_base.cpp.

References available_length(), get_length(), item_position_, recalculate_positioner(), and set_slider_position().

Referenced by place(), and slider_set_item_last().