interface_intern.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include <functional>
 
#include "BLI_compiler_attrs.h"
#include "BLI_math_vector_types.hh"
#include "BLI_rect.h"
#include "BLI_string_ref.hh"
#include "BLI_vector.hh"
 
#include "BKE_fcurve.hh"
 
#include "DNA_listBase.h"
#include "RNA_types.hh"
#include "UI_interface.hh"
#include "UI_resources.hh"
 
struct AnimationEvalContext;
struct ARegion;
struct bContext;
struct bContextStore;
struct ColorManagedDisplay;
struct CurveMapping;
struct CurveProfile;
namespace blender::gpu {
class Batch;
}
struct IconTextOverlay;
struct ID;
struct ImBuf;
struct LayoutPanelHeader;
struct Main;
struct Scene;
struct uiHandleButtonData;
struct uiLayout;
struct uiListType;
struct uiStyle;
struct uiUndoStack_Text;
struct uiWidgetColors;
struct UnitSettings;
struct wmEvent;
struct wmKeyConfig;
struct wmOperatorType;
struct wmTimer;
 
/* ****************** general defines ************** */
 
#define RNA_NO_INDEX -1
#define RNA_ENUM_VALUE -2
 
#define UI_MENU_PADDING (int)(0.2f * UI_UNIT_Y)
 
#define UI_MENU_WIDTH_MIN (UI_UNIT_Y * 9)
#define UI_MENU_SUBMENU_PADDING (6 * UI_SCALE_FAC)
 
/* menu scrolling */
#define UI_MENU_SCROLL_ARROW (12 * UI_SCALE_FAC)
#define UI_MENU_SCROLL_MOUSE (UI_MENU_SCROLL_ARROW + 2 * UI_SCALE_FAC)
#define UI_MENU_SCROLL_PAD (4 * UI_SCALE_FAC)

#define UI_POPOVER_WIDTH_UNITS 10

enum {
  UI_SELECT = (1 << 0),
  UI_SCROLLED = (1 << 1),
  UI_HOVER = (1 << 2),
  UI_HAS_ICON = (1 << 3),
  UI_HIDDEN = (1 << 4),
  UI_SELECT_DRAW = (1 << 5),
  UI_SEARCH_FILTER_NO_MATCH = (1 << 6),

  UI_BUT_ACTIVE_OVERRIDE = (1 << 7),
 
  /* WARNING: rest of #uiBut.flag in UI_interface.hh */
};

enum RadialDirection {
  UI_RADIAL_NONE = -1,
  UI_RADIAL_N = 0,
  UI_RADIAL_NE = 1,
  UI_RADIAL_E = 2,
  UI_RADIAL_SE = 3,
  UI_RADIAL_S = 4,
  UI_RADIAL_SW = 5,
  UI_RADIAL_W = 6,
  UI_RADIAL_NW = 7,
};

#define UI_RADIAL_DIRECTION_NEXT(dir) RadialDirection((int(dir) + 1) % (int(UI_RADIAL_NW) + 1))
#define UI_RADIAL_DIRECTION_PREV(dir) \
  RadialDirection(((int(dir) + int(UI_RADIAL_NW))) % (int(UI_RADIAL_NW) + 1))

#define UI_RADIAL_MASK_ALL_DIAGONAL \
  ((1 << int(UI_RADIAL_NE)) | (1 << int(UI_RADIAL_SE)) | (1 << int(UI_RADIAL_SW)) | \
   (1 << int(UI_RADIAL_NW)))
#define UI_RADIAL_MASK_ALL_AXIS_ALIGNED \
  ((1 << int(UI_RADIAL_N)) | (1 << int(UI_RADIAL_S)) | (1 << int(UI_RADIAL_E)) | \
   (1 << int(UI_RADIAL_W)))
 
extern const char ui_radial_dir_order[8];
extern const char ui_radial_dir_to_numpad[8];
extern const short ui_radial_dir_to_angle[8];
 
/* internal panel drawing defines */
#define PNL_HEADER (UI_UNIT_Y * 1.25) /* 24 default */
 
/* bit button defines */
/* Bit operations */
#define UI_BITBUT_TEST(a, b) (((a) & (1 << (b))) != 0)
#define UI_BITBUT_VALUE_TOGGLED(a, b) ((a) ^ (1 << (b)))
#define UI_BITBUT_VALUE_ENABLED(a, b) ((a) | (1 << (b)))
#define UI_BITBUT_VALUE_DISABLED(a, b) ((a) & ~(1 << (b)))
 
/* bit-row */
#define UI_BITBUT_ROW(min, max) \
  (((max) >= 31 ? 0xFFFFFFFF : (1 << ((max) + 1)) - 1) - ((min) ? ((1 << (min)) - 1) : 0))

#define USE_NUMBUTS_LR_ALIGN

#define USE_UIBUT_SPATIAL_ALIGN

enum {
  UI_PIE_INITIAL_DIRECTION = (1 << 1),
  UI_PIE_DRAG_STYLE = (1 << 2),
  UI_PIE_INVALID_DIR = (1 << 3),
  UI_PIE_CLICK_STYLE = (1 << 4),
  UI_PIE_ANIMATION_FINISHED = (1 << 5),
  UI_PIE_GESTURE_END_WAIT = (1 << 6),
};
 
#define PIE_CLICK_THRESHOLD_SQ 50.0f

#define PIE_MAX_ITEMS 8
 
struct uiBut {
  uiBut *next = nullptr, *prev = nullptr;

  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, bitnr = 0, retval = 0, strwidth = 0, alignnr = 0;
  short ofs = 0, pos = 0, selsta = 0, selend = 0;
 
  std::string str;
 
  std::string drawstr;
 
  char *placeholder = nullptr;
 
  rctf rect = {}; /* block relative coords */
 
