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 Types | Private Member Functions | Private Attributes | Friends | List of all members
gui2::scrollbar_container Class Reference

Base class for creating containers with one or two scrollbar(s). More...

#include <scrollbar_container.hpp>

Inheritance diagram for gui2::scrollbar_container:
Inheritance graph

Public Types

enum  scrollbar_mode { ALWAYS_VISIBLE, ALWAYS_INVISIBLE, AUTO_VISIBLE, AUTO_VISIBLE_FIRST_RUN }
 The way to handle the showing or hiding of the scrollbar. 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_container (const implementation::builder_styled_widget &builder, const std::string &control_type)
 
virtual ~scrollbar_container ()
 
virtual void layout_initialize (const bool full_initialization) override
 See widget::layout_initialize. More...
 
virtual void request_reduce_height (const unsigned maximum_height) override
 See widget::request_reduce_height. More...
 
virtual void request_reduce_width (const unsigned maximum_width) override
 See widget::request_reduce_width. More...
 
virtual bool can_wrap () const override
 See widget::can_wrap. More...
 
virtual void place (const point &origin, const point &size) override
 See widget::place. More...
 
virtual void set_origin (const point &origin) override
 See widget::set_origin. More...
 
virtual void set_visible_rectangle (const SDL_Rect &rectangle) override
 See widget::set_visible_rectangle. 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...
 
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 disable_click_dismiss () const override
 See widget::disable_click_dismiss. More...
 
void set_vertical_scrollbar_mode (const scrollbar_mode scrollbar_mode)
 
scrollbar_mode get_vertical_scrollbar_mode () const
 
void set_horizontal_scrollbar_mode (const scrollbar_mode scrollbar_mode)
 
scrollbar_mode get_horizontal_scrollbar_mode () const
 
gridcontent_grid ()
 
const gridcontent_grid () const
 
const SDL_Rect & content_visible_area () const
 
bool vertical_scrollbar_at_end ()
 
unsigned get_vertical_scrollbar_item_position () const
 Returns current position of the vertical scrollbar. More...
 
void set_vertical_scrollbar_item_position (const unsigned position)
 Move the vertical scrollbar to a position. More...
 
unsigned get_horizontal_scrollbar_item_position () const
 Returns current position of the horizontal scrollbar. More...
 
void set_horizontal_scrollbar_item_position (const unsigned position)
 Move the horizontal scrollbar to a position. More...
 
void scroll_vertical_scrollbar (const scrollbar_base::scroll_mode scroll)
 Scrolls the vertical scrollbar. More...
 
void scroll_horizontal_scrollbar (const scrollbar_base::scroll_mode scroll)
 Scrolls the horizontal scrollbar. More...
 
void vertical_scrollbar_moved ()
 Callback when the scrollbar moves (NOTE maybe only one callback needed). More...
 
void horizontal_scrollbar_moved ()
 
scrollbar_basehorizontal_scrollbar ()
 
scrollbar_basevertical_scrollbar ()
 
gridget_horizontal_scrollbar_grid ()
 
gridget_vertical_scrollbar_grid ()
 
- Public Member Functions inherited from gui2::container_base
 container_base (const implementation::builder_styled_widget &builder, const std::string &control_type)
 
virtual SDL_Rect get_client_rect () const
 Returns the client rect. More...
 
void reduce_width (const unsigned maximum_width)
 Tries to reduce the width of a container. More...
 
virtual void demand_reduce_width (const unsigned maximum_width) override
 See widget::demand_reduce_width. More...
 
void reduce_height (const unsigned maximum_height)
 Tries to reduce the height of a container. More...
 
virtual void demand_reduce_height (const unsigned maximum_height) override
 See widget::demand_reduce_height. More...
 
virtual bool has_widget (const widget &widget) const override
 See widget::has_widget. More...
 
virtual void set_active (const bool active) override
 See styled_widget::set_active. More...
 
virtual iteration::walker_basecreate_walker () override
 See widget::create_walker. More...
 
