A rich_label takes marked up text and shows it correctly formatted and wrapped but no scrollbars are provided. More...

#include <rich_label.hpp>

Inheritance diagram for gui2::rich_label:

Public Member Functions
	rich_label (const implementation::builder_rich_label &builder)

virtual bool	can_wrap () const override
	Can the widget wrap. More...

virtual unsigned	get_characters_per_line () const override
	Returns the number of characters per line. More...

virtual bool	get_link_aware () const override
	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 override
	Returns the color string to be used with links. More...

virtual void	set_active (const bool active) override
	Sets the styled_widget's state. More...

virtual bool	get_active () const override
	Gets the active state of the styled_widget. More...

virtual unsigned	get_state () const override
	Returns the id of the state. More...

bool	disable_click_dismiss () const override
	Does the widget disable easy close? More...

virtual bool	can_mouse_focus () const override
	Whether the mouse move/click event go 'through' this widget. More...

virtual void	update_canvas () override
	Updates the canvas(ses). 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)

const t_string &	get_label () const

void	set_label (const t_string &text) override

void	set_topic (const help::topic *topic)

std::pair< config, point >	get_parsed_text (const config &parsed_text, const point &origin, const unsigned init_width, const bool finalize=false)

void	register_link_callback (std::function< void(std::string)> link_handler)

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

void	set_text_maximum_width (int max_width)
	Set how wide the text can become. 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...

const grid *	get_parent_grid () const

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

template<class T >
NOT_DANGLING T *	find_widget (const std::string &id, const bool must_be_active, const bool must_exist)
	Gets a widget with the wanted id. More...

template<class T >
NOT_DANGLING const T *	find_widget (const std::string &id, const bool must_be_active, const bool must_exist) const

template<class T >
NOT_DANGLING T &	find_widget (const std::string &id, const bool must_be_active=false)
	Gets a widget with the wanted id. More...

template<class T >
NOT_DANGLING const T &	find_widget (const std::string &id, const bool must_be_active=false) const

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

void	default_text_config (config *txt_ptr, t_string text="")
	Create template for text config that can be shown in canvas. More...

std::pair< size_t, size_t >	add_text (config &curr_item, std::string text)

void	add_attribute (config &curr_item, std::string attr_name, size_t start=0, size_t end=0, std::string extra_data="")

std::pair< size_t, size_t >	add_text_with_attribute (config &curr_item, std::string text, std::string attr_name="", std::string extra_data="")

void	add_image (config &curr_item, std::string name, std::string align, bool has_prev_image, bool floating)

void	add_link (config &curr_item, std::string name, std::string dest, const point &origin, int img_width)

point	get_text_size (config &text_cfg, unsigned width=0) const
	size calculation functions More...

point	get_image_size (config &img_cfg) const

wfl::map_formula_callable	setup_text_renderer (config text_cfg, unsigned width=0) const

size_t	get_split_location (std::string_view text, const point &pos)

std::vector< std::string >	split_in_width (const std::string &s, const int font_size, const unsigned width)

int	get_offset_from_xy (const point &position) const

point	get_xy_from_offset (const unsigned offset) const

point	calculate_best_size () const override
	See widget::calculate_best_size. 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_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 rich_label can wrap or not. More...

unsigned	characters_per_line_
	The maximum number of characters per line. More...

bool	link_aware_
	Whether the rich_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_

config	text_dom_
	structure tree of the marked up text after parsing More...

t_string	unparsed_text_
	The unparsed/raw text. More...

const unsigned	init_w_
	Width and height of the canvas. More...

point	size_

unsigned	padding_
	Padding. More...

std::vector< std::pair< rect, std::string > >	links_
	link variables and functions More...

std::function< void(std::string)>	link_handler_

Friends
struct	implementation::builder_rich_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
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 rich_label takes marked up text and shows it correctly formatted and wrapped but no scrollbars are provided.

Definition at line 39 of file rich_label.hpp.

Member Enumeration Documentation

◆ state_t

