Blender  V3.3
Public Attributes | List of all members
wmTooltipState Struct Reference

#include <WM_types.h>

Public Attributes

struct wmTimertimer
 
struct ScrAreaarea_from
 
struct ARegionregion_from
 
struct ARegionregion
 
struct ARegion *(* init )(struct bContext *C, struct 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 1244 of file WM_types.h.

Member Data Documentation

◆ area_from

struct ScrArea* wmTooltipState::area_from

The area the tooltip is created in.

Definition at line 1248 of file WM_types.h.

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 1262 of file WM_types.h.

Referenced by wm_event_do_handlers(), and WM_tooltip_init().

◆ 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 1260 of file WM_types.h.

Referenced by wm_event_do_handlers(), and WM_tooltip_init().

◆ init

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

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

Definition at line 1252 of file WM_types.h.

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 1264 of file WM_types.h.

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

◆ region

struct ARegion* wmTooltipState::region

The tooltip region.

Definition at line 1252 of file WM_types.h.

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

◆ region_from

struct ARegion* wmTooltipState::region_from

The region the tooltip is created in.

Definition at line 1250 of file WM_types.h.

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

◆ timer

struct wmTimer* wmTooltipState::timer

Create tooltip on this event.

Definition at line 1246 of file WM_types.h.

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: