#include "BLI_listbase.h"
#include "BLI_math_rotation.h"
#include "BLI_math_vector.h"
#include "BLI_rect.h"
#include "BLI_string.h"
#include "BLI_utildefines.h"
#include "DNA_screen_types.h"
#include "UI_interface.hh"
#include "UI_view2d.hh"
#include "RNA_access.hh"
#include "interface_intern.hh"
#include "UI_abstract_view.hh"
#include "WM_api.hh"
#include "WM_types.hh"

Classes
struct	ListRowFindIndexData

Functions
Button (#uiBut) Spatial
void	ui_but_pie_dir (RadialDirection dir, float vec[2])

static bool	ui_but_isect_pie_seg (const uiBlock block, const uiBut but)

bool	ui_but_contains_pt (const uiBut *but, float mx, float my)

bool	ui_but_contains_rect (const uiBut but, const rctf rect)

bool	ui_but_contains_point_px (const uiBut but, const ARegion region, const int xy[2])

bool	ui_but_contains_point_px_icon (const uiBut but, ARegion region, const wmEvent *event)

static uiBut *	ui_but_find (const ARegion region, const uiButFindPollFn find_poll, const void find_custom_data)

uiBut *	ui_but_find_mouse_over_ex (const ARegion region, const int xy[2], const bool labeledit, const bool for_tooltip, const uiButFindPollFn find_poll, const void find_custom_data)

uiBut *	ui_but_find_mouse_over (const ARegion region, const wmEvent event)

uiBut *	ui_but_find_rect_over (const ARegion region, const rcti rect_px)

uiBut *	ui_list_find_mouse_over_ex (const ARegion *region, const int xy[2])

uiBut *	ui_list_find_mouse_over (const ARegion region, const wmEvent event)

uiList *	UI_list_find_mouse_over (const ARegion region, const wmEvent event)

static bool	ui_list_contains_row (const uiBut listbox_but, const uiBut listrow_but)

static bool	ui_but_is_listbox_with_row (const uiBut but, const void customdata)

uiBut *	ui_list_find_from_row (const ARegion region, const uiBut row_but)

static bool	ui_but_is_listrow (const uiBut but, const void )

uiBut *	ui_list_row_find_mouse_over (const ARegion *region, const int xy[2])

static bool	ui_but_is_listrow_at_index (const uiBut but, const void customdata)

uiBut *	ui_list_row_find_index (const ARegion region, const int index, uiBut listbox)

static bool	ui_but_is_view_item_fn (const uiBut but, const void )

uiBut *	ui_view_item_find_mouse_over (const ARegion *region, const int xy[2])

static bool	ui_but_is_active_view_item (const uiBut but, const void )

uiBut *	ui_view_item_find_active (const ARegion *region)

uiBut *	ui_view_item_find_search_highlight (const ARegion *region)

Button (#uiBut) Relations
uiBut *	ui_but_prev (uiBut *but)

uiBut *	ui_but_next (uiBut *but)

uiBut *	ui_but_first (uiBlock *block)

uiBut *	ui_but_last (uiBlock *block)

bool	ui_but_is_cursor_warp (const uiBut *but)

bool	ui_but_contains_password (const uiBut *but)

Button (#uiBut) Text
size_t	ui_but_drawstr_len_without_sep_char (const uiBut *but)

blender::StringRef	ui_but_drawstr_without_sep_char (const uiBut *but)

size_t	ui_but_tip_len_only_first_line (const uiBut *but)

Block (#uiBlock) State
uiBut *	ui_block_active_but_get (const uiBlock *block)

bool	ui_block_is_menu (const uiBlock *block)

bool	ui_block_is_popover (const uiBlock *block)

bool	ui_block_is_pie_menu (const uiBlock *block)

bool	ui_block_is_popup_any (const uiBlock *block)

static const uiBut *	ui_but_next_non_separator (const uiBut *but)

bool	UI_block_is_empty_ex (const uiBlock *block, const bool skip_title)

bool	UI_block_is_empty (const uiBlock *block)

bool	UI_block_can_add_separator (const uiBlock *block)

bool	UI_block_has_active_default_button (const uiBlock *block)

Block (#uiBlock) Spatial
uiBlock *	ui_block_find_mouse_over_ex (const ARegion *region, const int xy[2], bool only_clip)

uiBlock *	ui_block_find_mouse_over (const ARegion region, const wmEvent event, bool only_clip)

Region (#ARegion) State
uiBut *	ui_region_find_active_but (ARegion *region)

uiBut *	ui_region_find_first_but_test_flag (ARegion *region, int flag_include, int flag_exclude)

Region (#ARegion) Spatial
bool	ui_region_contains_point_px (const ARegion *region, const int xy[2])

bool	ui_region_contains_rect_px (const ARegion region, const rcti rect_px)

Screen (#bScreen) Spatial
ARegion *	ui_screen_region_find_mouse_over_ex (bScreen *screen, const int xy[2])

ARegion *	ui_screen_region_find_mouse_over (bScreen screen, const wmEvent event)

Manage Internal State
void	ui_interface_tag_script_reload_queries ()

Button (#uiBut) State
static wmOperatorType *	g_ot_tool_set_by_id = nullptr

bool	ui_but_is_editable (const uiBut *but)

bool	ui_but_is_editable_as_text (const uiBut *but)

bool	ui_but_is_toggle (const uiBut *but)

bool	ui_but_is_interactive_ex (const uiBut *but, const bool labeledit, const bool for_tooltip)

bool	ui_but_is_interactive (const uiBut *but, const bool labeledit)

bool	UI_but_is_utf8 (const uiBut *but)

bool	ui_but_is_popover_once_compat (const uiBut *but)

bool	ui_but_has_array_value (const uiBut *but)

bool	UI_but_is_tool (const uiBut *but)

bool	UI_but_has_tooltip_label (const uiBut *but)

int	ui_but_icon (const uiBut *but)

Detailed Description

Utilities to inspect the interface, extract information.

Definition in file interface_query.cc.

Function Documentation

◆ ui_block_active_but_get()

uiBut * ui_block_active_but_get ( const uiBlock * block )

Definition at line 641 of file interface_query.cc.

References uiBlock::buttons, and LISTBASE_FOREACH.

Referenced by ui_but_update_view_for_active(), and ui_region_find_active_but().

◆ UI_block_can_add_separator()

bool UI_block_can_add_separator ( const uiBlock * block )

Definition at line 703 of file interface_query.cc.

References uiBlock::buttons, ELEM, ListBase::last, uiBut::type, ui_block_is_menu(), ui_block_is_pie_menu(), UI_BTYPE_SEPR, and UI_BTYPE_SEPR_LINE.

Referenced by uiItemS_ex().

◆ ui_block_find_mouse_over()

uiBlock * ui_block_find_mouse_over	(	const ARegion *	region,
		const wmEvent *	event,
		bool	only_clip )

Definition at line 748 of file interface_query.cc.

References ui_block_find_mouse_over_ex(), and wmEvent::xy.

◆ ui_block_find_mouse_over_ex()

uiBlock * ui_block_find_mouse_over_ex	(	const ARegion *	region,
		const int	xy[2],
		bool	only_clip )

Definition at line 728 of file interface_query.cc.

References BLI_rctf_isect_pt(), LISTBASE_FOREACH, UI_BLOCK_CLIP_EVENTS, ui_region_contains_point_px(), ui_window_to_block_fl(), and xy.

Referenced by ui_block_find_mouse_over().

◆ UI_block_has_active_default_button()

bool UI_block_has_active_default_button ( const uiBlock * block )

Return true when the block has a default button. Use this for popups to detect when pressing "Return" will run an action.

Definition at line 712 of file interface_query.cc.

References uiBlock::buttons, LISTBASE_FOREACH, UI_BUT_ACTIVE_DEFAULT, and UI_HIDDEN.

Referenced by UI_popup_block_template_confirm(), and wm_block_dialog_create().

◆ UI_block_is_empty()

bool UI_block_is_empty ( const uiBlock * block )

Definition at line 698 of file interface_query.cc.

References UI_block_is_empty_ex().

◆ UI_block_is_empty_ex()

bool UI_block_is_empty_ex	(	const uiBlock *	block,
		const bool	skip_title )

Definition at line 684 of file interface_query.cc.

References uiBlock::buttons, ListBase::first, uiBut::next, uiBut::type, UI_BTYPE_LABEL, and ui_but_next_non_separator().

Referenced by UI_block_is_empty(), and UI_popup_menu_end_or_cancel().

◆ ui_block_is_menu()

bool ui_block_is_menu ( const uiBlock * block )

◆ ui_block_is_pie_menu()

bool ui_block_is_pie_menu ( const uiBlock * block )

Definition at line 664 of file interface_query.cc.

References uiBlock::flag, and UI_BLOCK_PIE_MENU.

Referenced by UI_block_can_add_separator(), ui_block_is_popup_any(), ui_handle_button_event(), ui_handle_menu_button(), ui_tooltip_data_from_button_or_extra_icon(), uiItemS_ex(), widget_draw_icon(), and widget_draw_text_icon().

◆ ui_block_is_popover()

bool ui_block_is_popover ( const uiBlock * block )

Definition at line 659 of file interface_query.cc.

References uiBlock::flag, and UI_BLOCK_POPOVER.

Referenced by ui_block_is_popup_any(), ui_def_but(), and ui_def_but_operator_ptr().

◆ ui_block_is_popup_any()

bool ui_block_is_popup_any ( const uiBlock * block )

Definition at line 669 of file interface_query.cc.

References ui_block_is_menu(), ui_block_is_pie_menu(), and ui_block_is_popover().

Referenced by ui_do_but_SCROLL(), ui_draw_layout_panels_backdrop(), ui_popup_context_menu_for_button(), and uiItemSpacer().

◆ ui_but_contains_password()

bool ui_but_contains_password ( const uiBut * but )

Definition at line 598 of file interface_query.cc.

References PROP_PASSWORD, RNA_property_subtype(), and uiBut::rnaprop.

Referenced by ui_but_copy().

◆ ui_but_contains_point_px()

bool ui_but_contains_point_px	(	const uiBut *	but,
		const ARegion *	region,
		const int	xy[2] )

Definition at line 249 of file interface_query.cc.

References uiBut::block, uiBut::pie_dir, ui_but_contains_pt(), ui_but_isect_pie_seg(), UI_RADIAL_NONE, ui_region_contains_point_px(), ui_window_to_block_fl(), and xy.

◆ ui_but_contains_point_px_icon()

bool ui_but_contains_point_px_icon	(	const uiBut *	but,
		ARegion *	region,
		const wmEvent *	event )

Definition at line 271 of file interface_query.cc.

References BLI_rcti_isect_pt(), BLI_rcti_rctf_copy(), BLI_rcti_size_x(), BLI_rcti_size_y(), uiBut::block, uiBut::dragflag, uiBut::drawflag, uiBut::rect, UI_BUT_DRAG_FULL_BUT, UI_BUT_ICON_LEFT, ui_window_to_block(), rcti::xmax, and rcti::xmin.

Referenced by ui_do_but_BLOCK(), ui_do_but_COLOR(), and ui_do_but_EXIT().

◆ ui_but_contains_pt()

bool ui_but_contains_pt	(	const uiBut *	but,
		float	mx,
		float	my )

Definition at line 239 of file interface_query.cc.

References BLI_rctf_isect_pt(), and uiBut::rect.

Referenced by ui_but_contains_point_px(), ui_but_find_mouse_over_ex(), ui_do_but_textedit(), and ui_list_find_mouse_over_ex().

◆ ui_but_contains_rect()

bool ui_but_contains_rect	(	const uiBut *	but,
		const rctf *	rect )

Definition at line 244 of file interface_query.cc.

References BLI_rctf_isect(), and uiBut::rect.

Referenced by ui_but_find_rect_over(), and UI_key_event_operator_string().

◆ ui_but_drawstr_len_without_sep_char()

size_t ui_but_drawstr_len_without_sep_char ( const uiBut * but )

Definition at line 609 of file interface_query.cc.

References uiBut::drawstr, uiBut::flag, UI_BUT_HAS_SEP_CHAR, and UI_SEP_CHAR.

Referenced by ui_apply_but_undo(), and ui_but_drawstr_without_sep_char().

◆ ui_but_drawstr_without_sep_char()

blender::StringRef ui_but_drawstr_without_sep_char ( const uiBut * but )

Definition at line 620 of file interface_query.cc.

References uiBut::drawstr, blender::StringRefBase::substr(), and ui_but_drawstr_len_without_sep_char().

Referenced by ui_apply_but_func(), ui_but_user_menu_add(), and ui_handle_afterfunc_add_operator_ex().

◆ ui_but_find()

static uiBut * ui_but_find	(	const ARegion *	region,
		const uiButFindPollFn	find_poll,
		const void *	find_custom_data )

static

Definition at line 295 of file interface_query.cc.

References LISTBASE_FOREACH, and LISTBASE_FOREACH_BACKWARD.

Referenced by ui_list_find_from_row(), ui_list_row_find_index(), ui_view_item_find_active(), and ui_view_item_find_search_highlight().

◆ ui_but_find_mouse_over()

uiBut * ui_but_find_mouse_over	(	const ARegion *	region,
		const wmEvent *	event )

Definition at line 357 of file interface_query.cc.

References KM_CTRL, wmEvent::modifier, ui_but_find_mouse_over_ex(), and wmEvent::xy.

Referenced by eyedropper_get_property_button_under_mouse(), ui_handle_button_event(), ui_handler_region_menu(), and ui_list_activate_hovered_row().

◆ ui_but_find_mouse_over_ex()

uiBut * ui_but_find_mouse_over_ex	(	const ARegion *	region,
		const int	xy[2],
		const bool	labeledit,
		const bool	for_tooltip,
		const uiButFindPollFn	find_poll,
		const void *	find_custom_data )