The Battle for Wesnoth  1.13.10+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 | Friends | List of all members
gui2::scrollbar_base Class Referenceabstract

Base class for a scroll bar. More...

#include <scrollbar.hpp>

Inheritance diagram for gui2::scrollbar_base:
Inheritance graph

Public Types

enum  scroll_mode {
  BEGIN, ITEM_BACKWARDS, HALF_JUMP_BACKWARDS, JUMP_BACKWARDS,
  END, ITEM_FORWARD, HALF_JUMP_FORWARD, JUMP_FORWARD
}
 scroll 'step size'. More...
 
enum  state_t { ENABLED, DISABLED, PRESSED, FOCUSED }
 Possible states of the widget. More...
 
- Public Types inherited from gui2::widget
enum  visibility { visibility::visible, visibility::hidden, visibility::invisible }
 Visibility settings done by the user. More...
 
enum  redraw_action { redraw_action::full, redraw_action::partly, redraw_action::none }
 Visibility set by the engine. More...
 
- 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  mouse_behavior { all, hit, none }
 The behavior of the mouse events. More...
 

Public Member Functions

 scrollbar_base (const implementation::builder_styled_widget &builder, const std::string &control_type)
 
void scroll (const scroll_mode scroll)
 Sets the item position. More...
 
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
 
- 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 string_map &data)
 Sets the members of the styled_widget. More...
 
bool disable_click_dismiss () const override
 See widget::disable_click_dismiss. More...
 
virtual iteration::walker_basecreate_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 &id, const bool must_be_active) override
 See widget::find. More...
 
