#include <slider.hpp>

Inheritance diagram for gui2::slider:

Public Types
using	label_generator = std::function< t_string(int, int)>

Public Types inherited from gui2::slider_base
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 (const implementation::builder_slider &builder)

virtual void	set_value (int value) override
	Inherited from integer_selector. More...

virtual int	get_value () const override
	Inherited from integer_selector. More...

virtual int	get_minimum_value () const override
	Inherited from integer_selector. More...

virtual int	get_maximum_value () const override
	Inherited from integer_selector. More...

int	get_item_count () const

unsigned	get_step_size () const

void	set_step_size (int step_size)

void	set_best_slider_length (const unsigned length)

unsigned	get_best_slider_length () const

void	set_value_range (int min_value, int max_value)

void	set_minimum_value_label (const t_string &minimum_value_label)

t_string	get_minimum_value_label () const

void	set_maximum_value_label (const t_string &maximum_value_label)

t_string	get_maximum_value_label () const

void	set_value_labels (const std::vector< t_string > &value_labels)

void	set_value_labels (const label_generator &generator)

t_string	get_value_label () const
	Returns the label shown for the current value. More...

Public Member Functions inherited from gui2::slider_base
	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 &id, const bool must_be_active) override
	See widget::find. More...

const widget *	find (const std::string &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 ()

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

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 >
NOT_DANGLING T *	find_widget (const std::string &id, const bool must_be_active, const bool must_exist)
	Gets a widget with the wanted id. More...

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

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

template<class T >
NOT_DANGLING const T &	find_widget (const std::string &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)

Public Member Functions inherited from gui2::integer_selector
virtual	~integer_selector ()

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 void	child_callback_positioner_moved () override
	Inherited from scrollbar_base. More...

Protected Member Functions inherited from gui2::slider_base
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 int	jump_size () const

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)

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
virtual point	calculate_best_size () const override
	See widget::calculate_best_size. More...

virtual unsigned	get_length () const override
	Inherited from scrollbar_base. More...

int	positioner_length () const override
	Inherited from scrollbar_base. More...

unsigned	offset_before () const override
	Inherited from scrollbar_base. More...

unsigned	offset_after () const override
	Inherited from scrollbar_base. More...

bool	on_positioner (const point &coordinate) const override
	Inherited from scrollbar_base. More...

int	on_bar (const point &coordinate) const override
	Inherited from scrollbar_base. More...

int	get_length_difference (const point &original, const point &current) const override
	Inherited from scrollbar_base. More...

virtual void	update_canvas () override
	Inherited from scrollbar_base. More...

virtual const std::string &	get_control_type () const override
	Inherited from styled_widget, implemented by REGISTER_WIDGET. More...

void	handle_key_decrease (bool &handled)
	Handlers for keyboard input. More...

void	handle_key_increase (bool &handled)

void	signal_handler_sdl_key_down (const event::ui_event event, bool &handled, const SDL_Keycode key)
	Signal handlers: More...

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

Private Attributes
unsigned	best_slider_length_
	The best size for the slider part itself, if 0 ignored. More...

int	minimum_value_
	The minimum value the slider holds. More...

int	step_size_

t_string	minimum_value_label_
	When the slider shows the minimum value can show a special text. More...

t_string	maximum_value_label_
	When the slider shows the maximum value can show a special text. More...

label_generator	value_label_generator_
	Function to output custom value labels for the slider. More...

point	current_item_mouse_position_
	When initially pressing the positioner and every time a new value is chosen through dragging, this value is updated with the mouse position at the time. More...

Friends
struct	implementation::builder_slider

Detailed Description

Definition at line 32 of file slider.hpp.

Member Typedef Documentation

◆ label_generator

using gui2::slider::label_generator = std::function<t_string(int , int )>

Definition at line 119 of file slider.hpp.

Constructor & Destructor Documentation

◆ slider()

gui2::slider::slider ( const implementation::builder_slider & builder )

explicit

Definition at line 44 of file slider.cpp.

References signal_handler_left_button_up(), and signal_handler_sdl_key_down().

Member Function Documentation

◆ calculate_best_size()

point gui2::slider::calculate_best_size ( ) const

overrideprivatevirtual

See widget::calculate_best_size.

Reimplemented from gui2::styled_widget.

Definition at line 62 of file slider.cpp.

References best_slider_length_, gui2::styled_widget::calculate_best_size(), DBG_GUI_L, gui2::log_gui_layout, LOG_HEADER, log_scope2, and LOG_SCOPE_HEADER.

