The Battle for Wesnoth  1.17.10+dev
Functions | Variables
gui2::dialogs::tip Namespace Reference

Functions

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

Variables

static std::unique_ptr< tooltiptip
 

Function Documentation

◆ remove()

void gui2::dialogs::tip::remove ( )

◆ show()

void gui2::dialogs::tip::show ( const std::string &  window_id,
const t_string message,
const point mouse,
const SDL_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_idThe id of the window used to show the tip.
messageThe message to show in the tip.
mouseThe position of the mouse.
source_rectThe thing being hovered over to show the tip.

Definition at line 81 of file tooltip.cpp.

References ERR_CFG, and tooltip.

Referenced by wb::side_actions::clear(), gui2::dialogs::get_modeless_dialog_id(), actions::get_village(), gui2::dialogs::make_screenshot(), unit_creator::post_create(), actions::recall_unit(), actions::recruit_unit(), gui2::generator< minimum_selection, maximum_selection, my_placement, select_action >::set_item_shown(), gui2::window::signal_handler_message_show_helptip(), gui2::window::signal_handler_message_show_tooltip(), SYNCED_COMMAND_HANDLER_FUNCTION(), and gui2::generator_base::toggle_item().

Variable Documentation

◆ tip

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