gui2::tip Namespace Reference

Functions
static ttip &	tip ()
void	show (CVideo &video, const std::string &window_id, const t_string &message, const tpoint &mouse)
	Shows a tip. More...
void	remove ()
	Removes a tip. More...

Function Documentation

void gui2::tip::remove

(

)

Removes a tip.

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

Definition at line 167 of file tip.cpp.

References gui2::tpopup::hide(), and tip().

Referenced by gui2::twindow::show(), gui2::tcontrol::signal_handler_notify_remove_tooltip(), and gui2::twindow::~twindow().

void gui2::tip::show	(	CVideo &	video,
		const std::string &	window_id,
		const t_string &	message,
		const tpoint &	mouse
	)

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

video	The video which contains the surface to draw upon.
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.

Definition at line 133 of file tip.cpp.

References ERR_CFG, and tip().

Referenced by lobby_info::apply_game_filter(), unit_creator::post_create(), actions::recall_unit(), actions::recruit_unit(), gui2::tgenerator< minimum_selection, maximum_selection, placement, select_action >::set_item_shown(), gui2::twindow::signal_handler_message_show_helptip(), gui2::twindow::signal_handler_message_show_tooltip(), and SYNCED_COMMAND_HANDLER_FUNCTION().

static ttip& gui2::tip::tip ( )

static

Definition at line 123 of file tip.cpp.

Referenced by gui2::tips::load(), gui2::ttitle_screen::pre_show(), remove(), show(), gui2::tips::shuffle(), and gui2::tcontrol::signal_handler_show_tooltip().