Blender V5.3
interface.cc File Reference
#include <algorithm>
#include <cctype>
#include <cfloat>
#include <climits>
#include <cmath>
#include <cstddef>
#include <cstring>
#include <fmt/format.h>
#include "MEM_guardedalloc.h"
#include "DNA_listBase.h"
#include "DNA_object_types.h"
#include "DNA_scene_types.h"
#include "DNA_screen_types.h"
#include "DNA_userdef_types.h"
#include "BLI_listbase.hh"
#include "BLI_rect.hh"
#include "BLI_set.hh"
#include "BLI_string.hh"
#include "BLI_string_utf8.hh"
#include "BLI_vector.hh"
#include "BLI_utildefines.hh"
#include "BKE_animsys.hh"
#include "BKE_context.hh"
#include "BKE_idprop.hh"
#include "BKE_report.hh"
#include "BKE_scene.hh"
#include "BKE_screen.hh"
#include "BKE_unit.hh"
#include "GPU_matrix.hh"
#include "GPU_state.hh"
#include "BLF_api.hh"
#include "BLT_translation.hh"
#include "UI_abstract_view.hh"
#include "UI_interface.hh"
#include "UI_interface_icons.hh"
#include "UI_interface_layout.hh"
#include "UI_string_search.hh"
#include "UI_view2d.hh"
#include "IMB_imbuf.hh"
#include "WM_api.hh"
#include "WM_message.hh"
#include "WM_types.hh"
#include "RNA_access.hh"
#include "RNA_enum_types.hh"
#include "ED_numinput.hh"
#include "ED_screen.hh"
#include "IMB_colormanagement.hh"
#include "CLG_log.h"
#include "buttons/interface_label.hh"
#include "buttons/interface_label_markdown.hh"
#include "interface_intern.hh"

Go to the source code of this file.

Classes

struct  blender::ui::AutoComplete

Namespaces

namespace  blender
 BMesh Iterators.
namespace  blender::ui

Macros

#define BUT_VALUE_UNSET   DBL_MAX
#define UI_GET_BUT_VALUE_INIT(_but, _value)
#define B_NOP   -1

Functions

