#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 "BKE_screen.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_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_quick_tooltip (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 648 of file interface_query.cc.

References uiBlock::buttons.

Referenced by ui_but_update_view_for_active(), ui_list_find_mouse_over_ex(), and ui_region_find_active_but().

◆ UI_block_can_add_separator()

bool UI_block_can_add_separator ( const uiBlock * block )

Definition at line 714 of file interface_query.cc.

References ELEM, uiBlock::last_but(), Sepr, SeprLine, uiBut::type, ui_block_is_menu(), and ui_block_is_pie_menu().

Referenced by uiLayout::separator().

◆ ui_block_find_mouse_over()

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

Definition at line 759 of file interface_query.cc.

References ui_block_find_mouse_over_ex(), and wmEvent::xy.

Referenced by ui_block_find_mouse_over_ex().

◆ 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 739 of file interface_query.cc.

References BLI_rctf_isect_pt(), LISTBASE_FOREACH, ARegion::runtime, 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 723 of file interface_query.cc.

References uiBlock::buttons, 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 709 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 695 of file interface_query.cc.

References uiBlock::first_but(), Label, uiBlock::next_but(), uiBut::type, 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 671 of file interface_query.cc.

References uiBlock::flag, and UI_BLOCK_PIE_MENU.

Referenced by uiLayout::separator(), UI_block_can_add_separator(), ui_block_is_popup_any(), ui_handle_button_event(), ui_handle_menu_button(), ui_list_find_mouse_over_ex(), ui_tooltip_data_from_button_or_extra_icon(), widget_draw_icon(), and widget_draw_text_icon().

◆ ui_block_is_popover()

bool ui_block_is_popover ( const uiBlock * block )

Definition at line 666 of file interface_query.cc.

References uiBlock::flag, and UI_BLOCK_POPOVER.

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

◆ ui_block_is_popup_any()

bool ui_block_is_popup_any ( const uiBlock * block )

Definition at line 676 of file interface_query.cc.

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

Referenced by uiLayout::separator_spacer(), ui_do_but_SCROLL(), ui_do_but_VIEW_ITEM(), ui_draw_layout_panels_backdrop(), ui_list_find_mouse_over_ex(), and ui_popup_context_menu_for_button().

◆ ui_but_contains_password()

bool ui_but_contains_password ( const uiBut * but )

Definition at line 602 of file interface_query.cc.

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

Referenced by ui_but_copy(), and ui_list_find_mouse_over_ex().

◆ ui_but_contains_point_px()

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

Definition at line 261 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 283 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(), x, rcti::xmax, rcti::xmin, and y.

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 251 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 256 of file interface_query.cc.

References BLI_rctf_isect(), and uiBut::rect.

Referenced by ui_but_find_rect_over().

◆ ui_but_drawstr_len_without_sep_char()

size_t ui_but_drawstr_len_without_sep_char ( const uiBut * but )

Definition at line 613 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(), ui_but_drawstr_without_sep_char(), and ui_list_find_mouse_over_ex().

◆ ui_but_drawstr_without_sep_char()

blender::StringRef ui_but_drawstr_without_sep_char ( const uiBut * but )

Definition at line 624 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(), ui_handle_afterfunc_add_operator_ex(), and ui_list_find_mouse_over_ex().

◆ ui_but_find()

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

static

Definition at line 307 of file interface_query.cc.

References i, LISTBASE_FOREACH, and ARegion::runtime.

Referenced by 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 )

Find a button under the mouse cursor, ignoring non-interactive ones (like labels). Holding Ctrl over a label button that can be Ctrl-Clicked to turn into an edit button will return that. Labels that are only interactive for the sake of displaying a tooltip are ignored too.

Definition at line 371 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(), blender::ed::space_node::node_group_enter_exit_invoke(), ui_handle_button_event(), and ui_handler_region_menu().

◆ 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 )