  char *poin = nullptr;
  float hardmin = 0, hardmax = 0, softmin = 0, 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;
 
  /* 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. */
  std::function<void(std::string &new_name)> rename_full_func = nullptr;
  std::string rename_full_new = "";

  uiButHandleHoldFunc hold_func = nullptr;
  void *hold_argN = nullptr;
 
  const char *tip = nullptr;
  uiButToolTipFunc tip_func = nullptr;
  void *tip_arg = nullptr;
  uiFreeArgFunc tip_arg_free = nullptr;
  std::function<std::string(const uiBut *)> tip_label_func;
 
  uiButToolTipCustomFunc tip_custom_func = nullptr;

  const char *disabled_info = nullptr;
 
  BIFIconID icon = ICON_NONE;
  eUIEmbossType emboss = UI_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;
 
  /* RNA data */
  PointerRNA rnapoin = {};
  PropertyRNA *rnaprop = nullptr;
  int rnaindex = 0;
 
  /* Operator data */
  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;
  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 = {};
 
  /* pointer back */
  uiBlock *block = nullptr;
 
  uiBut() = default;
  uiBut(const uiBut &other) = default;
  uiBut &operator=(const uiBut &other) = default;
};

struct uiButNumber : public uiBut {
  float step_size = 0.0f;
  float precision = 0.0f;
};

struct uiButNumberSlider : public uiBut {
  float step_size = 0.0f;
  float precision = 0.0f;
};

struct uiButColor : public uiBut {
  bool is_pallete_color = false;
  int palette_color_index = -1;
};

struct uiButTab : public uiBut {
  MenuType *menu = nullptr;
};

struct uiButSearch : public uiBut {
  uiButSearchCreateFn popup_create_fn = nullptr;
  uiButSearchUpdateFn items_update_fn = nullptr;
  uiButSearchListenFn listen_fn = nullptr;
 
  void *item_active = nullptr;
  char *item_active_str;
 
  void *arg = nullptr;
  uiFreeArgFunc arg_free_fn = nullptr;
 
  uiButSearchContextMenuFn item_context_menu_fn = nullptr;
  uiButSearchTooltipFn item_tooltip_fn = nullptr;
 
  const char *item_sep_string = nullptr;
 
  PointerRNA rnasearchpoin = {};
  PropertyRNA *rnasearchprop = nullptr;
 
  int preview_rows = 0;
  int preview_cols = 0;

  bool results_are_suggestions = false;
};

struct uiButDecorator : public uiBut {
  PointerRNA decorated_rnapoin = {};
  PropertyRNA *decorated_rnaprop = nullptr;
  int decorated_rnaindex = -1;
};

struct uiButProgress : public uiBut {
  float progress_factor = 0.0f;
  eButProgressType progress_type = UI_BUT_PROGRESS_TYPE_BAR;
};

struct uiButSeparatorLine : public uiBut {
  bool is_vertical;
};

struct uiButLabel : public uiBut {
  float alpha_factor = 1.0f;
};

struct uiButScrollBar : public uiBut {
  float visual_height = -1.0f;
};
 
struct uiButViewItem : public uiBut {
  /* The view item this button was created for. */
  blender::ui::AbstractViewItem *view_item = nullptr;
  /* Some items want to have a fixed size for drawing, differing from the interaction rectangle
   * (e.g. so highlights are drawn smaller). */
  int draw_width = 0;
  int draw_height = 0;
};

struct uiButHSVCube : public uiBut {
  eButGradientType gradient_type = UI_GRAD_SV;
};

struct uiButColorBand : public uiBut {
  ColorBand *edit_coba = nullptr;
};

struct uiButCurveProfile : public uiBut {
  CurveProfile *edit_profile = nullptr;
};

struct uiButCurveMapping : public uiBut {
  CurveMapping *edit_cumap = nullptr;
  eButGradientType gradient_type = UI_GRAD_SV;
};

struct uiButHotkeyEvent : public uiBut {
  short modifier_key = 0;
};

struct uiButExtraOpIcon {
  uiButExtraOpIcon *next, *prev;
 
  BIFIconID icon;
  wmOperatorCallParams *optype_params;
 
  bool highlighted;
  bool disabled;
};
 
struct ColorPicker {
  ColorPicker *next, *prev;

  float hsv_perceptual[3];
  float hsv_perceptual_init[3];
  bool is_init;

  float hsv_scene_linear[3];

  bool use_color_cubic;
  bool use_color_lock;
  bool use_luminosity_lock;
  float luminosity_lock_value;
 
  /* Alpha component. */
  bool has_alpha;
};
 
struct ColorPickerData {
  ListBase list;
};
 
struct PieMenuData {
  const char *title;
  int icon;

  int pie_dir_mask;
  float pie_dir[2];
  float pie_center_init[2];
  float pie_center_spawned[2];
  float last_pos[2];
  double duration_gesture;
  int flags;
  short event_type;
  float alphafac;
};

enum eBlockContentHints {
  UI_BLOCK_CONTAINS_SUBMENU_BUT = (1 << 0),
};
 
/* #uiButtonGroup.flag. */
enum uiButtonGroupFlag {
  UI_BUTTON_GROUP_LOCK = (1 << 0),
  UI_BUTTON_GROUP_PANEL_HEADER = (1 << 1),
};
ENUM_OPERATORS(uiButtonGroupFlag, UI_BUTTON_GROUP_PANEL_HEADER);

struct uiButtonGroup {
  blender::Vector<uiBut *> buttons;
  uiButtonGroupFlag flag;
};
 
struct uiBlockDynamicListener {
  uiBlockDynamicListener *next, *prev;
 
  void (*listener_func)(const wmRegionListenerParams *params);
};
 
struct uiBlock {
  uiBlock *next, *prev;
 