◆ child_callback_positioner_moved()

void gui2::slider::child_callback_positioner_moved ( )

overrideprotectedvirtual

Inherited from scrollbar_base.

Reimplemented from gui2::slider_base.

Definition at line 119 of file slider.cpp.

References sound::play_UI_sound(), and gui2::settings::sound_slider_adjust.

◆ get_best_slider_length()

unsigned gui2::slider::get_best_slider_length ( ) const

inline

Definition at line 90 of file slider.hpp.

References best_slider_length_.

◆ get_control_type()

virtual const std::string& gui2::slider::get_control_type ( ) const

overrideprivatevirtual

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Implements gui2::styled_widget.

◆ get_item_count()

int gui2::slider::get_item_count ( ) const

inline

Definition at line 70 of file slider.hpp.

References gui2::slider_base::slider_get_item_last(), and step_size_.

Referenced by get_value_label(), and set_step_size().

◆ get_length()

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

inlineoverrideprivatevirtual

Inherited from scrollbar_base.

Implements gui2::slider_base.

Definition at line 153 of file slider.hpp.

References gui2::widget::get_width().

◆ get_length_difference()

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

inlineoverrideprivatevirtual

Inherited from scrollbar_base.

Implements gui2::slider_base.

Definition at line 174 of file slider.hpp.

◆ get_maximum_value()

virtual int gui2::slider::get_maximum_value ( ) const

inlineoverridevirtual

Inherited from integer_selector.

Implements gui2::integer_selector.

Definition at line 64 of file slider.hpp.

References minimum_value_, gui2::slider_base::slider_get_item_last(), and step_size_.

Referenced by gui2::dialogs::mp_staging::add_side_node(), get_value_label(), set_step_size(), set_value(), and set_value_range().

◆ get_maximum_value_label()

t_string gui2::slider::get_maximum_value_label ( ) const

inline

Definition at line 112 of file slider.hpp.

References maximum_value_label_.

◆ get_minimum_value()

virtual int gui2::slider::get_minimum_value ( ) const

inlineoverridevirtual

Inherited from integer_selector.

Implements gui2::integer_selector.

Definition at line 58 of file slider.hpp.

References minimum_value_.

Referenced by gui2::dialogs::mp_staging::add_side_node(), get_value_label(), set_step_size(), and set_value_range().

◆ get_minimum_value_label()

t_string gui2::slider::get_minimum_value_label ( ) const

inline

Definition at line 102 of file slider.hpp.

References minimum_value_label_.

◆ get_step_size()

unsigned gui2::slider::get_step_size ( ) const

inline

Definition at line 76 of file slider.hpp.

References step_size_.

Referenced by get_value().

◆ get_value()

virtual int gui2::slider::get_value ( ) const

inlineoverridevirtual

Inherited from integer_selector.

Implements gui2::integer_selector.

Definition at line 52 of file slider.hpp.

References gui2::slider_base::get_slider_position(), get_step_size(), and minimum_value_.

Referenced by gui2::dialogs::preferences_dialog::apply_pixel_scale(), get_value_label(), gui2::dialogs::chat_log::controller::handle_page_number_changed(), gui2::dialogs::preferences_dialog::initialize_callbacks(), gui2::dialogs::mp_staging::on_side_slider_change(), set_step_size(), set_value(), and set_value_range().

◆ get_value_label()

t_string gui2::slider::get_value_label ( ) const

Returns the label shown for the current value.

Returns: The label for the current value, if no label for the current label is defined, it returns the result of get_value().

Definition at line 106 of file slider.cpp.

References t_string::empty(), get_item_count(), get_maximum_value(), get_minimum_value(), gui2::slider_base::get_slider_position(), get_value(), maximum_value_label_, minimum_value_label_, and value_label_generator_.

Referenced by update_canvas().

◆ handle_key_decrease()

void gui2::slider::handle_key_decrease ( bool & handled )

private

Handlers for keyboard input.

Definition at line 185 of file slider.cpp.

References DBG_GUI_E, gui2::slider_base::ITEM_BACKWARDS, LOG_HEADER, and gui2::slider_base::scroll().

Referenced by signal_handler_sdl_key_down().

◆ handle_key_increase()

void gui2::slider::handle_key_increase ( bool & handled )

private

Definition at line 194 of file slider.cpp.