enum gui2::rich_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 144 of file rich_label.hpp.

Constructor & Destructor Documentation

◆ rich_label()

gui2::rich_label::rich_label ( const implementation::builder_rich_label & builder )

explicit

Definition at line 63 of file rich_label.cpp.

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

Member Function Documentation

◆ add_attribute()

void gui2::rich_label::add_attribute	(	config &	curr_item,
		std::string	attr_name,
		size_t	start = `0`,
		size_t	end = `0`,
		std::string	extra_data = `""`
	)

private

Definition at line 123 of file rich_label.cpp.

References config::add_child(), utf8::size(), and editor::start().

Referenced by add_text_with_attribute(), and get_parsed_text().

◆ add_image()

void gui2::rich_label::add_image	(	config &	curr_item,
		std::string	name,
		std::string	align,
		bool	has_prev_image,
		bool	floating
	)

private

Definition at line 138 of file rich_label.cpp.

Referenced by get_parsed_text().

◆ add_link()

void gui2::rich_label::add_link	(	config &	curr_item,
		std::string	name,
		std::string	dest,
		const point &	origin,
		int	img_width
	)

private

Definition at line 181 of file rich_label.cpp.

References add_text_with_attribute(), DBG_GUI_RL, font::get_max_height(), get_xy_from_offset(), init_w_, link_color_, links_, setup_text_renderer(), utf8::size(), size_, font::SIZE_NORMAL, and color_t::to_hex_string().

Referenced by get_parsed_text().

◆ add_text()

std::pair< size_t, size_t > gui2::rich_label::add_text	(	config &	curr_item,
		std::string	text
	)

private

Definition at line 115 of file rich_label.cpp.

References editor::start().

Referenced by add_text_with_attribute(), and get_parsed_text().

◆ add_text_with_attribute()

std::pair< size_t, size_t > gui2::rich_label::add_text_with_attribute	(	config &	curr_item,
		std::string	text,
		std::string	attr_name = `""`,
		std::string	extra_data = `""`
	)

private

Definition at line 132 of file rich_label.cpp.

References add_attribute(), add_text(), and editor::start().

Referenced by add_link(), and get_parsed_text().

◆ calculate_best_size()

point gui2::rich_label::calculate_best_size ( ) const

inlineoverrideprivatevirtual

See widget::calculate_best_size.

Todo:: The value send should subtract the border size and read it after calculation to get the proper result.

Reimplemented from gui2::styled_widget.

Definition at line 237 of file rich_label.hpp.

References gui2::styled_widget::calculate_best_size(), and size_.

◆ can_mouse_focus()

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

inlineoverridevirtual

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

Reimplemented from gui2::widget.

Definition at line 83 of file rich_label.hpp.

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

◆ can_wrap()

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

inlineoverridevirtual

Can the widget wrap.

When a widget can wrap it can reduce its width by increasing its height. When a layout is too wide it should first try to wrap and if that fails it should check the vertical scrollbar status. After wrapping the height might (probably will) change so the layout engine needs to recalculate the height after wrapping.

Reimplemented from gui2::widget.

Definition at line 46 of file rich_label.hpp.

References can_wrap_, and characters_per_line_.

◆ default_text_config()

void gui2::rich_label::default_text_config	(	config *	txt_ptr,
		t_string	text = `""`
	)

private

Create template for text config that can be shown in canvas.

Definition at line 740 of file rich_label.cpp.

References gui2::encode_text_alignment(), gui2::styled_widget::get_text_alignment(), and font::SIZE_NORMAL.

Referenced by get_parsed_text().

◆ disable_click_dismiss()

bool gui2::rich_label::disable_click_dismiss ( ) const

inlineoverridevirtual

Does the widget disable easy close?

Implements gui2::widget.

Definition at line 78 of file rich_label.hpp.

◆ get_active()

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

inlineoverridevirtual

Gets the active state of the styled_widget.

Implements gui2::styled_widget.

Definition at line 68 of file rich_label.hpp.

