interface_region_search.c File Reference

#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include "DNA_ID.h"
#include "MEM_guardedalloc.h"
#include "DNA_userdef_types.h"
#include "BLI_math.h"
#include "BLI_listbase.h"
#include "BLI_rect.h"
#include "BLI_string.h"
#include "BLI_utildefines.h"
#include "BKE_context.h"
#include "BKE_screen.h"
#include "WM_api.h"
#include "WM_types.h"
#include "RNA_access.h"
#include "UI_interface.h"
#include "UI_interface_icons.h"
#include "UI_view2d.h"
#include "BLT_translation.h"
#include "ED_screen.h"
#include "GPU_state.h"
#include "interface_intern.h"
#include "interface_regions_intern.h"

Go to the source code of this file.

Classes
struct	uiSearchItems
struct	uiSearchboxData

Macros
#define	MENU_BORDER   (int)(0.3f * U.widget_unit)

Search Box Creation
#define	SEARCH_ITEMS   10
typedef struct uiSearchboxData	uiSearchboxData
bool	UI_search_item_add (uiSearchItems *items, const char *name, void *poin, int iconid, int state, const uint8_t name_prefix_offset)
int	UI_searchbox_size_y (void)
int	UI_searchbox_size_x (void)
int	UI_search_items_find_index (uiSearchItems *items, const char *name)
static void	ui_searchbox_select (bContext *C, ARegion *region, uiBut *but, int step)
static void	ui_searchbox_butrect (rcti *r_rect, uiSearchboxData *data, int itemnr)
int	ui_searchbox_find_index (ARegion *region, const char *name)
bool	ui_searchbox_inside (ARegion *region, int x, int y)
bool	ui_searchbox_apply (uiBut *but, ARegion *region)
static struct ARegion *	wm_searchbox_tooltip_init (struct bContext *C, struct ARegion *region, int *UNUSED(r_pass), double *UNUSED(pass_delay), bool *r_exit_on_event)
bool	ui_searchbox_event (bContext *C, ARegion *region, uiBut *but, ARegion *butregion, const wmEvent *event)
static void	ui_searchbox_update_fn (bContext *C, uiButSearch *search_but, const char *str, uiSearchItems *items)
void	ui_searchbox_update (bContext *C, ARegion *region, uiBut *but, const bool reset)
int	ui_searchbox_autocomplete (bContext *C, ARegion *region, uiBut *but, char *str)
static void	ui_searchbox_region_draw_cb (const bContext *C, ARegion *region)
static void	ui_searchbox_region_free_cb (ARegion *region)
ARegion *	ui_searchbox_create_generic (bContext *C, ARegion *butregion, uiButSearch *search_but)
static void	str_tolower_titlecaps_ascii (char *str, const size_t len)
static void	ui_searchbox_region_draw_cb__operator (const bContext *UNUSED(C), ARegion *region)
ARegion *	ui_searchbox_create_operator (bContext *C, ARegion *butregion, uiButSearch *search_but)
void	ui_searchbox_free (bContext *C, ARegion *region)
static void	ui_searchbox_region_draw_cb__menu (const bContext *UNUSED(C), ARegion *UNUSED(region))
ARegion *	ui_searchbox_create_menu (bContext *C, ARegion *butregion, uiButSearch *search_but)
void	ui_but_search_refresh (uiButSearch *search_but)

Detailed Description

Search Box Region & Interaction

Definition in file interface_region_search.c.

Macro Definition Documentation

MENU_BORDER

#define MENU_BORDER   (int)(0.3f * U.widget_unit)

Definition at line 62 of file interface_region_search.c.

SEARCH_ITEMS

#define SEARCH_ITEMS   10

Definition at line 107 of file interface_region_search.c.

Typedef Documentation

uiSearchboxData

typedef struct uiSearchboxData uiSearchboxData

Function Documentation

str_tolower_titlecaps_ascii()

static void str_tolower_titlecaps_ascii ( char *  str, const size_t  len  )