static bool blender::ui::but_is_unit_radians_ex (const UnitSettings *unit, const int unit_type)
static bool blender::ui::but_is_unit_radians (const Button *but)
Button Definition
static void blender::ui::def_but_rna__menu (bContext *C, Layout *layout, void *but_p)
static void blender::ui::def_but_rna__panel_type (bContext *, Layout *layout, void *arg)
static void blender::ui::def_but_rna__menu_type (bContext *, Layout *layout, void *but_p)
static std::unique_ptr< Button > blender::ui::but_new (const ButtonType type)
static Button * blender::ui::def_but (Block *block, ButtonTypeWithPointerType but_and_ptr_type, const StringRef str, int x, int y, short width, short height, void *poin, float min, float max, const std::optional< StringRef > tip)
void blender::ui::def_but_icon (Button *but, const int icon, const int64_t flag)
void blender::ui::def_but_icon_clear (Button *but)
void blender::ui::button_rna_menu_convert_to_panel_type (Button *but, const char *panel_type)
bool blender::ui::button_menu_draw_as_popover (const Button *but)
void blender::ui::button_rna_menu_convert_to_menu_type (Button *but, const char *menu_type)
static void blender::ui::but_submenu_enable (Block *block, Button *but)
static Button * blender::ui::def_but_rna (Block *block, ButtonType type, std::optional< StringRef > str, int x, int y, short width, short height, PointerRNA *ptr, PropertyRNA *prop, int index, float min, float max, std::optional< StringRef > tip)
static Button * blender::ui::def_but_rna_propname (Block *block, ButtonType type, std::optional< StringRef > str, int x, int y, short width, short height, PointerRNA *ptr, const StringRefNull propname, int index, float min, float max, const std::optional< StringRef > tip)
static Button * blender::ui::def_but_operator_ptr (Block *block, ButtonType type, wmOperatorType *ot, wm::OpCallContext opcontext, const StringRef str, int x, int y, short width, short height, std::optional< StringRef > tip)
Button & Block Free
static void blender::ui::but_free (const bContext *C, Button *but)
static void blender::ui::but_free_type_specific (Button *but)
static void blender::ui::block_free_active_operator (Block *block)
void blender::ui::block_set_active_operator (Block *block, wmOperator *op, const bool free)
void blender::ui::block_free (const bContext *C, Block *block)
Window Matrix
void blender::ui::block_to_region_fl (const ARegion *region, const Block *block, float *x, float *y)
void blender::ui::block_to_window_fl (const ARegion *region, const Block *block, float *x, float *y)
void blender::ui::block_to_window (const ARegion *region, const Block *block, int *x, int *y)
void blender::ui::block_to_region_rctf (const ARegion *region, const Block *block, rctf *rct_dst, const rctf *rct_src)
void blender::ui::block_to_window_rctf (const ARegion *region, const Block *block, rctf *rct_dst, const rctf *rct_src)
float blender::ui::block_to_window_scale (const ARegion *region, const Block *block)
void blender::ui::window_to_block_fl (const ARegion *region, const Block *block, float *x, float *y)
void blender::ui::window_to_block_rctf (const ARegion *region, const Block *block, rctf *rct_dst, const rctf *rct_src)
void blender::ui::window_to_block (const ARegion *region, const Block *block, int *x, int *y)
void blender::ui::window_to_region (const ARegion *region, int *x, int *y)
void blender::ui::window_to_region_rcti (const ARegion *region, rcti *rect_dst, const rcti *rct_src)
void blender::ui::window_to_region_rctf (const ARegion *region, rctf *rect_dst, const rctf *rct_src)
void blender::ui::region_to_window (const ARegion *region, int *x, int *y)
void blender::ui::region_to_window (const ARegion *region, int region_x, int region_y, int *r_window_x, int *r_window_y)
static void blender::ui::update_flexible_spacing (const ARegion *region, Block *block)
static void blender::ui::update_window_matrix (const wmWindow *window, const ARegion *region, Block *block)
void blender::ui::region_winrct_get_no_margin (const ARegion *region, rcti *r_rect)
Block Calculation
void blender::ui::block_translate (Block *block, float x, float y)
static bool blender::ui::but_is_row_alignment_group (const Button *left, const Button *right)
static void blender::ui::block_bounds_calc_text (Block *block, float offset)
void blender::ui::block_bounds_calc (Block *block)
static void blender::ui::block_bounds_calc_centered (wmWindow *window, Block *block)
static void blender::ui::block_bounds_calc_post_centered (Block *block)
static void blender::ui::block_bounds_calc_centered_pie (Block *block)
static void blender::ui::block_bounds_calc_popup (wmWindow *window, Block *block, BlockBoundsCalc bounds_calc, const int xy[2], int r_xy[2])
void blender::ui::block_bounds_set_normal (Block *block, int addval)
void blender::ui::block_bounds_set_text (Block *block, int addval)
void blender::ui::block_bounds_set_popup (Block *block, int addval, const int bounds_offset[2])
void blender::ui::block_bounds_set_menu (Block *block, int addval, const int bounds_offset[2])
void blender::ui::block_bounds_set_centered (Block *block, int addval)
void blender::ui::block_bounds_set_explicit (Block *block, int minx, int miny, int maxx, int maxy)
Button Float Precision
static float blender::ui::but_get_float_precision (Button *but)
static float blender::ui::but_get_float_step_size (Button *but)
static bool blender::ui::but_hide_fraction (Button *but, double value)
static int blender::ui::but_calc_float_precision (Button *but, double value)
Button Matching from Old Block
bool blender::ui::button_rna_equals (const Button *a, const Button *b)
bool blender::ui::button_rna_equals_ex (const Button *but, const PointerRNA *ptr, const PropertyRNA *prop, int index)
static bool blender::ui::but_equals_old (const Button *but, const Button *oldbut)
static Button * blender::ui::but_find_old (Block *block_old, const Button *but_new, const Set< const Button * > &ignore_old_buttons)
Button * blender::ui::button_find_old (Block *block_old, const Button *but_new)
static std::optional< int64_t > blender::ui::but_find_old_idx (Block *block_old, const Button *but_new, const Set< const Button * > &ignore_old_buttons={})
Button * blender::ui::button_find_new (Block *block_new, const Button *but_old)
static bool blender::ui::but_extra_icons_equals_old (const ButtonExtraOpIcon *new_extra_icon, const ButtonExtraOpIcon *old_extra_icon)
static ButtonExtraOpIcon * blender::ui::but_extra_icon_find_old (const ButtonExtraOpIcon *new_extra_icon, const Button *old_but)
static void blender::ui::but_extra_icons_update_from_old_but (const Button *new_but, const Button *old_but)
static void blender::ui::but_update_old_active_from_new (Button *oldbut, Button *but)
static bool blender::ui::but_update_from_old_block (Block *block, Set< const Button * > &matched_old_buttons, std::unique_ptr< Button > *but_uptr, std::optional< int64_t > *but_old_idx)
Button Activation & Execution
bool blender::ui::button_active_only_ex (const bContext *C, ARegion *region, Block *block, Button *but, bool remove_on_failure)
bool blender::ui::button_active_only (const bContext *C, ARegion *region, Block *block, Button *but)
bool blender::ui::block_active_only_flagged_buttons (const bContext *C, ARegion *region, Block *block)
void blender::ui::button_execute (const bContext *C, ARegion *region, Button *but)
static bool blender::ui::but_is_rna_undo (const Button *but)
Menu Key Accelerators
static void blender::ui::menu_block_set_keyaccels (Block *block)
void blender::ui::button_add_shortcut (Button *but, const char *shortcut_str, const bool do_strip)
Find Key Shortcut for Button
static std::optional< std::string > blender::ui::but_event_operator_string_from_operator (const bContext *C, wmOperatorCallParams *op_call_params)
static std::optional< std::string > blender::ui::but_event_operator_string_from_menu (const bContext *C, Button *but)
static std::optional< std::string > blender::ui::but_event_operator_string_from_panel (const bContext *C, Button *but)
static std::optional< std::string > blender::ui::but_event_operator_string (const bContext *C, Button *but)
static std::optional< std::string > blender::ui::but_extra_icon_event_operator_string (const bContext *C, const ButtonExtraOpIcon *extra_icon)
static std::optional< std::string > blender::ui::but_event_property_operator_string (const bContext *C, Button *but)
Menu Block Shortcuts
static void blender::ui::menu_block_set_keymaps (const bContext *C, Block *block)
Button Library Override Flag
void blender::ui::button_override_flag (Main *bmain, Button *but)
Block Ending
void blender::ui::block_update_from_old (const bContext *C, Block *block)
static void blender::ui::button_validate (const Button *but)
bool blender::ui::button_context_poll_operator_ex (bContext *C, const Button *but, const wmOperatorCallParams *optype_params)
bool blender::ui::button_context_poll_operator (bContext *C, wmOperatorType *ot, const Button *but)
void blender::ui::block_post_layout_callbacks_exec (const bContext *C, ARegion *region, Block *block)
void blender::ui::block_end_ex (const bContext *C, Main *bmain, wmWindow *window, Scene *scene, ARegion *region, Depsgraph *depsgraph, Block *block, const int xy[2]=nullptr, int r_xy[2]=nullptr, bool postpone_callbacks=false)
void blender::ui::block_end (const bContext *C, Block *block, bool postpone_callbacks=false)
Block Drawing
void blender::ui::fontscale (float *points, float aspect)
void blender::ui::button_to_pixelrect (rcti *rect, const ARegion *region, const Block *block, const Button *but)
rcti blender::ui::rect_to_pixelrect (const ARegion *region, const Block *block, const rctf *src_rect)
static bool blender::ui::but_pixelrect_in_view (const ARegion *region, const rcti *rect)
void blender::ui::block_draw (const bContext *C, Block *block)
Message Bus Subscription
static void blender::ui::block_message_subscribe (ARegion *region, wmMsgBus *mbus, Block *block)
void blender::ui::region_message_subscribe (ARegion *region, wmMsgBus *mbus)
Button Pushed State
int blender::ui::button_is_pushed_ex (Button *but, double *value)
int blender::ui::button_is_pushed (Button *but)
static void blender::ui::but_update_select_flag (Button *but, double *value)
Block Lock
void blender::ui::block_lock_set (Block *block, bool val, const char *lockstr)
void blender::ui::block_lock_clear (Block *block)
Block List
void blender::ui::block_listen (const Block *block, const wmRegionListenerParams *listener_params)
void blender::ui::blocklist_update_window_matrix (const bContext *C, const ListBaseT< Block > *lb)
void blender::ui::blocklist_update_view_for_buttons (const bContext *C, const ListBaseT< Block > *lb)
void blender::ui::blocklist_draw (const bContext *C, const ListBaseT< Block > *lb)
void blender::ui::blocklist_free (const bContext *C, ARegion *region)
void blender::ui::blocklist_free_inactive (const bContext *C, ARegion *region)
Block Begin
void blender::ui::block_region_set (Block *block, ARegion *region)
Block * blender::ui::block_begin (const bContext *C, Scene *scene, wmWindow *window, ARegion *region, std::string name, EmbossType emboss)
Block * blender::ui::block_begin (const bContext *C, ARegion *region, std::string name, EmbossType emboss)
void blender::ui::block_add_dynamic_listener (Block *block, void(*listener_func)(const wmRegionListenerParams *params))
EmbossType blender::ui::block_emboss_get (Block *block)
void blender::ui::block_emboss_set (Block *block, EmbossType emboss)
void blender::ui::block_theme_style_set (Block *block, char theme_style)
bool blender::ui::block_is_search_only (const Block *block)
void blender::ui::block_set_search_only (Block *block, bool search_only)
Button Update
static void blender::ui::but_build_drawstr_float (Button *but, double value)
static void blender::ui::but_build_drawstr_int (Button *but, int value)
static void blender::ui::but_update_ex (Button *but, const bool validate)
void blender::ui::button_update (Button *but)
void blender::ui::button_update_edited (Button *but)
void blender::ui::block_align_begin (Block *block)
void blender::ui::block_align_end (Block *block)
const ColorManagedDisplay * blender::ui::block_cm_display_get (Block *block)
void blender::ui::block_cm_to_display_space_v3 (Block *block, float pixel[3])
Button Definition Wrappers
Button * blender::ui::uiDefBut (Block *block, ButtonTypeWithPointerType but_and_ptr_type, StringRef str, int x, int y, short width, short height, void *poin, float min, float max, std::optional< StringRef > tip)
Button * blender::ui::uiDefButImage (Block *block, void *imbuf, int x, int y, short width, short height, const uchar color[4])
Button * blender::ui::uiDefButAlert (Block *block, AlertIcon icon, int x, int y, short width, short height)
void blender::ui::button_enum_prop_value_set (Button *but, int retval)
void blender::ui::button_retval_set (Button *but, int retval)
Auto-Complete
AutoComplete * blender::ui::autocomplete_begin (const char *startname, size_t maxncpy)
void blender::ui::autocomplete_update_name (AutoComplete *autocpl, StringRef name)
int blender::ui::autocomplete_end (AutoComplete *autocpl, char *autoname)
RNA & Operator Button Wrappers
static void blender::ui::but_update_and_icon_set (Button *but, int icon)
Button * blender::ui::uiDefButR (Block *block, ButtonType type, std::optional< StringRef > str, int x, int y, short width, short height, PointerRNA *ptr, StringRefNull propname, int index, float min, float max, std::optional< StringRef > tip)
Button * blender::ui::uiDefButR_prop (Block *block, ButtonType type, std::optional< StringRef > str, int x, int y, short width, short height, PointerRNA *ptr, PropertyRNA *prop, int index, float min, float max, std::optional< StringRef > tip)
Button * blender::ui::uiDefButO_ptr (Block *block, ButtonType type, wmOperatorType *ot, wm::OpCallContext opcontext, StringRef str, int x, int y, short width, short height, std::optional< StringRef > tip)
Button * blender::ui::uiDefButO (Block *block, ButtonType type, StringRefNull opname, wm::OpCallContext opcontext, const std::optional< StringRef > str, int x, int y, short width, short height, std::optional< StringRef > tip)
Button * blender::ui::uiDefIconBut (Block *block, ButtonTypeWithPointerType but_and_ptr_type, int icon, int x, int y, short width, short height, void *poin, float min, float max, std::optional< StringRef > tip)
Button * blender::ui::uiDefIconPreviewBut (Block *block, ButtonType type, int icon, int x, int y, short width, short height, void *poin, float min, float max, std::optional< StringRef > tip)
Button * blender::ui::uiDefIconButR (Block *block, ButtonType type, int icon, int x, int y, short width, short height, PointerRNA *ptr, StringRefNull propname, int index, float min, float max, std::optional< StringRef > tip)
Button * blender::ui::uiDefIconButR_prop (Block *block, ButtonType type, int icon, int x, int y, short width, short height, PointerRNA *ptr, PropertyRNA *prop, int index, float min, float max, std::optional< StringRef > tip)
Button * blender::ui::uiDefIconButO_ptr (Block *block, ButtonType type, wmOperatorType *ot, wm::OpCallContext opcontext, int icon, int x, int y, short width, short height, std::optional< StringRef > tip)
Button * blender::ui::uiDefIconButO (Block *block, ButtonType type, StringRefNull opname, wm::OpCallContext opcontext, int icon, int x, int y, short width, short height, std::optional< StringRef > tip)
Button * blender::ui::uiDefIconTextBut (Block *block, ButtonTypeWithPointerType but_and_ptr_type, int icon, StringRef str, int x, int y, short width, short height, void *poin, std::optional< StringRef > tip)
Button * blender::ui::uiDefIconTextButR (Block *block, ButtonType type, int icon, std::optional< StringRefNull > str, int x, int y, short width, short height, PointerRNA *ptr, StringRefNull propname, int index, std::optional< StringRef > tip)
Button * blender::ui::uiDefIconTextButR_prop (Block *block, ButtonType type, int icon, std::optional< StringRef > str, int x, int y, short width, short height, PointerRNA *ptr, PropertyRNA *prop, int index, float min, float max, std::optional< StringRef > tip)
Button * blender::ui::uiDefIconTextButO_ptr (Block *block, ButtonType type, wmOperatorType *ot, wm::OpCallContext opcontext, int icon, StringRef str, int x, int y, short width, short height, std::optional< StringRef > tip)
Button * blender::ui::uiDefIconTextButO (Block *block, ButtonType type, StringRefNull, wm::OpCallContext opcontext, int icon, StringRef str, int x, int y, short width, short height, std::optional< StringRef > tip)
void blender::ui::button_operator_set (Button *but, wmOperatorType *optype, wm::OpCallContext opcontext, const PointerRNA *opptr=nullptr)
void blender::ui::button_operator_set_never_call (Button *but)
Block & Button Flags
int blender::ui::blocklist_min_y_get (ListBaseT< Block > *lb)
void blender::ui::block_direction_set (Block *block, char direction)
void blender::ui::block_flag_enable (Block *block, int flag)
void blender::ui::block_flag_disable (Block *block, int flag)
void blender::ui::button_flag_enable (Button *but, int64_t flag)
void blender::ui::button_flag_disable (Button *but, int64_t flag)
bool blender::ui::button_flag_is_set (Button *but, int64_t flag)
void blender::ui::button_drawflag_enable (Button *but, int flag)
void blender::ui::button_drawflag_disable (Button *but, int flag)
void blender::ui::button_dragflag_enable (Button *but, int flag)
void blender::ui::button_dragflag_disable (Button *but, int flag)
void blender::ui::button_disable (Button *but, const char *disabled_hint)
void blender::ui::button_color_set (Button *but, const uchar color[4])
const ColorManagedDisplay * blender::ui::button_cm_display_get (Button &but)
bool blender::ui::button_is_color_gamma (Button &but)
void blender::ui::button_placeholder_set (Button *but, StringRef placeholder_text)
const char * blender::ui::button_placeholder_get (Button *but)
void blender::ui::button_type_set_menu_from_pulldown (Button *but)
int blender::ui::button_return_value_get (Button *but)
PointerRNA * blender::ui::button_operator_ptr_ensure (Button *but)
Button Context & Callbacks
void blender::ui::button_context_ptr_set (Block *block, Button *but, StringRef name, const PointerRNA *ptr)
void blender::ui::button_context_int_set (Block *block, Button *but, StringRef name, int64_t value)
const PointerRNA * blender::ui::button_context_ptr_get (const Button *but, StringRef name, const StructRNA *type=nullptr)
std::optional< StringRefNull > blender::ui::button_context_string_get (const Button *but, StringRef name)
std::optional< int64_t > blender::ui::button_context_int_get (const Button *but, StringRef name)
const bContextStore * blender::ui::button_context_get (const Button *but)
void blender::ui::button_unit_type_set (Button *but, int unit_type)
int blender::ui::button_unit_type_get (const Button *but)
void blender::ui::block_func_handle_set (Block *block, BlockHandleFunc func, void *arg)
void blender::ui::block_func_set (Block *block, ButtonHandleFunc func, void *arg1, void *arg2)
void blender::ui::block_funcN_set (Block *block, ButtonHandleNFunc funcN, void *argN, void *arg2, ButtonArgNFree func_argN_free_fn=MEM_delete_void, ButtonArgNCopy func_argN_copy_fn=MEM_dupalloc_void)
void * blender::ui::button_func_argN_get (const Button *but)
void blender::ui::button_poin_menu_argN_set (Button *but, void *poin, void *argN, ButtonArgNFree func_argN_free_fn, ButtonArgNCopy func_argN_copy_fn)
void blender::ui::text_button_func_rename_set (Button *but, std::function< void(bContext &C, StringRefNull oldname)> rename_func)
void blender::ui::text_button_func_rename_full_set (Button *but, std::function< void(StringRefNull new_name)> rename_full_func)
void blender::ui::button_func_drawextra_set (Block *block, std::function< void(const bContext *C, rcti *rect)> func)
void blender::ui::button_func_set (Button *but, ButtonHandleFunc func, void *arg1, void *arg2)
void blender::ui::button_func_set (Button *but, std::function< void(bContext &)> func)
void blender::ui::button_funcN_set (Button *but, ButtonHandleNFunc funcN, void *argN, void *arg2, ButtonArgNFree func_argN_free_fn=MEM_delete_void, ButtonArgNCopy func_argN_copy_fn=MEM_dupalloc_void)
void blender::ui::button_func_complete_set (Button *but, ButtonCompleteFunc func, void *arg)
void blender::ui::button_func_menu_step_set (Button *but, MenuStepFunc func)
void blender::ui::button_menu_disable_hover_open (Button *but)
void blender::ui::button_func_quick_tooltip_set (Button *but, std::function< std::string(const Button *but)> func)
void blender::ui::button_func_tooltip_set (Button *but, ButtonToolTipFunc func, void *arg, FreeArgFunc free_arg)
void blender::ui::button_func_tooltip_custom_set (Button *but, ButtonToolTipCustomFunc func, void *arg, FreeArgFunc free_arg)
void blender::ui::button_func_pushed_state_set (Button *but, std::function< bool(const Button &)> func)
Menu & Block Buttons
Button * blender::ui::uiDefBlockBut (Block *block, BlockCreateFunc func, void *arg, StringRef str, int x, int y, short width, short height, std::optional< StringRef > tip)
Button * blender::ui::uiDefBlockButN (Block *block, BlockCreateFunc func, void *argN, StringRef str, int x, int y, short width, short height, std::optional< StringRef > tip, ButtonArgNFree func_argN_free_fn=MEM_delete_void, ButtonArgNCopy func_argN_copy_fn=MEM_dupalloc_void)
Button * blender::ui::uiDefMenuBut (Block *block, MenuCreateFunc func, void *arg, StringRef str, int x, int y, short width, short height, std::optional< StringRef > tip)
Button * blender::ui::uiDefIconTextMenuBut (Block *block, MenuCreateFunc func, void *arg, int icon, StringRef str, int x, int y, short width, short height, std::optional< StringRef > tip)
Button * blender::ui::uiDefIconMenuBut (Block *block, MenuCreateFunc func, void *arg, int icon, int x, int y, short width, short height, std::optional< StringRef > tip)
Button * blender::ui::uiDefIconBlockBut (Block *block, BlockCreateFunc func, void *arg, int icon, int x, int y, short width, short height, std::optional< StringRef > tip)
Search Buttons
Button * blender::ui::uiDefSearchBut (Block *block, void *arg, int icon, int maxncpy, int x, int y, short width, short height, std::optional< StringRef > tip)
void blender::ui::button_func_search_set (Button *but, ButtonSearchCreateFn search_create_fn, ButtonSearchUpdateFn search_update_fn, void *arg, bool free_arg, FreeArgFunc search_arg_free_fn, ButtonHandleFunc search_exec_fn, void *active)
void blender::ui::button_func_search_set_context_menu (Button *but, ButtonSearchContextMenuFn context_menu_fn)
void blender::ui::button_func_search_set_sep_string (Button *but, const char *search_sep_string)
void blender::ui::button_func_search_set_tooltip (Button *but, ButtonSearchTooltipFn tooltip_fn)
void blender::ui::button_func_search_set_listen (Button *but, ButtonSearchListenFn listen_fn)
void blender::ui::button_func_search_set_results_are_suggestions (Button *but, bool value)
static void blender::ui::operator_enum_search_update_fn (const bContext *C, void *but, const char *str, SearchItems *items, const bool)
static void blender::ui::operator_enum_search_exec_fn (bContext *, void *but, void *arg2)
Button * blender::ui::uiDefSearchButO_ptr (Block *block, wmOperatorType *ot, IDProperty *properties, void *arg, int icon, int maxncpy, int x, int y, short width, short height, std::optional< StringRef > tip)
Button Property Setters
void blender::ui::button_hint_drawstr_set (Button *but, const char *string)
void blender::ui::button_icon_scale_set (Button *but, float scale)
void blender::ui::button_icon_indicator_number_set (Button *but, const int indicator_number)
void blender::ui::button_icon_indicator_set (Button *but, const char *string)
void blender::ui::button_icon_indicator_color_set (Button *but, const uchar color[4])
void blender::ui::button_node_link_set (Button *but, bNodeSocket *socket, const float draw_color[4])
void blender::ui::button_pushbutton_draw_as_overlay_set (Button *but, bool value)
void blender::ui::button_number_step_size_set (Button *but, float step_size)
void blender::ui::button_number_precision_set (Button *but, float precision)
void blender::ui::button_number_slider_step_size_set (Button *but, float step_size)
void blender::ui::button_number_slider_precision_set (Button *but, float precision)
void blender::ui::button_label_alpha_factor_set (Button *but, float alpha_factor)
void blender::ui::button_label_draw_icon_border_set (Button *but, bool use_icon_border)
void blender::ui::button_search_preview_grid_size_set (Button *but, int rows, int cols)
void blender::ui::button_view_item_draw_size_set (Button *but, const std::optional< int > draw_width=std::nullopt, const std::optional< int > draw_height=std::nullopt)
void blender::ui::button_focus_on_enter_event (wmWindow *win, Button *but)
void blender::ui::button_func_hold_set (Button *but, ButtonHandleHoldFunc func, void *argN)
Button String Access
std::optional< EnumPropertyItem > blender::ui::button_rna_enum_item_get (bContext &C, Button &but)
std::string blender::ui::button_string_get_rna_property_identifier (const Button &but)
std::string blender::ui::button_string_get_rna_struct_identifier (const Button &but)
std::string blender::ui::button_string_get_label (Button &but)
std::string blender::ui::button_context_menu_title_from_button (Button &but)
std::string blender::ui::button_string_get_tooltip_label (const Button &but)
std::string blender::ui::button_string_get_rna_label (Button &but)
std::string blender::ui::button_string_get_rna_label_context (const Button &but)
std::string blender::ui::button_string_get_tooltip (bContext &C, Button &but)
std::string blender::ui::button_string_get_rna_tooltip (bContext &C, Button &but)
std::string blender::ui::button_string_get_operator_keymap (bContext &C, Button &but)
std::string blender::ui::button_string_get_property_keymap (bContext &C, Button &but)
std::string blender::ui::button_extra_icon_string_get_label (const ButtonExtraOpIcon &extra_icon)
std::string blender::ui::button_extra_icon_string_get_tooltip (bContext &C, const ButtonExtraOpIcon &extra_icon)
std::string blender::ui::button_extra_icon_string_get_operator_keymap (const bContext &C, const ButtonExtraOpIcon &extra_icon)
Init / Exit
void blender::ui::init ()
void blender::ui::init_userdef ()
void blender::ui::reinit_font ()
void blender::ui::update_text_styles ()
void blender::ui::exit ()
void blender::ui::interface_tag_script_reload ()
Button Utilities
int blender::ui::button_text_padding (const Button *button)
std::string blender::ui::button_get_link (const Button *button, bContext *C)

