A label displays text that can be wrapped but no scrollbars are provided. More...

#include <label.hpp>

Inheritance diagram for gui2::label:

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

virtual bool	can_mouse_focus () const override
	See widget::can_mouse_focus. More...

virtual void	update_canvas () override
	See styled_widget::update_canvas. More...

void	set_can_wrap (const bool wrap)

void	set_characters_per_line (const unsigned characters_per_line)

void	set_link_aware (bool l)

void	set_link_color (const color_t &color)

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 widget_item &data)
	Sets the members of the styled_widget. More...

bool	disable_click_dismiss () const override
	See widget::disable_click_dismiss. More...

virtual iteration::walker_ptr	create_walker () override
	See widget::create_walker. More...

point	get_config_minimum_size () const
	Gets the minimum size as defined in the config. More...

point	get_config_default_size () const
	Gets the default size as defined in the config. More...

point	get_config_maximum_size () const
	Gets the best size as defined in the config. More...

virtual 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 widget *	find_at (const point &coordinate, const bool must_be_active) override
	See widget::find_at. More...

virtual const widget *	find_at (const point &coordinate, const bool must_be_active) const override
	See widget::find_at. More...

widget *	find (const std::string &id, const bool must_be_active) override
	See widget::find. More...

const widget *	find (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_string &	get_label () const

virtual void	set_label (const t_string &text)

virtual void	set_use_markup (bool use_markup)

bool	get_use_markup () const

const t_string &	tooltip () const

void	set_tooltip (const t_string &tooltip)

const t_string &	help_message () const

void	set_help_message (const t_string &help_message)

std::vector< canvas > &	get_canvases ()

canvas &	get_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

widget &	operator= (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

window *	get_window ()
	Get the parent window. More...

const window *	get_window () const
	The constant version of get_window. More...

grid *	get_parent_grid ()
	Get the parent grid. More...

void	set_parent (widget *parent)

widget *	parent ()

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

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
	Calculates the blitting rectangle of the widget. More...

SDL_Rect	calculate_clipping_rectangle () const
	Calculates the clipping rectangle of the widget. More...

bool	draw_background ()
	Draws the background of a widget. More...

void	draw_children ()
	Draws the children of a widget. More...

bool	draw_foreground ()
	Draws the foreground of the widget. More...

SDL_Rect	get_dirty_rectangle () const
	Gets the dirty rectangle of the widget. More...

virtual void	set_visible_rectangle (const SDL_Rect &rectangle)
	Sets the visible rectangle for a widget. More...

void	queue_redraw ()
	Indicates that this widget should be redrawn. More...

void	queue_redraw (const rect &region)
	Indicate that specific region of the screen should be redrawn. More...

void	set_visible (const visibility visible)

visibility	get_visible () const

redraw_action	get_drawing_action () const

void	set_debug_border_mode (const debug_border debug_border_mode)

void	set_debug_border_color (const color_t debug_border_color)

virtual bool	has_widget (const widget &widget) const
	Does the widget contain the widget. More...

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_executor &	set_wants_mouse_right_double_click (const bool click=true)

bool	wants_mouse_right_double_click () const

Public Member Functions inherited from gui2::event::dispatcher
	dispatcher ()

virtual	~dispatcher ()

void	connect ()
	Connects the dispatcher to the event handler. More...

void	disconnect ()
	Disconnects the dispatcher from the event handler. More...

bool	is_connected () const
	Return whether the dispatcher is currently connected. More...

bool	has_event (const ui_event event, const event_queue_type event_type)

bool	fire (const ui_event event, widget &target)
	Fires an event which has no extra parameters. More...

bool	fire (const ui_event event, widget &target, const point &coordinate)
	Fires an event which takes a coordinate parameter. More...

bool	fire (const ui_event event, widget &target, const SDL_Keycode key, const SDL_Keymod modifier, const std::string &unicode)
	Fires an event which takes keyboard parameters. More...

bool	fire (const ui_event event, widget &target, const point &pos, const point &distance)
	Fires an event which takes touch-motion parameters. More...

bool	fire (const ui_event event, widget &target, const point &center, float dTheta, float dDist, uint8_t numFingers)
	Fires an event which takes touch-gesture parameters. More...

bool	fire (const ui_event event, widget &target, void *)
	Fires an event which takes notification parameters. More...

bool	fire (const ui_event event, widget &target, const message &msg)
	Fires an event which takes message parameters. More...

bool	fire (const ui_event event, widget &target, const SDL_Event &sdlevent)
	Fires an event that's a raw SDL event. More...

bool	fire (const ui_event event, widget &target, const std::string &text, int32_t start, int32_t len)
	Fires an event which takes text input parameters. More...

template<ui_event E, typename F >
void	connect_signal (const F &func, const queue_position position=back_child)
	Adds a callback to the appropriate queue based on event type. More...

template<ui_event E, typename F >
void	disconnect_signal (const F &func, const queue_position position=back_child)
	Removes a callback from the appropriate queue based on event type. More...

void	capture_mouse ()
	Captures the mouse. More...

void	release_mouse ()
	Releases the mouse capture. More...

void	set_mouse_behavior (const mouse_behavior mouse_behavior)

mouse_behavior	get_mouse_behavior () const

void	set_want_keyboard_input (const bool want_keyboard_input)

bool	get_want_keyboard_input () const

void	register_hotkey (const hotkey::HOTKEY_COMMAND id, const hotkey_function &function)
	Registers a hotkey. More...

bool	execute_hotkey (const hotkey::HOTKEY_COMMAND id)
	Executes a hotkey. More...

Public Member Functions inherited from enable_lua_ptr< widget >
	enable_lua_ptr (widget *tp)

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

Private 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 (bool &handled)
	Left click signal handler: checks if we clicked on a hyperlink. More...

void	signal_handler_right_button_click (bool &handled)
	Right click signal handler: checks if we clicked on a hyperlink, copied to clipboard. More...

void	signal_handler_mouse_motion (bool &handled, const point &coordinate)
	Mouse motion signal handler: checks if the cursor is on a hyperlink. More...

void	signal_handler_mouse_leave (bool &handled)
	Mouse leave signal handler: checks if the cursor left a hyperlink. More...

void	update_mouse_cursor (bool enable)
	Implementation detail for (re)setting the hyperlink cursor. 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 class	visibility { visible , hidden , invisible }
	Visibility settings done by the user. More...

enum class	redraw_action { full , partly , none }
	Visibility set by the engine. More...

enum class	debug_border { none , outline , fill }

Public Types inherited from gui2::event::dispatcher
enum	event_queue_type { pre = 1 , child = 2 , post = 4 }

enum	queue_position { front_pre_child , back_pre_child , front_child , back_child , front_post_child , back_post_child }
	The position where to add a new callback in the signal handler. More...

enum class	mouse_behavior { all , hit , none }
	The behavior of the mouse events. More...

Protected Member Functions inherited from gui2::styled_widget
virtual point	calculate_best_size () const override
	See widget::calculate_best_size. More...

resolution_definition_ptr	get_config ()

resolution_definition_const_ptr	get_config () const

template<typename T >
std::shared_ptr< const typename T::resolution >	cast_config_to () const
	Casts the current resolution definition config to the respective type of a derived widget. More...

void	set_config (resolution_definition_ptr config)

unsigned int	get_text_font_size () const
	Resolves and returns the text_font_size. More...

int	get_text_maximum_width () const
	Returns the maximum width available for the text. More...

int	get_text_maximum_height () const
	Returns the maximum height available for the text. More...

virtual bool	impl_draw_background () override
	See widget::impl_draw_background. More...

virtual bool	impl_draw_foreground () override
	See widget::impl_draw_foreground. More...

std::string	get_label_token (const point &position, const char *delimiters=" \n\r\t") const
	Exposes font::pango_text::get_token, for the text label of this styled_widget. More...

std::string	get_label_link (const point &position) const

Protected Member Functions inherited from gui2::widget
void	set_layout_size (const point &size)

const point &	layout_size () const

void	clear_layout_size ()
	Throws away layout_size_. More...

Detailed Description

A label displays text that can be wrapped but no scrollbars are provided.

A label has two states because labels are often used as visual indication of the state of the widget it labels.

The following states exist:

state_enabled - the label is enabled.
state_disabled - the label is disabled.

Key	Type	Default	Description
link_color	string	#ffff00	The color to render links with. This string will be used verbatim in pango markup for each link.

The label specific variables:

Key	Type	Default	Description
wrap	bool	false	Is wrapping enabled for the label.
characters_per_line	unsigned	0	Sets the maximum number of characters per line. The amount is an approximate since the width of a character differs. E.g. iii is smaller than MMM. When the value is non-zero it also implies can_wrap is true. When having long strings wrapping them can increase readability, often 66 characters per line is considered the optimum for a one column text.
text_alignment	h_align	left	The way the text is aligned inside the canvas.
can_shrink	bool	false	Whether the label can shrink past its optimal size.
link_aware	bool	false	Whether the label is link aware. This means it is rendered with links highlighted, and responds to click events on those links.

Definition at line 55 of file label.hpp.

Member Enumeration Documentation

◆ state_t

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

Constructor & Destructor Documentation

◆ label()

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

explicit

Definition at line 42 of file label.cpp.

References signal_handler_left_button_click(), signal_handler_mouse_leave(), signal_handler_mouse_motion(), and signal_handler_right_button_click().

Member Function Documentation

◆ can_mouse_focus()

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

inlineoverridevirtual

See widget::can_mouse_focus.

Reimplemented from gui2::widget.

Definition at line 108 of file label.hpp.

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

◆ can_wrap()

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

inlineoverridevirtual

See widget::can_wrap.

Reimplemented from gui2::widget.

Definition at line 63 of file label.hpp.

References can_wrap_, and characters_per_line_.

◆ disable_click_dismiss()

bool gui2::label::disable_click_dismiss ( ) const

inlineoverridevirtual

See widget::disable_click_dismiss.

Implements gui2::widget.

Definition at line 102 of file label.hpp.

◆ get_active()

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

inlineoverridevirtual

See styled_widget::get_active.

Implements gui2::styled_widget.

Definition at line 90 of file label.hpp.

References DISABLED, and state_.

Referenced by set_active().

◆ get_characters_per_line()

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

inlineoverridevirtual

See styled_widget::get_characters_per_line.

Reimplemented from gui2::styled_widget.

Definition at line 69 of file label.hpp.

References characters_per_line_.

◆ get_control_type()

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

overrideprivatevirtual

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Implements gui2::styled_widget.

◆ get_link_aware()

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

inlineoverridevirtual

See styled_widget::get_link_aware.

Reimplemented from gui2::styled_widget.

Definition at line 75 of file label.hpp.

References link_aware_.

Referenced by can_mouse_focus(), signal_handler_left_button_click(), signal_handler_mouse_leave(), signal_handler_mouse_motion(), and signal_handler_right_button_click().

◆ get_link_color()

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

inlineoverridevirtual

See styled_widget::get_link_aware.

Reimplemented from gui2::styled_widget.

Definition at line 81 of file label.hpp.

References link_color_.

◆ get_state()

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

inlineoverridevirtual

See styled_widget::get_state.

Implements gui2::styled_widget.

Definition at line 96 of file label.hpp.

References state_.

◆ set_active()

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

overridevirtual

See styled_widget::set_active.

Implements gui2::styled_widget.

Definition at line 81 of file label.cpp.

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

◆ set_can_shrink()

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

inline

Definition at line 132 of file label.hpp.

References can_shrink_.

◆ set_can_wrap()

void gui2::label::set_can_wrap ( const bool wrap )

inline

Definition at line 118 of file label.hpp.

References can_wrap_.

Referenced by gui2::scroll_label::finalize_subclass(), gui2::dialogs::wml_message_base::pre_show(), and gui2::scroll_label::set_can_wrap().

◆ set_characters_per_line()

void gui2::label::set_characters_per_line ( const unsigned characters_per_line )

inline

Definition at line 123 of file label.hpp.

References characters_per_line_.

◆ set_link_aware()

void gui2::label::set_link_aware ( bool l )

Definition at line 88 of file label.cpp.

References link_aware_, gui2::widget::queue_redraw(), and update_canvas().

Referenced by gui2::dialogs::editor_edit_pbl::editor_edit_pbl(), gui2::scroll_label::finalize_subclass(), and gui2::dialogs::addon_manager::pre_show().

◆ set_link_color()

void gui2::label::set_link_color ( const color_t & color )

Definition at line 97 of file label.cpp.

References link_color_, gui2::widget::queue_redraw(), and update_canvas().

◆ set_state()

void gui2::label::set_state ( const state_t state )

private

Definition at line 106 of file label.cpp.

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

Referenced by set_active().

◆ set_text_alpha()

void gui2::label::set_text_alpha ( unsigned short alpha )

Definition at line 72 of file label.cpp.

References gui2::widget::queue_redraw(), text_alpha_, and update_canvas().

◆ signal_handler_left_button_click()

void gui2::label::signal_handler_left_button_click ( bool & handled )

private

Left click signal handler: checks if we clicked on a hyperlink.

Definition at line 114 of file label.cpp.

References _(), gui2::dialogs::message::auto_close, DBG_GUI_E, gui2::styled_widget::get_label_link(), get_link_aware(), gui2::get_mouse_position(), gui2::widget::get_x(), gui2::widget::get_y(), gui2::OK, desktop::open_object(), desktop::open_object_is_supported(), gui2::show_message(), and gui2::dialogs::message::yes_no_buttons.

Referenced by label().

◆ signal_handler_mouse_leave()

void gui2::label::signal_handler_mouse_leave ( bool & handled )

private

Mouse leave signal handler: checks if the cursor left a hyperlink.

Definition at line 195 of file label.cpp.

References DBG_GUI_E, get_link_aware(), and update_mouse_cursor().

Referenced by label().

◆ signal_handler_mouse_motion()

void gui2::label::signal_handler_mouse_motion	(	bool &	handled,
		const point &	coordinate
	)

private

Mouse motion signal handler: checks if the cursor is on a hyperlink.

Definition at line 177 of file label.cpp.

References DBG_GUI_E, gui2::styled_widget::get_label_link(), get_link_aware(), gui2::widget::get_x(), gui2::widget::get_y(), and update_mouse_cursor().

Referenced by label().

◆ signal_handler_right_button_click()

void gui2::label::signal_handler_right_button_click ( bool & handled )

private

Right click signal handler: checks if we clicked on a hyperlink, copied to clipboard.

Definition at line 149 of file label.cpp.

References _(), gui2::dialogs::message::auto_close, desktop::clipboard::copy_to_clipboard(), DBG_GUI_E, gui2::styled_widget::get_label_link(), get_link_aware(), gui2::get_mouse_position(), gui2::widget::get_x(), gui2::widget::get_y(), and gui2::show_message().

Referenced by label().

◆ text_can_shrink()

virtual bool gui2::label::text_can_shrink ( )

inlineoverrideprivatevirtual

Inherited from styled_widget.

Reimplemented from gui2::styled_widget.

Definition at line 186 of file label.hpp.

References can_shrink_.

◆ type()

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

static

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

◆ update_canvas()

void gui2::label::update_canvas ( )

overridevirtual

See styled_widget::update_canvas.

Reimplemented from gui2::styled_widget.

Definition at line 62 of file label.cpp.

References gui2::styled_widget::get_canvases(), text_alpha_, and gui2::styled_widget::update_canvas().

Referenced by set_link_aware(), set_link_color(), and set_text_alpha().

◆ update_mouse_cursor()

void gui2::label::update_mouse_cursor ( bool enable )

private

Implementation detail for (re)setting the hyperlink cursor.

Definition at line 209 of file label.cpp.

References cursor::get(), cursor::HYPERLINK, cursor::NORMAL, and cursor::set().

Referenced by signal_handler_mouse_leave(), and signal_handler_mouse_motion().

Friends And Related Function Documentation

◆ implementation::builder_label

friend struct implementation::builder_label

friend

Definition at line 57 of file label.hpp.

Member Data Documentation

◆ can_shrink_

bool gui2::label::can_shrink_

private

Definition at line 181 of file label.hpp.

Referenced by set_can_shrink(), and text_can_shrink().

◆ can_wrap_

bool gui2::label::can_wrap_

private

Holds the label can wrap or not.

Definition at line 161 of file label.hpp.

Referenced by can_wrap(), and set_can_wrap().

◆ characters_per_line_

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

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

◆ link_aware_

bool gui2::label::link_aware_

private

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

Definition at line 174 of file label.hpp.

Referenced by get_link_aware(), and set_link_aware().

◆ link_color_

color_t gui2::label::link_color_

private

What color links will be rendered in.

Definition at line 179 of file label.hpp.

Referenced by get_link_color(), and set_link_color().

◆ state_

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

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

◆ text_alpha_

unsigned short gui2::label::text_alpha_

private

Definition at line 183 of file label.hpp.

Referenced by set_text_alpha(), and update_canvas().

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

gui/widgets/label.hpp
gui/widgets/label.cpp

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ state_t

Constructor & Destructor Documentation

◆ label()

Member Function Documentation

◆ can_mouse_focus()

◆ can_wrap()

◆ disable_click_dismiss()

◆ get_active()

◆ get_characters_per_line()

◆ get_control_type()

◆ get_link_aware()

◆ get_link_color()

◆ get_state()

◆ set_active()

◆ set_can_shrink()

◆ set_can_wrap()

◆ set_characters_per_line()

◆ set_link_aware()

◆ set_link_color()

◆ set_state()

◆ set_text_alpha()

◆ signal_handler_left_button_click()

◆ signal_handler_mouse_leave()

◆ signal_handler_mouse_motion()

◆ signal_handler_right_button_click()

◆ text_can_shrink()

◆ type()

◆ update_canvas()

◆ update_mouse_cursor()

Friends And Related Function Documentation

◆ implementation::builder_label

Member Data Documentation

◆ can_shrink_

◆ can_wrap_

◆ characters_per_line_

◆ link_aware_

◆ link_color_

◆ state_

◆ text_alpha_