static

Similar to Python's str.title except...

• we know words are upper case and ascii only.
• '_' are replaces by spaces.

Definition at line 897 of file interface_region_search.c.

References ELEM, len, and str.

Referenced by ui_searchbox_region_draw_cb__operator().

ui_but_search_refresh()

void ui_but_search_refresh

(

uiButSearch *

search_but

)

Definition at line 1031 of file interface_region_search.c.

References uiBut::block, uiButSearch::but, uiBut::drawstr, uiBlock::evil_C, uiBut::hardmax, uiSearchItems::maxitem, uiSearchItems::maxstrlen, MEM_callocN, MEM_freeN, uiSearchItems::more, uiSearchItems::names, PROP_STRING, uiButSearch::results_are_suggestions, RNA_property_type(), uiBut::rnaprop, uiSearchItems::totitem, UI_but_flag_enable(), UI_BUT_REDALERT, UI_search_items_find_index(), and ui_searchbox_update_fn().

Referenced by UI_but_func_search_set().

UI_search_item_add()

bool UI_search_item_add	(	uiSearchItems *	items,
		const char *	name,
		void *	poin,
		int	iconid,
		int	state,
		const uint8_t	name_prefix_offset
	)

Public function exported for functions that use UI_BTYPE_SEARCH_MENU.

Parameters

items	Stores the items.
name	Text to display for the item.
poin	Opaque pointer (for use by the caller).
iconid	The icon, #ICON_NONE for no icon.
state	The buttons state flag, compatible with uiBut.flag, typically UI_BUT_DISABLED / UI_BUT_INACTIVE.

Returns

false if there is nothing to add.

Definition at line 120 of file interface_region_search.c.

References uiSearchItems::active, uiSearchItems::autocpl, BLI_assert, BLI_strncpy(), uiSearchItems::has_icon, uiSearchItems::icons, uiSearchItems::maxitem, uiSearchItems::maxstrlen, MEM_callocN, uiSearchItems::more, uiSearchItems::name_prefix_offsets, uiSearchItems::names, NULL, uiSearchItems::offset_i, uiSearchItems::pointers, state, uiSearchItems::states, uiSearchItems::totitem, UI_autocomplete_update_name(), UI_BUT_DISABLED, UI_BUT_HAS_SEP_CHAR, UI_BUT_INACTIVE, and UI_BUT_REDALERT.

Referenced by add_collection_search_item(), attribute_search_item_add(), attribute_search_update_fn(), id_search_add(), menu_search_update_fn(), merged_element_search_fn_recursive(), node_find_update_fn(), operator_enum_search_update_fn(), and operator_search_update_fn().

UI_search_items_find_index()

int UI_search_items_find_index	(	uiSearchItems *	items,
		const char *	name
	)

Definition at line 199 of file interface_region_search.c.

References uiSearchItems::name_prefix_offsets, uiSearchItems::names, NULL, STREQ, and uiSearchItems::totitem.

Referenced by merged_element_search_fn_recursive(), ui_but_search_refresh(), and ui_searchbox_find_index().

ui_searchbox_apply()

bool ui_searchbox_apply	(	uiBut *	but,
		ARegion *	region
	)

Definition at line 301 of file interface_region_search.c.

References BLI_assert, BLI_strncpy(), data, uiBut::editstr, uiBut::flag, uiButSearch::item_active, NULL, ARegion::regiondata, uiBut::type, UI_BTYPE_SEARCH_MENU, UI_BUT_VALUE_CLEAR, and UI_SEP_CHAR.

Referenced by ui_textedit_end().

ui_searchbox_autocomplete()

int ui_searchbox_autocomplete	(	bContext *	C,
		ARegion *	region,
		uiBut *	but,
		char *	str
	)

Definition at line 555 of file interface_region_search.c.

