The Battle for Wesnoth  1.13.4+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
gui2::tslider Class Reference

A slider. More...

#include <slider.hpp>

Inheritance diagram for gui2::tslider:
Inheritance graph

Public Types

typedef std::function
< t_string(int, int)> 
tlabel_creator
 
- Public Types inherited from gui2::tscrollbar_
enum  tscroll {
  BEGIN, ITEM_BACKWARDS, HALF_JUMP_BACKWARDS, JUMP_BACKWARDS,
  END, ITEM_FORWARD, HALF_JUMP_FORWARD, JUMP_FORWARD
}
 scroll 'step size'. More...
 
- Public Types inherited from gui2::event::tdispatcher
enum  tevent_type { pre = 1, child = 2, post = 4 }
 
enum  tposition {
  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  tmouse_behavior { all, hit, none }
 The behavior of the mouse events. More...
 

Public Member Functions

 tslider ()
 
void set_value (const int value)
 Inherited from tinteger_selector_. More...
 
int get_value () const
 Inherited from tinteger_selector_. More...
 
void set_minimum_value (const int minimum_value)
 Inherited from tinteger_selector_. More...
 
int get_minimum_value () const
 Inherited from tinteger_selector_. More...
 
void set_maximum_value (const int maximum_value)
 Inherited from tinteger_selector_. More...
 
int get_maximum_value () const
 Inherited from tinteger_selector_. More...
 
void set_best_slider_length (const unsigned length)
 
void set_minimum_value_label (const t_string &minimum_value_label)
 
void set_maximum_value_label (const t_string &maximum_value_label)
 
void set_value_labels (const std::vector< t_string > &value_labels)
 
void set_value_labels (const tlabel_creator &value_labels)
 
t_string get_value_label () const
 Returns the label shown for the current value. More...
 
- Public Member Functions inherited from gui2::tscrollbar_
 tscrollbar_ ()
 
void scroll (const tscroll scroll)
 Sets the item position. More...
 
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 tpoint &origin, const tpoint &size) override
 See twidget::place. More...
 
virtual void set_active (const bool active) override
 See tcontrol::set_active. More...
 
virtual bool get_active () const override
 See tcontrol::get_active. More...
 
virtual unsigned get_state () const override
 See tcontrol::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)
 
- Public Member Functions inherited from gui2::tcontrol
 tcontrol (const unsigned canvas_count)
 
 tcontrol (const implementation::tbuilder_control &builder, const unsigned canvas_count, const std::string &control_type)
 Constructor. More...
 
virtual void set_members (const string_map &data)
 Sets the members of the control. More...
 
bool disable_click_dismiss () const override
 See twidget::disable_click_dismiss. More...
 
virtual iterator::twalker_create_walker () override
 See twidget::create_walker. More...
 
tpoint get_config_minimum_size () const
 Gets the minimum size as defined in the config. More...
 
tpoint get_config_default_size () const
 Gets the default size as defined in the config. More...
 
tpoint 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 std::string get_link_color () const
 Returns the color string to be used with links. More...
 
virtual void layout_initialise (const bool full_initialisation) override
 See twidget::layout_initialise. More...
 
virtual void request_reduce_width (const unsigned maximum_width) override
 See twidget::request_reduce_width. More...
 
virtual twidgetfind_at (const tpoint &coordinate, const bool must_be_active) override
 See twidget::find_at. More...
 
virtual const twidgetfind_at (const tpoint &coordinate, const bool must_be_active) const override
 See twidget::find_at. More...
 
twidgetfind (const std::string &id, const bool must_be_active) override
 See twidget::find. More...
 
const twidgetfind (const std::string &id, const bool must_be_active) const override
 See twidget::find. More...
 
void set_definition (const std::string &definition)
 Sets the definition. More...
 
bool get_use_tooltip_on_label_overflow () const
 
void set_use_tooltip_on_label_overflow (const bool use_tooltip=true)
 
const t_stringlabel () const
 