void init_grid (const std::shared_ptr< builder_grid > &grid_builder)
 Initializes and builds the grid. More...
 
grid::iterator begin ()
 
grid::iterator end ()
 
unsigned add_row (const unsigned count=1)
 
void set_rows (const unsigned rows)
 
unsigned int get_rows () const
 
void set_cols (const unsigned cols)
 
unsigned int get_cols () const
 
void set_rows_cols (const unsigned rows, const unsigned cols)
 
void set_child (widget *widget, const unsigned row, const unsigned col, const unsigned flags, const unsigned border_size)
 
void set_row_grow_factor (const unsigned row, const unsigned factor)
 
void set_column_grow_factor (const unsigned column, const unsigned factor)
 
const gridget_grid () const
 
gridget_grid ()
 
- 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...
 
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...
 
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...
 
- 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 ()
 
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 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...
 
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...
 
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)
 
- 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 show_content_rect (const SDL_Rect &rect)
 Shows a certain part of the content. More...
 
void set_scrollbar_button_status ()
 Sets the status of the scrollbar buttons. More...
 
bool content_resize_request (const bool force_sizing=false)
 Notification if the content of a child needs a resize. More...
 
bool content_resize_request (const int width_modification, const int height_modification, const int width_modification_pos=-1, const int height_modification_pos=-1)
 Request from the content to modify the size of the container. More...
 
virtual void handle_key_home (SDL_Keymod modifier, bool &handled)
 Home key pressed. More...
 
virtual void handle_key_end (SDL_Keymod modifier, bool &handled)
 End key pressed. More...
 
virtual void handle_key_page_up (SDL_Keymod modifier, bool &handled)
 Page up key pressed. More...
 
virtual void handle_key_page_down (SDL_Keymod modifier, bool &handled)
 Page down key pressed. More...
 
virtual void handle_key_up_arrow (SDL_Keymod modifier, bool &handled)
 Up arrow key pressed. More...
 
virtual void handle_key_down_arrow (SDL_Keymod modifier, bool &handled)
 Down arrow key pressed. More...
 
virtual void handle_key_left_arrow (SDL_Keymod modifier, bool &handled)
 Left arrow key pressed. More...
 
virtual void handle_key_right_arrow (SDL_Keymod modifier, bool &handled)
 Right arrow key pressed. More...
 
- Protected Member Functions inherited from gui2::styled_widget
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)
 
virtual void update_canvas ()
 Updates the canvas(ses). 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 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 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...
 

Private Types

enum  state_t { ENABLED, DISABLED }
 Possible states of the widget. More...
 

Private Member Functions

virtual point calculate_best_size () const override
 See widget::calculate_best_size. More...
 
bool content_resize_width (const int width_modification, const int width_modification_pos)
 Helper for content_resize_request. More...
 
bool content_resize_height (const int height_modification, const int width_modification_pos)
 Helper for content_resize_request. More...
 
void finalize_setup ()
 The builder needs to call us so we do our setup. More...
 
virtual void finalize_subclass ()
 Function for the subclasses to do their setup. More...
 
virtual void layout_children () override
 See widget::layout_children. More...
 
virtual void impl_draw_children (surface &frame_buffer, int x_offset, int y_offset) override
 See widget::impl_draw_children. More...
 
virtual void child_populate_dirty_list (window &caller, const std::vector< widget * > &call_stack) override
 See widget::child_populate_dirty_list. More...
 
virtual void set_content_size (const point &origin, const point &size)
 Sets the size of the content grid. More...
 
void scrollbar_moved ()
 Helper function which needs to be called after the scollbar moved. More...
 
virtual const std::string & get_control_type () const override
 See styled_widget::get_control_type. More...
 
void signal_handler_sdl_key_down (const event::ui_event event, bool &handled, const SDL_Keycode key, SDL_Keymod modifier)
 
void signal_handler_sdl_wheel_up (const event::ui_event event, bool &handled)
 