References AUTOCOMPLETE_NO_MATCH, BLI_assert, C, data, uiBut::editstr, NULL, ARegion::regiondata, str, uiBut::type, UI_autocomplete_begin(), UI_autocomplete_end(), UI_BTYPE_SEARCH_MENU, ui_but_string_get_max_length(), and ui_searchbox_update_fn().

Referenced by ui_textedit_autocomplete().

ui_searchbox_butrect()

static void ui_searchbox_butrect ( rcti *  r_rect, uiSearchboxData *  data, int  itemnr  )

static

Definition at line 254 of file interface_region_search.c.

References BLI_rcti_size_x(), BLI_rcti_size_y(), col, data, MENU_BORDER, SEARCH_ITEMS, UI_POPUP_MENU_TOP, rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

Referenced by ui_searchbox_event(), ui_searchbox_region_draw_cb(), ui_searchbox_region_draw_cb__operator(), and wm_searchbox_tooltip_init().

ui_searchbox_create_generic()

ARegion* ui_searchbox_create_generic	(	bContext *	C,
		ARegion *	butregion,
		uiButSearch *	search_but
	)

Definition at line 722 of file interface_region_search.c.

References uiBut::a1, uiBut::a2, uiBlock::aspect, BLI_rctf_cent_y(), BLI_rctf_size_x(), BLI_rctf_size_y(), BLI_rctf_translate(), BLI_rcti_rctf_copy(), BLI_rcti_size_x(), BLI_rcti_size_y(), BLI_rcti_translate(), uiBut::block, uiButSearch::but, C, CTX_wm_screen(), CTX_wm_window(), View2D::cur, data, uiBut::drawflag, ED_region_floating_init(), ED_region_tag_redraw(), uiBlock::flag, uiBut::hardmax, uiButSearch::item_sep_string, MEM_callocN, NULL, Panel::ofsx, Panel::ofsy, uiBut::optype, uiBlock::panel, uiBut::rect, uiBlock::rect, ARegion::regiondata, RGN_TYPE_TEMPORARY, SEARCH_ITEMS, type, ARegion::type, UI_BLOCK_SEARCH_MENU, UI_BUT_HAS_SHORTCUT, ui_fontscale(), UI_fontstyle_set(), UI_POPUP_MARGIN, ui_region_temp_add(), ui_searchbox_region_draw_cb(), ui_searchbox_region_free_cb(), UI_searchbox_size_x(), UI_searchbox_size_y(), UI_style_get(), UI_view2d_view_to_region_rcti(), UI_view2d_view_to_region_y(), ARegion::v2d, uiStyle::widget, ARegion::winrct, ARegion::winx, WM_window_pixels_x(), rcti::xmax, rctf::xmax, rcti::xmin, rctf::xmin, rcti::ymax, rctf::ymax, rcti::ymin, and rctf::ymin.

Referenced by template_common_search_menu(), ui_but_add_search(), UI_but_func_search_set(), ui_searchbox_create_menu(), ui_searchbox_create_operator(), and uiDefSearchButO_ptr().

ui_searchbox_create_menu()

ARegion* ui_searchbox_create_menu	(	bContext *	C,
		ARegion *	butregion,
		uiButSearch *	search_but
	)

Definition at line 1017 of file interface_region_search.c.

References uiButSearch::but, C, ARegionType::draw, ARegion::type, UI_but_drawflag_enable(), UI_BUT_HAS_SHORTCUT, ui_searchbox_create_generic(), and ui_searchbox_region_draw_cb__menu().

Referenced by UI_but_func_menu_search().

ui_searchbox_create_operator()

ARegion* ui_searchbox_create_operator	(	bContext *	C,
		ARegion *	butregion,
		uiButSearch *	search_but
	)

Definition at line 997 of file interface_region_search.c.

References uiButSearch::but, C, ARegionType::draw, ARegion::type, UI_but_drawflag_enable(), UI_BUT_HAS_SHORTCUT, ui_searchbox_create_generic(), and ui_searchbox_region_draw_cb__operator().

Referenced by UI_but_func_operator_search().

ui_searchbox_event()