virtual void set_label (const t_string &label)
 
virtual void set_use_markup (bool use_markup)
 
bool get_use_markup () const
 
const t_stringtooltip () const
 
void set_tooltip (const t_string &tooltip)
 
const t_stringhelp_message () const
 
void set_help_message (const t_string &help_message)
 
std::vector< tcanvas > & canvas ()
 
tcanvascanvas (const unsigned index)
 
void set_text_alignment (const PangoAlignment text_alignment)
 
PangoAlignment get_text_alignment () const
 
- Public Member Functions inherited from gui2::twidget
 twidget ()
 
 twidget (const tbuilder_widget &builder)
 Constructor. More...
 
virtual ~twidget () override
 
void set_id (const std::string &id)
 
const std::stringid () const
 
twindowget_window ()
 Get the parent window. More...
 
const twindowget_window () const
 The constant version of get_window. More...
 
tdialogdialog ()
 Returns the top-level dialogue. More...
 
void set_parent (twidget *parent)
 
twidgetparent ()
 
virtual void demand_reduce_width (const unsigned maximum_width)
 Tries to reduce the width of a widget. More...
 
virtual void request_reduce_height (const unsigned maximum_height)
 Tries to reduce the height of a widget. More...
 
virtual void demand_reduce_height (const unsigned maximum_height)
 Tries to reduce the height of a widget. More...
 
tpoint 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 tpoint &origin)
 Sets the origin of the widget. More...
 
virtual void set_size (const tpoint &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 layout_children ()
 Allows a widget to update its children. More...
 
tpoint get_origin () const
 Returns the screen origin of the widget. More...
 
tpoint get_size () const
 Returns the size of the widget. More...
 
SDL_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)
 
SDL_Rect calculate_blitting_rectangle (const int x_offset, const int y_offset)
 Calculates the blitting rectangle of the widget. More...
 
SDL_Rect calculate_clipping_rectangle (const int x_offset, const int y_offset)
 Calculates the clipping rectangle of the widget. More...
 
void draw_background (surface &frame_buffer, int x_offset, int y_offset)
 Draws the background of a widget. More...
 
void draw_children (surface &frame_buffer, int x_offset, int y_offset)
 Draws the children of a widget. More...
 
void draw_foreground (surface &frame_buffer, int x_offset, int y_offset)
 Draws the foreground of the widget. More...
 
void populate_dirty_list (twindow &caller, std::vector< twidget * > &call_stack)
 Adds a widget to the dirty list if it is dirty. 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 set_is_dirty (const bool is_dirty)
 
bool get_is_dirty () const
 
void set_visible (const tvisible::scoped_enum visible)
 
tvisible::scoped_enum get_visible () const
 
tredraw_action::scoped_enum get_drawing_action () const
 
void set_debug_border_mode (const unsigned debug_border_mode)
 
void set_debug_border_colour (const unsigned debug_border_colour)
 
virtual bool has_widget (const twidget &widget) const
 Does the widget contain the widget. More...
 
- Public Member Functions inherited from gui2::tevent_executor
 tevent_executor ()
 
virtual ~tevent_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
 
tevent_executorset_wants_mouse_right_double_click (const bool click=true)
 
bool wants_mouse_right_double_click () const
 
- Public Member Functions inherited from gui2::event::tdispatcher
 tdispatcher ()
 
virtual ~tdispatcher ()
 
void connect ()
 Connects the dispatcher to the event handler. More...
 
bool has_event (const tevent event, const tevent_type event_type)
 
bool fire (const tevent event, twidget &target)
 Fires an event which has no extra parameters. More...
 
bool fire (const tevent event, twidget &target, const tpoint &coordinate)
 Fires an event which takes a coordinate parameter. More...
 
bool fire (const tevent event, twidget &target, const SDLKey key, const SDLMod modifier, const utf8::string &unicode)
 Fires an event which takes keyboard parameters. More...
 
bool fire (const tevent event, twidget &target, void *)
 Fires an event which takes notification parameters. More...
 
