Blender V5.0
uiButSearch Struct Reference

#include <interface_intern.hh>

Inherits uiBut.

Public Attributes

uiButSearchCreateFn popup_create_fn = nullptr
uiButSearchUpdateFn items_update_fn = nullptr
uiButSearchListenFn listen_fn = nullptr
void * item_active = nullptr
char * item_active_str
void * arg = nullptr
uiFreeArgFunc arg_free_fn = nullptr
uiButSearchContextMenuFn item_context_menu_fn = nullptr
uiButSearchTooltipFn item_tooltip_fn = nullptr
const char * item_sep_string = nullptr
PointerRNA rnasearchpoin = {}
PropertyRNArnasearchprop = nullptr
int preview_rows = 0
int preview_cols = 0
bool results_are_suggestions = false
Public Attributes inherited from uiBut
uiLayoutlayout = nullptr
int flag = 0
int drawflag = 0
char flag2 = 0
ButType type = ButType(0)
ButPointerType pointype = ButPointerType::None
bool bit = 0
char bitnr = 0
uchar menu_key = 0
short retval = 0
short strwidth = 0
short alignnr = 0
short ofs = 0
short pos = 0
short selsta = 0
short selend = 0
uchar col [4] = {0}
std::string str
std::string drawstr
char * placeholder = nullptr
rctf rect = {}
char * poin = nullptr
float hardmin = 0
float hardmax = 0
float softmin = 0
float softmax = 0
uiButIdentityCompareFunc identity_cmp_func = nullptr
uiButHandleFunc func = nullptr
void * func_arg1 = nullptr
void * func_arg2 = nullptr
std::function< void(bContext &)> apply_func
uiButHandleNFunc funcN = nullptr
void * func_argN = nullptr
uiButArgNFree func_argN_free_fn
uiButArgNCopy func_argN_copy_fn
const bContextStorecontext = nullptr
uiButCompleteFunc autocomplete_func = nullptr
void * autofunc_arg = nullptr
uiButHandleRenameFunc rename_func = nullptr
void * rename_arg1 = nullptr
void * rename_orig = nullptr
std::function< void(std::string &new_name)> rename_full_func = nullptr
std::string rename_full_new
uiButHandleHoldFunc hold_func = nullptr
void * hold_argN = nullptr
blender::StringRef tip
uiButToolTipFunc tip_func = nullptr
void * tip_arg = nullptr
uiFreeArgFunc tip_arg_free = nullptr
std::function< std::string(const uiBut *)> tip_quick_func
uiButToolTipCustomFunc tip_custom_func = nullptr
const char * disabled_info = nullptr
IconTextOverlay icon_overlay_text = {}
blender::ui::EmbossType emboss = blender::ui::EmbossType::Emboss
RadialDirection pie_dir = UI_RADIAL_NONE
bool changed = false
BIFIconID icon = ICON_NONE
float search_weight = 0.0f
short iconadd = 0
uchar unit_type = 0
bool menu_no_hover_open = false
uiBlockCreateFunc block_create_func = nullptr
uiMenuCreateFunc menu_create_func = nullptr
uiMenuStepFunc menu_step_func = nullptr
PointerRNA rnapoin = {}
PropertyRNArnaprop = nullptr
int rnaindex = 0
BIFIconID drag_preview_icon_id
void * dragpoin = nullptr
const ImBufimb = nullptr
float imb_scale = 0
eWM_DragDataType dragtype = WM_DRAG_ID
int8_t dragflag = 0
bool operator_never_call = false
blender::wm::OpCallContext opcontext = blender::wm::OpCallContext::InvokeDefault
wmOperatorTypeoptype = nullptr
PointerRNAopptr = nullptr
ListBase extra_op_icons = {nullptr, nullptr}
uiHandleButtonDataactive = nullptr
uiHandleButtonDatasemi_modal_state = nullptr
void * custom_data = nullptr
char * editstr = nullptr
double * editval = nullptr
floateditvec = nullptr
std::function< bool(const uiBut &)> pushed_state_func
uiBlockblock = nullptr

Additional Inherited Members

Public Member Functions inherited from uiBut
 uiBut ()=default
 uiBut (const uiBut &other)=default
uiButoperator= (const uiBut &other)=default
virtual ~uiBut ()=default

Detailed Description

Derived struct for ButType::SearchMenu

Definition at line 376 of file interface_intern.hh.

Member Data Documentation

◆ arg

◆ arg_free_fn

◆ item_active

◆ item_active_str

char* uiButSearch::item_active_str

◆ item_context_menu_fn

uiButSearchContextMenuFn uiButSearch::item_context_menu_fn = nullptr

Definition at line 387 of file interface_intern.hh.

Referenced by UI_but_func_search_set_context_menu(), and ui_searchbox_event().

◆ item_sep_string

const char* uiButSearch::item_sep_string = nullptr

◆ item_tooltip_fn

uiButSearchTooltipFn uiButSearch::item_tooltip_fn = nullptr

◆ items_update_fn

◆ listen_fn

uiButSearchListenFn uiButSearch::listen_fn = nullptr

◆ popup_create_fn

uiButSearchCreateFn uiButSearch::popup_create_fn = nullptr

Definition at line 377 of file interface_intern.hh.

Referenced by UI_but_func_search_set(), and ui_textedit_begin().

◆ preview_cols

int uiButSearch::preview_cols = 0

◆ preview_rows

int uiButSearch::preview_rows = 0

◆ results_are_suggestions

bool uiButSearch::results_are_suggestions = false

The search box only provides suggestions, it does not force the string to match one of the search items when applying.

Definition at line 402 of file interface_intern.hh.

Referenced by UI_but_func_search_set(), UI_but_func_search_set_results_are_suggestions(), ui_but_search_refresh(), and ui_textedit_end().

◆ rnasearchpoin

◆ rnasearchprop


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