  ListBase buttons;
  Panel *panel;
  uiBlock *oldblock;

  ListBase butstore;
 
  blender::Vector<uiButtonGroup> button_groups;
 
  ListBase layouts;
  uiLayout *curlayout;
 
  blender::Vector<std::unique_ptr<bContextStore>> contexts;

  ListBase views;
 
  ListBase dynamic_listeners; /* #uiBlockDynamicListener */
 
  std::string name;
 
  float winmat[4][4];
 
  rctf rect;
  float aspect;

  uint puphash;
 
  uiButHandleFunc func;
  void *func_arg1;
  void *func_arg2;
 
  uiButHandleNFunc funcN;
  void *func_argN;
  uiButArgNFree func_argN_free_fn;
  uiButArgNCopy func_argN_copy_fn;
 
  uiBlockHandleFunc handle_func;
  void *handle_func_arg;

  uiBlockInteraction_CallbackData custom_interaction_callbacks;

  int (*block_event_func)(const bContext *C, uiBlock *, const wmEvent *);

  std::function<void(const bContext *, rcti *)> drawextra;
 
  int flag;
  short alignnr;
  short content_hints; /* #eBlockContentHints */
 
  char direction;
  char theme_style;
  eUIEmbossType emboss;
  bool auto_open;
  char _pad[5];
  double auto_open_last;
 
  const char *lockstr;
 
  bool lock;
  bool active;
  bool tooltipdisabled;
  bool endblock;

  eBlockBoundsCalc bounds_type;
  int bounds_offset[2];
  int bounds, minbounds;

  rctf safety;
  ListBase saferct;
 
  uiPopupBlockHandle *handle;

  wmOperator *ui_operator;
  bool ui_operator_free;

  void *evil_C;

  const UnitSettings *unit;
  ColorPickerData color_pickers;

  bool is_color_gamma_picker;

  char display_device[64];
 
  PieMenuData pie_data;
};
 
struct uiSafetyRct {
  uiSafetyRct *next, *prev;
  rctf parent;
  rctf safety;
};
 
/* `interface.cc` */
 
void ui_fontscale(float *points, float aspect);

void ui_but_to_pixelrect(rcti *rect,
                         const ARegion *region,
                         const uiBlock *block,
                         const uiBut *but);
rcti ui_to_pixelrect(const ARegion *region, const uiBlock *block, const rctf *src_rect);
 
void ui_block_to_region_fl(const ARegion *region, const uiBlock *block, float *x, float *y);
void ui_block_to_window_fl(const ARegion *region, const uiBlock *block, float *x, float *y);
void ui_block_to_window(const ARegion *region, const uiBlock *block, int *x, int *y);
void ui_block_to_region_rctf(const ARegion *region,
                             const uiBlock *block,
                             rctf *rct_dst,
                             const rctf *rct_src);
void ui_block_to_window_rctf(const ARegion *region,
                             const uiBlock *block,
                             rctf *rct_dst,
                             const rctf *rct_src);
float ui_block_to_window_scale(const ARegion *region, const uiBlock *block);
void ui_window_to_block_fl(const ARegion *region, const uiBlock *block, float *x, float *y);
void ui_window_to_block(const ARegion *region, const uiBlock *block, int *x, int *y);
void ui_window_to_block_rctf(const ARegion *region,
                             const uiBlock *block,
                             rctf *rct_dst,
                             const rctf *rct_src);
void ui_window_to_region(const ARegion *region, int *x, int *y);
void ui_window_to_region_rcti(const ARegion *region, rcti *rect_dst, const rcti *rct_src);
void ui_window_to_region_rctf(const ARegion *region, rctf *rect_dst, const rctf *rct_src);
void ui_region_to_window(const ARegion *region, int *x, int *y);
void ui_region_winrct_get_no_margin(const ARegion *region, rcti *r_rect);

void ui_block_add_dynamic_listener(uiBlock *block,
                                   void (*listener_func)(const wmRegionListenerParams *params));

uiBut *ui_but_change_type(uiBut *but, eButType new_type);
 
double ui_but_value_get(uiBut *but);
void ui_but_value_set(uiBut *but, double value);
void ui_but_hsv_set(uiBut *but);
void ui_but_v3_get(uiBut *but, float vec[3]);
void ui_but_v3_set(uiBut *but, const float vec[3]);
void ui_but_v4_get(uiBut *but, float vec[4]);
void ui_but_v4_set(uiBut *but, const float vec[4]);
 
void ui_hsvcircle_vals_from_pos(
    const rcti *rect, float mx, float my, float *r_val_rad, float *r_val_dist);
void ui_hsvcircle_pos_from_vals(
    const ColorPicker *cpicker, const rcti *rect, const float *hsv, float *r_xpos, float *r_ypos);
void ui_hsvcube_pos_from_vals(
    const uiButHSVCube *hsv_but, const rcti *rect, const float *hsv, float *r_xp, float *r_yp);

void ui_but_string_get_ex(uiBut *but,
                          char *str,
                          size_t str_maxncpy,
                          int float_precision,
                          bool use_exp_float,
                          bool *r_use_exp_float) ATTR_NONNULL(1, 2);
void ui_but_string_get(uiBut *but, char *str, size_t str_maxncpy) ATTR_NONNULL();
char *ui_but_string_get_dynamic(uiBut *but, int *r_str_size);
void ui_but_convert_to_unit_alt_name(uiBut *but, char *str, size_t str_maxncpy) ATTR_NONNULL();
bool ui_but_string_set(bContext *C, uiBut *but, const char *str) ATTR_NONNULL();
bool ui_but_string_eval_number(bContext *C, const uiBut *but, const char *str, double *r_value)
    ATTR_NONNULL();
