wm_tooltip.cc File Reference

#include "MEM_guardedalloc.h"
#include "BLI_math_vector.h"
#include "BLI_time.h"
#include "BKE_context.hh"
#include "UI_interface.hh"
#include "WM_api.hh"
#include "WM_types.hh"

Go to the source code of this file.

Functions
double	WM_tooltip_time_closed ()
void	WM_tooltip_immediate_init (bContext *C, wmWindow *win, ScrArea *area, ARegion *region, wmTooltipInitFn init)
void	WM_tooltip_timer_init_ex (bContext *C, wmWindow *win, ScrArea *area, ARegion *region, wmTooltipInitFn init, double delay)
void	WM_tooltip_timer_init (bContext *C, wmWindow *win, ScrArea *area, ARegion *region, wmTooltipInitFn init)
void	WM_tooltip_timer_clear (bContext *C, wmWindow *win)
void	WM_tooltip_clear (bContext *C, wmWindow *win)
void	WM_tooltip_init (bContext *C, wmWindow *win)
void	WM_tooltip_refresh (bContext *C, wmWindow *win)

Variables
static double	g_tooltip_time_closed

Detailed Description

Manages a per-window tool-tip.

Definition in file wm_tooltip.cc.

Function Documentation

WM_tooltip_clear()

void WM_tooltip_clear	(	bContext *	C,
		wmWindow *	win )

Definition at line 82 of file wm_tooltip.cc.

References BLI_time_now_seconds(), C, g_tooltip_time_closed, MEM_freeN(), wmTooltipState::region, bScreen::tool_tip, UI_tooltip_free(), WM_tooltip_timer_clear(), and WM_window_get_active_screen().

Referenced by gizmo_tweak_invoke(), UI_but_tooltip_timer_remove(), ui_handle_layout_panel_header(), ui_handle_menu_event(), ui_searchbox_event(), ui_searchbox_update_fn(), wm_event_do_handlers(), wm_gizmomap_modal_set(), wm_handlers_do_gizmo_handler(), wm_handlers_do_intern(), and WM_tooltip_init().

WM_tooltip_immediate_init()

void WM_tooltip_immediate_init	(	bContext *	C,
		wmWindow *	win,
		ScrArea *	area,
		ARegion *	region,
		wmTooltipInitFn	init )

Definition at line 29 of file wm_tooltip.cc.

References wmTooltipState::area_from, C, init(), wmTooltipState::init, MEM_callocN(), wmTooltipState::region_from, bScreen::tool_tip, WM_tooltip_init(), WM_tooltip_timer_clear(), and WM_window_get_active_screen().

Referenced by button_activate_init().

WM_tooltip_init()

void WM_tooltip_init	(	bContext *	C,
		wmWindow *	win )

Definition at line 97 of file wm_tooltip.cc.

References wmTooltipState::area_from, C, copy_v2_v2_int(), CTX_wm_area(), CTX_wm_area_set(), CTX_wm_manager(), CTX_wm_region(), CTX_wm_region_set(), wmTooltipState::event_xy, wmWindow::eventstate, wmTooltipState::exit_on_event, wmTooltipState::init, wmTooltipState::pass, wmTooltipState::region, wmTooltipState::region_from, TIMER, wmTooltipState::timer, bScreen::tool_tip, UI_tooltip_free(), WM_event_timer_add(), WM_tooltip_clear(), WM_tooltip_timer_clear(), WM_window_get_active_screen(), and wmEvent::xy.

Referenced by wm_event_do_handlers(), WM_tooltip_immediate_init(), and WM_tooltip_refresh().

WM_tooltip_refresh()

void WM_tooltip_refresh	(	bContext *	C,
		wmWindow *	win )

Definition at line 133 of file wm_tooltip.cc.

References C, wmTooltipState::region, bScreen::tool_tip, UI_tooltip_free(), WM_tooltip_init(), WM_tooltip_timer_clear(), and WM_window_get_active_screen().

Referenced by UI_but_tooltip_refresh().

WM_tooltip_time_closed()

double WM_tooltip_time_closed

(

)

Definition at line 24 of file wm_tooltip.cc.

References g_tooltip_time_closed.

Referenced by button_activate_init().

WM_tooltip_timer_clear()

void WM_tooltip_timer_clear	(	bContext *	C,
		wmWindow *	win )

Definition at line 70 of file wm_tooltip.cc.

References C, CTX_wm_manager(), wmTooltipState::timer, bScreen::tool_tip, WM_event_timer_remove(), and WM_window_get_active_screen().

Referenced by button_tooltip_timer_reset(), WM_tooltip_clear(), WM_tooltip_immediate_init(), WM_tooltip_init(), WM_tooltip_refresh(), and WM_tooltip_timer_init_ex().

WM_tooltip_timer_init()

void WM_tooltip_timer_init	(	bContext *	C,
		wmWindow *	win,
		ScrArea *	area,
		ARegion *	region,
		wmTooltipInitFn	init )

Definition at line 64 of file wm_tooltip.cc.

References C, init(), UI_TOOLTIP_DELAY, and WM_tooltip_timer_init_ex().

Referenced by ui_searchbox_event(), and wm_handlers_do_gizmo_handler().

WM_tooltip_timer_init_ex()

void WM_tooltip_timer_init_ex	(	bContext *	C,
		wmWindow *	win,
		ScrArea *	area,
		ARegion *	region,
		wmTooltipInitFn	init,
		double	delay )

Definition at line 44 of file wm_tooltip.cc.

References wmTooltipState::area_from, C, copy_v2_v2_int(), CTX_wm_manager(), wmTooltipState::event_xy, wmWindow::eventstate, init(), wmTooltipState::init, MEM_callocN(), wmTooltipState::region_from, TIMER, wmTooltipState::timer, bScreen::tool_tip, WM_event_timer_add(), WM_tooltip_timer_clear(), WM_window_get_active_screen(), and wmEvent::xy.

Referenced by button_tooltip_timer_reset(), and WM_tooltip_timer_init().

Variable Documentation

g_tooltip_time_closed

double g_tooltip_time_closed

static

Definition at line 23 of file wm_tooltip.cc.

Referenced by WM_tooltip_clear(), and WM_tooltip_time_closed().