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::label Class Reference

Label showing a text. More...

#include <label.hpp>

Inheritance diagram for gui2::label:
Inheritance graph

Public Member Functions

 label (const implementation::builder_label &builder)
 
virtual bool can_wrap () const override
 See widget::can_wrap. More...
 
virtual unsigned get_characters_per_line () const override
 See styled_widget::get_characters_per_line. More...
 
virtual bool get_link_aware () const override
 See styled_widget::get_link_aware. More...
 
virtual color_t get_link_color () const override
 See styled_widget::get_link_aware. 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...
 
bool disable_click_dismiss () const override
 See widget::disable_click_dismiss. More...
 
void set_can_wrap (const bool wrap)
 
void set_characters_per_line (const unsigned set_characters_per_line)
 
void set_link_aware (bool l)
 
void set_link_color (const color_t &color)
 
virtual bool can_mouse_focus () const override
 Whether the mouse move/click event go 'through' this widget. More...
 
void set_can_shrink (bool can_shrink)
 
void set_text_alpha (unsigned short alpha)
 
- 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 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 void place (const point &origin, const point &size) override
 See widget::place. 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...
 
- 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 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...
 

Private Types

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

Private Member Functions

void set_state (const state_t state)
 
virtual bool text_can_shrink () override
 Inherited from styled_widget. More...
 
virtual const std::string & get_control_type () const override
 Inherited from styled_widget, implemented by REGISTER_WIDGET. More...
 
void signal_handler_left_button_click (const event::ui_event event, bool &handled)
 Left click signal handler: checks if we clicked on a hyperlink. More...
 
void signal_handler_right_button_click (const event::ui_event event, bool &handled)
 Right click signal handler: checks if we clicked on a hyperlink, copied to clipboard. More...
 

Private Attributes

state_t state_
 Current state of the widget. More...
 
bool can_wrap_
 Holds the label can wrap or not. More...
 
unsigned characters_per_line_
 The maximum number of characters per line. More...
 
bool link_aware_
 Whether the label is link aware, rendering links with special formatting and handling click events. More...
 
color_t link_color_
 What color links will be rendered in. More...
 
bool can_shrink_
 
unsigned short text_alpha_
 

Friends

struct implementation::builder_label
 

Additional Inherited Members

- 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::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)
 
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.

Definition at line 32 of file label.hpp.

Member Enumeration Documentation

enum gui2::label::state_t
private

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 91 of file label.hpp.

Constructor & Destructor Documentation

gui2::label::label ( const implementation::builder_label builder)
explicit

Member Function Documentation

virtual bool gui2::label::can_mouse_focus ( ) const
inlineoverridevirtual

Whether the mouse move/click event go 'through' this widget.

Reimplemented from gui2::widget.

Definition at line 76 of file label.hpp.

References t_string::empty(), and gui2::styled_widget::tooltip().

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

See widget::can_wrap.

Reimplemented from gui2::widget.

Definition at line 57 of file label.cpp.

References can_wrap_, and characters_per_line_.

bool gui2::label::disable_click_dismiss ( ) const
overridevirtual

See widget::disable_click_dismiss.

Implements gui2::widget.

Definition at line 105 of file label.cpp.

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

See styled_widget::get_active.

Implements gui2::styled_widget.

Definition at line 95 of file label.cpp.

References DISABLED, and state_.

Referenced by set_active().

unsigned gui2::label::get_characters_per_line ( ) const
overridevirtual

See styled_widget::get_characters_per_line.

Reimplemented from gui2::styled_widget.

Definition at line 62 of file label.cpp.

References characters_per_line_.

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

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Implements gui2::styled_widget.

bool gui2::label::get_link_aware ( ) const
overridevirtual

See styled_widget::get_link_aware.

Reimplemented from gui2::styled_widget.

Definition at line 67 of file label.cpp.

References link_aware_.

Referenced by signal_handler_left_button_click(), and signal_handler_right_button_click().

color_t gui2::label::get_link_color ( ) const
overridevirtual

See styled_widget::get_link_aware.

Reimplemented from gui2::styled_widget.

Definition at line 72 of file label.cpp.

References link_color_.

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

See styled_widget::get_state.

Implements gui2::styled_widget.

Definition at line 100 of file label.cpp.

References state_.

void gui2::label::set_active ( const bool  active)
overridevirtual

See styled_widget::set_active.

Implements gui2::styled_widget.

Definition at line 88 of file label.cpp.

References DISABLED, ENABLED, get_active(), and set_state().

void gui2::label::set_can_shrink ( bool  can_shrink)
inline

Definition at line 78 of file label.hpp.

References can_shrink_.

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

void gui2::label::set_can_wrap ( const bool  wrap)
inline
void gui2::label::set_characters_per_line ( const unsigned  set_characters_per_line)

Definition at line 110 of file label.cpp.

References characters_per_line_.

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

void gui2::label::set_link_aware ( bool  l)
void gui2::label::set_link_color ( const color_t color)
void gui2::label::set_state ( const state_t  state)
private

Definition at line 136 of file label.cpp.

References gui2::widget::set_is_dirty(), and state_.

Referenced by set_active().

void gui2::label::set_text_alpha ( unsigned short  alpha)
void gui2::label::signal_handler_left_button_click ( const event::ui_event  event,
bool &  handled 
)
private
void gui2::label::signal_handler_right_button_click ( const event::ui_event  event,
bool &  handled 
)
private
virtual bool gui2::label::text_can_shrink ( )
inlineoverrideprivatevirtual

Inherited from styled_widget.

Reimplemented from gui2::styled_widget.

Definition at line 132 of file label.hpp.

References can_shrink_.

Friends And Related Function Documentation

friend struct implementation::builder_label
friend

Definition at line 34 of file label.hpp.

Member Data Documentation

bool gui2::label::can_shrink_
private

Definition at line 127 of file label.hpp.

Referenced by set_can_shrink(), and text_can_shrink().

bool gui2::label::can_wrap_
private

Holds the label can wrap or not.

Definition at line 107 of file label.hpp.

Referenced by can_wrap(), and set_can_wrap().

unsigned gui2::label::characters_per_line_
private

The maximum number of characters per line.

The maximum is not an exact maximum, it uses the average character width.

Definition at line 114 of file label.hpp.

Referenced by can_wrap(), get_characters_per_line(), and set_characters_per_line().

bool gui2::label::link_aware_
private

Whether the label is link aware, rendering links with special formatting and handling click events.

Definition at line 120 of file label.hpp.

Referenced by get_link_aware(), and set_link_aware().

color_t gui2::label::link_color_
private

What color links will be rendered in.

Definition at line 125 of file label.hpp.

Referenced by get_link_color(), and set_link_color().

state_t gui2::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 104 of file label.hpp.

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

unsigned short gui2::label::text_alpha_
private

Definition at line 129 of file label.hpp.

Referenced by set_text_alpha().


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