Blender: uiPopupBlockHandle Struct Reference

Blender V5.0

#include <interface_intern.hh>

Public Attributes
ARegion *	region = nullptr
float	towards_xy [2]
double	towardstime = 0.0
bool	dotowards = false
bool	popup = false
void(*	popup_func )(bContext C, void arg, int event) = nullptr
void(*	cancel_func )(bContext C, void arg) = nullptr
void *	popup_arg = nullptr
uiPopupBlockCreate	popup_create_vars
bool	can_refresh = false
bool	refresh = false
wmTimer *	scrolltimer = nullptr
float	scrolloffset = 0.0f
uiKeyNavLock	keynav_state
wmOperator *	popup_op = nullptr
ScrArea *	ctx_area = nullptr
ARegion *	ctx_region = nullptr
int	butretval = 0
int	menuretval = 0
int	retvalue = 0
float	retvec [4] = {0.0f, 0.0f, 0.0f, 0.0f}
int	direction = 0
rctf	prev_block_rect = {}
rctf	prev_butrct = {}
short	prev_dir1 = 0
short	prev_dir2 = 0
int	prev_bounds_offset [2] = {0, 0}
float	max_size_x = 0.0f
float	max_size_y = 0.0f
bool	is_grab = false
int	grab_xy_prev [2] = {0, 0}
char	menu_idname [64] = ""

Detailed Description

Definition at line 929 of file interface_intern.hh.

Member Data Documentation

◆ butretval

int uiPopupBlockHandle::butretval = 0

Definition at line 965 of file interface_intern.hh.

Referenced by button_activate_exit(), and ui_handle_menu_return_submenu().

◆ can_refresh

bool uiPopupBlockHandle::can_refresh = false

True if we can re-create the popup using uiPopupBlockHandle.popup_create_vars.

Note: Popups that can refresh are called with #bContext::wm::region_popup set to the uiPopupBlockHandle::region both on initial creation and when refreshing.

Definition at line 951 of file interface_intern.hh.

Referenced by ui_block_region_refresh(), ui_popup_block_create(), and ui_popup_block_refresh().

◆ cancel_func

void(* uiPopupBlockHandle::cancel_func) (bContext *C, void *arg) = nullptr

Definition at line 940 of file interface_intern.hh.

Referenced by popup_block_template_close_cb(), UI_popup_block_ex(), ui_popup_handler(), and ui_popup_handler_remove().

◆ ctx_area

ScrArea* uiPopupBlockHandle::ctx_area = nullptr

Definition at line 961 of file interface_intern.hh.

Referenced by ui_block_region_refresh(), ui_handle_menu_button(), and ui_popup_block_create().

◆ ctx_region

ARegion* uiPopupBlockHandle::ctx_region = nullptr

Definition at line 962 of file interface_intern.hh.

Referenced by ui_block_func_POPOVER(), ui_block_region_refresh(), ui_handle_menu_button(), and ui_popup_block_create().

◆ direction

int uiPopupBlockHandle::direction = 0

Menu direction.

Definition at line 971 of file interface_intern.hh.

Referenced by ui_popup_block_refresh().

◆ dotowards

bool uiPopupBlockHandle::dotowards = false

Definition at line 936 of file interface_intern.hh.

Referenced by ui_handle_menu_event(), ui_mouse_motion_towards_check(), and ui_mouse_motion_towards_init_ex().

◆ grab_xy_prev

int uiPopupBlockHandle::grab_xy_prev[2] = {0, 0}

Definition at line 986 of file interface_intern.hh.

Referenced by UI_block_end_ex(), and ui_handle_menu_event().

◆ is_grab

bool uiPopupBlockHandle::is_grab = false

Definition at line 985 of file interface_intern.hh.

Referenced by ui_handle_menu_event().

◆ keynav_state

uiKeyNavLock uiPopupBlockHandle::keynav_state

Definition at line 957 of file interface_intern.hh.

Referenced by ui_handle_menu_event().

◆ max_size_x

float uiPopupBlockHandle::max_size_x = 0.0f

Definition at line 981 of file interface_intern.hh.

Referenced by ui_popup_block_position().

◆ max_size_y

float uiPopupBlockHandle::max_size_y = 0.0f

Definition at line 982 of file interface_intern.hh.

Referenced by ui_block_func_POPOVER(), and ui_popup_block_position().

◆ menu_idname

char uiPopupBlockHandle::menu_idname[64] = ""

Definition at line 989 of file interface_intern.hh.

Referenced by ui_handle_menu_event(), ui_handle_menu_letter_press_search(), and ui_popup_menu_create_from_menutype().

◆ menuretval