const widgetfind (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_stringget_label () 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< 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...
 
virtual const std::string & get_control_type () const =0
 Returns the control_type of the styled_widget. 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...
 
dialogs::modal_dialogdialog ()
 Returns the top-level dialog. More...
 
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...
 
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 (window &caller, std::vector< widget * > &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 visibility visible)
 
visibility get_visible () const
 
redraw_action get_drawing_action () const
 
void set_debug_border_mode (const unsigned 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...
 
- 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...
 
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 utf8::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 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, 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>
utils::enable_if_t< has_key
< set_event, E >::value > 
connect_signal (const signal_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event, E >::value > 
disconnect_signal (const signal_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_mouse, E >::value > 
connect_signal (const signal_mouse_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_mouse. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_mouse, E >::value > 
disconnect_signal (const signal_mouse_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_mouse. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_keyboard, E >
::value > 
connect_signal (const signal_keyboard_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_keyboard. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_keyboard, E >
::value > 
disconnect_signal (const signal_keyboard_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_keyboard. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_touch, E >::value > 
connect_signal (const signal_touch_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_touch. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_touch, E >::value > 
disconnect_signal (const signal_touch_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_touch. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_notification, E >
::value > 
connect_signal (const signal_notification_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_notification. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_notification, E >
::value > 
disconnect_signal (const signal_notification_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_notification. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_message, E >
::value > 
connect_signal (const signal_message_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_message. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_message, E >
::value > 
disconnect_signal (const signal_message_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_message. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_raw_event, E >
::value > 
connect_signal (const signal_raw_event_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_raw_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_raw_event, E >
::value > 
disconnect_signal (const signal_raw_event_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_raw_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_text_input, E >
::value > 
connect_signal (const signal_text_input_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_text_input. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_text_input, E >
::value > 
disconnect_signal (const signal_text_input_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_text_input. 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...
 

Protected Member Functions

void finalize_setup ()
 
unsigned get_positioner_offset () const
 
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 config ()
 
resolution_definition_const_ptr 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)
 
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 widget::impl_draw_background. More...
 
virtual void impl_draw_foreground (surface &frame_buffer, int x_offset, int y_offset) override
 See widget::impl_draw_foreground. More...
 
std::string get_label_token (const gui2::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 gui2::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...
 

Private Member Functions

void set_state (const state_t state)
 
virtual unsigned get_length () const =0
 Get the length of the scrollbar. More...
 
virtual unsigned minimum_positioner_length () const =0
 The minimum length of the positioner. More...
 
virtual unsigned maximum_positioner_length () const =0
 The maximum length of the positioner. More...
 
virtual unsigned offset_before () const =0
 The number of pixels we can't use since they're used for borders. More...
 
virtual unsigned offset_after () const =0
 The number of pixels we can't use since they're used for borders. More...
 
virtual bool on_positioner (const point &coordinate) const =0
 Is the coordinate on the positioner? More...
 
virtual int on_bar (const point &coordinate) const =0
 Is the coordinate on the bar? More...
 
virtual bool in_orthogonal_range (const point &coordinate) const =0
 Is the coordinate in the bar's orthogonal range? More...
 
virtual int get_length_difference (const point &original, const point &current) const =0
 Gets the relevant difference in between the two positions. More...
 
void recalculate ()
 Updates the scrollbar. More...
 
void recalculate_positioner ()
 Updates the positioner. More...
 
virtual void move_positioner (const int distance)
 Moves the positioner. More...
 
void signal_handler_mouse_enter (const event::ui_event event, bool &handled, bool &halt)
 
void signal_handler_mouse_motion (const event::ui_event event, bool &handled, bool &halt, const point &coordinate)
 
void signal_handler_mouse_leave (const event::ui_event event, bool &handled)
 
void signal_handler_left_button_down (const event::ui_event event, bool &handled)
 
void signal_handler_left_button_up (const event::ui_event event, bool &handled)
 

Private Attributes

state_t state_
 Current state of the widget. More...
 
unsigned item_count_
 The number of items the scrollbar 'holds'. More...
 
unsigned item_position_
 The item the positioner is at, starts at 0. More...
 
unsigned visible_items_
 The number of items which can be shown at the same time. More...
 
unsigned step_size_
 Number of items moved when scrolling. More...
 
float pixels_per_step_
 Number of pixels per step. More...
 
point mouse_
 The position the mouse was at the last movement. More...
 
unsigned positioner_offset_
 The start offset of the positioner. More...
 
unsigned positioner_length_
 The current length of the positioner. More...
 

Friends

class slider
 

Detailed Description

Base class for a scroll bar.

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

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

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

Common signal handlers:

Definition at line 40 of file scrollbar.hpp.

Member Enumeration Documentation

scroll 'step size'.

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

Enumerator
BEGIN 

Go to begin position.

ITEM_BACKWARDS 

Go one item towards the begin.

HALF_JUMP_BACKWARDS 

Go half the visible items towards the begin.

JUMP_BACKWARDS 

Go the visible items towards the begin.

END 

Go to the end position.

ITEM_FORWARD 

Go one item towards the end.

HALF_JUMP_FORWARD 

Go half the visible items towards the end.

JUMP_FORWARD 

Definition at line 54 of file scrollbar.hpp.

Possible states of the widget.

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

Enumerator
ENABLED 
DISABLED 
PRESSED 
FOCUSED 

Definition at line 118 of file scrollbar.hpp.

Constructor & Destructor Documentation

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

Member Function Documentation

bool gui2::scrollbar_base::all_items_visible ( ) const
inline

Are all items visible?

Definition at line 92 of file scrollbar.hpp.

References item_count_, and visible_items_.

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

bool gui2::scrollbar_base::at_begin ( ) const
inline

Is the positioner at the beginning of the scrollbar?

Definition at line 76 of file scrollbar.hpp.

References item_position_.

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

bool gui2::scrollbar_base::at_end ( ) const
inline

Is the positioner at the and of the scrollbar?

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

Definition at line 86 of file scrollbar.hpp.

References item_count_, item_position_, and visible_items_.

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

virtual void gui2::scrollbar_base::child_callback_positioner_moved ( )
inlineprotectedvirtual

Callback for subclasses to get notified about positioner movement.

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

Reimplemented in gui2::slider.

Definition at line 211 of file scrollbar.hpp.

Referenced by move_positioner().

void gui2::scrollbar_base::finalize_setup ( )
protected
bool gui2::scrollbar_base::get_active ( ) const
overridevirtual

See styled_widget::get_active.

Implements gui2::styled_widget.

Definition at line 134 of file scrollbar.cpp.

References DISABLED, and state_.

Referenced by set_active().

unsigned gui2::scrollbar_base::get_item_count ( ) const
inline
unsigned gui2::scrollbar_base::get_item_position ( ) const
inline
virtual unsigned gui2::scrollbar_base::get_length ( ) const
privatepure virtual

Get the length of the scrollbar.

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

Referenced by move_positioner(), and recalculate().

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

Gets the relevant difference in between the two positions.

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

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

Referenced by signal_handler_mouse_motion().

point gui2::scrollbar_base::get_mouse_position_last_move ( ) const
inlineprotected

Definition at line 192 of file scrollbar.hpp.

References mouse_.

float gui2::scrollbar_base::get_pixels_per_step ( ) const
inline

Definition at line 174 of file scrollbar.hpp.

References pixels_per_step_.

unsigned gui2::scrollbar_base::get_positioner_length ( ) const
inlineprotected
unsigned gui2::scrollbar_base::get_positioner_offset ( ) const
inlineprotected
unsigned gui2::scrollbar_base::get_state ( ) const
overridevirtual

See styled_widget::get_state.

Implements gui2::styled_widget.

Definition at line 139 of file scrollbar.cpp.

References state_.

unsigned gui2::scrollbar_base::get_step_size ( ) const
inline
unsigned gui2::scrollbar_base::get_visible_items ( ) const
inline

Definition at line 147 of file scrollbar.hpp.

References visible_items_.

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

Is the coordinate in the bar's orthogonal range?

Parameters
coordinateCoordinate to test whether it's in-range.
Returns
Whether the location is in the bar's. orthogonal range.

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

Referenced by signal_handler_mouse_motion().

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

The maximum length of the positioner.

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

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

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

The minimum length of the positioner.

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

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

void gui2::scrollbar_base::move_positioner ( const int  distance)
privatevirtual
virtual unsigned gui2::scrollbar_base::offset_after ( ) const
privatepure virtual

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

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

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

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

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

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

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

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

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

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

Is the coordinate on the bar?

Parameters
coordinateCoordinate to test whether it's on the bar.
Returns
Whether the location on the bar is.
Return values
-1Coordinate is on the bar before positioner.
0Coordinate is not on the bar.
1Coordinate is on the bar after the positioner.

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

Referenced by signal_handler_left_button_down().

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

Is the coordinate on the positioner?

Parameters
coordinateCoordinate to test whether it's on the positioner.
Returns
Whether the location on the positioner is.

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

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

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

See widget::place.

Reimplemented from gui2::styled_widget.

Definition at line 119 of file scrollbar.cpp.

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

void gui2::scrollbar_base::recalculate ( )
private

Updates the scrollbar.

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

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

Definition at line 189 of file scrollbar.cpp.

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

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

void gui2::scrollbar_base::recalculate_positioner ( )
private

Updates the positioner.

This is a helper for recalculate().

Definition at line 261 of file scrollbar.cpp.

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

Referenced by recalculate().

void gui2::scrollbar_base::scroll ( const scroll_mode  scroll)
void gui2::scrollbar_base::set_active ( const bool  active)
overridevirtual
void gui2::scrollbar_base::set_item_count ( const unsigned  item_count)
inline
void gui2::scrollbar_base::set_item_position ( const unsigned  item_position)
void gui2::scrollbar_base::set_state ( const state_t  state)
private
void gui2::scrollbar_base::set_step_size ( const unsigned  step_size)
inline
void gui2::scrollbar_base::set_visible_items ( const unsigned  visible_items)
inline

Definition at line 152 of file scrollbar.hpp.

References recalculate(), and visible_items_.

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

void gui2::scrollbar_base::signal_handler_left_button_down ( const event::ui_event  event,
bool &  handled 
)
private
void gui2::scrollbar_base::signal_handler_left_button_up ( const event::ui_event  event,
bool &  handled 
)
private
void gui2::scrollbar_base::signal_handler_mouse_enter ( const event::ui_event  event,
bool &  handled,
bool &  halt 
)
private
void gui2::scrollbar_base::signal_handler_mouse_leave ( const event::ui_event  event,
bool &  handled 
)
private

Definition at line 383 of file scrollbar.cpp.

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

Referenced by scrollbar_base().

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

See styled_widget::update_canvas.

After a recalculation the canvasses also need to be updated.

Reimplemented from gui2::styled_widget.

Reimplemented in gui2::slider.

Definition at line 171 of file scrollbar.cpp.

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

Referenced by move_positioner(), recalculate(), set_item_position(), and gui2::slider::update_canvas().

Friends And Related Function Documentation

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

Definition at line 43 of file scrollbar.hpp.

Member Data Documentation

unsigned gui2::scrollbar_base::item_count_
private

The number of items the scrollbar 'holds'.

Definition at line 226 of file scrollbar.hpp.

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

unsigned gui2::scrollbar_base::item_position_
private

The item the positioner is at, starts at 0.

Definition at line 229 of file scrollbar.hpp.

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

point gui2::scrollbar_base::mouse_
private

The position the mouse was at the last movement.

This is used during dragging the positioner.

Definition at line 261 of file scrollbar.hpp.

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

float gui2::scrollbar_base::pixels_per_step_
private

Number of pixels per step.

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

Definition at line 254 of file scrollbar.hpp.

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

unsigned gui2::scrollbar_base::positioner_length_
private

The current length of the positioner.

Definition at line 271 of file scrollbar.hpp.

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

unsigned gui2::scrollbar_base::positioner_offset_
private

The start offset of the positioner.

This takes the offset before in consideration.

Definition at line 268 of file scrollbar.hpp.

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

state_t gui2::scrollbar_base::state_
private

Current state of the widget.

The state of the widget determines what to render and how the widget reacts to certain 'events'.

Definition at line 223 of file scrollbar.hpp.

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

unsigned gui2::scrollbar_base::step_size_
private

Number of items moved when scrolling.

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

Definition at line 245 of file scrollbar.hpp.

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

unsigned gui2::scrollbar_base::visible_items_
private

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

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

Definition at line 236 of file scrollbar.hpp.

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


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