The Battle for Wesnoth  1.19.6+dev
Public Member Functions | Static Public Member Functions | Private Member Functions | Friends | List of all members
gui2::horizontal_scrollbar Class Reference

#include <horizontal_scrollbar.hpp>

Inheritance diagram for gui2::horizontal_scrollbar:

Public Member Functions

 horizontal_scrollbar (const implementation::builder_horizontal_scrollbar &builder)
 
- Public Member Functions inherited from gui2::scrollbar_base
 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 widgetfind_at (const point &coordinate, const bool must_be_active) override
 See widget::find_at. More...
 
virtual const widgetfind_at (const point &coordinate, const bool must_be_active) const override
 See widget::find_at. More...
 
widgetfind (const std::string_view id, const bool must_be_active) override
 See widget::find. More...
 
const widgetfind (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_stringget_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_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< canvas > & get_canvases ()
 
canvasget_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
 
widgetoperator= (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
 
windowget_window ()
 Get the parent window. More...
 
const windowget_window () const
 The constant version of get_window. More...
 
gridget_parent_grid ()
 Get the parent grid. More...
 
const gridget_parent_grid () const
 
void set_parent (widget *parent)
 
widgetparent ()
 
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_executorset_wants_mouse_right_double_click (const bool click=true)
 
bool wants_mouse_right_double_click () const
 
- Public Member Functions inherited from gui2::event::dispatcher
 dispatcher ()
 
virtual ~dispatcher ()
 
void connect ()
 Connects the dispatcher to the event handler. More...
 
void disconnect ()
 Disconnects the dispatcher from the event handler. More...
 
bool is_connected () const
 Return whether the dispatcher is currently connected. More...
 
bool has_event (const ui_event event, const event_queue_type event_type)
 
bool fire (const ui_event event, widget &target)
 Fires an event which has no extra parameters. More...
 
bool fire (const ui_event event, widget &target, const point &coordinate)
 Fires an event which takes a coordinate parameter. More...
 
bool fire (const ui_event event, widget &target, const SDL_Keycode key, const SDL_Keymod modifier, const std::string &unicode)
 Fires an event which takes keyboard parameters. More...
 
bool fire (const ui_event event, widget &target, const point &pos, const point &distance)
 Fires an event which takes touch-motion parameters. More...
 
bool fire (const ui_event event, widget &target, const point &center, float dTheta, float dDist, uint8_t numFingers)
 Fires an event which takes touch-gesture parameters. More...
 
bool fire (const ui_event event, widget &target, void *)
 Fires an event which takes notification parameters. More...
 
bool fire (const ui_event event, widget &target, const message &msg)
 Fires an event which takes message parameters. More...
 
bool fire (const ui_event event, widget &target, const SDL_Event &sdlevent)
 Fires an event that's a raw SDL event. More...
 
bool fire (const ui_event event, widget &target, const std::string &text, int32_t start, int32_t len)
 Fires an event which takes text input parameters. More...
 
template<ui_event E, typename F >
void connect_signal (const F &func, const queue_position position=back_child)
 Adds a callback to the appropriate queue based on event type. More...
 
template<ui_event E, typename F >
void disconnect_signal (const F &func, const queue_position position=back_child)
 Removes a callback from the appropriate queue based on event type. More...
 
void capture_mouse ()
 Captures the mouse. More...
 
void release_mouse ()
 Releases the mouse capture. More...
 
void set_mouse_behavior (const mouse_behavior mouse_behavior)
 
mouse_behavior get_mouse_behavior () const
 
void set_want_keyboard_input (const bool want_keyboard_input)
 
bool get_want_keyboard_input () const
 
void register_hotkey (const hotkey::HOTKEY_COMMAND id, const hotkey_function &function)
 Registers a hotkey. More...
 
bool execute_hotkey (const hotkey::HOTKEY_COMMAND id)
 Executes a hotkey. More...
 
- Public Member Functions inherited from enable_lua_ptr< widget >
 enable_lua_ptr (widget *tp)
 

Static Public Member Functions

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

Private Member Functions

virtual unsigned get_length () const override
 Inherited from scrollbar_base. More...
 
virtual unsigned minimum_positioner_length () const override
 Inherited from scrollbar_base. More...
 
virtual unsigned maximum_positioner_length () const override
 Inherited from scrollbar_base. More...
 
virtual unsigned offset_before () const override
 Inherited from scrollbar_base. More...
 
virtual unsigned offset_after () const override
 Inherited from scrollbar_base. More...
 
virtual bool on_positioner (const point &coordinate) const override
 Inherited from scrollbar_base. More...
 
virtual int on_bar (const point &coordinate) const override
 Inherited from scrollbar_base. More...
 
virtual bool in_orthogonal_range (const point &coordinate) const override
 Inherited from scrollbar_base. More...
 
virtual int get_length_difference (const point &original, const point &current) const override
 Inherited from scrollbar_base. More...
 
virtual const std::string & get_control_type () const override
 Inherited from styled_widget, implemented by REGISTER_WIDGET. More...
 

Friends

struct implementation::builder_horizontal_scrollbar
 

Additional Inherited Members

- Public Types inherited from gui2::scrollbar_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 }
 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...
 
- Protected Member Functions inherited from gui2::scrollbar_base
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 pointlayout_size () const
 
void clear_layout_size ()
 Throws away layout_size_. More...
 

Detailed Description

Definition at line 31 of file horizontal_scrollbar.hpp.

Constructor & Destructor Documentation

◆ horizontal_scrollbar()

gui2::horizontal_scrollbar::horizontal_scrollbar ( const implementation::builder_horizontal_scrollbar builder)
explicit

Definition at line 32 of file horizontal_scrollbar.cpp.

Member Function Documentation

◆ get_control_type()

virtual const std::string& gui2::horizontal_scrollbar::get_control_type ( ) const
overrideprivatevirtual

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Implements gui2::styled_widget.

◆ get_length()

virtual unsigned gui2::horizontal_scrollbar::get_length ( ) const
inlineoverrideprivatevirtual

Inherited from scrollbar_base.

Implements gui2::scrollbar_base.

Definition at line 40 of file horizontal_scrollbar.hpp.

References gui2::widget::get_width().

◆ get_length_difference()

virtual int gui2::horizontal_scrollbar::get_length_difference ( const point original,
const point current 
) const
inlineoverrideprivatevirtual

Inherited from scrollbar_base.

Implements gui2::scrollbar_base.

Definition at line 67 of file horizontal_scrollbar.hpp.

◆ in_orthogonal_range()

bool gui2::horizontal_scrollbar::in_orthogonal_range ( const point coordinate) const
overrideprivatevirtual

Inherited from scrollbar_base.

Implements gui2::scrollbar_base.

Definition at line 99 of file horizontal_scrollbar.cpp.

References gui2::widget::get_width(), and map_location::x.

◆ maximum_positioner_length()

unsigned gui2::horizontal_scrollbar::maximum_positioner_length ( ) const
overrideprivatevirtual

Inherited from scrollbar_base.

Implements gui2::scrollbar_base.

Definition at line 45 of file horizontal_scrollbar.cpp.

◆ minimum_positioner_length()

unsigned gui2::horizontal_scrollbar::minimum_positioner_length ( ) const
overrideprivatevirtual

Inherited from scrollbar_base.

Implements gui2::scrollbar_base.

Definition at line 37 of file horizontal_scrollbar.cpp.

◆ offset_after()

unsigned gui2::horizontal_scrollbar::offset_after ( ) const
overrideprivatevirtual

Inherited from scrollbar_base.

Implements gui2::scrollbar_base.

Definition at line 61 of file horizontal_scrollbar.cpp.

◆ offset_before()

unsigned gui2::horizontal_scrollbar::offset_before ( ) const
overrideprivatevirtual

Inherited from scrollbar_base.

Implements gui2::scrollbar_base.

Definition at line 53 of file horizontal_scrollbar.cpp.

◆ on_bar()

int gui2::horizontal_scrollbar::on_bar ( const point coordinate) const
overrideprivatevirtual

◆ on_positioner()

bool gui2::horizontal_scrollbar::on_positioner ( const point coordinate) const
overrideprivatevirtual

◆ type()

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

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

Friends And Related Function Documentation

◆ implementation::builder_horizontal_scrollbar

Definition at line 33 of file horizontal_scrollbar.hpp.


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