bool ui_searchbox_event	(	bContext *	C,
		ARegion *	region,
		uiBut *	but,
		ARegion *	butregion,
		const wmEvent *	event
	)

Definition at line 369 of file interface_region_search.c.

References Freestyle::a, blender::compositor::active, blender::compositor::area(), uiButSearch::arg, BLI_assert, BLI_rcti_isect_pt(), C, CTX_wm_area(), CTX_wm_window(), data, EVT_DOWNARROWKEY, EVT_UPARROWKEY, is_inside(), uiButSearch::item_active, uiButSearch::item_context_menu_fn, MOUSEMOVE, MOUSEPAN, ARegion::regiondata, RIGHTMOUSE, uiBut::type, type, UI_BTYPE_SEARCH_MENU, ui_pan_to_scroll(), ui_searchbox_butrect(), ui_searchbox_select(), USER_TOOLTIPS, WHEELDOWNMOUSE, WHEELUPMOUSE, ARegion::winrct, wm_searchbox_tooltip_init(), WM_tooltip_clear(), WM_tooltip_timer_init(), wmEvent::x, rcti::xmin, wmEvent::y, and rcti::ymin.

ui_searchbox_find_index()

int ui_searchbox_find_index	(	ARegion *	region,
		const char *	name
	)

Definition at line 286 of file interface_region_search.c.

References data, ARegion::regiondata, and UI_search_items_find_index().

Referenced by ui_textedit_end().

ui_searchbox_free()

void ui_searchbox_free	(	bContext *	C,
		ARegion *	region
	)

Definition at line 1007 of file interface_region_search.c.

References C, CTX_wm_screen(), and ui_region_temp_remove().

Referenced by ui_textedit_end().

ui_searchbox_inside()

bool ui_searchbox_inside	(	ARegion *	region,
		int	x,
		int	y
	)

Definition at line 293 of file interface_region_search.c.

References BLI_rcti_isect_pt(), data, ARegion::regiondata, ARegion::winrct, x, rcti::xmin, y, and rcti::ymin.

Referenced by ui_do_but_textedit().

ui_searchbox_region_draw_cb()

static void ui_searchbox_region_draw_cb ( const bContext *  C, ARegion *  region  )

static

Definition at line 575 of file interface_region_search.c.

References Freestyle::a, BLI_rcti_size_x(), C, data, GPU_blend(), GPU_BLEND_ALPHA, GPU_BLEND_NONE, NULL, ARegion::regiondata, state, UI_ACTIVE, UI_BUT_HAS_SEP_CHAR, UI_BUT_INACTIVE, UI_DPI_ICON_SIZE, ui_draw_menu_item(), ui_draw_preview_item(), ui_draw_widget_menu_back(), UI_icon_draw(), ui_icon_ensure_deferred(), UI_MENU_ITEM_SEPARATOR_HINT, UI_MENU_ITEM_SEPARATOR_NONE, UI_MENU_ITEM_SEPARATOR_SHORTCUT, ui_searchbox_butrect(), UI_UNIT_X, wmOrtho2_region_pixelspace(), rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

Referenced by ui_searchbox_create_generic().

ui_searchbox_region_draw_cb__menu()

static void ui_searchbox_region_draw_cb__menu ( const bContext *  UNUSEDC, ARegion *  UNUSEDregion  )

static

Definition at line 1012 of file interface_region_search.c.

Referenced by ui_searchbox_create_menu().

ui_searchbox_region_draw_cb__operator()

static void ui_searchbox_region_draw_cb__operator ( const bContext *  UNUSEDC, ARegion *  region  )

static

Definition at line 916 of file interface_region_search.c.