Variables

static CLG_LogRef blender::ui::LOG = {"ui"}

Data Get/Set

This either works with the pointed to data, or can work with an edit override pointer while dragging for example.

#define UI_NUMBER_EVAL_ERROR_PREFIX   RPT_("Error evaluating number, see Info editor for details")
void blender::ui::button_v3_get (Button *but, float vec[3])
void blender::ui::button_v3_set (Button *but, const float vec[3])
void blender::ui::button_v4_get (Button *but, float vec[4])
void blender::ui::button_v4_set (Button *but, const float vec[4])
bool blender::ui::button_is_float (const Button *but)
PropertyScaleType blender::ui::button_scale_type (const Button *but)
bool blender::ui::button_is_bool (const Button *but)
bool blender::ui::button_is_unit (const Button *but)
bool blender::ui::button_is_compatible (const Button *but_a, const Button *but_b)
bool blender::ui::button_is_rna_valid (Button *but)
bool blender::ui::button_supports_cycling (const Button *but)
double blender::ui::button_value_get (Button *but)
void blender::ui::button_value_set (Button *but, double value)
int blender::ui::button_string_get_maxncpy (Button *but)
Button * blender::ui::button_drag_multi_edit_get (Button *but)
static double blender::ui::get_but_scale_unit (Button *but, double value)
void blender::ui::button_convert_to_unit_alt_name (Button *but, char *str, size_t str_maxncpy)
static void blender::ui::get_but_string_unit (Button *but, char *str, int str_maxncpy, double value, bool pad, int float_precision, bool do_suffix)
static float blender::ui::get_but_step_unit (Button *but, float step_default)
static std::string blender::ui::textbox_string_get (ButtonTextBox *textbox)
static bool blender::ui::button_edit_string_include_unit_suffix (const Button *button)
void blender::ui::button_string_get_ex (Button *but, char *str, const size_t str_maxncpy, const int float_precision, const bool use_exp_float, bool *r_use_exp_float)
void blender::ui::button_string_get (Button *but, char *str, const size_t str_maxncpy)
char * blender::ui::button_string_get_dynamic (Button *but, int *r_str_size)
static bool blender::ui::number_from_string_units (bContext *C, const char *str, const int unit_type, const UnitSettings *unit, double *r_value)
static bool blender::ui::number_from_string_units_with_but (bContext *C, const char *str, const Button *but, double *r_value)
static bool blender::ui::number_from_string (bContext *C, const char *str, double *r_value)
static bool blender::ui::number_from_string_factor (bContext *C, const char *str, double *r_value)
static bool blender::ui::number_from_string_percentage (bContext *C, const char *str, double *r_value)
bool blender::ui::button_string_eval_number (bContext *C, const Button *but, const char *str, double *r_value)
bool blender::ui::button_string_set (bContext *C, Button *but, const char *str)
static double blender::ui::soft_range_round_up (double value, double max)
static double blender::ui::soft_range_round_down (double value, double max)
void blender::ui::button_range_set_hard (Button *but)
void blender::ui::button_range_set_soft (Button *but)