References DBG_GUI_E, gui2::slider_base::ITEM_FORWARD, LOG_HEADER, and gui2::slider_base::scroll().

Referenced by signal_handler_sdl_key_down().

◆ offset_after()

unsigned gui2::slider::offset_after ( ) const

overrideprivatevirtual

Inherited from scrollbar_base.

Implements gui2::slider_base.

Definition at line 138 of file slider.cpp.

◆ offset_before()

unsigned gui2::slider::offset_before ( ) const

overrideprivatevirtual

Inherited from scrollbar_base.

Implements gui2::slider_base.

Definition at line 131 of file slider.cpp.

◆ on_bar()

int gui2::slider::on_bar ( const point & coordinate ) const

overrideprivatevirtual

Inherited from scrollbar_base.

Implements gui2::slider_base.

Definition at line 155 of file slider.cpp.

References gui2::widget::get_height(), gui2::slider_base::get_positioner_length(), gui2::slider_base::get_positioner_offset(), gui2::widget::get_width(), map_location::x, and map_location::y.

◆ on_positioner()

bool gui2::slider::on_positioner ( const point & coordinate ) const

overrideprivatevirtual

Inherited from scrollbar_base.

Implements gui2::slider_base.

Definition at line 145 of file slider.cpp.

References rect::contains(), gui2::widget::get_height(), gui2::slider_base::get_positioner_length(), and gui2::slider_base::get_positioner_offset().

◆ positioner_length()

int gui2::slider::positioner_length ( ) const

overrideprivatevirtual

Inherited from scrollbar_base.

Implements gui2::slider_base.

Definition at line 124 of file slider.cpp.

◆ set_best_slider_length()

void gui2::slider::set_best_slider_length ( const unsigned length )

inline

Definition at line 84 of file slider.hpp.

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

◆ set_maximum_value_label()

void gui2::slider::set_maximum_value_label ( const t_string & maximum_value_label )

inline

Definition at line 107 of file slider.hpp.

References maximum_value_label_.

◆ set_minimum_value_label()

void gui2::slider::set_minimum_value_label ( const t_string & minimum_value_label )

inline

Definition at line 97 of file slider.hpp.

References minimum_value_label_.

◆ set_step_size()

void gui2::slider::set_step_size ( int step_size )

Definition at line 276 of file slider.cpp.

References get_item_count(), get_maximum_value(), get_minimum_value(), get_value(), set_value(), gui2::slider_base::slider_set_item_last(), and step_size_.

Referenced by gui2::dialogs::mp_options_helper::display_custom_options().

◆ set_value()

void gui2::slider::set_value ( int value )

overridevirtual

Inherited from integer_selector.

Implements gui2::integer_selector.

Definition at line 81 of file slider.cpp.

References ERR_GUI_G, gui2::event::dispatcher::fire(), get_maximum_value(), get_value(), minimum_value_, gui2::event::NOTIFY_MODIFIED, rounded_division(), gui2::slider_base::set_slider_position(), and step_size_.

Referenced by gui2::dialogs::mp_staging::add_side_node(), gui2::dialogs::mp_options_helper::display_custom_options(), gui2::dialogs::preferences_dialog::initialize_callbacks(), set_step_size(), set_value_range(), and gui2::dialogs::chat_log::controller::update_view_from_model().

◆ set_value_labels() [1/2]

void gui2::slider::set_value_labels ( const label_generator & generator )

inline

Definition at line 121 of file slider.hpp.

References randomness::generator, and value_label_generator_.

◆ set_value_labels() [2/2]

void gui2::slider::set_value_labels ( const std::vector< t_string > & value_labels )

Definition at line 243 of file slider.cpp.

References gui2::default_value_label_generator().

◆ set_value_range()

void gui2::slider::set_value_range	(	int	min_value,
		int	max_value
	)

Definition at line 250 of file slider.cpp.

References get_maximum_value(), get_minimum_value(), get_value(), minimum_value_, set_value(), gui2::slider_base::slider_set_item_last(), step_size_, and VALIDATE.

Referenced by gui2::dialogs::mp_staging::add_side_node(), gui2::dialogs::mp_options_helper::display_custom_options(), and gui2::dialogs::chat_log::controller::update_view_from_model().

◆ signal_handler_left_button_up()

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

private

Definition at line 227 of file slider.cpp.

References DBG_GUI_E, gui2::widget::get_window(), gui2::window::keyboard_capture(), and LOG_HEADER.

Referenced by slider().

◆ signal_handler_sdl_key_down()