References Freestyle::a, BLI_rcti_size_x(), BLI_strncpy_rlen(), BLT_I18NCONTEXT_OPERATOR_DEFAULT, CTX_IFACE_, data, GPU_blend(), GPU_BLEND_ALPHA, GPU_BLEND_NONE, wmOperatorType::idname, min_ii(), NULL, ot, ARegion::regiondata, state, str_tolower_titlecaps_ascii(), UI_ACTIVE, ui_draw_menu_item(), ui_draw_widget_menu_back(), UI_icon_draw(), UI_MENU_ITEM_SEPARATOR_NONE, UI_MENU_ITEM_SEPARATOR_SHORTCUT, ui_searchbox_butrect(), wmOrtho2_region_pixelspace(), rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

Referenced by ui_searchbox_create_operator().

ui_searchbox_region_free_cb()

static void ui_searchbox_region_free_cb ( ARegion *  region )

static

Definition at line 700 of file interface_region_search.c.

References Freestyle::a, data, MEM_freeN, NULL, and ARegion::regiondata.

Referenced by ui_searchbox_create_generic().

ui_searchbox_select()

static void ui_searchbox_select ( bContext *  C, ARegion *  region, uiBut *  but, int  step  )

static

Definition at line 219 of file interface_region_search.c.

References C, data, ED_region_tag_redraw(), uiBut::flag, ARegion::regiondata, UI_BUT_VALUE_CLEAR, and ui_searchbox_update().

Referenced by ui_searchbox_event(), and ui_searchbox_update().

UI_searchbox_size_x()

int UI_searchbox_size_x

(

void

)

Definition at line 194 of file interface_region_search.c.

References UI_UNIT_X.

Referenced by node_find_menu(), template_common_search_menu(), ui_searchbox_create_generic(), wm_enum_search_menu(), and wm_search_menu_invoke().

UI_searchbox_size_y()

int UI_searchbox_size_y

(

void

)

Definition at line 189 of file interface_region_search.c.

References SEARCH_ITEMS, UI_POPUP_MENU_TOP, and UI_UNIT_Y.

Referenced by merged_element_search_menu(), node_find_menu(), template_common_search_menu(), ui_searchbox_create_generic(), wm_enum_search_menu(), and wm_search_menu_invoke().

ui_searchbox_update()

void ui_searchbox_update	(	bContext *	C,
		ARegion *	region,
		uiBut *	but,
		const bool	reset
	)

Definition at line 476 of file interface_region_search.c.

References Freestyle::a, BLI_assert, C, data, ED_region_tag_redraw(), uiBut::editstr, uiButSearch::item_active, uiButSearch::items_update_fn, NULL, ARegion::regiondata, reset(), STREQLEN, uiBut::type, UI_BTYPE_SEARCH_MENU, ui_searchbox_select(), ui_searchbox_update_fn(), and UI_SEP_CHAR.

Referenced by ui_but_drop(), ui_but_paste_text(), ui_do_but_textedit(), ui_searchbox_select(), and ui_textedit_begin().

ui_searchbox_update_fn()

static void ui_searchbox_update_fn ( bContext *  C, uiButSearch *  search_but, const char *  str, uiSearchItems *  items  )

static

Wrap uiButSearchUpdateFn callback.

Definition at line 461 of file interface_region_search.c.

References uiButSearch::arg, uiButSearch::but, C, uiBut::changed, CTX_wm_window(), uiBut::editstr, uiButSearch::items_update_fn, str, and WM_tooltip_clear().

Referenced by ui_but_search_refresh(), ui_searchbox_autocomplete(), and ui_searchbox_update().

wm_searchbox_tooltip_init()

static struct ARegion* wm_searchbox_tooltip_init ( struct bContext *  C, struct ARegion *  region, int *  UNUSEDr_pass, double *  UNUSEDpass_delay, bool *  r_exit_on_event  )

static

Definition at line 335 of file interface_region_search.c.

References uiButSearch::arg, BLI_assert, C, data, uiButSearch::item_active, uiButSearch::item_tooltip_fn, LISTBASE_FOREACH, NULL, ARegion::regiondata, UI_BTYPE_SEARCH_MENU, UI_region_searchbox_region_get(), ui_searchbox_butrect(), and ARegion::uiblocks.

Referenced by ui_searchbox_event().