Preview Tiles

#define PREVIEW_TILE_PAD   (0.225f * UI_UNIT_X)
int blender::ui::preview_tile_size_x (const int size_px=96)
int blender::ui::preview_tile_size_y (const int size_px=96)
int blender::ui::preview_tile_size_y_no_label (const int size_px=96)

Button Extra Operator Icons

Extra icons are shown on the right hand side of buttons. They can be clicked to invoke custom operators. There are some predefined here, which get added to buttons automatically based on button data (type, flags, state, etc).

enum  blender::ui::PredefinedExtraOpIconType { blender::ui::PREDEFINED_EXTRA_OP_ICON_NONE = 1 , blender::ui::PREDEFINED_EXTRA_OP_ICON_CLEAR , blender::ui::PREDEFINED_EXTRA_OP_ICON_EYEDROPPER , blender::ui::PREDEFINED_EXTRA_OP_ICON_BONE_EYEDROPPER }
static PointerRNA * blender::ui::but_extra_operator_icon_add_ptr (Button *but, wmOperatorType *optype, wm::OpCallContext opcontext, int icon)
static void blender::ui::but_extra_operator_icon_free (ButtonExtraOpIcon *extra_icon)
void blender::ui::button_extra_operator_icons_free (Button *but)
PointerRNA * blender::ui::button_extra_operator_icon_add (Button *but, StringRefNull opname, wm::OpCallContext opcontext, int icon)
wmOperatorType * blender::ui::button_extra_operator_icon_optype_get (const ButtonExtraOpIcon *extra_icon)
PointerRNA * blender::ui::button_extra_operator_icon_opptr_get (const ButtonExtraOpIcon *extra_icon)
static bool blender::ui::but_icon_extra_is_visible_text_clear (const Button *but)
static bool blender::ui::but_icon_extra_is_visible_search_unlink (const Button *but)
static bool blender::ui::but_icon_extra_is_visible_search_eyedropper (Button *but)
static bool blender::ui::but_icon_extra_is_visible_bone_eyedropper (Button *but)
static PredefinedExtraOpIconType blender::ui::but_icon_extra_get (Button *but)
static void blender::ui::but_predefined_extra_operator_icons_add (Button *but)