void signal_handler_sdl_wheel_down (const event::ui_event event, bool &handled)
 
void signal_handler_sdl_wheel_left (const event::ui_event event, bool &handled)
 
void signal_handler_sdl_wheel_right (const event::ui_event event, bool &handled)
 

Private Attributes

state_t state_
 Current state of the widget. More...
 
scrollbar_mode vertical_scrollbar_mode_
 The mode of how to show the scrollbar. More...
 
scrollbar_mode horizontal_scrollbar_mode_
 
gridvertical_scrollbar_grid_
 These are valid after finalize_setup(). More...
 
gridhorizontal_scrollbar_grid_
 
scrollbar_basevertical_scrollbar_
 These are valid after finalize_setup(). More...
 
scrollbar_basehorizontal_scrollbar_
 
std::unique_ptr< gridcontent_grid_
 The grid that holds the content. More...
 
spacercontent_
 Dummy spacer to hold the contents location. More...
 
SDL_Rect content_visible_area_
 Cache for the visible area for the content. More...
 

Friends

class debug_layout_graph
 
struct implementation::builder_scroll_label
 
struct implementation::builder_scrollbar_panel
 
class listbox
 
class tree_view
 
struct scrollbar_container_implementation
 

Detailed Description

Base class for creating containers with one or two scrollbar(s).

For now users can't instanciate this class directly and needs to use small wrapper classes. Maybe in the future users can use the class directly.

Todo:
events are not yet send to the content grid.

Definition at line 40 of file scrollbar_container.hpp.

Member Enumeration Documentation

The way to handle the showing or hiding of the scrollbar.

Enumerator
ALWAYS_VISIBLE 

The scrollbar is always shown, whether needed or not.

ALWAYS_INVISIBLE 

The scrollbar is never shown even notwhen needed.

There's also no space reserved for the scrollbar.

AUTO_VISIBLE 

The scrollbar is shown when the number of items is larger as the visible items.

The space for the scrollbar is always reserved, just in case it's needed after the initial sizing (due to adding items).

AUTO_VISIBLE_FIRST_RUN 

Like AUTO_VISIBLE, but when not needed upon the initial layout phase, the bars are not shown and no space is reserved for them.

