Blender V5.3
interface_handlers.cc File Reference
#include <algorithm>
#include <cctype>
#include <cfloat>
#include <cmath>
#include <cstdlib>
#include <cstring>
#include <optional>
#include <variant>
#include "MEM_guardedalloc.h"
#include "DNA_brush_types.h"
#include "DNA_curveprofile_types.h"
#include "DNA_scene_types.h"
#include "DNA_screen_types.h"
#include "BLI_array.hh"
#include "BLI_array_utils_c.hh"
#include "BLI_linklist.hh"
#include "BLI_listbase.hh"
#include "BLI_math_geom_c.hh"
#include "BLI_rect.hh"
#include "BLI_sort_utils.hh"
#include "BLI_string.hh"
#include "BLI_string_cursor_utf8.hh"
#include "BLI_string_utf8.hh"
#include "BLI_time.hh"
#include "BLI_utildefines.hh"
#include "BKE_animsys.hh"
#include "BKE_blender_undo.hh"
#include "BKE_brush.hh"
#include "BKE_colorband.hh"
#include "BKE_colortools.hh"
#include "BKE_context.hh"
#include "BKE_curveprofile.h"
#include "BKE_global.hh"
#include "BKE_main.hh"
#include "BKE_movieclip.hh"
#include "BKE_paint.hh"
#include "BKE_paint_types.hh"
#include "BKE_report.hh"
#include "BKE_scene.hh"
#include "BKE_screen.hh"
#include "BKE_tracking.hh"
#include "BKE_unit.hh"
#include "BLT_translation.hh"
#include "GHOST_ISystem.hh"
#include "IMB_colormanagement.hh"
#include "ED_numinput.hh"
#include "ED_screen.hh"
#include "ED_undo.hh"
#include "UI_abstract_view.hh"
#include "UI_interface.hh"
#include "UI_interface_c.hh"
#include "UI_string_search.hh"
#include "BLF_api.hh"
#include "BPY_extern_run.hh"
#include "buttons/interface_textbox.hh"
#include "interface_intern.hh"
#include "RNA_access.hh"
#include "RNA_prototypes.hh"
#include "CLG_log.h"
#include "WM_api.hh"
#include "WM_types.hh"
#include "wm_event_system.hh"

Go to the source code of this file.

Classes

struct  blender::ui::BlockInteraction_Handle
struct  blender::ui::uiSelectContextElem
struct  blender::ui::uiSelectContextStore
struct  blender::ui::ButtonMultiState
struct  blender::ui::HandleButtonMulti
struct  blender::ui::TextEdit
struct  blender::ui::HandleButtonData
struct  blender::ui::AfterFunc
struct  blender::ui::uiDragToggleHandle

Namespaces

namespace  blender
 BMesh Iterators.
namespace  blender::ui

Macros

#define CASE_NUM_TO_DIR(n, d)
Feature Defines

These defines allow developers to locally toggle functionality which may be useful for testing (especially conflicts in dragging). Ideally the code would be refactored to support this functionality in a less fragile way. Until then keep these defines.

#define USE_CONT_MOUSE_CORRECT
#define USE_DRAG_TOGGLE
#define USE_DRAG_MULTINUM
#define USE_ALLSELECT
#define USE_KEYNAV_LIMIT
#define USE_DRAG_POPUP
Local Defines
#define UI_PROP_SCALE_LOG_MIN   0.5e-8f
#define UI_PROP_SCALE_LOG_SNAP_OFFSET   0.03f
#define UI_DRAG_MAP_SOFT_RANGE_PIXEL_MAX   1000

Functions