References DISABLED, and state_.

Referenced by set_active().

◆ get_characters_per_line()

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

inlineoverridevirtual

Returns the number of characters per line.

This value is used to call pango_text::set_characters_per_line (indirectly).

Returns: The characters per line. This implementation always returns 0.

Reimplemented from gui2::styled_widget.

Definition at line 51 of file rich_label.hpp.

References characters_per_line_.

◆ get_control_type()

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

overrideprivatevirtual

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Implements gui2::styled_widget.

◆ get_image_size()

point gui2::rich_label::get_image_size ( config & img_cfg ) const

private

Definition at line 104 of file rich_label.cpp.

References wfl::map_formula_callable::add(), wfl::variant::as_int(), and wfl::formula_callable::query_value().

Referenced by get_parsed_text().

◆ get_label()

const t_string& gui2::rich_label::get_label ( ) const

inline

Definition at line 113 of file rich_label.hpp.

References t_string::empty(), gui2::styled_widget::get_label(), and unparsed_text_.

◆ get_link_aware()

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

inlineoverridevirtual

Returns whether the label should be link_aware, in in rendering and in searching for links with get_link.

This value is used to call pango_text::set_link_aware (indirectly).

Returns: The link aware status. This impl always always returns false.

Reimplemented from gui2::styled_widget.

Definition at line 56 of file rich_label.hpp.

References link_aware_.

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

◆ get_link_color()

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

inlineoverridevirtual

Returns the color string to be used with links.

This value is used to call pango_text::set_link_color (indirectly).

Returns: The link color string. This impl returns "#ffff00".

Reimplemented from gui2::styled_widget.

Definition at line 61 of file rich_label.hpp.

References link_color_.

◆ get_offset_from_xy()

int gui2::rich_label::get_offset_from_xy ( const point & position ) const

inlineprivate

Definition at line 227 of file rich_label.hpp.

References font::get_text_renderer(), and font::pango_text::xy_to_index().

Referenced by get_split_location().

◆ get_parsed_text()

std::pair< config, point > gui2::rich_label::get_parsed_text	(	const config &	parsed_text,
		const point &	origin,
		const unsigned	init_width,
		const bool	finalize = `false`
	)

◆ get_split_location()

size_t gui2::rich_label::get_split_location	(	std::string_view	text,
		const point &	pos
	)

private

Definition at line 227 of file rich_label.cpp.

References c, and get_offset_from_xy().

Referenced by get_parsed_text().

◆ get_state()

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

inlineoverridevirtual

Returns the id of the state.

The current state is also the index canvases_.

Implements gui2::styled_widget.

Definition at line 73 of file rich_label.hpp.

References state_.

◆ get_text_size()

point gui2::rich_label::get_text_size	(	config &	text_cfg,
		unsigned	width = `0`
	)		const

private

size calculation functions

Definition at line 96 of file rich_label.cpp.

References wfl::variant::as_int(), wfl::formula_callable::query_value(), and setup_text_renderer().

Referenced by get_parsed_text().

◆ get_xy_from_offset()

point gui2::rich_label::get_xy_from_offset ( const unsigned offset ) const

inlineprivate

Definition at line 232 of file rich_label.hpp.

References font::pango_text::get_cursor_position(), and font::get_text_renderer().

Referenced by add_link().

◆ register_link_callback()

void gui2::rich_label::register_link_callback ( std::function< void(std::string)> link_handler )

inline

Definition at line 133 of file rich_label.hpp.

References link_handler_.

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

◆ set_active()

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

overridevirtual

Sets the styled_widget's state.

Sets the styled_widget in the active state, when inactive a styled_widget can't be used and doesn't react to events. (Note read-only for a text_box_base is a different state.)

Implements gui2::styled_widget.

Definition at line 784 of file rich_label.cpp.

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

◆ set_can_shrink()

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

inline

Definition at line 106 of file rich_label.hpp.

References can_shrink_.

◆ set_can_wrap()

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

inline

Definition at line 92 of file rich_label.hpp.