Pie Menu Direction

This goes in a seemingly weird pattern:

    4
 5     6
1       2
 7     8
    3

but it's actually quite logical. It's designed to be 'upwards compatible' for muscle memory so that the menu item locations are fixed and don't move as new items are added to the menu later on. It also optimizes efficiency - a radial menu is best kept symmetrical, with as large an angle between items as possible, so that the gestural mouse movements can be fast and inexact.

It starts off with two opposite sides for the first two items then joined by the one below for the third (this way, even with three items, the menu seems to still be 'in order' reading left to right). Then the fourth is added to complete the compass directions. From here, it's just a matter of subdividing the rest of the angles for the last 4 items.

–Matt 07/2006

const char blender::ui::radial_dir_order [8]
const char blender::ui::radial_dir_to_numpad [8] = {8, 9, 6, 3, 2, 1, 4, 7}
const short blender::ui::radial_dir_to_angle [8] = {90, 45, 0, 315, 270, 225, 180, 135}
static std::string blender::ui::but_pie_direction_string (const Button *but)

Macro Definition Documentation

◆ B_NOP

#define B_NOP   -1

Definition at line 97 of file interface.cc.

◆ BUT_VALUE_UNSET

#define BUT_VALUE_UNSET   DBL_MAX

◆ PREVIEW_TILE_PAD

#define PREVIEW_TILE_PAD   (0.225f * UI_UNIT_X)

◆ UI_GET_BUT_VALUE_INIT

#define UI_GET_BUT_VALUE_INIT ( _but,
_value )
Value:
if (_value == DBL_MAX) { \
(_value) = button_value_get(_but); \
} \
((void)0)

Definition at line 91 of file interface.cc.

Referenced by blender::ui::but_update_ex(), and blender::ui::button_is_pushed_ex().

◆ UI_NUMBER_EVAL_ERROR_PREFIX

#define UI_NUMBER_EVAL_ERROR_PREFIX   RPT_("Error evaluating number, see Info editor for details")

Report a generic error prefix when evaluating a string with #BPY_run_string_as_number as the Python error on its own doesn't provide enough context.

Definition at line 3428 of file interface.cc.

Referenced by blender::ui::number_from_string(), and blender::ui::number_from_string_units().