std::optional< int2 > blender::ui::try_activate_rna_button (bContext *C, ARegion *region, ActivationButtonState target_state, PointerRNA *ptr, PropertyRNA *prop, bool warp_cursor_at_button=false, int index=0)
Local Prototypes
static int blender::ui::do_but_EXIT (bContext *C, Button *but, HandleButtonData *data, const wmEvent *event)
static bool blender::ui::but_find_select_in_enum__cmp (const Button *but_a, const Button *but_b)
static void blender::ui::textedit_string_set (Button *but, TextEdit &text_edit, const char *str)
static void blender::ui::button_tooltip_timer_reset (bContext *C, Button *but)
static void blender::ui::block_interaction_begin_ensure (bContext *C, Block *block, HandleButtonData *data, const bool is_click)
static BlockInteraction_Handle * blender::ui::block_interaction_begin (bContext *C, Block *block, const bool is_click)
static void blender::ui::block_interaction_end (bContext *C, BlockInteraction_CallbackData *callbacks, BlockInteraction_Handle *interaction)
static void blender::ui::block_interaction_update (bContext *C, BlockInteraction_CallbackData *callbacks, BlockInteraction_Handle *interaction)
static void blender::ui::mouse_motion_keynav_init (KeyNavLock *keynav, const wmEvent *event)
static bool blender::ui::mouse_motion_keynav_test (KeyNavLock *keynav, const wmEvent *event)
static void blender::ui::with_but_active_as_semi_modal (bContext *C, ARegion *region, Button *but, FunctionRef< void()> fn)
static int blender::ui::handle_region_semi_modal_buttons (bContext *C, const wmEvent *event, ARegion *region)
Struct allocation & freeing
void blender::ui::but_handle_data_free (HandleButtonData **data)
UI Queries
bool blender::ui::button_is_editing (const Button *but)
void blender::ui::pan_to_scroll (const wmEvent *event, int *type, int *val)
Button * blender::ui::button_find_select_in_enum (Button *but, int direction)
static float blender::ui::mouse_scale_warp_factor (const bool shift)
static void blender::ui::mouse_scale_warp (HandleButtonData *data, const float mx, const float my, float *r_mx, float *r_my, const bool shift)
UI Utilities
static bool blender::ui::multibut_drag_wait (const HandleButtonMulti &multi_data)
static bool blender::ui::but_dragedit_update_mval (HandleButtonData *data, int mx, FunctionRef< int()> drag_threshold_fn)
static bool blender::ui::rna_is_userdef (PointerRNA *ptr, PropertyRNA *prop)
bool blender::ui::button_is_userdef (const Button *but)
static void blender::ui::rna_update_preferences_dirty (PointerRNA *ptr, PropertyRNA *prop)
static void blender::ui::but_update_preferences_dirty (Button *but)
static void blender::ui::afterfunc_update_preferences_dirty (AfterFunc *after)
Button Drag Multi-Number
static void blender::ui::multibut_add (HandleButtonData *data, Button *but)
static void blender::ui::multibut_free (HandleButtonData *data, Block *block)
static bool blender::ui::multibut_states_tag (Button *but_active, HandleButtonData *data, const wmEvent *event)
static void blender::ui::multibut_states_create (Button *but_active, HandleButtonData *data)
static void blender::ui::multibut_states_apply (bContext *C, HandleButtonData *data, Block *block)
Button Drag Toggle
static bool blender::ui::drag_toggle_but_is_supported (const Button *but)
static bool blender::ui::drag_toggle_but_pushed_state (Button *but)
static bool blender::ui::drag_toggle_set_xy_xy (bContext *C, ARegion *region, const bool pushed_state, const int xy_src[2], const int xy_dst[2], const bool drag_lock[2])
static void blender::ui::drag_toggle_set (bContext *C, uiDragToggleHandle *drag_info, const int xy_input[2])
static void blender::ui::handler_region_drag_toggle_remove (bContext *, void *userdata)
static int blender::ui::handler_region_drag_toggle (bContext *C, const wmEvent *event, void *userdata)
static bool blender::ui::but_is_drag_toggle (const Button *but)
Button Drag
static bool blender::ui::but_drag_init (bContext *C, Button *but, HandleButtonData *data, const wmEvent *event)
Button Apply
static void blender::ui::apply_but_IMAGE (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::apply_but_HISTOGRAM (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::apply_but_WAVEFORM (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::apply_but_TRACKPREVIEW (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::apply_but (bContext *C, Block *block, Button *but, HandleButtonData *data, const bool interactive)
Button Copy & Paste
static void blender::ui::but_get_pasted_text_from_clipboard (const bool ensure_utf8, char **r_buf_paste, int *r_buf_len, bool paste_all_lines)
static int blender::ui::get_but_property_array_length (Button *but)
static void blender::ui::but_set_float_array (bContext *C, Button *but, HandleButtonData *data, const float *values, const int values_len)
static void blender::ui::float_array_to_string (const float *values, const int values_len, char *output, int output_maxncpy)
static void blender::ui::but_copy_numeric_array (Button *but, char *output, int output_maxncpy)
static bool blender::ui::parse_float_array (char *text, float *values, int values_len_expected)
static void blender::ui::but_paste_numeric_array (bContext *C, Button *but, HandleButtonData *data, char *buf_paste)
static void blender::ui::but_copy_numeric_value (Button *but, char *output, int output_maxncpy)
static void blender::ui::but_paste_numeric_value (bContext *C, Button *but, HandleButtonData *data, char *buf_paste)
static void blender::ui::but_paste_normalized_vector (bContext *C, Button *but, HandleButtonData *data, char *buf_paste)
static void blender::ui::but_copy_color (Button *but, char *output, int output_maxncpy)
static void blender::ui::but_paste_color (bContext *C, Button *but, char *buf_paste)
static void blender::ui::but_copy_text (Button *but, char *output, int output_maxncpy)
static void blender::ui::but_paste_text (bContext *C, Button *but, HandleButtonData *data, char *buf_paste)
static void blender::ui::but_copy_colorband (Button *but)
static void blender::ui::but_paste_colorband (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::but_copy_curvemapping (Button *but)
static void blender::ui::but_paste_curvemapping (bContext *C, Button *but)
static void blender::ui::but_copy_CurveProfile (Button *but)
static void blender::ui::but_paste_CurveProfile (bContext *C, Button *but)
static void blender::ui::but_copy_operator (bContext *C, Button *but, char *output, int output_maxncpy)
static bool blender::ui::but_copy_menu (bContext *C, Button *but, char *output, int output_maxncpy)
static void blender::ui::but_paste_menu (bContext *C, Button *but, const StringRef value)
static bool blender::ui::but_copy_popover (Button *but, char *output, int output_maxncpy)
static bool blender::ui::but_copy (bContext *C, Button *but, const bool copy_array)
static void blender::ui::but_paste (bContext *C, Button *but, HandleButtonData *data, const bool paste_array)
void blender::ui::button_clipboard_free ()
Button Text Password

Functions to convert password strings that should not be displayed to asterisk representation (e.g. mysecretpasswd -> *************)

It converts every UTF8 character to an asterisk, and also remaps the cursor position and selection start/end.

Note
remapping is used, because password could contain UTF8 characters.
static int blender::ui::text_position_from_hidden (Button *but, int pos)
static int blender::ui::text_position_to_hidden (Button *but, int pos)
void blender::ui::button_text_password_hide (std::string &password_str, Button *but, const bool restore)
Button Number Editing (various types)
static void blender::ui::numedit_begin (Button *but, HandleButtonData *data)
static void blender::ui::numedit_end (Button *but, HandleButtonData *data)
static void blender::ui::numedit_apply (bContext *C, Block *block, Button *but, HandleButtonData *data)
static void blender::ui::but_extra_operator_icon_apply (bContext *C, Button *but, ButtonExtraOpIcon *op_icon)
Menu/Popup Begin/End (various popup types)
static void blender::ui::block_open_begin (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::block_open_end (bContext *C, Button *but, HandleButtonData *data)
int blender::ui::button_menu_direction (Button *but)
static Button * blender::ui::but_list_row_text_activate (bContext *C, Button *but, HandleButtonData *data, const wmEvent *event, ButtonActivateType activate_type)
Events for Various Button Types
static ButtonExtraOpIcon * blender::ui::but_extra_operator_icon_mouse_over_get (Button *but, ARegion *region, const wmEvent *event)
static bool blender::ui::do_but_ANY_drag_toggle (bContext *C, Button *but, HandleButtonData *data, const wmEvent *event, int *r_retval)
static int blender::ui::do_but_BUT (bContext *C, Button *but, HandleButtonData *data, const wmEvent *event)
static int blender::ui::do_but_HOTKEYEVT (bContext *C, Button *but, HandleButtonData *data, const wmEvent *event)
static int blender::ui::do_but_KEYEVT (bContext *C, Button *but, HandleButtonData *data, const wmEvent *event)
static int blender::ui::do_but_TAB (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static int blender::ui::do_but_text_value_cycle (bContext *C, Button *but, HandleButtonData *data, const int inc_value)
static int blender::ui::do_but_TEX (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static int blender::ui::do_but_TEXTBOX (bContext *C, Block *block, ButtonTextBox *textbox, HandleButtonData *data, const wmEvent *event)
static int blender::ui::do_but_SEARCH_UNLINK (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static int blender::ui::do_but_TOG (bContext *C, Button *but, HandleButtonData *data, const wmEvent *event)
static void blender::ui::force_activate_view_item_but (bContext *C, ARegion *region, ButtonViewItem *but, const bool close_popup=true)
static int blender::ui::do_but_VIEW_ITEM (bContext *C, Button *but, HandleButtonData *data, const wmEvent *event)
static float blender::ui::numedit_apply_snapf (Button *but, float tempf, float softmin, float softmax, const eSnapType snap)
static float blender::ui::numedit_apply_snap (int temp, float softmin, float softmax, const eSnapType snap)
static bool blender::ui::numedit_but_NUM (ButtonNumber *but, HandleButtonData *data, int mx, FunctionRef< int()> drag_threshold_fn, const bool is_motion, const eSnapType snap, float fac)
static void blender::ui::numedit_set_active (Button *but)
static int blender::ui::do_but_NUM (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static bool blender::ui::numedit_but_SLI (Button *but, HandleButtonData *data, int mx, FunctionRef< int()> drag_threshold_fn, const bool is_horizontal, const bool is_motion, const bool snap, const bool shift)
static int blender::ui::do_but_SLI (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static int blender::ui::do_but_SCROLL (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static int blender::ui::do_but_GRIP (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static int blender::ui::do_but_LISTROW (bContext *C, Button *but, HandleButtonData *data, const wmEvent *event)
static int blender::ui::do_but_BLOCK (bContext *C, Button *but, HandleButtonData *data, const wmEvent *event)
static bool blender::ui::numedit_but_UNITVEC (Button *but, HandleButtonData *data, int mx, int my, const eSnapType snap)
static void blender::ui::palette_set_active (ButtonColor *color_but)
static int blender::ui::do_but_COLOR (bContext *C, Button *but, HandleButtonData *data, const wmEvent *event)
static int blender::ui::do_but_UNITVEC (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static void blender::ui::clamp_axis_max_v3 (float v[3], const float max)
static void blender::ui::rgb_to_color_picker_HSVCUBE_compat_v (const ButtonHSVCube *hsv_but, const float rgb[3], float hsv[3])
static void blender::ui::rgb_to_color_picker_HSVCUBE_v (const ButtonHSVCube *hsv_but, const float rgb[3], float hsv[3])
static void blender::ui::color_picker_to_rgb_HSVCUBE_v (const ButtonHSVCube *hsv_but, const float hsv[3], float rgb[3])
static bool blender::ui::numedit_but_HSVCUBE (Button *but, HandleButtonData *data, int mx, int my, const eSnapType snap, const bool shift, const bool use_continuous_grab, bool start_drag=false)
static int blender::ui::do_but_HSVCUBE (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static bool blender::ui::numedit_but_HSVCIRCLE (Button *but, HandleButtonData *data, float mx, float my, const eSnapType snap, const bool shift, const bool use_continuous_grab, const bool start_drag=false)
static int blender::ui::do_but_HSVCIRCLE (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static bool blender::ui::numedit_but_COLORBAND (Button *but, HandleButtonData *data, int mx)
static int blender::ui::do_but_COLORBAND (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static bool blender::ui::numedit_but_CURVE (Block *block, Button *but, HandleButtonData *data, int evtx, int evty, bool snap, const bool shift)
static int blender::ui::do_but_CURVE (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static bool blender::ui::numedit_but_CURVEPROFILE (Block *block, Button *but, HandleButtonData *data, int evtx, int evty, bool snap, const bool shift)
static bool blender::ui::point_draw_handles (CurveProfilePoint *point)
static eCurveProfilePoint_Flag blender::ui::profile_select_to_active (eCurveProfilePoint_Flag selection_type)
static int blender::ui::do_but_CURVEPROFILE (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static bool blender::ui::numedit_but_HISTOGRAM (Button *but, HandleButtonData *data, int mx, int my)
static int blender::ui::do_but_HISTOGRAM (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static bool blender::ui::numedit_but_WAVEFORM (Button *but, HandleButtonData *data, int mx, int my)
static int blender::ui::do_but_WAVEFORM (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static bool blender::ui::numedit_but_TRACKPREVIEW (bContext *C, Button *but, HandleButtonData *data, int mx, int my, const bool shift)
static int blender::ui::do_but_TRACKPREVIEW (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static int blender::ui::do_button (bContext *C, Block *block, Button *but, const wmEvent *event)
Button Tool Tip
static void blender::ui::blocks_set_tooltips (ARegion *region, const bool enable)
void blender::ui::button_tooltip_refresh (bContext *C, Button *but)
void blender::ui::button_tooltip_timer_remove (bContext *C, Button *but)
static ARegion * blender::ui::but_tooltip_init (bContext *C, ARegion *region, int *pass, double *r_pass_delay, bool *r_exit_on_event)
Button State Handling
static bool blender::ui::button_modal_state (HandleButtonState state)
static int blender::ui::popup_handler (bContext *C, const wmEvent *event, void *userdata)
static void blender::ui::popup_handler_remove (bContext *C, void *userdata)
void blender::ui::button_active_free (const bContext *C, Button *but)
void blender::ui::button_semi_modal_state_free (const bContext *C, Button *but)
static Button * blender::ui::context_button_active (const ARegion *region, bool(*but_check_cb)(const Button *))
Button * blender::ui::context_active_but_get (const bContext *C)
Button * blender::ui::context_active_but_get_respect_popup (const bContext *C)
Button * blender::ui::region_active_but_get (const ARegion *region)
Button * blender::ui::region_but_find_rect_over (const ARegion *region, const rcti *rect_px)
Block * blender::ui::region_block_find_mouse_over (const ARegion *region, const int xy[2], bool only_clip)
Button * blender::ui::region_active_but_prop_get (const ARegion *region, PointerRNA *r_ptr, PropertyRNA **r_prop, int *r_index)
Button * blender::ui::context_active_but_prop_get (const bContext *C, PointerRNA *r_ptr, PropertyRNA **r_prop, int *r_index)
void blender::ui::context_active_but_prop_handle (bContext *C, bool handle_undo)
void blender::ui::context_active_but_clear (bContext *C, wmWindow *win, ARegion *region)
wmOperator * blender::ui::context_active_operator_get (const bContext *C)
ARegion * blender::ui::region_searchbox_region_get (const ARegion *button_region)
void blender::ui::context_update_anim_flag (const bContext *C)
void blender::ui::button_update_view_for_active (const bContext *C, const Block *block)
Button Activation Handling
static Button * blender::ui::but_find_open_event (ARegion *region, const wmEvent *event)
static int blender::ui::handle_button_over (bContext *C, const wmEvent *event, ARegion *region)
void blender::ui::button_activate_event (bContext *C, ARegion *region, Button *but)
void blender::ui::button_activate_over (bContext *C, ARegion *region, Button *but)
void blender::ui::button_execute_begin (bContext *, ARegion *region, Button *but, void **active_back)
void blender::ui::button_execute_end (bContext *C, ARegion *, Button *but, void *active_back)
static bool blender::ui::handle_button_activate_by_type (bContext *C, ARegion *region, Button *but)
static void blender::ui::foreach_semi_modal_but_as_active (bContext *C, ARegion *region, FunctionRef< void(Button *semi_modal_but)> fn)
Handle Events for Activated Buttons
static bool blender::ui::button_value_default (Button *but, double *r_value)
static int blender::ui::handle_button_event (bContext *C, const wmEvent *event, Button *but)
static int blender::ui::uilist_get_increment (const uiList *list, const int type)
static int blender::ui::handle_uilist_event (bContext *C, const wmEvent *event, ARegion *region, Button *listbox)
static int blender::ui::handle_viewlist_items_hover (const wmEvent *event, ARegion *region)
static int blender::ui::handle_view_item_event (bContext *C, const wmEvent *event, Button *active_but, ARegion *region)
static void blender::ui::handle_button_return_submenu (bContext *C, const wmEvent *event, Button *but)
Menu Towards (mouse motion logic)
static void blender::ui::mouse_motion_towards_init_ex (PopupBlockHandle *menu, const int xy[2], const bool force)
static void blender::ui::mouse_motion_towards_init (PopupBlockHandle *menu, const int xy[2])
static void blender::ui::mouse_motion_towards_reinit (PopupBlockHandle *menu, const int xy[2])
static bool blender::ui::mouse_motion_towards_check (Block *block, PopupBlockHandle *menu, const int xy[2], const bool use_wiggle_room)
Menu Scroll
static char blender::ui::menu_scroll_test (Block *block, int2 xy)
static void blender::ui::menu_scroll_apply_offset_y (ARegion *region, Block *block, float dy)
static bool blender::ui::menu_scroll_to_but (ARegion *region, Block *block, Button *but_target)
static bool blender::ui::menu_scroll_to_y (ARegion *region, Block *block, int y)
static bool blender::ui::menu_scroll_step (ARegion *region, Block *block, const int scroll_dir)
Menu Event Handling
static void blender::ui::region_auto_open_clear (ARegion *region)
static bool blender::ui::menu_pass_event_to_parent_if_nonactive (PopupBlockHandle *menu, const Button *but, const int level, const bool is_parent_menu, const int retval)
static int blender::ui::handle_menu_button (bContext *C, const wmEvent *event, PopupBlockHandle *menu)
float blender::ui::block_calc_pie_segment (Block *block, const float event_xy[2])
static void blender::ui::set_initial_search_query_from_event (const wmEvent *event, PointerRNA *props, const StringRefNull prop_name)
static int blender::ui::handle_menu_letter_press_search (PopupBlockHandle *menu, const wmEvent *event)
static int blender::ui::handle_menu_mmb_event (bContext *C, const wmEvent *event, PopupBlockHandle *menu, int level, const bool is_parent_menu)
static int blender::ui::handle_menu_event (bContext *C, const wmEvent *event, PopupBlockHandle *menu, int level, const bool is_parent_inside, const bool is_parent_menu, const bool is_floating)
static int blender::ui::handle_menu_return_submenu (bContext *C, const wmEvent *event, PopupBlockHandle *menu)
static bool blender::ui::but_pie_menu_supported_apply (Button *but)
static int blender::ui::but_pie_menu_apply (bContext *C, PopupBlockHandle *menu, Button *but, bool force_close)
static Button * blender::ui::block_pie_dir_activate (Block *block, const wmEvent *event, RadialDirection dir)
static int blender::ui::but_pie_button_activate (bContext *C, Button *but, PopupBlockHandle *menu)
static int blender::ui::pie_handler (bContext *C, const wmEvent *event, PopupBlockHandle *menu)
static int blender::ui::handle_menus_recursive (bContext *C, const wmEvent *event, PopupBlockHandle *menu, int level, const bool is_parent_inside, const bool is_parent_menu, const bool is_floating)
void blender::ui::popup_menu_retval_set (const Block *block, int retval, bool enable)
UI Event Handlers
static int blender::ui::region_handler (bContext *C, const wmEvent *event, void *)
static void blender::ui::region_handler_remove (bContext *C, void *)
static bool blender::ui::can_activate_other_menu (Button *but, Button *but_other, const wmEvent *event)
void blender::ui::region_handlers_add (ListBaseT< wmEventHandler > *handlers)
void blender::ui::popup_handlers_add (bContext *C, ListBaseT< wmEventHandler > *handlers, PopupBlockHandle *popup, char flag)
void blender::ui::popup_handlers_remove (ListBaseT< wmEventHandler > *handlers, PopupBlockHandle *popup)
void blender::ui::popup_handlers_remove_all (bContext *C, ListBaseT< wmEventHandler > *handlers)
static bool blender::ui::button_references_srna (Button &button, const StructRNA *srna)
static bool blender::ui::popup_needs_update_for_unreg_srna_recursive (bContext *C, PopupBlockHandle *popup_block_handle, StructRNA *srna_to_unreg)
void blender::ui::refresh_for_srna_unregister (Main *bmain, StructRNA *srna_to_unreg)
static Button * blender::ui::block_find_rna_text_button (Block &block, const void *rna_poin_data, const char *rna_prop_id)
bool blender::ui::textbutton_activate_rna (const bContext *C, ARegion *region, const void *rna_poin_data, const char *rna_prop_id, Block &block)
bool blender::ui::textbutton_activate_rna (const bContext *C, ARegion *region, const void *rna_poin_data, const char *rna_prop_id)
bool blender::ui::textbutton_activate_but (const bContext *C, Button *actbut)
Public Utilities
void blender::ui::UI_region_free_active_but_all (bContext *C, ARegion *region)
void blender::ui::UI_screen_free_active_but_highlight (const bContext *C, bScreen *screen)
Button * blender::ui::button_active_drop_name_button (const bContext *C)
bool blender::ui::button_active_drop_name (const bContext *C)
bool blender::ui::button_active_drop_color (bContext *C)
Custom Interaction

Sometimes it's useful to create data that remains available while the user interacts with a button.

A common case is dragging a number button or slider however this could be used in other cases too.

void blender::ui::block_interaction_set (Block *block, BlockInteraction_CallbackData *callbacks)

Variables

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

Structs & Defines

#define BUTTON_FLASH_DELAY   0.020
#define MENU_SCROLL_INTERVAL   0.1
#define PIE_MENU_INTERVAL   0.01
#define BUTTON_AUTO_OPEN_THRESH   0.2
#define BUTTON_MOUSE_TOWARDS_THRESH   1.0
#define BUTTON_KEYNAV_PX_LIMIT   8
#define MENU_TOWARDS_MARGIN   20
#define MENU_TOWARDS_WIGGLE_ROOM   64
#define USE_ALLSELECT_LAYER_HACK
#define IS_ALLSELECT_EVENT(event)
#define BUT_IS_SELECT_CONTEXT   BUT_NODE_ACTIVE
#define DRAG_MULTINUM_THRESHOLD_DRAG_X   (UI_UNIT_Y / 4)
#define DRAG_MULTINUM_THRESHOLD_DRAG_Y   (UI_UNIT_Y / 4)
#define DRAG_MULTINUM_THRESHOLD_VERTICAL   (0.75f)
enum  blender::ui::ButtonActivateType {
  blender::ui::BUTTON_ACTIVATE_OVER , blender::ui::BUTTON_ACTIVATE , blender::ui::BUTTON_ACTIVATE_APPLY , blender::ui::BUTTON_ACTIVATE_TEXT_EDITING ,
  blender::ui::BUTTON_ACTIVATE_OPEN
}
enum  blender::ui::HandleButtonState : int {
  blender::ui::BUTTON_STATE_INIT , blender::ui::BUTTON_STATE_HIGHLIGHT , blender::ui::BUTTON_STATE_WAIT_FLASH , blender::ui::BUTTON_STATE_WAIT_RELEASE ,
  blender::ui::BUTTON_STATE_WAIT_KEY_EVENT , blender::ui::BUTTON_STATE_NUM_EDITING , blender::ui::BUTTON_STATE_TEXT_EDITING , blender::ui::BUTTON_STATE_TEXT_SELECTING ,
  blender::ui::BUTTON_STATE_TEXTBOX_SCROLLING , blender::ui::BUTTON_STATE_TEXTBOX_RESIZING , blender::ui::BUTTON_STATE_MENU_OPEN , blender::ui::BUTTON_STATE_WAIT_DRAG ,
  blender::ui::BUTTON_STATE_EXIT
}
enum  blender::ui::MenuScrollType { blender::ui::MENU_SCROLL_UP , blender::ui::MENU_SCROLL_DOWN , blender::ui::MENU_SCROLL_TOP , blender::ui::MENU_SCROLL_BOTTOM }
static constexpr double blender::ui::menu_keep_open_duration = 0.4f
static ColorBand blender::ui::but_copypaste_coba
static CurveMapping blender::ui::but_copypaste_curve
static bool blender::ui::but_copypaste_curve_alive = false
static CurveProfile blender::ui::but_copypaste_profile
static bool blender::ui::but_copypaste_profile_alive = false
static bool blender::ui::selectcontext_begin (bContext *C, Button *but, uiSelectContextStore *selctx_data)
static void blender::ui::selectcontext_end (Button *but, uiSelectContextStore *selctx_data)
static void blender::ui::selectcontext_apply (bContext *C, Button *but, uiSelectContextStore *selctx_data, const double value, const double value_orig)
static void blender::ui::button_activate_init (bContext *C, ARegion *region, Button *but, ButtonActivateType type)
static void blender::ui::button_activate_state (bContext *C, Button *but, HandleButtonState state)
static void blender::ui::button_activate_exit (bContext *C, Button *but, HandleButtonData *data, const bool mousemove, const bool onfree)
static int blender::ui::handler_region_menu (bContext *C, const wmEvent *event, void *userdata)
static void blender::ui::handle_button_activate (bContext *C, ARegion *region, Button *but, ButtonActivateType type)
static bool blender::ui::do_but_extra_operator_icon (bContext *C, Button *but, HandleButtonData *data, const wmEvent *event)
static void blender::ui::do_but_extra_operator_icons_mousemove (Button *but, HandleButtonData *data, const wmEvent *event)
static void blender::ui::numedit_begin_set_values (Button *but, HandleButtonData *data)
static void blender::ui::multibut_restore (bContext *C, HandleButtonData *data, Block *block)
static ButtonMultiState * blender::ui::multibut_lookup (HandleButtonData *data, const Button *but)

Button Snap Values

enum  blender::ui::eSnapType { blender::ui::SNAP_OFF = 0 , blender::ui::SNAP_ON , blender::ui::SNAP_ON_SMALL }
static eSnapType blender::ui::event_to_snap (const wmEvent *event)
static bool blender::ui::event_is_snap (const wmEvent *event)
static void blender::ui::color_snap_hue (const eSnapType snap, float *r_hue)

Button Text Selection/Editing

enum  { blender::ui::UI_TEXTEDIT_PASTE = 1 , blender::ui::UI_TEXTEDIT_COPY , blender::ui::UI_TEXTEDIT_CUT }
void blender::ui::button_set_string_interactive (bContext *C, Button *but, const char *value)
void blender::ui::button_active_string_clear_and_exit (bContext *C, Button *but)
static void blender::ui::textedit_string_ensure_max_length (Button *but, TextEdit &text_edit, int str_maxncpy)
static bool blender::ui::textedit_delete_selection (Button *but, TextEdit &text_edit)
static void blender::ui::textedit_set_cursor_pos (Button *but, const ARegion *region, const float2 xy)
static void blender::ui::textedit_set_cursor_select (Button *but, HandleButtonData *data, const float2 xy)
static bool blender::ui::textedit_insert_buf (Button *but, TextEdit &text_edit, const char *buf, int buf_len)
static void blender::ui::textedit_move (Button *but, TextEdit &text_edit, eStrCursorJumpDirection direction, const bool select, eStrCursorJumpType jump, bool jump_all_multiline=false)
static bool blender::ui::textedit_delete (Button *but, TextEdit &text_edit, eStrCursorJumpDirection direction, eStrCursorJumpType jump)
static int blender::ui::textedit_autocomplete (bContext *C, Button *but, HandleButtonData *data)
static bool blender::ui::textedit_copypaste (Button *but, TextEdit &text_edit, const int mode)
std::optional< StringRef > blender::ui::button_edit_unit_hint_get (const Button &but)
static std::optional< StringRef > blender::ui::button_edit_unit_hint_get_from_prop_subtype (const PropertySubType subtype)
static void blender::ui::button_edit_unit_hint_refresh (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::textedit_begin (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::textedit_end (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::textedit_next_but (Block *block, Button *actbut, HandleButtonData *data)
static void blender::ui::textedit_prev_but (Block *block, Button *actbut, HandleButtonData *data)
static eStrCursorJumpType blender::ui::textedit_jump_type_from_event (const wmEvent *event)
static int blender::ui::do_but_textedit (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)
static int blender::ui::do_but_textedit_select (bContext *C, Block *block, Button *but, HandleButtonData *data, const wmEvent *event)

Button Apply/Revert

static ListBaseT< AfterFunc > blender::ui::UIAfterFuncs = {nullptr, nullptr}
static AfterFunc * blender::ui::afterfunc_new ()
static void blender::ui::handle_afterfunc_add_operator_ex (wmOperatorType *ot, PointerRNA **properties, wm::OpCallContext opcontext, const Button *context_but)
void blender::ui::handle_afterfunc_add_operator (wmOperatorType *ot, wm::OpCallContext opcontext)
static void blender::ui::popup_check (bContext *C, wmOperator *op)
static bool blender::ui::afterfunc_check (const Block *block, const Button *but)
static void blender::ui::apply_but_func (bContext *C, Button *but)
static void blender::ui::apply_but_undo (Button *but, bool use_undo_grouped=false)
static void blender::ui::apply_but_autokey (bContext *C, Button *but)
static void blender::ui::apply_but_funcs_after (bContext *C)
static void blender::ui::apply_but_BUT (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::apply_but_BUTM (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::apply_but_BLOCK (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::apply_but_TOG (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::apply_but_ROW (bContext *C, Block *block, Button *but, HandleButtonData *data)
static void blender::ui::apply_but_VIEW_ITEM (bContext *C, Block *block, Button *but, HandleButtonData *data)
static void blender::ui::apply_but_TEX (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::apply_but_TAB (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::apply_but_NUM (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::apply_but_VEC (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::apply_but_COLORBAND (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::apply_but_CURVE (bContext *C, Button *but, HandleButtonData *data)
static void blender::ui::apply_but_CURVEPROFILE (bContext *C, Button *but, HandleButtonData *data)

Macro Definition Documentation

◆ BUT_IS_SELECT_CONTEXT

#define BUT_IS_SELECT_CONTEXT   BUT_NODE_ACTIVE

just show a tinted color so users know its activated

Definition at line 314 of file interface_handlers.cc.

Referenced by blender::ui::selectcontext_begin(), and blender::ui::selectcontext_end().

◆ BUTTON_AUTO_OPEN_THRESH

#define BUTTON_AUTO_OPEN_THRESH   0.2

◆ BUTTON_FLASH_DELAY

#define BUTTON_FLASH_DELAY   0.020

Definition at line 202 of file interface_handlers.cc.

Referenced by blender::ui::button_activate_state().

◆ BUTTON_KEYNAV_PX_LIMIT

#define BUTTON_KEYNAV_PX_LIMIT   8

Pixels to move the cursor to get out of keyboard navigation.

Definition at line 208 of file interface_handlers.cc.

Referenced by blender::ui::mouse_motion_keynav_test().

◆ BUTTON_MOUSE_TOWARDS_THRESH

#define BUTTON_MOUSE_TOWARDS_THRESH   1.0

Definition at line 206 of file interface_handlers.cc.

Referenced by blender::ui::mouse_motion_towards_check().

◆ CASE_NUM_TO_DIR

#define CASE_NUM_TO_DIR ( n,
d )
Value:
case (EVT_ZEROKEY + n): \
case (EVT_PAD0 + n): { \
if (num_dir == UI_RADIAL_NONE) { \
num_dir = d; \
} \
} \
(void)0

Referenced by blender::ui::pie_handler().

◆ DRAG_MULTINUM_THRESHOLD_DRAG_X

#define DRAG_MULTINUM_THRESHOLD_DRAG_X   (UI_UNIT_Y / 4)

how far to drag before we check for gesture direction (in pixels), NOTE: half the height of a button is about right...

Definition at line 323 of file interface_handlers.cc.

Referenced by blender::ui::do_button().

◆ DRAG_MULTINUM_THRESHOLD_DRAG_Y

#define DRAG_MULTINUM_THRESHOLD_DRAG_Y   (UI_UNIT_Y / 4)

How far to drag horizontally before we stop checking which buttons the gesture spans (in pixels), locking down the buttons so we can drag freely without worrying about vertical movement.

Definition at line 330 of file interface_handlers.cc.

Referenced by blender::ui::do_button().

◆ DRAG_MULTINUM_THRESHOLD_VERTICAL

#define DRAG_MULTINUM_THRESHOLD_VERTICAL   (0.75f)

How strict to be when detecting a vertical gesture: [0.5 == sloppy], [0.9 == strict], (unsigned dot-product).

Note
We should be quite strict here, since doing a vertical gesture by accident should be avoided, however with some care a user should be able to do a vertical movement without missing.

Definition at line 340 of file interface_handlers.cc.

Referenced by blender::ui::do_button().

◆ IS_ALLSELECT_EVENT

#define IS_ALLSELECT_EVENT ( event)
Value:
(((event)->modifier & KM_ALT) != 0)

Ideally we would only respond to events which are expected to be used for multi button editing (additionally checking if this is a mouse[wheel] or return-key event to avoid the ALT conflict with button array pasting, see #108096, but unfortunately wheel events are not part of win->runtime->eventstate with modifiers held down). Instead, the conflict is avoided by specifically filtering out CTRL ALT V in #apply_but().

Definition at line 311 of file interface_handlers.cc.

Referenced by blender::ui::apply_but(), blender::ui::block_open_begin(), and blender::ui::textedit_begin().

◆ MENU_SCROLL_INTERVAL

#define MENU_SCROLL_INTERVAL   0.1

Definition at line 203 of file interface_handlers.cc.

Referenced by blender::ui::handle_menu_event().

◆ MENU_TOWARDS_MARGIN

#define MENU_TOWARDS_MARGIN   20

Margin around the menu, use to check if we're moving towards this rectangle (in pixels).

Definition at line 211 of file interface_handlers.cc.

Referenced by blender::ui::mouse_motion_towards_check().

◆ MENU_TOWARDS_WIGGLE_ROOM

#define MENU_TOWARDS_WIGGLE_ROOM   64

Tolerance for closing menus (in pixels).

Definition at line 213 of file interface_handlers.cc.

Referenced by blender::ui::mouse_motion_towards_check().

◆ PIE_MENU_INTERVAL

#define PIE_MENU_INTERVAL   0.01

Definition at line 204 of file interface_handlers.cc.

Referenced by blender::ui::pie_handler().

◆ UI_DRAG_MAP_SOFT_RANGE_PIXEL_MAX

#define UI_DRAG_MAP_SOFT_RANGE_PIXEL_MAX   1000

When #USER_CONTINUOUS_MOUSE is disabled or tablet input is used, Use this as a maximum soft range for mapping cursor motion to the value. Otherwise min/max of FLT_MAX, INT_MAX cause small adjustments to jump to large numbers.

This is needed for values such as location & dimensions which don't have a meaningful min/max, Instead of mapping cursor motion to the min/max, map the motion to the click-step.

This value is multiplied by the click step to calculate a range to clamp the soft-range by. See: #68130

Definition at line 155 of file interface_handlers.cc.

Referenced by blender::ui::numedit_begin().

◆ UI_PROP_SCALE_LOG_MIN

#define UI_PROP_SCALE_LOG_MIN   0.5e-8f

This is a lower limit on the soft minimum of the range. Usually the derived lower limit from the visible precision is higher, so this number is the backup minimum.

Logarithmic scale does not work with a minimum value of zero, but we want to support it anyway. It is set to 0.5e... for correct rounding since when the tweaked value is lower than the log minimum (lower limit), it will snap to 0.

Definition at line 136 of file interface_handlers.cc.

Referenced by blender::ui::numedit_begin(), and blender::ui::numedit_but_NUM().

◆ UI_PROP_SCALE_LOG_SNAP_OFFSET

#define UI_PROP_SCALE_LOG_SNAP_OFFSET   0.03f

This constant defines an offset for the precision change in snap rounding, when going to higher values. It is set to 0.5 - log10(3) = 0.03 to make the switch at 0.3 values.

Definition at line 142 of file interface_handlers.cc.

Referenced by blender::ui::do_but_NUM(), blender::ui::do_but_SLI(), and blender::ui::numedit_apply_snapf().

◆ USE_ALLSELECT

#define USE_ALLSELECT

Allow dragging/editing all other selected items at once.

Definition at line 109 of file interface_handlers.cc.

◆ USE_ALLSELECT_LAYER_HACK

#define USE_ALLSELECT_LAYER_HACK

Definition at line 275 of file interface_handlers.cc.

◆ USE_CONT_MOUSE_CORRECT

#define USE_CONT_MOUSE_CORRECT

Place the mouse at the scaled down location when un-grabbing.

Definition at line 101 of file interface_handlers.cc.

◆ USE_DRAG_MULTINUM

#define USE_DRAG_MULTINUM

Support dragging multiple number buttons at once.

Definition at line 106 of file interface_handlers.cc.

◆ USE_DRAG_POPUP

#define USE_DRAG_POPUP

Support dragging popups by their header.

Definition at line 118 of file interface_handlers.cc.

◆ USE_DRAG_TOGGLE

#define USE_DRAG_TOGGLE

Support dragging toggle buttons.

Definition at line 103 of file interface_handlers.cc.

◆ USE_KEYNAV_LIMIT

#define USE_KEYNAV_LIMIT

Check to avoid very small mouse-moves from jumping away from keyboard navigation, while larger mouse motion will override keyboard input, see: #34936.

Definition at line 115 of file interface_handlers.cc.