#include <interface_intern.hh>

Inherited by uiButColor, uiButColorBand, uiButCurveMapping, uiButCurveProfile, uiButDecorator, uiButHSVCube, uiButHotkeyEvent, uiButLabel, uiButNumber, uiButNumberSlider, uiButProgress, uiButScrollBar, uiButSearch, uiButSeparatorLine, uiButTab, and uiButViewItem.

Public Member Functions
	uiBut ()=default

	uiBut (const uiBut &other)=default

uiBut &	operator= (const uiBut &other)=default

virtual	~uiBut ()=default

Public Attributes
uiLayout *	layout = nullptr

int	flag = 0

int	flag2 = 0

int	drawflag = 0

eButType	type = eButType(0)

eButPointerType	pointype = UI_BUT_POIN_NONE

short	bit = 0

short	bitnr = 0

short	retval = 0

short	strwidth = 0

short	alignnr = 0

short	ofs = 0

short	pos = 0

short	selsta = 0

short	selend = 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

uchar	col [4] = {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 bContextStore *	context = 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

BIFIconID	icon = ICON_NONE

blender::ui::EmbossType	emboss = blender::ui::EmbossType::Emboss

RadialDirection	pie_dir = UI_RADIAL_NONE

bool	changed = false

uchar	unit_type = 0

short	iconadd = 0

float	search_weight = 0.0f

uiBlockCreateFunc	block_create_func = nullptr

uiMenuCreateFunc	menu_create_func = nullptr

uiMenuStepFunc	menu_step_func = nullptr

bool	menu_no_hover_open = false

PointerRNA	rnapoin = {}

PropertyRNA *	rnaprop = nullptr

int	rnaindex = 0

wmOperatorType *	optype = nullptr

PointerRNA *	opptr = nullptr

wmOperatorCallContext	opcontext = WM_OP_INVOKE_DEFAULT

bool	operator_never_call = false

uchar	menu_key = 0

ListBase	extra_op_icons = {nullptr, nullptr}

eWM_DragDataType	dragtype = WM_DRAG_ID

short	dragflag = 0

void *	dragpoin = nullptr

BIFIconID	drag_preview_icon_id

const ImBuf *	imb = nullptr

float	imb_scale = 0

uiHandleButtonData *	active = nullptr

uiHandleButtonData *	semi_modal_state = nullptr

void *	custom_data = nullptr

char *	editstr = nullptr

double *	editval = nullptr

float *	editvec = nullptr

std::function< bool(const uiBut &)>	pushed_state_func

IconTextOverlay	icon_overlay_text = {}

uiBlock *	block = nullptr

Detailed Description

Definition at line 177 of file interface_intern.hh.

Constructor & Destructor Documentation

◆ uiBut() [1/2]

uiBut::uiBut ( )

default

◆ uiBut() [2/2]

uiBut::uiBut ( const uiBut & other )

default

Performs a mostly shallow copy for now. Only contained C++ types are deep copied.

◆ ~uiBut()

virtual uiBut::~uiBut ( )

virtualdefault

Member Function Documentation

◆ operator=()

uiBut & uiBut::operator= ( const uiBut & other )

default

Mostly shallow copy, just like copy constructor above.

Member Data Documentation

◆ active

uiHandleButtonData* uiBut::active = nullptr

Active button data, set when the user is hovering or interacting with a button (UI_HOVER and UI_SELECT state mostly).

Definition at line 311 of file interface_intern.hh.

Referenced by button_activate_exit(), button_activate_init(), button_activate_state(), button_tooltip_timer_reset(), force_activate_view_item_but(), ui_apply_but_func(), ui_block_interaction_begin(), ui_but_active_free(), UI_but_active_only_ex(), ui_but_active_string_clear_and_exit(), ui_but_execute_begin(), ui_but_execute_end(), ui_but_extra_icons_update_from_old_but(), ui_but_extra_operator_icon_apply(), ui_but_free(), ui_but_is_editing(), ui_but_menu_direction(), ui_but_paste_text(), ui_but_pie_button_activate(), ui_but_pie_menu_apply(), ui_but_set_string_interactive(), ui_but_tooltip_init(), UI_but_tooltip_refresh(), UI_but_tooltip_timer_remove(), ui_but_update_from_old_block(), ui_but_update_old_active_from_new(), ui_but_update_view_for_active(), ui_can_activate_other_menu(), ui_context_button_active(), UI_context_update_anim_flag(), ui_do_but_HOTKEYEVT(), ui_do_but_TOG(), ui_do_button(), ui_handle_button_activate(), ui_handle_button_event(), ui_handle_button_over(), ui_handle_button_return_submenu(), ui_handle_menu_button(), ui_handle_menu_event(), ui_handle_menu_return_submenu(), ui_handle_menus_recursive(), ui_handler_region_menu(), ui_multibut_states_apply(), ui_multibut_states_tag(), ui_numedit_set_active(), ui_pie_handler(), UI_region_free_active_but_all(), UI_region_searchbox_region_get(), UI_screen_free_active_but_highlight(), widget_roundbox_set(), and with_but_active_as_semi_modal().

◆ alignnr

short uiBut::alignnr = 0

Definition at line 186 of file interface_intern.hh.

Referenced by ui_block_align_butal_cmp(), ui_block_align_calc(), ui_but_find_select_in_enum__cmp(), ui_but_is_row_alignment_group(), ui_but_update_old_active_from_new(), ui_def_but(), ui_def_but_rna__menu(), and ui_item_align().

◆ apply_func

std::function<void(bContext &)> uiBut::apply_func

C++ version of func above. Allows storing arbitrary data in a type safe way, no void pointer arguments.

Definition at line 217 of file interface_intern.hh.

Referenced by ui_afterfunc_check(), ui_apply_but_func(), ui_but_equals_old(), UI_but_func_set(), and ui_popup_context_menu_for_button().

◆ autocomplete_func

uiButCompleteFunc uiBut::autocomplete_func = nullptr

Definition at line 226 of file interface_intern.hh.

Referenced by UI_but_func_complete_set(), ui_do_but_textedit(), ui_textedit_autocomplete(), and ui_textedit_begin().

◆ autofunc_arg

void* uiBut::autofunc_arg = nullptr

Definition at line 227 of file interface_intern.hh.

Referenced by UI_but_func_complete_set(), and ui_textedit_autocomplete().

◆ bit

short uiBut::bit = 0

Definition at line 186 of file interface_intern.hh.

Referenced by ui_apply_but_TOG(), ui_but_is_pushed_ex(), and ui_def_but().

◆ bitnr

short uiBut::bitnr = 0

Definition at line 186 of file interface_intern.hh.

Referenced by ui_apply_but_TOG(), ui_but_is_pushed_ex(), and ui_def_but().

◆ block

uiBlock* uiBut::block = nullptr

Definition at line 338 of file interface_intern.hh.

Referenced by button_activate_exit(), button_activate_init(), button_activate_state(), button_tooltip_timer_reset(), draw_emboss(), blender::ui::find_item_from_rename_button(), force_activate_view_item_but(), blender::ui::AbstractTreeViewItem::get_win_rect(), blender::ui::AbstractTreeViewItem::is_hovered(), menu_items_from_ui_create_item_from_button(), ui_apply_but_func(), ui_apply_but_TEX(), ui_apply_but_undo(), ui_block_func_POPOVER(), ui_block_func_POPUP(), ui_block_open_begin(), ui_block_open_end(), ui_but_activate_event(), ui_but_add_search(), ui_but_anim_decorate_find_attached_button(), ui_but_anim_expression_create(), ui_but_anim_expression_set(), ui_but_change_type(), ui_but_contains_point_px(), ui_but_contains_point_px_icon(), ui_but_convert_to_unit_alt_name(), ui_but_drag_init(), ui_but_drag_multi_edit_get(), ui_but_event_property_operator_string(), ui_but_execute_begin(), ui_but_execute_end(), ui_but_extra_operator_icon_apply(), ui_but_extra_operator_icon_mouse_over_get(), ui_but_find_select_in_enum(), ui_but_free(), UI_but_func_menu_search(), UI_but_func_search_set(), ui_but_get_fcurve(), ui_but_is_color_gamma(), ui_but_is_drag_toggle(), ui_but_is_unit(), ui_but_is_unit_radians(), ui_but_menu_step(), ui_but_next(), ui_but_next_non_separator(), ui_but_prev(), ui_but_rect_to_view(), ui_but_search_refresh(), ui_but_string_get_dynamic(), ui_but_string_get_ex(), ui_but_string_set(), ui_but_update_ex(), ui_but_update_from_old_block(), ui_but_update_view_for_active(), UI_butstore_clear(), ui_colorpicker_create_mode_cb(), ui_colorpicker_hex_rna_cb(), ui_colorpicker_hsv_update_cb(), ui_colorpicker_rgba_update_cb(), UI_context_active_but_prop_handle(), ui_def_but(), ui_def_but_icon(), ui_def_but_rna__menu(), ui_do_but_ANY_drag_toggle(), ui_do_but_BLOCK(), ui_do_but_BUT(), ui_do_but_COLOR(), ui_do_but_HSVCIRCLE(), ui_do_but_HSVCUBE(), ui_do_but_SCROLL(), ui_do_but_TOG(), ui_draw_but(), ui_draw_but_COLORBAND(), ui_draw_but_CURVE(), ui_draw_but_CURVEPROFILE(), ui_draw_but_HSVCIRCLE(), ui_draw_but_HSVCUBE(), ui_get_but_scale_unit(), ui_get_but_step_unit(), ui_get_but_string_unit(), ui_handle_button_event(), ui_handle_button_over(), ui_handle_button_return_submenu(), ui_handle_list_event(), ui_handle_menu_button(), UI_key_event_operator_string(), ui_layer_but_cb(), ui_layout_introspect_button(), ui_multibut_states_create(), ui_multibut_states_tag(), ui_number_from_string_units_with_but(), ui_numedit_apply_snapf(), ui_numedit_but_NUM(), ui_numedit_but_SLI(), ui_numedit_but_TRACKPREVIEW(), ui_numedit_set_active(), ui_popup_block_position(), ui_popup_block_refresh(), ui_popup_close_cb(), ui_popup_context_menu_for_button(), UI_popup_menu_close_from_but(), ui_popup_menu_create_impl(), ui_search_menu_create_context_menu(), ui_search_menu_create_tooltip(), ui_searchbox_create_generic_ex(), ui_searchbox_region_layout_fn(), ui_text_clip_middle(), ui_text_clip_middle_protect_right(), ui_textedit_begin(), ui_textedit_set_cursor_pos(), UI_tooltip_create_from_button_or_extra_icon(), ui_tooltip_data_from_button_or_extra_icon(), ui_tooltip_data_from_tool(), widget_draw_extra_mask(), widget_draw_icon(), widget_draw_node_link_socket(), widget_draw_submenu_tria(), widget_draw_text_icon(), widget_menu_pie_itembut(), and widget_swatch().

◆ block_create_func

uiBlockCreateFunc uiBut::block_create_func = nullptr

UI_BTYPE_BLOCK data

Definition at line 271 of file interface_intern.hh.

Referenced by ui_block_open_begin(), ui_but_equals_old(), uiDefBlockBut(), uiDefBlockButN(), and uiDefIconBlockBut().

◆ changed

bool uiBut::changed = false

could be made into a single flag

Definition at line 262 of file interface_intern.hh.

Referenced by ui_but_set_string_interactive(), ui_but_update_view_for_active(), ui_do_but_textedit(), ui_searchbox_update(), ui_searchbox_update_fn(), and ui_textedit_begin().

◆ col

uchar uiBut::col[4] = {0}

Optional color for monochrome icon. Also used as text color for labels without icons. Set with UI_but_color_set().

Definition at line 205 of file interface_intern.hh.

Referenced by UI_but_color_set(), UI_but_node_link_set(), ui_draw_but(), ui_draw_but_IMAGE(), uiDefButImage(), uiTemplateNodeSocket(), uiTemplateReportsBanner(), uiTemplateStatusInfo(), widget_box(), widget_draw_icon(), widget_draw_node_link_socket(), widget_draw_text_icon(), and widget_nodesocket().

◆ context

◆ custom_data

void* uiBut::custom_data = nullptr

Custom button data (borrowed, not owned).

Definition at line 326 of file interface_intern.hh.

Referenced by blender::ui::eyedropper_colorband_init(), uiLayout::list_box(), template_ID_tabs(), ui_apply_but_LISTROW(), ui_block_colorpicker(), ui_but_hsv_set(), ui_but_is_pushed_ex(), UI_but_node_link_set(), ui_but_string_get_ex(), ui_but_string_set(), ui_colorpicker_circle(), ui_colorpicker_hex_rna_cb(), ui_colorpicker_hsv_update_cb(), ui_colorpicker_rgba_update_cb(), ui_colorpicker_square(), UI_context_active_but_get_tab_ID(), ui_do_but_COLOR(), ui_do_but_EXIT(), ui_do_but_HSVCIRCLE(), ui_do_but_HSVCUBE(), ui_do_but_TAB(), ui_draw_but_HSVCIRCLE(), ui_draw_but_HSVCUBE(), ui_handle_list_event(), UI_key_event_operator_string(), UI_list_find_mouse_over(), ui_numedit_but_HSVCIRCLE(), ui_numedit_but_HSVCUBE(), ui_popup_close_cb(), uiTemplateColorPicker(), and widget_draw_node_link_socket().

◆ disabled_info

const char* uiBut::disabled_info = nullptr

info on why button is disabled, displayed in tooltip

Definition at line 254 of file interface_intern.hh.

Referenced by UI_but_disable(), ui_def_but(), and ui_tooltip_data_from_button_or_extra_icon().

◆ drag_preview_icon_id

BIFIconID uiBut::drag_preview_icon_id

Definition at line 303 of file interface_intern.hh.

Referenced by UI_but_drag_set_asset(), and ui_but_drag_start().

◆ dragflag

short uiBut::dragflag = 0

Definition at line 301 of file interface_intern.hh.

Referenced by ui_but_contains_point_px_icon(), ui_but_drag_free(), UI_but_drag_set_asset(), UI_but_drag_set_id(), UI_but_drag_set_name(), UI_but_drag_set_path(), UI_but_drag_set_rna(), ui_but_drag_start(), UI_but_dragflag_disable(), UI_but_dragflag_enable(), and ui_def_but().

◆ dragpoin

void* uiBut::dragpoin = nullptr

Definition at line 302 of file interface_intern.hh.

Referenced by ui_but_drag_free(), ui_but_drag_is_draggable(), UI_but_drag_set_asset(), UI_but_drag_set_id(), UI_but_drag_set_name(), UI_but_drag_set_path(), UI_but_drag_set_rna(), ui_but_drag_start(), and ui_but_update_old_active_from_new().

◆ dragtype

eWM_DragDataType uiBut::dragtype = WM_DRAG_ID

uiButExtraOpIcon

Definition at line 300 of file interface_intern.hh.

Referenced by ui_but_drag_free(), UI_but_drag_set_asset(), UI_but_drag_set_id(), UI_but_drag_set_name(), UI_but_drag_set_path(), UI_but_drag_set_rna(), ui_but_drag_start(), and ui_but_equals_old().

◆ drawflag

int uiBut::drawflag = 0

Definition at line 183 of file interface_intern.hh.

Referenced by block_align_stitch_neighbors(), create_title_button(), curvemap_buttons_layout(), draw_emboss(), uiLayout::prop(), template_texture_user_menu(), ui_block_align_but_to_region(), ui_block_align_calc(), ui_but_add_search(), ui_but_anim_flag(), ui_but_contains_point_px_icon(), UI_but_drawflag_disable(), UI_but_drawflag_enable(), UI_but_has_quick_tooltip(), ui_but_icon(), ui_but_is_pushed_ex(), ui_but_update_ex(), ui_but_update_old_active_from_new(), ui_def_but(), ui_def_but_icon(), ui_def_but_icon_clear(), ui_do_but_NUM(), ui_draw_but(), ui_item_layout(), ui_litem_layout_radial(), ui_numedit_set_active(), UI_pie_menu_begin(), ui_popup_block_position(), blender::ed::space_node::ui_template_node_link_menu(), ui_textedit_set_cursor_pos(), UI_tooltip_create_from_button_or_extra_icon(), uiDefIconBlockBut(), uiDefIconMenuBut(), uiDefIconPreviewBut(), uiDefIconTextBut(), uiDefIconTextButO_ptr(), uiDefIconTextButR(), uiDefIconTextButR_prop(), uiDefIconTextMenuBut(), uiDefSearchBut(), uiItemL_(), uiItemProgressIndicator(), uiItemsEnumR(), uiTemplateInputStatus(), widget_draw_extra_icons(), widget_draw_icon(), widget_draw_text(), widget_draw_text_icon(), widget_numslider(), widget_preview_tile(), widget_roundbox_set(), and widget_swatch().

◆ drawstr

std::string uiBut::drawstr

Definition at line 191 of file interface_intern.hh.

Referenced by menu_items_from_ui_create_item_from_button(), menu_items_to_ui_button(), ui_apply_but_undo(), ui_block_func_POPUP(), ui_but_build_drawstr_float(), ui_but_build_drawstr_int(), ui_but_drawstr_len_without_sep_char(), ui_but_drawstr_without_sep_char(), UI_but_func_search_set(), ui_but_icon_extra_is_visible_search_unlink(), ui_but_icon_extra_is_visible_text_clear(), ui_but_is_rna_valid(), ui_but_search_refresh(), ui_but_text_password_hide(), ui_but_update_ex(), ui_do_but_HOTKEYEVT(), ui_draw_but(), ui_item_menu_hold(), ui_item_with_label(), ui_layout_introspect_button(), ui_text_clip_middle(), ui_text_clip_middle_protect_right(), ui_text_clip_right_label(), ui_text_position_from_hidden(), ui_text_position_to_hidden(), ui_tooltip_data_from_button_or_extra_icon(), ui_tooltip_data_from_tool(), widget_draw_text(), widget_draw_text_icon(), widget_preview_tile(), and widget_progress_type_ring().

◆ editstr

◆ editval

double* uiBut::editval = nullptr

Definition at line 329 of file interface_intern.hh.

Referenced by ui_apply_but(), ui_block_open_end(), ui_but_value_get(), ui_but_value_set(), ui_numedit_begin(), and ui_numedit_end().

◆ editvec

float* uiBut::editvec = nullptr

Definition at line 330 of file interface_intern.hh.

Referenced by ui_apply_but(), ui_block_func_COLOR(), ui_block_open_begin(), ui_block_open_end(), ui_but_v3_get(), ui_but_v3_set(), ui_but_v4_get(), ui_but_v4_set(), ui_numedit_begin(), and ui_numedit_end().

◆ emboss

blender::ui::EmbossType uiBut::emboss = blender::ui::EmbossType::Emboss

Copied from the uiBlock.emboss

Definition at line 258 of file interface_intern.hh.

Referenced by asset_view_draw_item(), uiLayout::prop(), ui_but_draw_menu_icon(), ui_but_is_interactive_ex(), ui_def_but(), ui_def_but_rna(), ui_do_but_TEX(), ui_draw_but(), ui_layout_add_but(), ui_litem_layout_radial(), widget_draw_icon(), widget_draw_text_icon(), widget_icon_has_anim(), and widget_preview_tile().

◆ extra_op_icons

ListBase uiBut::extra_op_icons = {nullptr, nullptr}

Definition at line 298 of file interface_intern.hh.

Referenced by ui_but_extra_icon_find_old(), ui_but_extra_icons_update_from_old_but(), ui_but_extra_operator_icon_add_ptr(), ui_but_extra_operator_icon_mouse_over_get(), ui_but_extra_operator_icons_free(), ui_but_predefined_extra_operator_icons_add(), ui_but_update_old_active_from_new(), ui_do_but_extra_operator_icons_mousemove(), and widget_draw_extra_icons().

◆ flag

int uiBut::flag = 0

Definition at line 181 of file interface_intern.hh.

Referenced by blender::ui::bonedropper_poll(), button_activate_exit(), button_activate_init(), button_activate_state(), curvemap_buttons_layout(), datadropper_poll(), driverdropper_init(), drop_name_poll(), blender::ui::AbstractTreeViewItem::is_hovered(), uiLayout::list_box(), menu_items_from_ui_create_item_from_button(), template_common_search_menu(), template_ID(), ui_apply_but(), ui_apply_but_TEX(), ui_apply_but_undo(), ui_block_func_POPUP(), ui_block_interaction_begin(), ui_but_add_search(), ui_but_add_shortcut(), ui_but_anim_decorate_cb(), ui_but_anim_decorate_update_from_flag(), ui_but_anim_flag(), ui_but_context_poll_operator_ex(), ui_but_drag_multi_edit_get(), ui_but_draw_menu_icon(), ui_but_drawstr_len_without_sep_char(), ui_but_execute_end(), UI_but_flag_disable(), UI_but_flag_enable(), UI_but_flag_is_set(), ui_but_icon(), ui_but_icon_extra_get(), ui_but_icon_extra_is_visible_bone_eyedropper(), ui_but_icon_extra_is_visible_search_eyedropper(), ui_but_icon_extra_is_visible_search_unlink(), ui_but_icon_extra_is_visible_text_clear(), ui_but_is_interactive_ex(), UI_but_is_utf8(), ui_but_list_row_text_activate(), UI_but_node_link_set(), UI_but_operator_set(), ui_but_override_flag(), ui_but_paste(), ui_but_set_string_interactive(), UI_but_string_get_label(), ui_but_submenu_enable(), ui_but_update_ex(), ui_but_update_from_old_block(), ui_but_update_old_active_from_new(), ui_but_update_select_flag(), ui_button_press_invoke(), ui_can_activate_other_menu(), UI_context_active_but_prop_get_filebrowser(), ui_context_button_active(), UI_context_update_anim_flag(), ui_def_but(), ui_def_but_icon(), ui_def_but_icon_clear(), ui_def_but_rna(), ui_def_but_rna__menu(), ui_do_but_BUT(), ui_do_but_textedit(), ui_do_button(), ui_drag_toggle_but_is_supported(), ui_drag_toggle_set(), ui_draw_but(), ui_draw_but_HSV_v(), ui_draw_but_HSVCIRCLE(), ui_draw_but_HSVCUBE(), ui_handle_button_event(), ui_handle_menu_event(), ui_handle_viewlist_items_hover(), ui_item_enum_expand_tabs(), ui_item_flag(), ui_layout_has_panel_label(), ui_layout_list_set_labels_active(), ui_multibut_add(), ui_multibut_restore(), ui_multibut_states_apply(), ui_multibut_states_create(), ui_multibut_states_tag(), ui_numedit_set_active(), ui_popup_context_menu_for_button(), ui_popup_context_menu_for_panel(), ui_popup_menu_memory__internal(), ui_searchbox_select(), ui_selectcontext_begin(), ui_selectcontext_end(), ui_textedit_begin(), ui_textedit_end(), ui_textedit_next_but(), ui_textedit_prev_but(), ui_textedit_set_cursor_pos(), ui_tooltip_data_from_button_or_extra_icon(), uiItemDecoratorR_prop(), uiItemFullO_ptr_ex(), uiItemL_(), uiItemPopoverPanel_ptr(), uiItemsFullEnumO_items(), uiTemplateNodeLink(), uiTemplateTextureUser(), widget_draw_icon(), widget_draw_text(), and widget_draw_text_icon().

◆ flag2

int uiBut::flag2 = 0

Definition at line 182 of file interface_intern.hh.

Referenced by foreach_semi_modal_but_as_active(), UI_but_flag2_enable(), and ui_textedit_begin().

◆ func

uiButHandleFunc uiBut::func = nullptr

Definition at line 210 of file interface_intern.hh.

Referenced by ui_afterfunc_check(), ui_apply_but_func(), ui_but_equals_old(), UI_but_func_search_set(), UI_but_func_set(), UI_context_active_but_prop_handle(), ui_def_but(), and ui_selectcontext_apply().

◆ func_arg1

void* uiBut::func_arg1 = nullptr

Definition at line 211 of file interface_intern.hh.

Referenced by ui_apply_but_func(), ui_but_equals_old(), UI_but_func_set(), UI_context_active_but_prop_handle(), and ui_def_but().

◆ func_arg2

void* uiBut::func_arg2 = nullptr

Definition at line 212 of file interface_intern.hh.

Referenced by ui_apply_but_func(), ui_apply_but_TEX(), ui_but_equals_old(), UI_but_func_set(), UI_but_funcN_set(), UI_context_active_but_prop_handle(), and ui_def_but().

◆ func_argN

void* uiBut::func_argN = nullptr

Definition at line 220 of file interface_intern.hh.

Referenced by menu_item_enum_opname_menu(), ui_apply_but_func(), ui_block_open_begin(), ui_but_free(), UI_but_funcN_set(), UI_but_operatortype_get_from_enum_menu(), ui_but_rna_menu_convert_to_menu_type(), ui_but_rna_menu_convert_to_panel_type(), ui_but_update_old_active_from_new(), UI_context_active_but_prop_get_templateID(), ui_def_but(), ui_def_but_rna__menu_type(), ui_item_menu(), blender::ed::space_node::ui_template_node_link_menu(), uiDefBlockButN(), and uiTemplateNodeLink().

◆ func_argN_copy_fn

uiButArgNCopy uiBut::func_argN_copy_fn

Definition at line 222 of file interface_intern.hh.

Referenced by ui_apply_but_func(), UI_but_funcN_set(), ui_but_rna_menu_convert_to_menu_type(), ui_but_rna_menu_convert_to_panel_type(), ui_def_but(), ui_item_menu(), uiDefBlockButN(), and uiTemplateNodeLink().

◆ func_argN_free_fn

uiButArgNFree uiBut::func_argN_free_fn

Definition at line 221 of file interface_intern.hh.

Referenced by ui_apply_but_func(), ui_but_free(), UI_but_funcN_set(), ui_but_rna_menu_convert_to_menu_type(), ui_but_rna_menu_convert_to_panel_type(), ui_def_but(), ui_item_menu(), uiDefBlockButN(), and uiTemplateNodeLink().

◆ funcN

uiButHandleNFunc uiBut::funcN = nullptr

Definition at line 219 of file interface_intern.hh.

Referenced by ui_afterfunc_check(), ui_apply_but_func(), ui_but_equals_old(), UI_but_funcN_set(), UI_context_active_but_prop_get_templateID(), and ui_def_but().

◆ hardmax

◆ hardmin

float uiBut::hardmin = 0

Definition at line 199 of file interface_intern.hh.

Referenced by ui_apply_but_BUTM(), ui_but_event_property_operator_string(), ui_but_is_pushed_ex(), ui_but_range_set_hard(), ui_but_range_set_soft(), ui_but_string_set(), ui_but_update_ex(), and ui_def_but().

◆ hold_argN

void* uiBut::hold_argN = nullptr

Definition at line 242 of file interface_intern.hh.

Referenced by ui_but_free(), UI_but_func_hold_set(), and ui_item_menu_hold().

◆ hold_func

uiButHandleHoldFunc uiBut::hold_func = nullptr

Run an action when holding the button down.

Definition at line 241 of file interface_intern.hh.

Referenced by button_activate_state(), UI_but_func_hold_set(), ui_draw_but(), and ui_handle_button_event().

◆ icon

◆ icon_overlay_text

IconTextOverlay uiBut::icon_overlay_text = {}

Little indicator (e.g., counter) displayed on top of some icons.

Definition at line 335 of file interface_intern.hh.

Referenced by UI_but_icon_indicator_color_set(), UI_but_icon_indicator_number_set(), UI_but_icon_indicator_set(), uiTemplateStatusInfo(), and widget_draw_icon().

◆ iconadd

short uiBut::iconadd = 0

Definition at line 265 of file interface_intern.hh.

Referenced by ui_but_icon(), ui_but_update_ex(), ui_but_update_old_active_from_new(), and ui_drag_toggle_but_pushed_state().

◆ identity_cmp_func

uiButIdentityCompareFunc uiBut::identity_cmp_func = nullptr

See UI_but_func_identity_compare_set().

Definition at line 208 of file interface_intern.hh.

Referenced by ui_but_equals_old(), and UI_but_func_identity_compare_set().

◆ imb

const ImBuf* uiBut::imb = nullptr

Definition at line 304 of file interface_intern.hh.

Referenced by UI_but_drag_attach_image(), ui_but_drag_start(), and ui_but_update_old_active_from_new().

◆ imb_scale

float uiBut::imb_scale = 0

Definition at line 305 of file interface_intern.hh.

Referenced by UI_but_drag_attach_image(), and ui_but_drag_start().

◆ layout

uiLayout* uiBut::layout = nullptr

Pointer back to the layout item holding this button.

Definition at line 180 of file interface_intern.hh.

Referenced by UI_but_active_only_ex(), ui_but_change_type(), ui_layout_add_but(), and ui_layout_free().

◆ menu_create_func

uiMenuCreateFunc uiBut::menu_create_func = nullptr

UI_BTYPE_PULLDOWN / UI_BTYPE_MENU data

Definition at line 274 of file interface_intern.hh.

Referenced by ui_block_open_begin(), ui_but_event_property_operator_string(), ui_but_menu_draw_as_popover(), UI_but_menutype_get(), UI_but_operatortype_get_from_enum_menu(), UI_but_paneltype_get(), ui_but_rna_menu_convert_to_menu_type(), ui_but_rna_menu_convert_to_panel_type(), ui_def_but_rna(), ui_popup_context_menu_for_button(), uiDefIconMenuBut(), uiDefIconTextMenuBut(), and uiDefMenuBut().

◆ menu_key

uchar uiBut::menu_key = 0

When non-zero, this is the key used to activate a menu items (a-z always lower case).

Definition at line 296 of file interface_intern.hh.

Referenced by ui_pie_handler(), and widget_draw_text().

◆ menu_no_hover_open

bool uiBut::menu_no_hover_open = false

See UI_but_menu_disable_hover_open().

Definition at line 278 of file interface_intern.hh.

Referenced by UI_but_menu_disable_hover_open(), and ui_can_activate_other_menu().

◆ menu_step_func

uiMenuStepFunc uiBut::menu_step_func = nullptr

Definition at line 276 of file interface_intern.hh.

Referenced by UI_but_func_menu_step_set(), ui_but_menu_step(), ui_but_menu_step_poll(), and ui_but_supports_cycling().

◆ ofs

short uiBut::ofs = 0

Definition at line 187 of file interface_intern.hh.

Referenced by ui_text_clip_cursor(), ui_text_clip_give_next_off(), ui_text_clip_give_prev_off(), ui_text_clip_middle(), ui_text_clip_middle_protect_right(), ui_text_clip_right_label(), ui_textedit_delete_selection(), ui_textedit_set_cursor_pos(), widget_draw_text(), and widget_draw_text_icon().

◆ opcontext

wmOperatorCallContext uiBut::opcontext = WM_OP_INVOKE_DEFAULT

Definition at line 288 of file interface_intern.hh.

Referenced by but_shortcut_name_func(), menu_add_shortcut_cancel(), menu_change_shortcut(), menu_items_from_ui_create_item_from_button(), menu_items_to_ui_button(), remove_shortcut_func(), ui_apply_but_func(), ui_but_context_poll_operator(), ui_but_event_operator_string(), UI_but_operator_set(), ui_but_user_menu_add(), ui_but_user_menu_find(), ui_popup_context_menu_for_button(), ui_tooltip_data_from_button_or_extra_icon(), and uiDefSearchButO_ptr().

◆ operator_never_call

bool uiBut::operator_never_call = false

Keep an operator attached but never actually call it through the button. See UI_but_operator_set_never_call().

Definition at line 293 of file interface_intern.hh.

Referenced by ui_apply_but_func(), and UI_but_operator_set_never_call().

◆ opptr

◆ optype

wmOperatorType* uiBut::optype = nullptr

Definition at line 286 of file interface_intern.hh.

Referenced by blender::ed::asset::shelf::AssetViewItem::build_grid_tile(), button_matches_search_filter(), copy_python_command_button_exec(), copy_python_command_button_poll(), depthdropper_poll(), menu_items_from_ui_create_item_from_button(), menu_items_to_ui_button(), shortcut_get_operator_property(), ui_afterfunc_check(), ui_apply_but_func(), ui_but_copy(), ui_but_copy_operator(), ui_but_equals_old(), ui_but_event_operator_string(), ui_but_is_pushed_ex(), UI_but_is_tool(), ui_but_is_user_menu_compatible(), UI_but_online_manual_id(), UI_but_operator_ptr_ensure(), UI_but_operator_set(), UI_but_rna_enum_item_get(), UI_but_string_get_rna_label(), UI_but_string_get_rna_label_context(), UI_but_string_get_rna_struct_identifier(), UI_but_string_get_rna_tooltip(), ui_but_tip_from_enum_item(), ui_but_user_menu_add(), ui_but_user_menu_find(), ui_button_press_invoke(), ui_layout_introspect_button(), ui_popup_context_menu_for_button(), ui_searchbox_create_generic_ex(), ui_tooltip_data_from_button_or_extra_icon(), ui_tooltip_data_from_tool(), uiDefSearchButO_ptr(), and uiItemFullO_ptr_ex().

◆ pie_dir

RadialDirection uiBut::pie_dir = UI_RADIAL_NONE

direction in a pie menu, used for collision detection.

Definition at line 260 of file interface_intern.hh.

Referenced by ui_block_pie_dir_activate(), ui_but_contains_point_px(), ui_but_find_mouse_over_ex(), ui_but_find_rect_over(), ui_but_isect_pie_seg(), ui_but_pie_direction_string(), ui_litem_layout_radial(), and ui_pie_handler().

◆ placeholder

char* uiBut::placeholder = nullptr

Definition at line 193 of file interface_intern.hh.

Referenced by ui_but_free(), ui_but_placeholder_get(), and UI_but_placeholder_set().

◆ poin

char* uiBut::poin = nullptr

Definition at line 198 of file interface_intern.hh.

Referenced by blender::ui::eyedropper_colorband_init(), blender::ui::find_item_from_rename_button(), ui_apply_but_ROW(), ui_block_open_begin(), ui_but_change_type(), ui_but_copy(), ui_but_copy_colorband(), ui_but_copy_curvemapping(), ui_but_copy_CurveProfile(), ui_but_drag_init(), ui_but_equals_old(), ui_but_find_select_in_enum__cmp(), ui_but_free(), ui_but_is_float(), ui_but_menu_step(), UI_but_menutype_get(), UI_but_paneltype_get(), ui_but_paste(), ui_but_paste_colorband(), ui_but_paste_curvemapping(), ui_but_paste_CurveProfile(), ui_but_range_set_soft(), ui_but_rna_menu_convert_to_menu_type(), ui_but_string_get_ex(), ui_but_string_set(), ui_but_update_ex(), ui_but_update_old_active_from_new(), ui_but_v3_get(), ui_but_v3_set(), ui_but_v4_get(), ui_but_v4_set(), ui_but_value_get(), ui_but_value_set(), ui_def_but(), ui_def_but_rna(), ui_do_but_COLORBAND(), ui_do_but_CURVE(), ui_do_but_CURVEPROFILE(), ui_do_but_HISTOGRAM(), ui_do_but_WAVEFORM(), ui_do_button(), ui_drag_toggle_but_pushed_state(), ui_draw_but_COLORBAND(), ui_draw_but_CURVE(), ui_draw_but_CURVEPROFILE(), ui_draw_but_HISTOGRAM(), ui_draw_but_IMAGE(), ui_draw_but_TRACKPREVIEW(), ui_draw_but_VECTORSCOPE(), ui_draw_but_WAVEFORM(), ui_item_menu(), ui_numedit_begin(), ui_numedit_but_CURVE(), ui_numedit_but_CURVEPROFILE(), ui_numedit_but_HISTOGRAM(), ui_numedit_but_TRACKPREVIEW(), ui_numedit_but_WAVEFORM(), and uiTemplateNodeLink().

◆ pointype

eButPointerType uiBut::pointype = UI_BUT_POIN_NONE

Definition at line 185 of file interface_intern.hh.

Referenced by ui_but_drag_init(), ui_but_equals_old(), ui_but_is_compatible(), ui_but_is_float(), ui_but_range_set_soft(), ui_but_update_ex(), ui_but_v3_get(), ui_but_v3_set(), ui_but_v4_get(), ui_but_v4_set(), ui_but_validate(), ui_but_value_get(), ui_but_value_set(), ui_def_but(), and ui_do_button().

◆ pos

short uiBut::pos = 0

Definition at line 187 of file interface_intern.hh.

Referenced by ui_but_text_password_hide(), ui_def_but(), ui_do_but_textedit(), ui_text_clip_cursor(), ui_textedit_autocomplete(), ui_textedit_begin(), ui_textedit_delete(), ui_textedit_delete_selection(), ui_textedit_end(), ui_textedit_insert_buf(), ui_textedit_move(), ui_textedit_set_cursor_pos(), ui_textedit_set_cursor_select(), widget_draw_text(), and widget_draw_text_icon().

◆ pushed_state_func

std::function<bool(const uiBut &)> uiBut::pushed_state_func

Definition at line 332 of file interface_intern.hh.

Referenced by UI_but_func_pushed_state_set(), ui_but_is_pushed_ex(), and ui_but_update_old_active_from_new().

◆ rect

rctf uiBut::rect = {}

Block relative coordinates.

Definition at line 196 of file interface_intern.hh.

Referenced by button_activate_init(), button_activate_state(), blender::ui::AbstractTreeViewItem::get_win_rect(), ui_block_align_but_to_region(), ui_block_func_POPOVER(), ui_block_func_POPUP(), ui_but_can_align(), ui_but_contains_point_px_icon(), ui_but_contains_pt(), ui_but_contains_rect(), ui_but_drag_init(), ui_but_extra_operator_icon_mouse_over_get(), ui_but_is_row_alignment_group(), ui_but_rect_to_view(), ui_but_to_pixelrect(), ui_but_update_ex(), ui_but_update_old_active_from_new(), ui_can_activate_other_menu(), ui_def_but(), ui_do_but_COLORBAND(), ui_do_but_CURVE(), ui_do_but_CURVEPROFILE(), ui_do_but_GRIP(), ui_do_but_NUM(), ui_do_but_SCROLL(), ui_do_but_SLI(), ui_drag_toggle_set(), ui_drag_toggle_set_xy_xy(), ui_handler_region_menu(), ui_item_move(), ui_item_offset(), ui_item_position(), ui_item_size(), UI_key_event_operator_string(), ui_litem_layout_box(), ui_litem_layout_radial(), ui_menu_scroll_to_but(), ui_multibut_states_tag(), ui_numedit_but_COLORBAND(), ui_numedit_but_CURVE(), ui_numedit_but_CURVEPROFILE(), ui_numedit_but_HSVCIRCLE(), ui_numedit_but_HSVCUBE(), ui_numedit_but_SLI(), ui_numedit_but_UNITVEC(), ui_numedit_set_active(), ui_pie_handler(), ui_popup_block_position(), ui_search_menu_create_tooltip(), ui_searchbox_region_layout_fn(), ui_textedit_set_cursor_pos(), UI_tooltip_create_from_button_or_extra_icon(), and ViewLink::views_bounds_calc().

◆ rename_arg1

void* uiBut::rename_arg1 = nullptr

Definition at line 230 of file interface_intern.hh.

Referenced by ui_apply_but_func(), and UI_but_func_rename_set().

◆ rename_full_func

std::function<void(std::string &new_name)> uiBut::rename_full_func = nullptr

When defined, and the button edits a string RNA property, the new name is not set at all, instead this function is called with the new name.

Definition at line 237 of file interface_intern.hh.

Referenced by ui_afterfunc_check(), ui_apply_but_func(), UI_but_func_rename_full_set(), ui_but_string_set(), and ui_but_update_old_active_from_new().

◆ rename_full_new

std::string uiBut::rename_full_new

Definition at line 238 of file interface_intern.hh.

Referenced by ui_apply_but_func(), and ui_but_string_set().

◆ rename_func

uiButHandleRenameFunc uiBut::rename_func = nullptr

Definition at line 229 of file interface_intern.hh.

Referenced by ui_afterfunc_check(), ui_apply_but_func(), and UI_but_func_rename_set().

◆ rename_orig

void* uiBut::rename_orig = nullptr

Definition at line 231 of file interface_intern.hh.

Referenced by ui_apply_but_func(), and ui_apply_but_TEX().

◆ retval

◆ rnaindex

int uiBut::rnaindex = 0

Definition at line 283 of file interface_intern.hh.

Referenced by driverdropper_sample(), menu_items_from_ui_create_item_from_button(), menu_items_to_ui_button(), uiLayout::prop(), shortcut_property_from_rna(), ui_apply_but_autokey(), ui_but_anim_autokey(), ui_but_anim_decorate_cb(), ui_but_anim_expression_create(), ui_but_event_property_operator_string(), ui_but_get_fcurve(), ui_but_override_flag(), ui_but_range_set_soft(), ui_but_rna_equals_ex(), ui_but_set_float_array(), ui_but_user_menu_add(), ui_but_user_menu_find(), ui_but_value_get(), ui_but_value_set(), ui_button_value_default(), ui_def_but_rna(), ui_handle_menu_event(), ui_layout_introspect_button(), ui_popup_context_menu_for_button(), UI_region_active_but_prop_get(), ui_selectcontext_apply(), ui_selectcontext_begin(), ui_tooltip_data_from_button_or_extra_icon(), uiTemplateComponentMenu(), uiTemplateCryptoPicker(), and widget_swatch().

◆ rnapoin

PointerRNA uiBut::rnapoin = {}

Definition at line 281 of file interface_intern.hh.

Referenced by button_activate_exit(), button_matches_search_filter(), colorband_buttons_layout(), colorband_update_cb(), driverdropper_sample(), drop_color_invoke(), blender::ui::eyedropper_colorband_init(), eyedropper_get_property_button_under_mouse(), get_but_property_array_length(), handle_layer_buttons(), uiLayout::list_box(), menu_items_from_ui_create_item_from_button(), menu_items_to_ui_button(), uiLayout::prop(), shortcut_property_from_rna(), template_keymap_item_properties(), ui_apply_but_autokey(), ui_apply_but_func(), ui_apply_but_undo(), ui_block_colorpicker(), ui_block_message_subscribe(), ui_but_anim_autokey(), ui_but_anim_expression_create(), ui_but_anim_flag(), ui_but_color_has_alpha(), ui_but_copy(), ui_but_copy_color(), ui_but_copy_numeric_array(), ui_but_event_property_operator_string(), ui_but_find_select_in_enum__cmp(), ui_but_get_fcurve(), ui_but_has_array_value(), ui_but_icon_extra_is_visible_search_eyedropper(), ui_but_is_compatible(), ui_but_is_pushed_ex(), ui_but_is_rna_undo(), ui_but_is_rna_valid(), ui_but_is_user_menu_compatible(), UI_but_is_userdef(), ui_but_menu_step(), UI_but_online_manual_id(), ui_but_override_flag(), ui_but_paste(), ui_but_placeholder_get(), ui_but_range_set_hard(), ui_but_range_set_soft(), UI_but_rna_enum_item_get(), ui_but_rna_equals(), ui_but_rna_equals_ex(), ui_but_set_float_array(), ui_but_string_get_dynamic(), ui_but_string_get_ex(), UI_but_string_get_rna_struct_identifier(), ui_but_string_set(), ui_but_update_ex(), ui_but_update_preferences_dirty(), ui_but_user_menu_add(), ui_but_user_menu_find(), ui_but_v3_get(), ui_but_v3_set(), ui_but_v4_get(), ui_but_v4_set(), ui_but_value_get(), ui_but_value_set(), ui_button_value_default(), ui_colorpicker_hex_rna_cb(), ui_colorpicker_hsv_update_cb(), ui_colorpicker_rgba_update_cb(), UI_context_active_but_prop_get_filebrowser(), ui_def_but_rna(), ui_def_but_rna__menu(), ui_do_but_COLOR(), ui_do_but_HSVCIRCLE(), ui_do_but_HSVCUBE(), ui_drag_toggle_but_pushed_state(), ui_handle_list_event(), ui_handle_menu_event(), ui_item_enum_expand_handle(), ui_keymap_but_cb(), ui_layer_but_cb(), ui_layout_introspect_button(), ui_list_activate_row_from_index(), ui_palette_set_active(), ui_popup_context_menu_for_button(), UI_region_active_but_prop_get(), ui_selectcontext_apply(), ui_selectcontext_begin(), UI_textbutton_activate_rna(), ui_tooltip_data_from_button_or_extra_icon(), uiLayoutSetContextFromBut(), uiTemplateComponentMenu(), uiTemplateCryptoPicker(), and widget_swatch().

◆ rnaprop

PropertyRNA* uiBut::rnaprop = nullptr

Definition at line 282 of file interface_intern.hh.

Referenced by button_matches_search_filter(), colorband_buttons_layout(), driverdropper_sample(), drop_color_invoke(), blender::ui::eyedropper_colorband_init(), eyedropper_get_property_button_under_mouse(), get_but_property_array_length(), handle_layer_buttons(), uiLayout::list_box(), menu_items_from_ui_create_item_from_button(), menu_items_to_ui_button(), uiLayout::prop(), shortcut_get_operator_property(), shortcut_property_from_rna(), template_keymap_item_properties(), ui_afterfunc_check(), ui_apply_but_autokey(), ui_apply_but_func(), ui_apply_but_undo(), ui_block_colorpicker(), ui_block_message_subscribe(), ui_but_anim_autokey(), ui_but_anim_expression_create(), ui_but_anim_flag(), ui_but_build_drawstr_float(), ui_but_build_drawstr_int(), ui_but_color_has_alpha(), ui_but_contains_password(), ui_but_copy_color(), ui_but_copy_numeric_array(), ui_but_drag_init(), ui_but_event_property_operator_string(), ui_but_find_select_in_enum__cmp(), ui_but_get_fcurve(), ui_but_has_array_value(), ui_but_icon_extra_is_visible_bone_eyedropper(), ui_but_icon_extra_is_visible_search_eyedropper(), ui_but_is_bool(), ui_but_is_color_gamma(), ui_but_is_compatible(), ui_but_is_float(), ui_but_is_pushed_ex(), ui_but_is_rna_undo(), ui_but_is_rna_valid(), ui_but_is_user_menu_compatible(), UI_but_is_userdef(), UI_but_is_utf8(), ui_but_menu_step(), ui_but_menu_step_poll(), UI_but_online_manual_id(), ui_but_override_flag(), ui_but_paste_color(), ui_but_placeholder_get(), ui_but_range_set_hard(), ui_but_range_set_soft(), UI_but_rna_enum_item_get(), ui_but_rna_equals_ex(), ui_but_scale_type(), ui_but_search_refresh(), ui_but_set_float_array(), ui_but_string_eval_number(), ui_but_string_get_dynamic(), ui_but_string_get_ex(), UI_but_string_get_rna_label(), UI_but_string_get_rna_label_context(), UI_but_string_get_rna_property_identifier(), UI_but_string_get_rna_struct_identifier(), UI_but_string_get_rna_tooltip(), ui_but_string_set(), ui_but_text_password_hide(), UI_but_unit_type_get(), ui_but_update_ex(), ui_but_update_preferences_dirty(), ui_but_user_menu_add(), ui_but_user_menu_find(), ui_but_v3_get(), ui_but_v3_set(), ui_but_v4_get(), ui_but_v4_set(), ui_but_value_get(), ui_but_value_set(), ui_button_value_default(), ui_colorpicker_hex_rna_cb(), ui_colorpicker_hsv_update_cb(), ui_colorpicker_rgba_update_cb(), UI_context_active_but_prop_get_filebrowser(), ui_def_but_rna(), ui_def_but_rna__menu(), ui_do_but_COLOR(), ui_do_but_HSVCIRCLE(), ui_do_but_HSVCUBE(), ui_do_but_TAB(), ui_handle_button_event(), ui_handle_list_event(), ui_handle_menu_event(), ui_item_enum_expand_handle(), ui_layer_but_cb(), ui_layout_introspect_button(), ui_list_activate_row_from_index(), ui_multibut_states_create(), ui_popup_context_menu_for_button(), UI_region_active_but_prop_get(), ui_selectcontext_apply(), ui_selectcontext_begin(), UI_textbutton_activate_rna(), ui_tooltip_data_from_button_or_extra_icon(), uiItemFullR_with_menu(), uiItemFullR_with_popover(), uiLayoutSetContextFromBut(), uiTemplateComponentMenu(), uiTemplateCryptoPicker(), uiTemplateKeymapItemProperties(), widget_numslider(), and widget_swatch().

◆ search_weight

float uiBut::search_weight = 0.0f

Affects the order if this uiBut is used in menu-search.

Definition at line 268 of file interface_intern.hh.

Referenced by menu_items_from_ui_create_item_from_button(), and ui_layout_add_but().

◆ selend

short uiBut::selend = 0

Definition at line 187 of file interface_intern.hh.

Referenced by ui_but_text_password_hide(), ui_do_but_textedit(), ui_textedit_autocomplete(), ui_textedit_begin(), ui_textedit_copypaste(), ui_textedit_delete(), ui_textedit_delete_selection(), ui_textedit_insert_buf(), ui_textedit_move(), ui_textedit_set_cursor_select(), and widget_draw_text().

◆ selsta

short uiBut::selsta = 0

Definition at line 187 of file interface_intern.hh.

Referenced by ui_but_text_password_hide(), ui_do_but_textedit(), ui_textedit_autocomplete(), ui_textedit_begin(), ui_textedit_copypaste(), ui_textedit_delete(), ui_textedit_delete_selection(), ui_textedit_insert_buf(), ui_textedit_move(), ui_textedit_set_cursor_select(), and widget_draw_text().

◆ semi_modal_state

uiHandleButtonData* uiBut::semi_modal_state = nullptr

Event handling only supports one active button at a time, but there are cases where that's not enough. A common one is to keep some filter button active to receive text input, while other buttons remain active for interaction.

Buttons that have semi_modal_state set will be temporarily activated for event handling. If they don't consume the event (for example text input events) the event will be forwarded to other buttons.

Currently only text buttons support this well.

Definition at line 323 of file interface_intern.hh.

Referenced by button_activate_exit(), button_activate_init(), foreach_semi_modal_but_as_active(), ui_but_extra_icons_update_from_old_but(), ui_but_free(), ui_but_semi_modal_state_free(), ui_but_update_from_old_block(), ui_but_update_old_active_from_new(), and with_but_active_as_semi_modal().

◆ softmax

float uiBut::softmax = 0

Definition at line 199 of file interface_intern.hh.

Referenced by ui_but_range_set_soft(), ui_but_update_ex(), ui_def_but(), ui_do_but_NUM(), ui_do_but_SLI(), ui_draw_but_HSV_v(), ui_hsvcube_pos_from_vals(), ui_multibut_states_apply(), ui_numedit_begin(), ui_numedit_but_HSVCUBE(), ui_numedit_but_NUM(), ui_numedit_but_SLI(), widget_numslider(), and widget_scroll().

◆ softmin

float uiBut::softmin = 0

Definition at line 199 of file interface_intern.hh.

Referenced by ui_but_range_set_soft(), ui_but_update_ex(), ui_def_but(), ui_do_but_NUM(), ui_do_but_SLI(), ui_draw_but_HSV_v(), ui_hsvcube_pos_from_vals(), ui_multibut_states_apply(), ui_numedit_begin(), ui_numedit_but_HSVCUBE(), ui_numedit_but_NUM(), ui_numedit_but_SLI(), widget_numslider(), and widget_scroll().

◆ str

◆ strwidth

short uiBut::strwidth = 0

Definition at line 186 of file interface_intern.hh.

Referenced by ui_text_clip_cursor(), ui_text_clip_middle(), ui_text_clip_middle_protect_right(), ui_text_clip_right_label(), and widget_draw_text_icon().

◆ tip

blender::StringRef uiBut::tip

Definition at line 244 of file interface_intern.hh.

Referenced by uiLayout::list_box(), ui_apply_but_undo(), ui_but_is_interactive_ex(), UI_but_string_get_tooltip(), ui_but_tip_from_enum_item(), ui_but_tip_len_only_first_line(), ui_def_but(), and ui_layout_introspect_button().

◆ tip_arg

void* uiBut::tip_arg = nullptr

Definition at line 246 of file interface_intern.hh.

Referenced by ui_but_free(), UI_but_func_tooltip_custom_set(), UI_but_func_tooltip_set(), UI_but_string_get_tooltip(), ui_but_update_old_active_from_new(), and ui_tooltip_data_from_custom_func().

◆ tip_arg_free

uiFreeArgFunc uiBut::tip_arg_free = nullptr

Definition at line 247 of file interface_intern.hh.

Referenced by ui_but_free(), UI_but_func_tooltip_custom_set(), UI_but_func_tooltip_set(), and ui_but_update_old_active_from_new().

◆ tip_custom_func

uiButToolTipCustomFunc uiBut::tip_custom_func = nullptr

Definition at line 251 of file interface_intern.hh.

Referenced by UI_but_func_tooltip_custom_set(), ui_but_update_old_active_from_new(), UI_tooltip_create_from_button_or_extra_icon(), and ui_tooltip_data_from_custom_func().

◆ tip_func

uiButToolTipFunc uiBut::tip_func = nullptr

Definition at line 245 of file interface_intern.hh.

Referenced by UI_but_func_tooltip_set(), ui_but_is_interactive_ex(), UI_but_string_get_tooltip(), ui_but_update_old_active_from_new(), and ui_tooltip_data_from_button_or_extra_icon().

◆ tip_quick_func

std::function<std::string(const uiBut *)> uiBut::tip_quick_func

Function to override the label to be displayed in the tooltip.

Definition at line 249 of file interface_intern.hh.

Referenced by UI_but_func_quick_tooltip_set(), UI_but_string_get_tooltip_label(), ui_but_update_old_active_from_new(), and ui_but_user_menu_add().

◆ type

eButType uiBut::type = eButType(0)

Definition at line 184 of file interface_intern.hh.

Referenced by blender::ui::bonedropper_init(), blender::ui::bonedropper_poll(), button_activate_exit(), button_activate_init(), button_activate_state(), button_matches_search_filter(), datadropper_poll(), depthdropper_poll(), depthdropper_test(), draw_emboss(), drop_color_invoke(), blender::ui::eyedropper_colorband_init(), blender::ui::eyedropper_colorband_poll(), blender::ui::find_item_from_rename_button(), jump_to_target_button(), uiLayout::prop(), ui_apply_but(), ui_apply_but_BLOCK(), ui_apply_but_func(), ui_apply_but_TEX(), ui_apply_but_TOG(), ui_apply_but_undo(), UI_block_can_add_separator(), UI_block_is_empty_ex(), ui_block_open_begin(), ui_block_pie_dir_activate(), UI_but_active_drop_color(), UI_but_active_drop_name_button(), ui_but_add_search(), ui_but_can_align(), ui_but_change_type(), UI_but_context_menu_title_from_button(), ui_but_copy(), ui_but_drag_init(), ui_but_equals_old(), ui_but_event_property_operator_string(), ui_but_find_select_in_enum__cmp(), ui_but_free(), ui_but_free_type_specific(), UI_but_func_search_set(), UI_but_func_search_set_context_menu(), UI_but_func_search_set_listen(), UI_but_func_search_set_results_are_suggestions(), UI_but_func_search_set_sep_string(), UI_but_func_search_set_tooltip(), ui_but_get_float_precision(), ui_but_get_float_step_size(), ui_but_icon_extra_get(), ui_but_icon_extra_is_visible_bone_eyedropper(), ui_but_icon_extra_is_visible_search_eyedropper(), ui_but_icon_extra_is_visible_search_unlink(), ui_but_icon_extra_is_visible_text_clear(), ui_but_is_active_view_item(), ui_but_is_bool(), ui_but_is_compatible(), ui_but_is_cursor_warp(), ui_but_is_editable(), ui_but_is_editable_as_text(), ui_but_is_interactive_ex(), ui_but_is_listbox_with_row(), ui_but_is_listrow(), ui_but_is_popover_once_compat(), ui_but_is_pushed_ex(), ui_but_is_toggle(), ui_but_is_view_item_fn(), UI_but_label_alpha_factor_set(), ui_but_list_row_text_activate(), ui_but_menu_step_poll(), ui_but_next_non_separator(), UI_but_number_precision_set(), UI_but_number_slider_precision_set(), UI_but_number_slider_step_size_set(), UI_but_number_step_size_set(), ui_but_paste(), ui_but_pie_menu_apply(), ui_but_pie_menu_supported_apply(), ui_but_placeholder_get(), UI_but_rna_enum_item_get(), ui_but_rna_menu_convert_to_menu_type(), ui_but_rna_menu_convert_to_panel_type(), UI_but_search_preview_grid_size_set(), ui_but_set_float_array(), ui_but_set_string_interactive(), ui_but_string_get_dynamic(), ui_but_string_get_ex(), ui_but_string_get_maxncpy(), UI_but_string_get_rna_label(), UI_but_string_get_rna_label_context(), UI_but_string_get_rna_struct_identifier(), UI_but_string_get_rna_tooltip(), ui_but_string_set(), ui_but_supports_cycling(), UI_but_type_set_menu_from_pulldown(), ui_but_update_ex(), ui_but_update_from_old_block(), ui_but_update_old_active_from_new(), ui_but_v3_get(), ui_but_validate(), UI_but_view_item_draw_size_set(), ui_can_activate_other_menu(), UI_context_active_but_get_tab_ID(), ui_def_but(), ui_def_but_rna(), ui_def_but_rna__menu(), ui_do_but_COLOR(), ui_do_but_HOTKEYEVT(), ui_do_but_NUM(), ui_do_but_SLI(), ui_do_but_textedit(), ui_do_but_TOG(), ui_do_but_VIEW_ITEM(), ui_do_button(), ui_draw_but(), ui_handle_button_activate_by_type(), ui_handle_button_event(), ui_handle_button_return_submenu(), ui_handle_menu_button(), ui_handle_menu_event(), ui_handle_menus_recursive(), ui_handle_view_item_event(), ui_handle_viewlist_items_hover(), ui_handler_panel_region(), ui_item_array(), ui_item_is_radial_drawable(), ui_item_with_label(), UI_key_event_operator_string(), ui_keymap_but_cb(), ui_layout_introspect_button(), ui_list_contains_row(), ui_list_find_mouse_over_ex(), ui_list_row_find_index(), ui_litem_layout_radial(), ui_numedit_begin(), ui_numedit_but_SLI(), ui_numedit_end(), ui_popup_block_position(), ui_popup_context_menu_for_button(), ui_popup_menu_create_impl(), ui_searchbox_apply(), ui_searchbox_autocomplete(), ui_searchbox_event(), ui_searchbox_update(), ui_text_clip_middle(), ui_text_clip_middle_protect_right(), UI_textbutton_activate_but(), UI_textbutton_activate_rna(), ui_textedit_begin(), ui_textedit_end(), ui_textedit_next_but(), ui_textedit_prev_but(), ui_textedit_set_cursor_pos(), UI_tooltip_create_from_button_or_extra_icon(), ui_tooltip_data_from_button_or_extra_icon(), ui_view_item_find_search_highlight(), uiItemFullR_with_menu(), uiItemFullR_with_popover(), uiItemPopoverPanel_ptr(), uiLayoutSetTooltipFunc(), uiTemplateLayers(), widget_draw_icon(), widget_draw_text(), widget_draw_text_icon(), widget_icon_has_anim(), widget_list_itembut(), widget_roundbox_set(), and widget_swatch().

◆ unit_type

uchar uiBut::unit_type = 0

so buttons can support unit systems which are not RNA

Definition at line 264 of file interface_intern.hh.

Referenced by UI_but_unit_type_get(), UI_but_unit_type_set(), and ui_multibut_states_create().

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

interface_intern.hh

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ uiBut() [1/2]

◆ uiBut() [2/2]

◆ ~uiBut()

Member Function Documentation

◆ operator=()

Member Data Documentation

◆ active

◆ alignnr

◆ apply_func

◆ autocomplete_func

◆ autofunc_arg

◆ bit

◆ bitnr

◆ block

◆ block_create_func

◆ changed

◆ col

◆ context

◆ custom_data

◆ disabled_info

◆ drag_preview_icon_id

◆ dragflag

◆ dragpoin

◆ dragtype

◆ drawflag

◆ drawstr

◆ editstr

◆ editval

◆ editvec

◆ emboss

◆ extra_op_icons

◆ flag

◆ flag2

◆ func

◆ func_arg1

◆ func_arg2

◆ func_argN

◆ func_argN_copy_fn

◆ func_argN_free_fn

◆ funcN

◆ hardmax

◆ hardmin

◆ hold_argN

◆ hold_func

◆ icon

◆ icon_overlay_text

◆ iconadd

◆ identity_cmp_func

◆ imb

◆ imb_scale

◆ layout

◆ menu_create_func

◆ menu_key

◆ menu_no_hover_open

◆ menu_step_func

◆ ofs

◆ opcontext

◆ operator_never_call

◆ opptr

◆ optype

◆ pie_dir

◆ placeholder

◆ poin

◆ pointype

◆ pos

◆ pushed_state_func

◆ rect

◆ rename_arg1

◆ rename_full_func

◆ rename_full_new

◆ rename_func

◆ rename_orig

◆ retval

◆ rnaindex

◆ rnapoin

◆ rnaprop