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

Label showing a text. More...

#include <scroll_label.hpp>

Inheritance diagram for gui2::scroll_label:
Inheritance graph

Public Member Functions

 scroll_label (const implementation::builder_scroll_label &builder)
 
virtual void set_label (const t_string &label) override
 See styled_widget::set_label. More...
 
virtual void set_text_alignment (const PangoAlignment text_alignment) override
 See styled_widget::set_text_alignment. More...
 
virtual void set_use_markup (bool use_markup) override
 See styled_widget::set_use_markup. More...
 
virtual void set_self_active (const bool active) override
 See container_base::set_self_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...
 
bool can_wrap () const override
 See widget::can_wrap. More...
 
void set_can_wrap (bool can_wrap)
 
void set_text_alpha (unsigned short alpha)
 
void set_link_aware (bool l)
 
- Public Member Functions inherited from gui2::scrollbar_container
 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 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 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
 
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)
 
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...
 

Private Types

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

Private Member Functions

void finalize_subclass () override
 Function for the subclasses to do their setup. More...
 
labelget_internal_label ()
 
virtual const std::string & get_control_type () const override
 Inherited from styled_widget, implemented by REGISTER_WIDGET. More...
 
void signal_handler_left_button_down (const event::ui_event event)
 

Private Attributes

state_t state_
 Current state of the widget. More...
 
bool wrap_on_
 
PangoAlignment text_alignment_
 

Friends

struct implementation::builder_scroll_label
 

Additional Inherited Members

- Public Types inherited from gui2::scrollbar_container
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...
 
- Protected Member Functions inherited from gui2::scrollbar_container
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 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...
 

Detailed Description

Label showing a text.

This version shows a scrollbar if the text gets too long and has some scrolling features. In general this widget is slower as the normal label so the normal label should be preferred.

Definition at line 42 of file scroll_label.hpp.

Member Enumeration Documentation

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 82 of file scroll_label.hpp.

Constructor & Destructor Documentation

gui2::scroll_label::scroll_label ( const implementation::builder_scroll_label builder)
explicit

Member Function Documentation

bool gui2::scroll_label::can_wrap ( ) const
overridevirtual

See widget::can_wrap.

Note
This function is called before the object is finalized.

Reimplemented from gui2::scrollbar_container.

Definition at line 148 of file scroll_label.cpp.

References wrap_on_.

Referenced by set_can_wrap().

void gui2::scroll_label::finalize_subclass ( )
overrideprivatevirtual
bool gui2::scroll_label::get_active ( ) const
overridevirtual

See styled_widget::get_active.

Reimplemented from gui2::scrollbar_container.

Definition at line 118 of file scroll_label.cpp.

References DISABLED, and state_.

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

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Reimplemented from gui2::scrollbar_container.

label * gui2::scroll_label::get_internal_label ( )
private
unsigned gui2::scroll_label::get_state ( ) const
overridevirtual

See styled_widget::get_state.

Reimplemented from gui2::scrollbar_container.

Definition at line 123 of file scroll_label.cpp.

References state_.

void gui2::scroll_label::set_can_wrap ( bool  can_wrap)
void gui2::scroll_label::set_label ( const t_string label)
overridevirtual
void gui2::scroll_label::set_link_aware ( bool  l)

Definition at line 106 of file scroll_label.cpp.

References get_internal_label().

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

void gui2::scroll_label::set_self_active ( const bool  active)
overridevirtual

See container_base::set_self_active.

Implements gui2::container_base.

Definition at line 113 of file scroll_label.cpp.

References DISABLED, ENABLED, and state_.

void gui2::scroll_label::set_text_alignment ( const PangoAlignment  text_alignment)
overridevirtual
void gui2::scroll_label::set_text_alpha ( unsigned short  alpha)

Definition at line 99 of file scroll_label.cpp.

References get_internal_label().

void gui2::scroll_label::set_use_markup ( bool  use_markup)
overridevirtual
void gui2::scroll_label::signal_handler_left_button_down ( const event::ui_event  event)
private

Friends And Related Function Documentation

Definition at line 44 of file scroll_label.hpp.

Member Data Documentation

state_t gui2::scroll_label::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 96 of file scroll_label.hpp.

Referenced by get_active(), get_state(), and set_self_active().

PangoAlignment gui2::scroll_label::text_alignment_
private

Definition at line 100 of file scroll_label.hpp.

Referenced by finalize_subclass(), and set_text_alignment().

bool gui2::scroll_label::wrap_on_
private

Definition at line 98 of file scroll_label.hpp.

Referenced by can_wrap(), finalize_subclass(), and set_can_wrap().


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