(The algorithm hides them by default.

Definition at line 60 of file scrollbar_container.hpp.

Possible states of the widget.

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

Enumerator
ENABLED 
DISABLED 

Definition at line 453 of file scrollbar_container.hpp.

Constructor & Destructor Documentation

gui2::scrollbar_container::scrollbar_container ( const implementation::builder_styled_widget builder,
const std::string &  control_type 
)
explicit
virtual gui2::scrollbar_container::~scrollbar_container ( )
inlinevirtual

Definition at line 55 of file scrollbar_container.hpp.

Member Function Documentation

point gui2::scrollbar_container::calculate_best_size ( ) const
overrideprivatevirtual
bool gui2::scrollbar_container::can_wrap ( ) const
overridevirtual

See widget::can_wrap.

Note
This function is called before the object is finalized.

Reimplemented from gui2::container_base.

Reimplemented in gui2::scroll_label.

Definition at line 274 of file scrollbar_container.cpp.

References content_grid_.

void gui2::scrollbar_container::child_populate_dirty_list ( window caller,
const std::vector< widget * > &  call_stack 
)
overrideprivatevirtual
grid* gui2::scrollbar_container::content_grid ( )
inline
const grid* gui2::scrollbar_container::content_grid ( ) const
inline

Definition at line 165 of file scrollbar_container.hpp.

References content_grid_.

bool gui2::scrollbar_container::content_resize_height ( const int  height_modification,
const int  width_modification_pos 
)
private
bool gui2::scrollbar_container::content_resize_request ( const bool  force_sizing = false)
protected

Notification if the content of a child needs a resize.

When a resize is required the container first can try to handle it itself. If it can't honor the request the function will call window::invalidate_layout().

Note
Calling this function on a widget with size == (0, 0) results false but doesn't call invalidate_layout, the engine expects to be in build up phase with the layout already invalidated.
Parameters
force_sizingIf the contents fit do we want to force a resize? This is needed in the MP lobby since items might not be properly placed yet. (The listboxes with the player info need it.)
Returns
True if the resize is handled, false otherwise.
Todo:
Try to handle AUTO_VISIBLE_FIRST_RUN here as well.

Handling it here makes the code a bit more complex but allows to not reserve space for scrollbars, which will look nicer in the MP lobby. But the extra complexity is no 1.8 material.

Definition at line 509 of file scrollbar_container.cpp.

References ALWAYS_INVISIBLE, AUTO_VISIBLE_FIRST_RUN, content_, content_grid_, DBG_GUI_L, gui2::event::dispatcher::fire(), gui2::widget::get_origin(), gui2::widget::get_size(), gui2::widget::get_visible(), horizontal_scrollbar_grid_, horizontal_scrollbar_mode_, gui2::widget::invisible, LOG_HEADER, place(), gui2::event::REQUEST_PLACEMENT, utf8::size(), vertical_scrollbar_grid_, vertical_scrollbar_mode_, point::x, and point::y.

Referenced by gui2::tree_view::resize_content(), gui2::listbox::resize_content(), gui2::scroll_label::set_label(), gui2::listbox::set_row_shown(), and gui2::listbox::update_content_size().

bool gui2::scrollbar_container::content_resize_request ( const int  width_modification,
const int  height_modification,
const int  width_modification_pos = -1,
const int  height_modification_pos = -1 
)
protected

Request from the content to modify the size of the container.

When the wanted resize fails the function will call window::invalidate_layout().

Note
Calling this function on a widget with size == (0, 0) results false but doesn't call invalidate_layout, the engine expects to be in build up phase with the layout already invalidated.
If window::get_need_layout() is true the function returns false and doesn't try to fit the contents since a layout phase will be triggered anyway.
This function might replace the content_resize_request above.
Parameters
width_modificationThe wanted modification to the width:
  • negative values reduce width.
  • zero leave width as is.
  • positive values increase width.
height_modificationThe wanted modification to the height:
  • negative values reduce height.
  • zero leave height as is.
  • positive values increase height.
width_modification_posThe position where the additional content was inserted/removed, defaults to -1 which means 'at end'
height_modification_posThe position where the additional content was inserted/removed, defaults to -1 which means 'at end'
Returns
True is wanted modification is accepted false otherwise.

Definition at line 589 of file scrollbar_container.cpp.

References content_, content_grid_, content_resize_height(), content_resize_width(), DBG_GUI_L, gui2::window::get_need_layout(), gui2::widget::get_size(), gui2::widget::get_window(), LOG_HEADER, scrollbar_moved(), and set_scrollbar_button_status().

bool gui2::scrollbar_container::content_resize_width ( const int  width_modification,
const int  width_modification_pos 
)
private
const SDL_Rect& gui2::scrollbar_container::content_visible_area ( ) const
inline
bool gui2::scrollbar_container::disable_click_dismiss ( ) const
overridevirtual
void gui2::scrollbar_container::finalize_setup ( )
private
virtual void gui2::scrollbar_container::finalize_subclass ( )
inlineprivatevirtual

Function for the subclasses to do their setup.

This function is called at the end of finalize_setup().

Reimplemented in gui2::scroll_label.

Definition at line 501 of file scrollbar_container.hpp.

Referenced by finalize_setup().

widget * gui2::scrollbar_container::find ( const std::string &  id,
const bool  must_be_active 
)
overridevirtual

See widget::find.

Reimplemented from gui2::container_base.

Definition at line 493 of file scrollbar_container.cpp.

References gui2::widget::id().

Referenced by gui2::dialogs::end_credits::pre_show().

const widget * gui2::scrollbar_container::find ( const std::string &  id,
const bool  must_be_active 
) const
overridevirtual

See widget::find.

Reimplemented from gui2::container_base.

Definition at line 498 of file scrollbar_container.cpp.

References gui2::widget::id().

widget * gui2::scrollbar_container::find_at ( const point coordinate,
const bool  must_be_active 
)
overridevirtual

See widget::find_at.

Reimplemented from gui2::container_base.

Definition at line 473 of file scrollbar_container.cpp.

References gui2::widget::find_at(), and w.

const widget * gui2::scrollbar_container::find_at ( const point coordinate,
const bool  must_be_active 
) const
overridevirtual

See widget::find_at.

Reimplemented from gui2::container_base.

Definition at line 483 of file scrollbar_container.cpp.

References gui2::widget::find_at(), and w.

bool gui2::scrollbar_container::get_active ( ) const
overridevirtual

See styled_widget::get_active.

Implements gui2::styled_widget.

Reimplemented in gui2::scroll_label, and gui2::scrollbar_panel.

Definition at line 463 of file scrollbar_container.cpp.

References DISABLED, and state_.

const std::string & gui2::scrollbar_container::get_control_type ( ) const
overrideprivatevirtual
grid* gui2::scrollbar_container::get_horizontal_scrollbar_grid ( )
inline

Definition at line 552 of file scrollbar_container.hpp.

References horizontal_scrollbar_grid_.

unsigned gui2::scrollbar_container::get_horizontal_scrollbar_item_position ( ) const

Returns current position of the horizontal scrollbar.

Definition at line 937 of file scrollbar_container.cpp.

References gui2::scrollbar_base::get_item_position(), and horizontal_scrollbar_.

Referenced by gui2::listbox::place().

scrollbar_mode gui2::scrollbar_container::get_horizontal_scrollbar_mode ( ) const
inline

Definition at line 155 of file scrollbar_container.hpp.

References horizontal_scrollbar_mode_.

unsigned gui2::scrollbar_container::get_state ( ) const
overridevirtual

See styled_widget::get_state.

Implements gui2::styled_widget.

Reimplemented in gui2::scroll_label, and gui2::scrollbar_panel.

Definition at line 468 of file scrollbar_container.cpp.

References state_.

grid* gui2::scrollbar_container::get_vertical_scrollbar_grid ( )
inline

Definition at line 557 of file scrollbar_container.hpp.

References vertical_scrollbar_grid_.

unsigned gui2::scrollbar_container::get_vertical_scrollbar_item_position ( ) const

Returns current position of the vertical scrollbar.

Definition at line 922 of file scrollbar_container.cpp.

References gui2::scrollbar_base::get_item_position(), and vertical_scrollbar_.

Referenced by gui2::chatbox::append_to_chatbox(), gui2::listbox::place(), and gui2::dialogs::end_credits::timer_callback().

scrollbar_mode gui2::scrollbar_container::get_vertical_scrollbar_mode ( ) const
inline

Definition at line 147 of file scrollbar_container.hpp.

References vertical_scrollbar_mode_.

void gui2::scrollbar_container::handle_key_down_arrow ( SDL_Keymod  modifier,
bool &  handled 
)
protectedvirtual

Down arrow key pressed.

Parameters
modifierThe SDL keyboard modifier when the key was pressed.
handledIf the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Reimplemented in gui2::listbox, and gui2::tree_view.

Definition at line 1020 of file scrollbar_container.cpp.

References gui2::scrollbar_base::ITEM_FORWARD, gui2::scrollbar_base::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by gui2::tree_view::handle_key_down_arrow(), and signal_handler_sdl_key_down().

void gui2::scrollbar_container::handle_key_end ( SDL_Keymod  modifier,
bool &  handled 
)
protectedvirtual

End key pressed.

Parameters
modifierThe SDL keyboard modifier when the key was pressed.
handledIf the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Definition at line 979 of file scrollbar_container.cpp.

References gui2::scrollbar_base::END, gui2::scrollbar_base::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by signal_handler_sdl_key_down().

void gui2::scrollbar_container::handle_key_home ( SDL_Keymod  modifier,
bool &  handled 
)
protectedvirtual

Home key pressed.

Parameters
modifierThe SDL keyboard modifier when the key was pressed.
handledIf the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Definition at line 968 of file scrollbar_container.cpp.

References gui2::scrollbar_base::BEGIN, horizontal_scrollbar_, gui2::scrollbar_base::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by signal_handler_sdl_key_down().

void gui2::scrollbar_container::handle_key_left_arrow ( SDL_Keymod  modifier,
bool &  handled 
)
protectedvirtual

Left arrow key pressed.

Parameters
modifierThe SDL keyboard modifier when the key was pressed.
handledIf the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Reimplemented in gui2::listbox, and gui2::tree_view.

Definition at line 1030 of file scrollbar_container.cpp.

References horizontal_scrollbar_, gui2::scrollbar_base::ITEM_BACKWARDS, gui2::scrollbar_base::scroll(), and scrollbar_moved().

Referenced by gui2::tree_view::handle_key_left_arrow(), gui2::listbox::handle_key_left_arrow(), gui2::listbox::handle_key_right_arrow(), and signal_handler_sdl_key_down().

void gui2::scrollbar_container::handle_key_page_down ( SDL_Keymod  modifier,
bool &  handled 
)
protectedvirtual

Page down key pressed.

Parameters
modifierThe SDL keyboard modifier when the key was pressed.
handledIf the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Definition at line 999 of file scrollbar_container.cpp.

References gui2::scrollbar_base::JUMP_FORWARD, gui2::scrollbar_base::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by signal_handler_sdl_key_down().

void gui2::scrollbar_container::handle_key_page_up ( SDL_Keymod  modifier,
bool &  handled 
)
protectedvirtual

Page up key pressed.

Parameters
modifierThe SDL keyboard modifier when the key was pressed.
handledIf the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Definition at line 989 of file scrollbar_container.cpp.

References gui2::scrollbar_base::JUMP_BACKWARDS, gui2::scrollbar_base::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by signal_handler_sdl_key_down().

void gui2::scrollbar_container::handle_key_right_arrow ( SDL_Keymod  modifier,
bool &  handled 
)
protectedvirtual

Right arrow key pressed.

Parameters
modifierThe SDL keyboard modifier when the key was pressed.
handledIf the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Reimplemented in gui2::listbox, and gui2::tree_view.

Definition at line 1040 of file scrollbar_container.cpp.

References horizontal_scrollbar_, gui2::scrollbar_base::ITEM_FORWARD, gui2::scrollbar_base::scroll(), and scrollbar_moved().

Referenced by gui2::tree_view::handle_key_right_arrow(), and signal_handler_sdl_key_down().

void gui2::scrollbar_container::handle_key_up_arrow ( SDL_Keymod  modifier,
bool &  handled 
)
protectedvirtual

Up arrow key pressed.

Parameters
modifierThe SDL keyboard modifier when the key was pressed.
handledIf the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Reimplemented in gui2::listbox, and gui2::tree_view.

Definition at line 1010 of file scrollbar_container.cpp.

References gui2::scrollbar_base::ITEM_BACKWARDS, gui2::scrollbar_base::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by gui2::listbox::handle_key_down_arrow(), gui2::tree_view::handle_key_up_arrow(), gui2::listbox::handle_key_up_arrow(), and signal_handler_sdl_key_down().

scrollbar_base* gui2::scrollbar_container::horizontal_scrollbar ( )
inline

Definition at line 542 of file scrollbar_container.hpp.

References horizontal_scrollbar_.

void gui2::scrollbar_container::horizontal_scrollbar_moved ( )
inline
void gui2::scrollbar_container::impl_draw_children ( surface frame_buffer,
int  x_offset,
int  y_offset 
)
overrideprivatevirtual
void gui2::scrollbar_container::layout_children ( )
overrideprivatevirtual

See widget::layout_children.

Reimplemented from gui2::container_base.

Reimplemented in gui2::listbox, and gui2::tree_view.

Definition at line 798 of file scrollbar_container.cpp.

References content_grid_, and gui2::container_base::layout_children().

void gui2::scrollbar_container::layout_initialize ( const bool  full_initialization)
overridevirtual
void gui2::scrollbar_container::place ( const point origin,
const point size 
)
overridevirtual
void gui2::scrollbar_container::request_reduce_height ( const unsigned  maximum_height)
overridevirtual
void gui2::scrollbar_container::request_reduce_width ( const unsigned  maximum_width)
overridevirtual
void gui2::scrollbar_container::scroll_horizontal_scrollbar ( const scrollbar_base::scroll_mode  scroll)

Scrolls the horizontal scrollbar.

Parameters
scrollThe position to scroll to.

Definition at line 960 of file scrollbar_container.cpp.

References horizontal_scrollbar_, gui2::scrollbar_base::scroll(), and scrollbar_moved().

Referenced by finalize_setup().

void gui2::scrollbar_container::scroll_vertical_scrollbar ( const scrollbar_base::scroll_mode  scroll)
void gui2::scrollbar_container::scrollbar_moved ( )
private
void gui2::scrollbar_container::set_content_size ( const point origin,
const point size 
)
privatevirtual

Sets the size of the content grid.

This function normally just updates the content grid but can be overridden by a subclass.

Parameters
originThe origin for the content.
sizeThe size of the content.

Reimplemented in gui2::listbox.

Definition at line 817 of file scrollbar_container.cpp.

References content_grid_.

Referenced by place().

void gui2::scrollbar_container::set_horizontal_scrollbar_item_position ( const unsigned  position)

Move the horizontal scrollbar to a position.

Parameters
positionThe position to scroll to.

Definition at line 944 of file scrollbar_container.cpp.

References horizontal_scrollbar_, scrollbar_moved(), and gui2::scrollbar_base::set_item_position().

Referenced by gui2::listbox::place().

void gui2::scrollbar_container::set_horizontal_scrollbar_mode ( const scrollbar_mode  scrollbar_mode)
void gui2::scrollbar_container::set_origin ( const point origin)
overridevirtual
void gui2::scrollbar_container::set_scrollbar_button_status ( )
protected

Sets the status of the scrollbar buttons.

This is needed after the scrollbar moves so the status of the buttons will be active or inactive as needed.

Todo:
scrollbar visibility.
Todo:
scrollbar visibility.

Definition at line 866 of file scrollbar_container.cpp.

References gui2::scrollbar_base::all_items_visible(), gui2::scrollbar_base::at_begin(), gui2::scrollbar_base::at_end(), horizontal_scrollbar_, horizontal_scrollbar_grid_, name(), gui2::styled_widget::set_active(), gui2::scrollbar_base::set_active(), vertical_scrollbar_, and vertical_scrollbar_grid_.

Referenced by content_resize_request(), place(), and scrollbar_moved().

void gui2::scrollbar_container::set_vertical_scrollbar_item_position ( const unsigned  position)

Move the vertical scrollbar to a position.

Parameters
positionThe position to scroll to.

Definition at line 929 of file scrollbar_container.cpp.

References scrollbar_moved(), gui2::scrollbar_base::set_item_position(), and vertical_scrollbar_.

Referenced by gui2::chatbox::append_to_chatbox(), gui2::listbox::place(), and gui2::dialogs::end_credits::timer_callback().

void gui2::scrollbar_container::set_vertical_scrollbar_mode ( const scrollbar_mode  scrollbar_mode)
void gui2::scrollbar_container::set_visible_rectangle ( const SDL_Rect &  rectangle)
overridevirtual
void gui2::scrollbar_container::show_content_rect ( const SDL_Rect &  rect)
protected

Shows a certain part of the content.

When the part to be shown is bigger as the visible viewport the top left of the wanted rect will be the top left of the viewport.

Parameters
rectThe rect which should be visible.

Definition at line 822 of file scrollbar_container.cpp.

References content_, gui2::widget::get_height(), gui2::scrollbar_base::get_item_position(), gui2::widget::get_width(), gui2::widget::get_x(), gui2::widget::get_y(), horizontal_scrollbar_, scrollbar_moved(), gui2::scrollbar_base::set_item_position(), and vertical_scrollbar_.

Referenced by gui2::tree_view::handle_up_down_arrow(), gui2::listbox::layout_children(), gui2::listbox::list_item_clicked(), gui2::listbox::place(), and gui2::listbox::update_visible_area_on_key_event().

void gui2::scrollbar_container::signal_handler_sdl_key_down ( const event::ui_event  event,
bool &  handled,
const SDL_Keycode  key,
SDL_Keymod  modifier 
)
private
void gui2::scrollbar_container::signal_handler_sdl_wheel_down ( const event::ui_event  event,
bool &  handled 
)
private
void gui2::scrollbar_container::signal_handler_sdl_wheel_left ( const event::ui_event  event,
bool &  handled 
)
private
void gui2::scrollbar_container::signal_handler_sdl_wheel_right ( const event::ui_event  event,
bool &  handled 
)
private
void gui2::scrollbar_container::signal_handler_sdl_wheel_up ( const event::ui_event  event,
bool &  handled 
)
private
scrollbar_base* gui2::scrollbar_container::vertical_scrollbar ( )
inline

Definition at line 547 of file scrollbar_container.hpp.

References vertical_scrollbar_.

bool gui2::scrollbar_container::vertical_scrollbar_at_end ( )
void gui2::scrollbar_container::vertical_scrollbar_moved ( )
inline

Callback when the scrollbar moves (NOTE maybe only one callback needed).

Maybe also make protected or private and add a friend.

Definition at line 226 of file scrollbar_container.hpp.

References scrollbar_moved().

Referenced by finalize_setup().

Friends And Related Function Documentation

friend class debug_layout_graph
friend

Definition at line 42 of file scrollbar_container.hpp.

Definition at line 44 of file scrollbar_container.hpp.

Definition at line 45 of file scrollbar_container.hpp.

friend class listbox
friend

Definition at line 47 of file scrollbar_container.hpp.

friend struct scrollbar_container_implementation
friend

Definition at line 50 of file scrollbar_container.hpp.

friend class tree_view
friend

Definition at line 49 of file scrollbar_container.hpp.

Member Data Documentation

spacer* gui2::scrollbar_container::content_
private
std::unique_ptr<grid> gui2::scrollbar_container::content_grid_
private
SDL_Rect gui2::scrollbar_container::content_visible_area_
private

Cache for the visible area for the content.

The visible area for the content needs to be updated when scrolling.

Definition at line 491 of file scrollbar_container.hpp.

Referenced by content_visible_area(), gui2::tree_view::layout_children(), gui2::listbox::layout_children(), place(), scrollbar_moved(), set_origin(), and set_visible_rectangle().

scrollbar_base * gui2::scrollbar_container::horizontal_scrollbar_
private
grid * gui2::scrollbar_container::horizontal_scrollbar_grid_
private
scrollbar_mode gui2::scrollbar_container::horizontal_scrollbar_mode_
private
state_t gui2::scrollbar_container::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 464 of file scrollbar_container.hpp.

Referenced by get_active(), and get_state().

scrollbar_base* gui2::scrollbar_container::vertical_scrollbar_
private
grid* gui2::scrollbar_container::vertical_scrollbar_grid_
private
scrollbar_mode gui2::scrollbar_container::vertical_scrollbar_mode_
private

The mode of how to show the scrollbar.

This value should only be modified before showing, doing it while showing results in UB.

Definition at line 472 of file scrollbar_container.hpp.

Referenced by content_resize_height(), content_resize_request(), get_vertical_scrollbar_mode(), layout_initialize(), place(), request_reduce_height(), scrollbar_moved(), and set_vertical_scrollbar_mode().


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