void gui2::slider::signal_handler_sdl_key_down	(	const event::ui_event	event,
		bool &	handled,
		const SDL_Keycode	key
	)

private

Signal handlers:

Definition at line 203 of file slider.cpp.

References DBG_GUI_E, handle_key_decrease(), handle_key_increase(), and LOG_HEADER.

Referenced by slider().

◆ type()

static const std::string& gui2::slider::type ( )

static

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

◆ update_canvas()

void gui2::slider::update_canvas ( )

overrideprivatevirtual

Inherited from scrollbar_base.

See styled_widget::update_canvas.

Reimplemented from gui2::slider_base.

Definition at line 175 of file slider.cpp.

References gui2::styled_widget::get_canvases(), get_value_label(), and gui2::slider_base::update_canvas().

Friends And Related Function Documentation

◆ implementation::builder_slider

friend struct implementation::builder_slider

friend

Definition at line 34 of file slider.hpp.

Member Data Documentation

◆ best_slider_length_

unsigned gui2::slider::best_slider_length_

private

The best size for the slider part itself, if 0 ignored.

Definition at line 141 of file slider.hpp.

Referenced by calculate_best_size(), get_best_slider_length(), and set_best_slider_length().

◆ current_item_mouse_position_

point gui2::slider::current_item_mouse_position_

private

When initially pressing the positioner and every time a new value is chosen through dragging, this value is updated with the mouse position at the time.

This allows the widget to track how far the mouse has moved since setting the last value.

Definition at line 209 of file slider.hpp.

◆ maximum_value_label_

t_string gui2::slider::maximum_value_label_

private

When the slider shows the maximum value can show a special text.

If this text is not empty this text is shown else the maximum value.

Definition at line 195 of file slider.hpp.

Referenced by get_maximum_value_label(), get_value_label(), and set_maximum_value_label().

◆ minimum_value_

int gui2::slider::minimum_value_

private

The minimum value the slider holds.

The maximum value is minimum + item_last_. The current value is minimum + item_position_.

Definition at line 149 of file slider.hpp.

Referenced by get_maximum_value(), get_minimum_value(), get_value(), set_value(), and set_value_range().

◆ minimum_value_label_

t_string gui2::slider::minimum_value_label_

private

When the slider shows the minimum value can show a special text.

If this text is not empty this text is shown else the minimum value.

Definition at line 189 of file slider.hpp.

Referenced by get_minimum_value_label(), get_value_label(), and set_minimum_value_label().

◆ step_size_

int gui2::slider::step_size_

private

Definition at line 150 of file slider.hpp.

Referenced by get_item_count(), get_maximum_value(), get_step_size(), set_step_size(), set_value(), and set_value_range().

◆ value_label_generator_

label_generator gui2::slider::value_label_generator_

private

Function to output custom value labels for the slider.

When set its output is shown instead of the numeric values. It also overrides minimum_value_label_ and maximum_value_label_.

Definition at line 202 of file slider.hpp.

Referenced by get_value_label(), and set_value_labels().

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

gui/widgets/slider.hpp
gui/widgets/slider.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ label_generator

Constructor & Destructor Documentation

◆ slider()

Member Function Documentation

◆ calculate_best_size()

◆ child_callback_positioner_moved()

◆ get_best_slider_length()

◆ get_control_type()

◆ get_item_count()

◆ get_length()

◆ get_length_difference()

◆ get_maximum_value()

◆ get_maximum_value_label()

◆ get_minimum_value()

◆ get_minimum_value_label()

◆ get_step_size()

◆ get_value()

◆ get_value_label()

◆ handle_key_decrease()

◆ handle_key_increase()

◆ offset_after()

◆ offset_before()

◆ on_bar()

◆ on_positioner()

◆ positioner_length()

◆ set_best_slider_length()

◆ set_maximum_value_label()

◆ set_minimum_value_label()

◆ set_step_size()

◆ set_value()

◆ set_value_labels() [1/2]

◆ set_value_labels() [2/2]

◆ set_value_range()

◆ signal_handler_left_button_up()

◆ signal_handler_sdl_key_down()

◆ type()

◆ update_canvas()

Friends And Related Function Documentation

◆ implementation::builder_slider

Member Data Documentation

◆ best_slider_length_

◆ current_item_mouse_position_

◆ maximum_value_label_

◆ minimum_value_

◆ minimum_value_label_

◆ step_size_

◆ value_label_generator_