tooltips Namespace Reference

tooltips. More...

Classes
class	manager

Functions
void	clear_tooltips ()
void	clear_tooltips (const SDL_Rect &r)
bool	update_tooltip (int id, const SDL_Rect &origin, const std::string &message)
void	remove_tooltip (int id)
int	add_tooltip (const SDL_Rect &origin, const std::string &message, const std::string &action)
static void	raise_to_top ()
static void	select_active (int id)
void	process (int mousex, int mousey)
bool	click (int mousex, int mousey)

Detailed Description

tooltips.

This module can be used to register tooltips, which will be shown provided process() is called every time mouse motion events are received from the events system. If tooltips::draw_text() is used instead of font::draw_text(), the text will also be registered as a tooltip.

Function Documentation

add_tooltip()

int tooltips::add_tooltip	(	const SDL_Rect &	origin,
		const std::string &	message,
		const std::string &	action
	)

Definition at line 237 of file tooltips.cpp.

References clear_tooltips(), DBG_FT, id, gui2::dialogs::tip::tip, gui2::settings::tips, and tooltip.

Referenced by terrain_label::calculate_shroud(), display::draw_label(), display::draw_report(), editor::mouse_action_unit::move(), font::pango_draw_text(), and gui::widget::process_tooltip_string().

clear_tooltips() [1/2]

void tooltips::clear_tooltips

(

)

Definition at line 179 of file tooltips.cpp.

References clear_active(), LOG_FT, and gui2::settings::tips.

Referenced by add_tooltip(), tooltips::manager::manager(), editor::mouse_action_unit::move(), display::queue_rerender(), display::refresh_report(), and tooltips::manager::~manager().

clear_tooltips() [2/2]

void tooltips::clear_tooltips

(

const SDL_Rect &

r

)

Definition at line 186 of file tooltips.cpp.

References DBG_FT, i, and gui2::settings::tips.

click()

bool tooltips::click	(	int	mousex,
		int	mousey
	)

Definition at line 294 of file tooltips.cpp.

References help::show_help(), gui2::dialogs::tip::tip, and gui2::settings::tips.

Referenced by gui2::event::fire_event_double_click(), events::mouse_handler_base::mouse_button_event(), events::mouse_handler::mouse_button_event(), events::mouse_handler::select_or_action(), gui2::event_executor::set_wants_mouse_left_double_click(), gui2::event_executor::set_wants_mouse_middle_double_click(), and gui2::event_executor::set_wants_mouse_right_double_click().

process()

void tooltips::process	(	int	mousex,
		int	mousey
	)

Definition at line 278 of file tooltips.cpp.

References clear_active(), LOG_FT, select_active(), gui2::dialogs::tip::tip, and gui2::settings::tips.

Referenced by events::mouse_handler_base::mouse_motion_default(), help::help_menu::process(), and events::mouse_handler::touch_motion().

raise_to_top()

static void tooltips::raise_to_top ( )

static

Definition at line 256 of file tooltips.cpp.

References draw_manager::raise_drawable().

Referenced by select_active().

remove_tooltip()

void tooltips::remove_tooltip

(

int

id

)

Definition at line 227 of file tooltips.cpp.

References clear_active(), DBG_FT, id, and gui2::settings::tips.

Referenced by terrain_label::calculate_shroud(), and terrain_label::clear().

select_active()

static void tooltips::select_active ( int  id )

static

Definition at line 265 of file tooltips.cpp.

References clear_active(), id, LOG_FT, raise_to_top(), gui2::dialogs::tip::tip, gui2::settings::tips, and tooltip.

Referenced by process().

update_tooltip()

bool tooltips::update_tooltip	(	int	id,
		const SDL_Rect &	origin,
		const std::string &	message
	)

Definition at line 205 of file tooltips.cpp.

References DBG_FT, LOG_FT, gui2::dialogs::tip::tip, gui2::settings::tips, and tooltip.

Referenced by terrain_label::calculate_shroud().