References can_wrap_.

◆ set_characters_per_line()

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

inline

Definition at line 97 of file rich_label.hpp.

References characters_per_line_.

◆ set_label()

void gui2::rich_label::set_label ( const t_string & text )

overridevirtual

Reimplemented from gui2::styled_widget.

Definition at line 264 of file rich_label.cpp.

References get_parsed_text(), init_w_, help::topic_text::parsed_text(), gui2::styled_widget::set_label(), size_, text_dom_, and unparsed_text_.

◆ set_link_aware()

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

Definition at line 791 of file rich_label.cpp.

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

◆ set_link_color()

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

Definition at line 800 of file rich_label.cpp.

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

◆ set_state()

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

private

Definition at line 809 of file rich_label.cpp.

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

Referenced by set_active().

◆ set_text_alpha()

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

Definition at line 775 of file rich_label.cpp.

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

◆ set_topic()

void gui2::rich_label::set_topic ( const help::topic * topic )

Definition at line 259 of file rich_label.cpp.

References config::debug(), get_parsed_text(), init_w_, help::topic_text::parsed_text(), gui2::styled_widget::set_label(), size_, help::topic::text, and text_dom_.

◆ setup_text_renderer()

wfl::map_formula_callable gui2::rich_label::setup_text_renderer	(	config	text_cfg,
		unsigned	width = `0`
	)		const

private

Definition at line 84 of file rich_label.cpp.

References wfl::map_formula_callable::add().

Referenced by add_link(), and get_text_size().

◆ signal_handler_left_button_click()

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

private

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

Definition at line 817 of file rich_label.cpp.

References DBG_GUI_E, DBG_GUI_RL, get_link_aware(), gui2::get_mouse_position(), gui2::widget::get_origin(), link_handler_, links_, sound::play_UI_sound(), and gui2::settings::sound_button_click.

Referenced by rich_label().

◆ signal_handler_mouse_leave()

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

private

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

Definition at line 869 of file rich_label.cpp.

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

Referenced by rich_label().

◆ signal_handler_mouse_motion()

void gui2::rich_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 848 of file rich_label.cpp.

References DBG_GUI_E, get_link_aware(), gui2::widget::get_origin(), links_, and update_mouse_cursor().

Referenced by rich_label().

◆ split_in_width()

std::vector< std::string > gui2::rich_label::split_in_width	(	const std::string &	s,
		const int	font_size,
		const unsigned	width
	)

private

Definition at line 244 of file rich_label.cpp.

References _(), font::pango_word_wrap(), and s.

Referenced by get_parsed_text().

◆ text_can_shrink()

virtual bool gui2::rich_label::text_can_shrink ( )

inlineoverrideprivatevirtual

Inherited from styled_widget.

Reimplemented from gui2::styled_widget.

Definition at line 185 of file rich_label.hpp.

References can_shrink_.

◆ type()

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

static

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

◆ update_canvas()

void gui2::rich_label::update_canvas ( )

overridevirtual

Updates the canvas(ses).

This function should be called if either the size of the widget changes or the text on the widget changes.

Reimplemented from gui2::styled_widget.

Definition at line 757 of file rich_label.cpp.

References gui2::styled_widget::get_canvases(), init_w_, padding_, text_alpha_, and text_dom_.

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

◆ update_mouse_cursor()

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

private

Implementation detail for (re)setting the hyperlink cursor.

Definition at line 883 of file rich_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_rich_label

friend struct implementation::builder_rich_label

friend

Definition at line 41 of file rich_label.hpp.

Member Data Documentation

◆ can_shrink_

bool gui2::rich_label::can_shrink_

private

Definition at line 180 of file rich_label.hpp.

Referenced by set_can_shrink(), and text_can_shrink().

◆ can_wrap_

bool gui2::rich_label::can_wrap_

private

Holds the rich_label can wrap or not.

Definition at line 160 of file rich_label.hpp.

Referenced by can_wrap(), and set_can_wrap().

