Blender V4.3
wmTooltipState Struct Reference

#include <WM_types.hh>

Public Attributes

wmTimertimer
 
ScrAreaarea_from
 
ARegionregion_from
 
ARegionregion
 
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 1375 of file WM_types.hh.

Member Data Documentation

◆ area_from

ScrArea* wmTooltipState::area_from

The area the tooltip is created in.

Definition at line 1379 of file WM_types.hh.

Referenced by WM_tooltip_immediate_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 1390 of file WM_types.hh.

◆ 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 1388 of file WM_types.hh.

◆ 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 1385 of file WM_types.hh.

◆ pass

int wmTooltipState::pass

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

Definition at line 1392 of file WM_types.hh.

◆ region

ARegion* wmTooltipState::region

The tooltip region.

Definition at line 1383 of file WM_types.hh.

◆ region_from

ARegion* wmTooltipState::region_from

The region the tooltip is created in.

Definition at line 1381 of file WM_types.hh.

◆ timer

wmTimer* wmTooltipState::timer

Create tooltip on this event.

Definition at line 1377 of file WM_types.hh.


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