bool fire (const tevent event, twidget &target, tmessage &message)
 Fires an event which takes message parameters. More...
 
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event, boost::mpl::int_
< E > > >::type 
connect_signal (const tsignal_function &signal, const tposition position=back_child)
 Connect a signal for callback in tset_event. More...
 
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event, boost::mpl::int_
< E > > >::type 
disconnect_signal (const tsignal_function &signal, const tposition position=back_child)
 Disconnect a signal for callback in tset_event. More...
 
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event_mouse,
boost::mpl::int_< E >
> >::type 
connect_signal (const tsignal_mouse_function &signal, const tposition position=back_child)
 Connect a signal for callback in tset_event_mouse. More...
 
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event_mouse,
boost::mpl::int_< E >
> >::type 
disconnect_signal (const tsignal_mouse_function &signal, const tposition position=back_child)
 Disconnect a signal for callback in tset_event_mouse. More...
 
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event_keyboard,
boost::mpl::int_< E >
> >::type 
connect_signal (const tsignal_keyboard_function &signal, const tposition position=back_child)
 Connect a signal for callback in tset_event_keyboard. More...
 
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event_keyboard,
boost::mpl::int_< E >
> >::type 
disconnect_signal (const tsignal_keyboard_function &signal, const tposition position=back_child)
 Disconnect a signal for callback in tset_event_keyboard. More...
 
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event_notification,
boost::mpl::int_< E >
> >::type 
connect_signal (const tsignal_notification_function &signal, const tposition position=back_child)
 Connect a signal for callback in tset_event_notification. More...
 
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event_notification,
boost::mpl::int_< E >
> >::type 
disconnect_signal (const tsignal_notification_function &signal, const tposition position=back_child)
 Disconnect a signal for callback in tset_event_notification. More...
 
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event_message,
boost::mpl::int_< E >
> >::type 
connect_signal (const tsignal_message_function &signal, const tposition position=back_child)
 Connect a signal for callback in tset_event_message. More...
 
template<tevent E>
boost::enable_if
< boost::mpl::has_key
< tset_event_message,
boost::mpl::int_< E >
> >::type 
disconnect_signal (const tsignal_message_function &signal, const tposition position=back_child)
 Disconnect a signal for callback in tset_event_message. More...
 
void capture_mouse ()
 Captures the mouse. More...
 
void release_mouse ()
 Releases the mouse capture. More...
 
void set_mouse_behavior (const tmouse_behavior mouse_behavior)
 
tmouse_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 thotkey_function &function)
 Registers a hotkey. More...
 
bool execute_hotkey (const hotkey::HOTKEY_COMMAND id)
 Executes a hotkey. More...
 
- Public Member Functions inherited from gui2::tinteger_selector_
virtual ~tinteger_selector_ ()
 

Protected Member Functions

void child_callback_positioner_moved ()
 Inherited from tscrollbar. More...
 
- Protected Member Functions inherited from gui2::tscrollbar_
unsigned get_positioner_offset () const
 
unsigned get_positioner_length () const
 
- Protected Member Functions inherited from gui2::tcontrol
tresolution_definition_ptr config ()
 
tresolution_definition_const_ptr config () const
 
void set_config (tresolution_definition_ptr config)
 
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 void impl_draw_background (surface &frame_buffer, int x_offset, int y_offset) override
 See twidget::impl_draw_background. More...
 
virtual void impl_draw_foreground (surface &frame_buffer, int x_offset, int y_offset) override
 See twidget::impl_draw_foreground. More...
 
std::string get_label_token (const gui2::tpoint &position, const char *delimiters=" \n\r\t") const
 Exposes font::ttext::get_token, for the text label of this control. More...
 
std::string get_label_link (const gui2::tpoint &position) const
 
- Protected Member Functions inherited from gui2::twidget
void set_layout_size (const tpoint &size)
 
const tpointlayout_size () const
 

Private Member Functions

virtual tpoint calculate_best_size () const override
 See twidget::calculate_best_size. More...
 
