#include <cstdarg>
#include <cstdlib>
#include <cstring>
#include <iostream>
#include "DNA_ID.h"
#include "MEM_guardedalloc.h"
#include "DNA_userdef_types.h"
#include "BLI_listbase.h"
#include "BLI_rect.h"
#include "BLI_string.h"
#include "BLI_utildefines.h"
#include "BKE_context.hh"
#include "BKE_screen.hh"
#include "WM_api.hh"
#include "WM_types.hh"
#include "RNA_access.hh"
#include "UI_interface.hh"
#include "UI_interface_icons.hh"
#include "UI_view2d.hh"
#include "BLT_translation.hh"
#include "ED_screen.hh"
#include "GPU_state.hh"
#include "interface_intern.hh"
#include "interface_regions_intern.hh"

Classes
struct	uiSearchItems

struct	uiSearchboxData

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

Search Box Creation
#define	SEARCH_ITEMS 10

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

int	UI_searchbox_size_y ()

int	UI_searchbox_size_x ()

int	UI_search_items_find_index (const 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, const int xy[2])

bool	ui_searchbox_apply (uiBut but, ARegion region)

static ARegion *	wm_searchbox_tooltip_init (bContext C, ARegion region, int , double , 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 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_fn (const bContext C, ARegion region)

static void	ui_searchbox_region_free_fn (ARegion *region)

static void	ui_searchbox_region_listen_fn (const wmRegionListenerParams *params)

static uiMenuItemSeparatorType	ui_searchbox_item_separator (uiSearchboxData *data)

static void	ui_searchbox_region_layout_fn (const bContext C, ARegion region)

static ARegion *	ui_searchbox_create_generic_ex (bContext C, ARegion butregion, uiButSearch *but, const bool use_shortcut_sep)

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 , 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 , ARegion )

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

void	ui_but_search_refresh (uiButSearch *but)

Detailed Description

Search Box Region & Interaction

Definition in file interface_region_search.cc.

Macro Definition Documentation

◆ MENU_BORDER

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

Definition at line 46 of file interface_region_search.cc.

Referenced by ui_searchbox_butrect().

◆ SEARCH_ITEMS

#define SEARCH_ITEMS 10

Definition at line 98 of file interface_region_search.cc.

Referenced by ui_searchbox_butrect(), ui_searchbox_create_generic_ex(), and UI_searchbox_size_y().

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 944 of file interface_region_search.cc.

References ELEM, len, and str.

Referenced by ui_searchbox_region_draw_cb__operator().

◆ ui_but_search_refresh()

void ui_but_search_refresh ( uiButSearch * but )

XXX weak: search_func adds all partial matches.

Definition at line 1083 of file interface_region_search.cc.

References uiBut::block, 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	but_flag,
		uint8_t	name_prefix_offset )

Public function exported for functions that use UI_BTYPE_SEARCH_MENU.

Use inside searchfunc to add items.

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.
but_flag	Button flags (uiBut.flag) indicating the state of the item, typically UI_BUT_DISABLED, UI_BUT_INACTIVE or UI_BUT_HAS_SEP_CHAR.