Blender V5.3
blender::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 1532 of file WM_types.hh.

Member Data Documentation

◆ area_from

ScrArea* blender::wmTooltipState::area_from

The area the tool-tip is created in.

Definition at line 1536 of file WM_types.hh.

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

◆ event_xy

int blender::wmTooltipState::event_xy[2]

Cursor location at the point of tool-tip creation.

Definition at line 1547 of file WM_types.hh.

Referenced by blender::ui::handle_button_event(), blender::wm_event_do_handlers(), blender::WM_tooltip_init(), and blender::WM_tooltip_timer_init_ex().

◆ exit_on_event

bool blender::wmTooltipState::exit_on_event

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

Definition at line 1545 of file WM_types.hh.

Referenced by blender::wm_event_do_handlers(), and blender::WM_tooltip_init().

◆ init

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

Create the tool-tip region (assign to 'region').

Definition at line 1542 of file WM_types.hh.

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

◆ pass

int blender::wmTooltipState::pass

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

Definition at line 1549 of file WM_types.hh.

Referenced by blender::ui::button_activate_init(), blender::ui::button_tooltip_timer_reset(), and blender::WM_tooltip_init().

◆ region

◆ region_from

ARegion* blender::wmTooltipState::region_from

The region the tool-tip is created in.

Definition at line 1538 of file WM_types.hh.

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

◆ timer

wmTimer* blender::wmTooltipState::timer

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