gui2::dialogs::tip Namespace Reference

Functions
void	show (const std::string &window_id, const t_string &message, const point &mouse, const rect &source_rect)
	Shows a tip.
void	remove ()
	Removes a tip.

Variables
static std::unique_ptr< tooltip >	tip

Function Documentation

remove()

void gui2::dialogs::tip::remove

(

)

Removes a tip.

It is safe to call this function when no tip is shown.

Definition at line 94 of file tooltip.cpp.

References tip.

Referenced by gui2::window::show(), gui2::styled_widget::signal_handler_notify_remove_tooltip(), and gui2::window::~window().

show()

void gui2::dialogs::tip::show	(	const std::string &	window_id,
		const t_string &	message,
		const point &	mouse,
		const rect &	source_rect
	)

Shows a tip.

The tip is a tooltip or a helptip. One type of tip is shown at the same time, opening a second tip closes the first.

Parameters

window_id	The id of the window used to show the tip.
message	The message to show in the tip.
mouse	The position of the mouse.
source_rect	The thing being hovered over to show the tip.

Definition at line 64 of file tooltip.cpp.

References ERR_CFG, and tip.

Referenced by gui2::window::signal_handler_message_show_helptip(), and gui2::window::signal_handler_message_show_tooltip().

Variable Documentation

tip

std::unique_ptr<tooltip> gui2::dialogs::tip::tip

static

Definition at line 62 of file tooltip.cpp.

Referenced by remove(), and show().