◆ characters_per_line_

unsigned gui2::rich_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 167 of file rich_label.hpp.

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

◆ init_w_

const unsigned gui2::rich_label::init_w_

private

Width and height of the canvas.

Definition at line 197 of file rich_label.hpp.

Referenced by add_link(), set_label(), set_topic(), and update_canvas().

◆ link_aware_

bool gui2::rich_label::link_aware_

private

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

Definition at line 173 of file rich_label.hpp.

Referenced by get_link_aware(), and set_link_aware().

◆ link_color_

color_t gui2::rich_label::link_color_

private

What color links will be rendered in.

Definition at line 178 of file rich_label.hpp.

Referenced by add_link(), get_link_color(), and set_link_color().

◆ link_handler_

std::function<void(std::string)> gui2::rich_label::link_handler_

private

Definition at line 225 of file rich_label.hpp.

Referenced by register_link_callback(), and signal_handler_left_button_click().

◆ links_

std::vector<std::pair<rect, std::string> > gui2::rich_label::links_

private

link variables and functions

Definition at line 223 of file rich_label.hpp.

Referenced by add_link(), get_parsed_text(), signal_handler_left_button_click(), and signal_handler_mouse_motion().

◆ padding_

unsigned gui2::rich_label::padding_

private

Padding.

Definition at line 201 of file rich_label.hpp.

Referenced by get_parsed_text(), and update_canvas().

◆ size_

point gui2::rich_label::size_

private

Definition at line 198 of file rich_label.hpp.

Referenced by add_link(), calculate_best_size(), set_label(), and set_topic().

◆ state_

state_t gui2::rich_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 157 of file rich_label.hpp.

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

◆ text_alpha_

unsigned short gui2::rich_label::text_alpha_

private

Definition at line 182 of file rich_label.hpp.

Referenced by set_text_alpha(), and update_canvas().

◆ text_dom_

config gui2::rich_label::text_dom_

private

structure tree of the marked up text after parsing

Definition at line 191 of file rich_label.hpp.

Referenced by set_label(), set_topic(), and update_canvas().

◆ unparsed_text_

t_string gui2::rich_label::unparsed_text_

private

The unparsed/raw text.

Definition at line 194 of file rich_label.hpp.

Referenced by get_label(), and set_label().

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

gui/widgets/rich_label.hpp
gui/widgets/rich_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

◆ rich_label()

Member Function Documentation

◆ add_attribute()

◆ add_image()

◆ add_link()

◆ add_text()

◆ add_text_with_attribute()

◆ calculate_best_size()

◆ can_mouse_focus()

◆ can_wrap()

◆ default_text_config()

◆ disable_click_dismiss()

◆ get_active()

◆ get_characters_per_line()

◆ get_control_type()

◆ get_image_size()

◆ get_label()

◆ get_link_aware()

◆ get_link_color()

◆ get_offset_from_xy()

◆ get_parsed_text()

◆ get_split_location()

◆ get_state()

◆ get_text_size()

◆ get_xy_from_offset()

◆ register_link_callback()

◆ set_active()

◆ set_can_shrink()

◆ set_can_wrap()

◆ set_characters_per_line()

◆ set_label()

◆ set_link_aware()

◆ set_link_color()

◆ set_state()

◆ set_text_alpha()

◆ set_topic()

◆ setup_text_renderer()

◆ signal_handler_left_button_click()

◆ signal_handler_mouse_leave()

◆ signal_handler_mouse_motion()

◆ split_in_width()

◆ text_can_shrink()

◆ type()

◆ update_canvas()

◆ update_mouse_cursor()

Friends And Related Function Documentation

◆ implementation::builder_rich_label

Member Data Documentation

◆ can_shrink_

◆ can_wrap_

◆ characters_per_line_

◆ init_w_

◆ link_aware_

◆ link_color_

◆ link_handler_

◆ links_

◆ padding_

◆ size_

◆ state_

◆ text_alpha_

◆ text_dom_

◆ unparsed_text_