wmTooltipState Struct Reference

#include <WM_types.hh>

Public Attributes
wmTimer *	timer
ScrArea *	area_from
ARegion *	region_from
ARegion *	region
ARegion *(*	init )(bContext *C, ARegion *region, int *pass, double *pass_delay, bool *r_exit_on_event)
bool	exit_on_event
int	event_xy [2]
int	pass

Detailed Description

Struct to store tool-tip timer and possible creation if the time is reached. Allows UI code to call WM_tooltip_timer_init without each user having to handle the timer.

Definition at line 1427 of file WM_types.hh.

Member Data Documentation

area_from

ScrArea* wmTooltipState::area_from

The area the tooltip is created in.

Definition at line 1431 of file WM_types.hh.

Referenced by WM_tooltip_immediate_init(), WM_tooltip_init(), and WM_tooltip_timer_init_ex().

event_xy

int wmTooltipState::event_xy[2]

Cursor location at the point of tooltip creation.

Definition at line 1442 of file WM_types.hh.

Referenced by ui_handle_button_event(), wm_event_do_handlers(), WM_tooltip_init(), and WM_tooltip_timer_init_ex().

exit_on_event

bool wmTooltipState::exit_on_event

Exit on any event, not needed for buttons since their highlight state is used.

Definition at line 1440 of file WM_types.hh.

Referenced by wm_event_do_handlers(), and WM_tooltip_init().

init

ARegion *(* wmTooltipState::init) (bContext *C, ARegion *region, int *pass, double *pass_delay, bool *r_exit_on_event)

Create the tooltip region (assign to 'region').

Definition at line 1437 of file WM_types.hh.

Referenced by WM_tooltip_immediate_init(), WM_tooltip_init(), and WM_tooltip_timer_init_ex().

pass

int wmTooltipState::pass

Pass, use when we want multiple tips, count down to zero.

Definition at line 1444 of file WM_types.hh.

Referenced by button_activate_init(), button_tooltip_timer_reset(), and WM_tooltip_init().

region

ARegion* wmTooltipState::region

The tooltip region.

Definition at line 1435 of file WM_types.hh.

Referenced by button_tooltip_timer_reset(), UI_but_tooltip_refresh(), WM_tooltip_clear(), WM_tooltip_init(), and WM_tooltip_refresh().

region_from

ARegion* wmTooltipState::region_from

The region the tooltip is created in.

Definition at line 1433 of file WM_types.hh.

Referenced by WM_tooltip_immediate_init(), WM_tooltip_init(), and WM_tooltip_timer_init_ex().

timer

wmTimer* wmTooltipState::timer

Create tooltip on this event.

Definition at line 1429 of file WM_types.hh.

Referenced by wm_event_do_handlers(), WM_tooltip_init(), WM_tooltip_timer_clear(), and WM_tooltip_timer_init_ex().

---

The documentation for this struct was generated from the following file:

• WM_types.hh