int ui_but_string_get_maxncpy(uiBut *but);
void ui_but_active_string_clear_and_exit(bContext *C, uiBut *but) ATTR_NONNULL();
void ui_but_set_string_interactive(bContext *C, uiBut *but, const char *value);
uiBut *ui_but_drag_multi_edit_get(uiBut *but);

const char *ui_but_placeholder_get(uiBut *but);
 
void ui_def_but_icon(uiBut *but, int icon, int flag);
void ui_def_but_icon_clear(uiBut *but);
 
void ui_but_extra_operator_icons_free(uiBut *but);
 
void ui_but_rna_menu_convert_to_panel_type(uiBut *but, const char *panel_type);
void ui_but_rna_menu_convert_to_menu_type(uiBut *but, const char *menu_type);
bool ui_but_menu_draw_as_popover(const uiBut *but);
 
void ui_but_range_set_hard(uiBut *but);
void ui_but_range_set_soft(uiBut *but);
 
bool ui_but_context_poll_operator(bContext *C, wmOperatorType *ot, const uiBut *but);
bool ui_but_context_poll_operator_ex(bContext *C,
                                     const uiBut *but,
                                     const wmOperatorCallParams *optype_params);
 
void ui_but_update(uiBut *but);
void ui_but_update_edited(uiBut *but);
PropertyScaleType ui_but_scale_type(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
bool ui_but_is_float(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
bool ui_but_is_bool(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
bool ui_but_is_unit(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
bool ui_but_is_compatible(const uiBut *but_a, const uiBut *but_b) ATTR_WARN_UNUSED_RESULT;
bool ui_but_is_rna_valid(uiBut *but) ATTR_WARN_UNUSED_RESULT;
bool ui_but_supports_cycling(const uiBut *but) ATTR_WARN_UNUSED_RESULT;

int ui_but_is_pushed_ex(uiBut *but, double *value) ATTR_WARN_UNUSED_RESULT;
int ui_but_is_pushed(uiBut *but) ATTR_WARN_UNUSED_RESULT;
 
void ui_but_override_flag(Main *bmain, uiBut *but);
 
void ui_block_bounds_calc(uiBlock *block);
 
ColorManagedDisplay *ui_block_cm_display_get(uiBlock *block);
void ui_block_cm_to_display_space_v3(uiBlock *block, float pixel[3]);
 
/* `interface_regions.cc` */
 
struct uiKeyNavLock {
  bool is_keynav;
  int event_xy[2];
};
 
using uiBlockHandleCreateFunc = uiBlock *(*)(bContext *C, uiPopupBlockHandle *handle, void *arg1);
 
struct uiPopupBlockCreate {
  uiBlockCreateFunc create_func;
  uiBlockHandleCreateFunc handle_create_func;
  void *arg;
  uiFreeArgFunc arg_free;
 
  int event_xy[2];

  ARegion *butregion;
  uiBut *but;
};
 
struct uiPopupBlockHandle {
  /* internal */
  ARegion *region;

  float towards_xy[2];
  double towardstime;
  bool dotowards;
 
  bool popup;
  void (*popup_func)(bContext *C, void *arg, int event);
  void (*cancel_func)(bContext *C, void *arg);
  void *popup_arg;

  uiPopupBlockCreate popup_create_vars;
  bool can_refresh;
  bool refresh;
 
  wmTimer *scrolltimer;
  float scrolloffset;
 
  uiKeyNavLock keynav_state;
 
  /* for operator popups */
  wmOperator *popup_op;
  ScrArea *ctx_area;
  ARegion *ctx_region;
 
  /* return values */
  int butretval;
  int menuretval;
  int retvalue;
  float retvec[4];

  int direction;
 
  /* Previous values so we don't resize or reposition on refresh. */
  rctf prev_block_rect;
  rctf prev_butrct;
  short prev_dir1, prev_dir2;
  int prev_bounds_offset[2];
 
  /* Maximum estimated size to avoid having to reposition on refresh. */
  float max_size_x, max_size_y;
 
  /* #ifdef USE_DRAG_POPUP */
  bool is_grab;
  int grab_xy_prev[2];
  /* #endif */
 
  char menu_idname[64];
};
 
/* -------------------------------------------------------------------- */
/* interface_region_*.c */
 
/* `interface_region_tooltip.cc` */
 
/* exposed as public API in UI_interface.hh */
 
/* `interface_region_color_picker.cc` */
 
void ui_color_picker_rgb_to_hsv_compat(const float rgb[3], float r_cp[3]);
void ui_color_picker_rgb_to_hsv(const float rgb[3], float r_cp[3]);
void ui_color_picker_hsv_to_rgb(const float r_cp[3], float rgb[3]);

bool ui_but_is_color_gamma(uiBut *but);

bool ui_but_color_has_alpha(uiBut *but);
 
void ui_scene_linear_to_perceptual_space(uiBut *but, float rgb[3]);
void ui_perceptual_to_scene_linear_space(uiBut *but, float rgb[3]);
 
uiBlock *ui_block_func_COLOR(bContext *C, uiPopupBlockHandle *handle, void *arg_but);
ColorPicker *ui_block_colorpicker_create(uiBlock *block);
 
/* `interface_region_search.cc` */

ARegion *ui_searchbox_create_generic(bContext *C, ARegion *butregion, uiButSearch *search_but);
ARegion *ui_searchbox_create_operator(bContext *C, ARegion *butregion, uiButSearch *search_but);
ARegion *ui_searchbox_create_menu(bContext *C, ARegion *butregion, uiButSearch *search_but);

bool ui_searchbox_inside(ARegion *region, const int xy[2]) ATTR_NONNULL(1, 2);
int ui_searchbox_find_index(ARegion *region, const char *name);
void ui_searchbox_update(bContext *C, ARegion *region, uiBut *but, bool reset);
int ui_searchbox_autocomplete(bContext *C, ARegion *region, uiBut *but, char *str);
bool ui_searchbox_event(
    bContext *C, ARegion *region, uiBut *but, ARegion *butregion, const wmEvent *event);
bool ui_searchbox_apply(uiBut *but, ARegion *region);
void ui_searchbox_free(bContext *C, ARegion *region);
void ui_but_search_refresh(uiButSearch *but);
 
/* `interface_region_menu_popup.cc` */
 
int ui_but_menu_step(uiBut *but, int direction);
bool ui_but_menu_step_poll(const uiBut *but);
uiBut *ui_popup_menu_memory_get(uiBlock *block);
void ui_popup_menu_memory_set(uiBlock *block, uiBut *but);

uiBlock *ui_popup_block_refresh(bContext *C,
                                uiPopupBlockHandle *handle,
                                ARegion *butregion,
                                uiBut *but);
 
uiPopupBlockHandle *ui_popup_block_create(bContext *C,
                                          ARegion *butregion,
                                          uiBut *but,
                                          uiBlockCreateFunc create_func,
                                          uiBlockHandleCreateFunc handle_create_func,
                                          void *arg,
                                          uiFreeArgFunc arg_free,
                                          bool can_refresh);
uiPopupBlockHandle *ui_popup_menu_create(
    bContext *C, ARegion *butregion, uiBut *but, uiMenuCreateFunc menu_func, void *arg);
 
/* `interface_region_popover.cc` */
 
using uiPopoverCreateFunc = std::function<void(bContext *, uiLayout *, PanelType *)>;
 
uiPopupBlockHandle *ui_popover_panel_create(bContext *C,
                                            ARegion *butregion,
                                            uiBut *but,
                                            uiPopoverCreateFunc popover_func,
                                            const PanelType *panel_type);
 
/* `interface_region_menu_pie.cc` */

void ui_pie_menu_level_create(uiBlock *block,
                              wmOperatorType *ot,
                              const char *propname,
                              IDProperty *properties,
                              const EnumPropertyItem *items,
                              int totitem,
                              wmOperatorCallContext context,
                              eUI_Item_Flag flag);
 
/* `interface_region_popup.cc` */

void ui_popup_translate(ARegion *region, const int mdiff[2]);
void ui_popup_block_free(bContext *C, uiPopupBlockHandle *handle);
void ui_popup_block_scrolltest(uiBlock *block);
 
/* end interface_region_*.c */
 
/* `interface_panel.cc` */

int ui_handler_panel_region(bContext *C,
                            const wmEvent *event,
                            ARegion *region,
                            const uiBut *active_but);
void ui_draw_aligned_panel(const ARegion *region,
                           const uiStyle *style,
                           const uiBlock *block,
                           const rcti *rect,
                           bool show_pin,
                           bool show_background,
                           bool region_search_filter_active);
void ui_draw_layout_panels_backdrop(const ARegion *region,
                                    const Panel *panel,
                                    const float radius,
                                    float subpanel_backcolor[4]);
void ui_panel_drag_collapse_handler_add(const bContext *C, const bool was_open);
void ui_panel_tag_search_filter_match(Panel *panel);
bool ui_layout_panel_toggle_open(const bContext *C, LayoutPanelHeader *header);
LayoutPanelHeader *ui_layout_panel_header_under_mouse(const Panel &panel, const int my);
void ui_layout_panel_popup_scroll_apply(Panel *panel, const float dy);

void ui_draw_gradient(const rcti *rect, const float hsv[3], eButGradientType type, float alpha);

void ui_draw_rounded_corners_inverted(const rcti &rect,
                                      const float rad,
                                      const blender::float4 color);
 
/* based on UI_draw_roundbox_gl_mode,
 * check on making a version which allows us to skip some sides */
void ui_draw_but_TAB_outline(const rcti *rect,
                             float rad,
                             uchar highlight[3],
                             uchar highlight_fade[3]);
void ui_draw_but_HISTOGRAM(ARegion *region,
                           uiBut *but,
                           const uiWidgetColors *wcol,
                           const rcti *recti);
void ui_draw_but_WAVEFORM(ARegion *region,
                          uiBut *but,
                          const uiWidgetColors *wcol,
                          const rcti *recti);
void ui_draw_but_VECTORSCOPE(ARegion *region,
                             uiBut *but,
                             const uiWidgetColors *wcol,
                             const rcti *recti);
void ui_draw_but_COLORBAND(uiBut *but, const uiWidgetColors *wcol, const rcti *rect);
void ui_draw_but_UNITVEC(uiBut *but, const uiWidgetColors *wcol, const rcti *rect, float radius);
void ui_draw_but_CURVE(ARegion *region, uiBut *but, const uiWidgetColors *wcol, const rcti *rect);
void ui_draw_but_CURVEPROFILE(ARegion *region,
                              uiBut *but,
                              const uiWidgetColors *wcol,
                              const rcti *rect);
void ui_draw_but_IMAGE(ARegion *region, uiBut *but, const uiWidgetColors *wcol, const rcti *rect);
void ui_draw_but_TRACKPREVIEW(ARegion *region,
                              uiBut *but,
                              const uiWidgetColors *wcol,
                              const rcti *recti);
 
/* `interface_undo.cc` */

uiUndoStack_Text *ui_textedit_undo_stack_create();
void ui_textedit_undo_stack_destroy(uiUndoStack_Text *stack);
void ui_textedit_undo_push(uiUndoStack_Text *stack, const char *text, int cursor_index);
const char *ui_textedit_undo(uiUndoStack_Text *stack, int direction, int *r_cursor_index);
 
/* interface_handlers.cc */
 
void ui_handle_afterfunc_add_operator(wmOperatorType *ot, wmOperatorCallContext opcontext);
void ui_pan_to_scroll(const wmEvent *event, int *type, int *val);
void ui_but_activate_event(bContext *C, ARegion *region, uiBut *but);
void ui_but_activate_over(bContext *C, ARegion *region, uiBut *but);
void ui_but_execute_begin(bContext *C, ARegion *region, uiBut *but, void **active_back);
void ui_but_execute_end(bContext *C, ARegion *region, uiBut *but, void *active_back);
void ui_but_active_free(const bContext *C, uiBut *but);
void ui_but_semi_modal_state_free(const bContext *C, uiBut *but);
void ui_but_update_view_for_active(const bContext *C, const uiBlock *block);
int ui_but_menu_direction(uiBut *but);
void ui_but_text_password_hide(char password_str[128], uiBut *but, bool restore);
uiBut *ui_but_find_select_in_enum(uiBut *but, int direction);
bool ui_but_is_editing(const uiBut *but);
float ui_block_calc_pie_segment(uiBlock *block, const float event_xy[2]);
 
/* XXX, this code will shorten any allocated string to 'UI_MAX_NAME_STR'
 * since this is really long its unlikely to be an issue,
 * but this could be supported */
void ui_but_add_shortcut(uiBut *but, const char *shortcut_str, bool do_strip);
void ui_but_clipboard_free();
bool ui_but_rna_equals(const uiBut *a, const uiBut *b);
bool ui_but_rna_equals_ex(const uiBut *but,
                          const PointerRNA *ptr,
                          const PropertyRNA *prop,
                          int index);
uiBut *ui_but_find_old(uiBlock *block_old, const uiBut *but_new);
uiBut *ui_but_find_new(uiBlock *block_new, const uiBut *but_old);
 
#ifdef WITH_INPUT_IME
void ui_but_ime_reposition(uiBut *but, int x, int y, bool complete);
const wmIMEData *ui_but_ime_data_get(uiBut *but);
#endif
 
/* interface_widgets.cc */
 
/* Widget shader parameters, must match the shader layout. */
struct uiWidgetBaseParameters {
  rctf recti, rect;
  float radi, rad;
  float facxi, facyi;
  float round_corners[4];
  float color_inner1[4], color_inner2[4];
  float color_outline[4], color_emboss[4];
  float color_tria[4];
  float tria1_center[2], tria2_center[2];
  float tria1_size, tria2_size;
  float shade_dir;
  /* We pack alpha check and discard factor in alpha_discard.
   * If the value is negative then we do alpha check.
   * The absolute value itself is the discard factor.
   * Initialize value to 1.0f if you don't want discard. */
  float alpha_discard;
  float tria_type;
  float _pad[3];
};
 
enum {
  ROUNDBOX_TRIA_NONE = 0,
  ROUNDBOX_TRIA_ARROWS,
  ROUNDBOX_TRIA_SCROLL,
  ROUNDBOX_TRIA_MENU,
  ROUNDBOX_TRIA_CHECK,
  ROUNDBOX_TRIA_HOLD_ACTION_ARROW,
  ROUNDBOX_TRIA_DASH,
 
  ROUNDBOX_TRIA_MAX, /* don't use */
};
 
blender::gpu::Batch *ui_batch_roundbox_widget_get();
blender::gpu::Batch *ui_batch_roundbox_shadow_get();
 
void ui_draw_menu_back(uiStyle *style, uiBlock *block, const rcti *rect);
void ui_draw_popover_back(ARegion *region, uiStyle *style, uiBlock *block, const rcti *rect);
void ui_draw_pie_center(uiBlock *block);
const uiWidgetColors *ui_tooltip_get_theme();
 
void ui_draw_widget_menu_back_color(const rcti *rect, bool use_shadow, const float color[4]);
void ui_draw_widget_menu_back(const rcti *rect, bool use_shadow);
void ui_draw_tooltip_background(const uiStyle *style, uiBlock *block, const rcti *rect);

void ui_draw_but(const bContext *C, ARegion *region, uiStyle *style, uiBut *but, rcti *rect);

enum uiMenuItemSeparatorType {
  UI_MENU_ITEM_SEPARATOR_NONE,
  UI_MENU_ITEM_SEPARATOR_SHORTCUT,
  UI_MENU_ITEM_SEPARATOR_HINT,
};

void ui_draw_menu_item(const uiFontStyle *fstyle,
                       rcti *rect,
                       const char *name,
                       int iconid,
                       int but_flag,
                       uiMenuItemSeparatorType separator_type,
                       int *r_xmax);
void ui_draw_preview_item(const uiFontStyle *fstyle,
                          rcti *rect,
                          const char *name,
                          int iconid,
                          int but_flag,
                          eFontStyle_Align text_align);
void ui_draw_preview_item_stateless(const uiFontStyle *fstyle,
                                    rcti *rect,
                                    blender::StringRef name,
                                    int iconid,
                                    const uchar text_col[4],
                                    eFontStyle_Align text_align,
                                    bool draw_as_icon = false);
 
#define UI_TEXT_MARGIN_X 0.4f
#define UI_POPUP_MARGIN (UI_SCALE_FAC * 12)
#define UI_POPUP_MENU_TOP (int)(10 * UI_SCALE_FAC)
 
#define UI_PIXEL_AA_JITTER 8
extern const float ui_pixel_jitter[UI_PIXEL_AA_JITTER][2];
 
/* `interface_style.cc` */

void uiStyleInit();
 
/* interface_icons.cc */
 
void ui_icon_ensure_deferred(const bContext *C, int icon_id, bool big);
int ui_id_icon_get(const bContext *C, ID *id, bool big);
 
/* interface_icons_event.cc */
 
float ui_event_icon_offset(int icon_id);
 
void icon_draw_rect_input(
    float x, float y, int w, int h, int icon_id, float aspect, float alpha, bool inverted);
 
/* resources.cc */
 
void ui_resources_init();
void ui_resources_free();
 
/* interface_layout.cc */
 
void ui_layout_add_but(uiLayout *layout, uiBut *but);
void ui_layout_remove_but(uiLayout *layout, const uiBut *but);
bool ui_layout_replace_but_ptr(uiLayout *layout, const void *old_but_ptr, uiBut *new_but);
uiBut *ui_but_add_search(uiBut *but,
                         PointerRNA *ptr,
                         PropertyRNA *prop,
                         PointerRNA *searchptr,
                         PropertyRNA *searchprop,
                         bool results_are_suggestions);
void ui_layout_list_set_labels_active(uiLayout *layout);
/* menu callback */
void ui_item_menutype_func(bContext *C, uiLayout *layout, void *arg_mt);
void ui_item_paneltype_func(bContext *C, uiLayout *layout, void *arg_pt);
 
/* interface_button_group.cc */

void ui_block_new_button_group(uiBlock *block, uiButtonGroupFlag flag);
void ui_button_group_add_but(uiBlock *block, uiBut *but);
void ui_button_group_replace_but_ptr(uiBlock *block, const uiBut *old_but_ptr, uiBut *new_but);
 
/* interface_drag.cc */
 
void ui_but_drag_free(uiBut *but);
bool ui_but_drag_is_draggable(const uiBut *but);
void ui_but_drag_start(bContext *C, uiBut *but);
 
/* interface_align.cc */
 
bool ui_but_can_align(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
int ui_but_align_opposite_to_area_align_get(const ARegion *region) ATTR_WARN_UNUSED_RESULT;
void ui_block_align_calc(uiBlock *block, const ARegion *region);
 
/* `interface_anim.cc` */
 
void ui_but_anim_flag(uiBut *but, const AnimationEvalContext *anim_eval_context);
void ui_but_anim_copy_driver(bContext *C);
void ui_but_anim_paste_driver(bContext *C);
bool ui_but_anim_expression_get(uiBut *but, char *str, size_t str_maxncpy);
bool ui_but_anim_expression_set(uiBut *but, const char *str);
bool ui_but_anim_expression_create(uiBut *but, const char *str);
void ui_but_anim_autokey(bContext *C, uiBut *but, Scene *scene, float cfra);
 
void ui_but_anim_decorate_cb(bContext *C, void *arg_but, void *arg_dummy);
void ui_but_anim_decorate_update_from_flag(uiButDecorator *but);
 
/* `interface_query.cc` */
 
bool ui_but_is_editable(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
bool ui_but_is_editable_as_text(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
bool ui_but_is_toggle(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
bool ui_but_is_interactive_ex(const uiBut *but, const bool labeledit, const bool for_tooltip);
bool ui_but_is_interactive(const uiBut *but, bool labeledit) ATTR_WARN_UNUSED_RESULT;
bool ui_but_is_popover_once_compat(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
bool ui_but_has_array_value(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
int ui_but_icon(const uiBut *but);
void ui_but_pie_dir(RadialDirection dir, float vec[2]);
 
bool ui_but_is_cursor_warp(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
 
bool ui_but_contains_pt(const uiBut *but, float mx, float my) ATTR_WARN_UNUSED_RESULT;
bool ui_but_contains_rect(const uiBut *but, const rctf *rect);
bool ui_but_contains_point_px_icon(const uiBut *but,
                                   ARegion *region,
                                   const wmEvent *event) ATTR_WARN_UNUSED_RESULT;
bool ui_but_contains_point_px(const uiBut *but, const ARegion *region, const int xy[2])
    ATTR_NONNULL(1, 2, 3) ATTR_WARN_UNUSED_RESULT;
 
uiBut *ui_list_find_mouse_over(const ARegion *region,
                               const wmEvent *event) ATTR_WARN_UNUSED_RESULT;
uiBut *ui_list_find_from_row(const ARegion *region, const uiBut *row_but) ATTR_WARN_UNUSED_RESULT;
uiBut *ui_list_row_find_mouse_over(const ARegion *region, const int xy[2])
    ATTR_NONNULL(1, 2) ATTR_WARN_UNUSED_RESULT;
uiBut *ui_list_row_find_index(const ARegion *region,
                              int index,
                              uiBut *listbox) ATTR_WARN_UNUSED_RESULT;
uiBut *ui_view_item_find_mouse_over(const ARegion *region, const int xy[2]) ATTR_NONNULL(1, 2);
uiBut *ui_view_item_find_active(const ARegion *region);
uiBut *ui_view_item_find_search_highlight(const ARegion *region);
 
using uiButFindPollFn = bool (*)(const uiBut *but, const void *customdata);
uiBut *ui_but_find_mouse_over_ex(const ARegion *region,
                                 const int xy[2],
                                 bool labeledit,
                                 bool for_tooltip,
                                 const uiButFindPollFn find_poll,
                                 const void *find_custom_data)
    ATTR_NONNULL(1, 2) ATTR_WARN_UNUSED_RESULT;
uiBut *ui_but_find_mouse_over(const ARegion *region, const wmEvent *event) ATTR_WARN_UNUSED_RESULT;
uiBut *ui_but_find_rect_over(const ARegion *region, const rcti *rect_px) ATTR_WARN_UNUSED_RESULT;
 
uiBut *ui_list_find_mouse_over_ex(const ARegion *region, const int xy[2])
    ATTR_NONNULL(1, 2) ATTR_WARN_UNUSED_RESULT;
 
bool ui_but_contains_password(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
 
blender::StringRef ui_but_drawstr_without_sep_char(const uiBut *but) ATTR_NONNULL();
size_t ui_but_drawstr_len_without_sep_char(const uiBut *but);
size_t ui_but_tip_len_only_first_line(const uiBut *but);
 
uiBut *ui_but_prev(uiBut *but) ATTR_WARN_UNUSED_RESULT;
uiBut *ui_but_next(uiBut *but) ATTR_WARN_UNUSED_RESULT;
uiBut *ui_but_first(uiBlock *block) ATTR_WARN_UNUSED_RESULT;
uiBut *ui_but_last(uiBlock *block) ATTR_WARN_UNUSED_RESULT;
 
uiBut *ui_block_active_but_get(const uiBlock *block);
bool ui_block_is_menu(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
bool ui_block_is_popover(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
bool ui_block_is_pie_menu(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
bool ui_block_is_popup_any(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
 
uiBlock *ui_block_find_mouse_over_ex(const ARegion *region, const int xy[2], bool only_clip)
    ATTR_NONNULL(1, 2);
uiBlock *ui_block_find_mouse_over(const ARegion *region, const wmEvent *event, bool only_clip);
 
uiBut *ui_region_find_first_but_test_flag(ARegion *region, int flag_include, int flag_exclude);
uiBut *ui_region_find_active_but(ARegion *region) ATTR_WARN_UNUSED_RESULT;
bool ui_region_contains_point_px(const ARegion *region, const int xy[2])
    ATTR_NONNULL(1, 2) ATTR_WARN_UNUSED_RESULT;
bool ui_region_contains_rect_px(const ARegion *region, const rcti *rect_px);

ARegion *ui_screen_region_find_mouse_over_ex(bScreen *screen, const int xy[2]) ATTR_NONNULL(1, 2);
ARegion *ui_screen_region_find_mouse_over(bScreen *screen, const wmEvent *event);
 
/* interface_context_menu.cc */
 
bool ui_popup_context_menu_for_button(bContext *C, uiBut *but, const wmEvent *event);
void ui_popup_context_menu_for_panel(bContext *C, ARegion *region, Panel *panel);
 
/* `interface_eyedropper.cc` */
 
wmKeyMap *eyedropper_modal_keymap(wmKeyConfig *keyconf);
wmKeyMap *eyedropper_colorband_modal_keymap(wmKeyConfig *keyconf);
 
/* interface_eyedropper_color.c */
 
void UI_OT_eyedropper_color(wmOperatorType *ot);
 
/* interface_eyedropper_colorband.c */
 
namespace blender::ui {
void UI_OT_eyedropper_colorramp(wmOperatorType *ot);
void UI_OT_eyedropper_colorramp_point(wmOperatorType *ot);
 
void UI_OT_eyedropper_bone(wmOperatorType *ot);
 
}  // namespace blender::ui
 
/* interface_eyedropper_datablock.c */
 
void UI_OT_eyedropper_id(wmOperatorType *ot);
 
/* interface_eyedropper_depth.c */
 
void UI_OT_eyedropper_depth(wmOperatorType *ot);
 
/* interface_eyedropper_driver.c */
 
void UI_OT_eyedropper_driver(wmOperatorType *ot);
 
/* eyedropper_grease_pencil_color.cc */
 
void UI_OT_eyedropper_grease_pencil_color(wmOperatorType *ot);
 
/* interface_template_asset_shelf_popover.cc */
std::optional<blender::StringRefNull> UI_asset_shelf_idname_from_button_context(const uiBut *but);
 
/* interface_template_asset_view.cc */
 
uiListType *UI_UL_asset_view();

struct uiRNACollectionSearch {
  PointerRNA target_ptr;
  PropertyRNA *target_prop;
 
  PointerRNA search_ptr;
  PropertyRNA *search_prop;
 
  uiBut *search_but;
  /* Let UI_butstore_ API update search_but pointer above over redraws. */
  uiButStore *butstore;
  /* Block has to be stored for freeing butstore (uiBut.block doesn't work with undo). */
  uiBlock *butstore_block;
};
void ui_rna_collection_search_update_fn(
    const bContext *C, void *arg, const char *str, uiSearchItems *items, bool is_first);
 
/* `interface_ops.cc` */
 
bool ui_jump_to_target_button_poll(bContext *C);
 
/* interface_queries.c */
 
void ui_interface_tag_script_reload_queries();
 
/* interface_view.cc */
 
void ui_block_free_views(uiBlock *block);
void ui_block_views_bounds_calc(const uiBlock *block);
void ui_block_views_listen(const uiBlock *block, const wmRegionListenerParams *listener_params);
void ui_block_views_draw_overlays(const ARegion *region, const uiBlock *block);
blender::ui::AbstractView *ui_block_view_find_matching_in_old_block(
    const uiBlock &new_block, const blender::ui::AbstractView &new_view);
 
uiButViewItem *ui_block_view_find_matching_view_item_but_in_old_block(
    const uiBlock &new_block, const blender::ui::AbstractViewItem &new_item);
 
/* abstract_view_item.cc */
 
void ui_view_item_swap_button_pointers(blender::ui::AbstractViewItem &a,
                                       blender::ui::AbstractViewItem &b);
 
/* interface_templates.cc */
 
uiListType *UI_UL_cache_file_layers();
 
ID *ui_template_id_liboverride_hierarchy_make(
    bContext *C, Main *bmain, ID *owner_id, ID *id, const char **r_undo_push_label);
 
/* Functions in this namespace are only exposed for unit testing purposes, and
 * should not be used outside of the files where they are defined. */
namespace blender::interface::internal {

blender::Vector<FCurve *> get_property_drivers(
    PointerRNA *ptr, PropertyRNA *prop, bool get_all, int index, bool *r_is_array_prop);

int paste_property_drivers(blender::Span<FCurve *> src_drivers,
                           bool is_array_prop,
                           PointerRNA *dst_ptr,
                           PropertyRNA *dst_prop);
 
}  // namespace blender::interface::internal