◆ popup

bool uiPopupBlockHandle::popup = false

Definition at line 938 of file interface_intern.hh.

Referenced by button_activate_state(), ui_block_open_begin(), ui_menu_pass_event_to_parent_if_nonactive(), UI_pie_menu_end(), UI_popover_end(), ui_popover_panel_create(), UI_popup_block_ex(), UI_popup_block_invoke_ex(), ui_popup_menu_create_impl(), and UI_popup_menu_end().

◆ popup_arg

void* uiPopupBlockHandle::popup_arg = nullptr

Definition at line 941 of file interface_intern.hh.

Referenced by popup_block_template_close_cb(), UI_popup_block_ex(), ui_popup_handler(), and ui_popup_handler_remove().

◆ popup_create_vars

uiPopupBlockCreate uiPopupBlockHandle::popup_create_vars

Store data for refreshing popups.

Definition at line 944 of file interface_intern.hh.

Referenced by ui_block_region_refresh(), ui_but_event_property_operator_string(), ui_handle_menu_event(), UI_popover_panel_invoke(), ui_popup_block_create(), ui_popup_block_free(), and ui_popup_block_refresh().

◆ popup_func

void(* uiPopupBlockHandle::popup_func) (bContext *C, void *arg, int event) = nullptr

Definition at line 939 of file interface_intern.hh.

Referenced by UI_popup_block_ex(), and ui_popup_handler().

◆ popup_op

wmOperator* uiPopupBlockHandle::popup_op = nullptr

Definition at line 960 of file interface_intern.hh.

Referenced by ui_afterfunc_check(), ui_apply_but_func(), and UI_popup_block_ex().

◆ prev_block_rect

rctf uiPopupBlockHandle::prev_block_rect = {}

Definition at line 974 of file interface_intern.hh.

Referenced by ui_popup_block_refresh(), and ui_popup_translate().

◆ prev_bounds_offset

int uiPopupBlockHandle::prev_bounds_offset[2] = {0, 0}

Definition at line 978 of file interface_intern.hh.

Referenced by ui_block_func_POPOVER(), and ui_block_func_POPUP().

◆ prev_butrct

rctf uiPopupBlockHandle::prev_butrct = {}

Definition at line 975 of file interface_intern.hh.

Referenced by ui_popup_block_position().

◆ prev_dir1

short uiPopupBlockHandle::prev_dir1 = 0

Definition at line 976 of file interface_intern.hh.

Referenced by ui_popup_block_position().

◆ prev_dir2

short uiPopupBlockHandle::prev_dir2 = 0

Definition at line 977 of file interface_intern.hh.

Referenced by ui_popup_block_position().

◆ refresh

bool uiPopupBlockHandle::refresh = false

Definition at line 952 of file interface_intern.hh.

Referenced by ui_block_func_POPOVER(), ui_block_func_POPUP(), ui_popup_block_position(), and ui_popup_block_refresh().

◆ region

ARegion* uiPopupBlockHandle::region = nullptr

◆ retvalue

int uiPopupBlockHandle::retvalue = 0

Definition at line 967 of file interface_intern.hh.

Referenced by ui_def_but_rna__menu(), ui_handle_button_return_submenu(), ui_handle_menus_recursive(), UI_popup_block_ex(), and ui_popup_handler().

◆ retvec

float uiPopupBlockHandle::retvec[4] = {0.0f, 0.0f, 0.0f, 0.0f}

Definition at line 968 of file interface_intern.hh.

Referenced by ui_block_func_COLOR(), and ui_handle_button_return_submenu().

◆ scrolloffset

float uiPopupBlockHandle::scrolloffset = 0.0f

Definition at line 955 of file interface_intern.hh.

Referenced by ui_menu_scroll_apply_offset_y(), and ui_popup_block_refresh().

◆ scrolltimer

wmTimer* uiPopupBlockHandle::scrolltimer = nullptr

Definition at line 954 of file interface_intern.hh.

Referenced by ui_handle_menu_event(), ui_pie_handler(), and ui_popup_block_remove().

◆ towards_xy

float uiPopupBlockHandle::towards_xy[2]

Use only for UI_BLOCK_MOVEMOUSE_QUIT popups.

Definition at line 934 of file interface_intern.hh.

Referenced by ui_mouse_motion_towards_check(), and ui_mouse_motion_towards_init_ex().

◆ towardstime

double uiPopupBlockHandle::towardstime = 0.0

Definition at line 935 of file interface_intern.hh.

Referenced by ui_mouse_motion_towards_check(), ui_mouse_motion_towards_init_ex(), and UI_pie_menu_end().

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

interface_intern.hh