unsigned get_length () const
 Inherited from tscrollbar. More...
 
unsigned minimum_positioner_length () const
 Inherited from tscrollbar. More...
 
unsigned maximum_positioner_length () const
 Inherited from tscrollbar. More...
 
unsigned offset_before () const
 Inherited from tscrollbar. More...
 
unsigned offset_after () const
 Inherited from tscrollbar. More...
 
bool on_positioner (const tpoint &coordinate) const
 Inherited from tscrollbar. More...
 
int on_bar (const tpoint &coordinate) const
 Inherited from tscrollbar. More...
 
bool in_orthogonal_range (const tpoint &coordinate) const
 Inherited from tscrollbar. More...
 
int get_length_difference (const tpoint &original, const tpoint &current) const
 Inherited from tscrollbar. More...
 
virtual void update_canvas () override
 See tcontrol::update_canvas. More...
 
virtual const std::stringget_control_type () const override
 See tcontrol::get_control_type. 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::tevent event, bool &handled, const SDLKey key)
 Signal handlers: More...
 
void signal_handler_left_button_up (const event::tevent 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...
 
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...
 
tlabel_creator value_labels_
 This allows the slider to show custom texts instead of the values. More...
 

Detailed Description

A slider.

Definition at line 30 of file slider.hpp.

Member Typedef Documentation

typedef std::function<t_string(int , int )> gui2::tslider::tlabel_creator

Definition at line 71 of file slider.hpp.

Constructor & Destructor Documentation

gui2::tslider::tslider ( )

Definition at line 40 of file slider.cpp.

References signal_handler_left_button_up(), and signal_handler_sdl_key_down().

Member Function Documentation

tpoint gui2::tslider::calculate_best_size ( ) const
overrideprivatevirtual
void gui2::tslider::child_callback_positioner_moved ( )
protectedvirtual

Inherited from tscrollbar.

Reimplemented from gui2::tscrollbar_.

Definition at line 153 of file slider.cpp.

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

const std::string & gui2::tslider::get_control_type ( ) const
overrideprivatevirtual

See tcontrol::get_control_type.

Implements gui2::tcontrol.

Definition at line 240 of file slider.cpp.

unsigned gui2::tslider::get_length ( ) const
inlineprivatevirtual

Inherited from tscrollbar.

Implements gui2::tscrollbar_.

Definition at line 123 of file slider.hpp.

References gui2::twidget::get_width().

int gui2::tslider::get_length_difference ( const tpoint original,
const tpoint current 
) const
inlineprivatevirtual

Inherited from tscrollbar.

Implements gui2::tscrollbar_.

Definition at line 150 of file slider.hpp.

References gui2::tpoint::x.

int gui2::tslider::get_maximum_value ( ) const
inlinevirtual
int gui2::tslider::get_minimum_value ( ) const
inlinevirtual

Inherited from tinteger_selector_.

Implements gui2::tinteger_selector_.

Definition at line 57 of file slider.hpp.

References minimum_value_.

Referenced by get_value_label().

int gui2::tslider::get_value ( ) const
inlinevirtual
t_string gui2::tslider::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 138 of file slider.cpp.

References t_string::empty(), gui2::tscrollbar_::get_item_count(), gui2::tscrollbar_::get_item_position(), get_maximum_value(), get_minimum_value(), get_value(), maximum_value_label_, minimum_value_label_, and value_labels_.

Referenced by gui2::tpreferences::bind_status_label(), gui2::disambiguate_widget_value(), and update_canvas().

void gui2::tslider::handle_key_decrease ( bool &  handled)
private

Handlers for keyboard input.

Definition at line 246 of file slider.cpp.

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

Referenced by signal_handler_sdl_key_down().

void gui2::tslider::handle_key_increase ( bool &  handled)
private
bool gui2::tslider::in_orthogonal_range ( const tpoint coordinate) const
privatevirtual

Inherited from tscrollbar.

Implements gui2::tscrollbar_.

Definition at line 223 of file slider.cpp.

References gui2::twidget::get_width(), offset_after(), and gui2::tpoint::x.

unsigned gui2::tslider::maximum_positioner_length ( ) const
privatevirtual

Inherited from tscrollbar.

Implements gui2::tscrollbar_.

Definition at line 167 of file slider.cpp.

References gui2::tcontrol::config().

unsigned gui2::tslider::minimum_positioner_length ( ) const
privatevirtual

Inherited from tscrollbar.

Implements gui2::tscrollbar_.

Definition at line 158 of file slider.cpp.

References gui2::tcontrol::config().

unsigned gui2::tslider::offset_after ( ) const
privatevirtual

Inherited from tscrollbar.

Implements gui2::tscrollbar_.

Definition at line 185 of file slider.cpp.

References gui2::tcontrol::config().

Referenced by in_orthogonal_range().

unsigned gui2::tslider::offset_before ( ) const
privatevirtual

Inherited from tscrollbar.

Implements gui2::tscrollbar_.

Definition at line 176 of file slider.cpp.

References gui2::tcontrol::config().

int gui2::tslider::on_bar ( const tpoint coordinate) const
privatevirtual
bool gui2::tslider::on_positioner ( const tpoint coordinate) const
privatevirtual
void gui2::tslider::set_best_slider_length ( const unsigned  length)
inline
void gui2::tslider::set_maximum_value ( const int  maximum_value)
virtual
void gui2::tslider::set_maximum_value_label ( const t_string maximum_value_label)
inline

Definition at line 85 of file slider.hpp.

References maximum_value_label_.

Referenced by gui2::implementation::tbuilder_slider::build().

void gui2::tslider::set_minimum_value ( const int  minimum_value)
virtual
void gui2::tslider::set_minimum_value_label ( const t_string minimum_value_label)
inline

Definition at line 80 of file slider.hpp.

References minimum_value_label_.

Referenced by gui2::implementation::tbuilder_slider::build().

void gui2::tslider::set_value ( const int  value)
virtual
void gui2::tslider::set_value_labels ( const std::vector< t_string > &  value_labels)
void gui2::tslider::set_value_labels ( const tlabel_creator value_labels)
inline

Definition at line 92 of file slider.hpp.

References value_labels_.

void gui2::tslider::signal_handler_left_button_up ( const event::tevent  event,
bool &  handled 
)
private

Definition at line 280 of file slider.cpp.

References DBG_GUI_E, gui2::twidget::get_window(), gui2::twindow::keyboard_capture(), and LOG_HEADER.

Referenced by tslider().

void gui2::tslider::signal_handler_sdl_key_down ( const event::tevent  event,
bool &  handled,
const SDLKey  key 
)
private

Signal handlers:

Definition at line 264 of file slider.cpp.

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

Referenced by tslider().

void gui2::tslider::update_canvas ( )
overrideprivatevirtual

Member Data Documentation

unsigned gui2::tslider::best_slider_length_
private

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

Definition at line 112 of file slider.hpp.

Referenced by calculate_best_size(), and set_best_slider_length().

t_string gui2::tslider::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 169 of file slider.hpp.

Referenced by get_value_label(), and set_maximum_value_label().

int gui2::tslider::minimum_value_
private

The minimum value the slider holds.

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

Definition at line 120 of file slider.hpp.

Referenced by get_maximum_value(), get_minimum_value(), get_value(), set_maximum_value(), set_minimum_value(), and set_value().

t_string gui2::tslider::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 163 of file slider.hpp.

Referenced by get_value_label(), and set_minimum_value_label().

tlabel_creator gui2::tslider::value_labels_
private

This allows the slider to show custom texts instead of the values.

This vector should have the same amount of items as options for the sliders. When set these texts are shown instead of the values. It also overrides minimum_value_label_ and maximum_value_label_.

Definition at line 177 of file slider.hpp.

Referenced by get_value_label(), and set_value_labels().


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