/* SPDX-License-Identifier: GPL-2.0-or-later * Copyright 2001-2002 NaN Holding BV. All rights reserved. */ /** \file * \ingroup edinterface */ #pragma once #include "BLI_compiler_attrs.h" #include "BLI_rect.h" #include "DNA_listBase.h" #include "RNA_types.h" #include "UI_interface.h" #include "UI_resources.h" #ifdef __cplusplus extern "C" { #endif struct ARegion; struct AnimationEvalContext; struct CurveMapping; struct CurveProfile; struct IconTextOverlay; struct ID; struct ImBuf; struct Main; struct Scene; struct bContext; struct bContextStore; struct uiHandleButtonData; struct uiLayout; struct uiStyle; struct uiUndoStack_Text; struct uiWidgetColors; 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) /** Some extra padding added to menus containing sub-menu icons. */ #define UI_MENU_SUBMENU_PADDING (6 * UI_DPI_FAC) /* menu scrolling */ #define UI_MENU_SCROLL_ARROW (12 * UI_DPI_FAC) #define UI_MENU_SCROLL_MOUSE (UI_MENU_SCROLL_ARROW + 2 * UI_DPI_FAC) #define UI_MENU_SCROLL_PAD (4 * UI_DPI_FAC) /* panel limits */ #define UI_PANEL_MINX 100 #define UI_PANEL_MINY 70 /** Popover width (multiplied by #U.widget_unit) */ #define UI_POPOVER_WIDTH_UNITS 10 /** #uiBut.flag */ enum { /** Use when the button is pressed. */ UI_SELECT = (1 << 0), /** Temporarily hidden (scrolled out of the view). */ UI_SCROLLED = (1 << 1), UI_ACTIVE = (1 << 2), UI_HAS_ICON = (1 << 3), UI_HIDDEN = (1 << 4), /** Display selected, doesn't impact interaction. */ UI_SELECT_DRAW = (1 << 5), /** Property search filter is active and the button does not match. */ UI_SEARCH_FILTER_NO_MATCH = (1 << 6), /** Temporarily override the active button for lookups in context, regions, etc. (everything * using #ui_context_button_active()). For example, so that operators normally acting on the * active button can be polled on non-active buttons to (e.g. for disabling). */ UI_BUT_ACTIVE_OVERRIDE = (1 << 7), /* WARNING: rest of #uiBut.flag in UI_interface.h */ }; /** #uiBut.dragflag */ enum { UI_BUT_DRAGPOIN_FREE = (1 << 0), }; /** #uiBut.pie_dir */ typedef 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, } RadialDirection; 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)) /** Split number-buttons by ':' and align left/right. */ #define USE_NUMBUTS_LR_ALIGN /** Use new 'align' computation code. */ #define USE_UIBUT_SPATIAL_ALIGN /** #PieMenuData.flags */ enum { /** Pie menu item collision is detected at 90 degrees. */ UI_PIE_DEGREES_RANGE_LARGE = (1 << 0), /** Use initial center of pie menu to calculate direction. */ UI_PIE_INITIAL_DIRECTION = (1 << 1), /** Pie menu is drag style. */ UI_PIE_DRAG_STYLE = (1 << 2), /** Mouse not far enough from center position. */ UI_PIE_INVALID_DIR = (1 << 3), /** Pie menu changed to click style, click to confirm. */ UI_PIE_CLICK_STYLE = (1 << 4), /** Pie animation finished, do not calculate any more motion. */ UI_PIE_ANIMATION_FINISHED = (1 << 5), /** Pie gesture selection has been done, now wait for mouse motion to end. */ UI_PIE_GESTURE_END_WAIT = (1 << 6), }; #define PIE_CLICK_THRESHOLD_SQ 50.0f /** The maximum number of items a radial menu (pie menu) can contain. */ #define PIE_MAX_ITEMS 8 struct uiBut { struct uiBut *next, *prev; /** Pointer back to the layout item holding this button. */ uiLayout *layout; int flag, drawflag; eButType type; eButPointerType pointype; short bit, bitnr, retval, strwidth, alignnr; short ofs, pos, selsta, selend; char *str; char strdata[UI_MAX_NAME_STR]; char drawstr[UI_MAX_DRAW_STR]; rctf rect; /* block relative coords */ char *poin; float hardmin, hardmax, softmin, softmax; /* both these values use depends on the button type * (polymorphic struct or union would be nicer for this stuff) */ /** * For #uiBut.type: * - UI_BTYPE_LABEL: Use `(a1 == 1.0f)` to use a2 as a blending factor (imaginative!). * - UI_BTYPE_SCROLL: Use as scroll size. * - UI_BTYPE_SEARCH_MENU: Use as number or rows. */ float a1; /** * For #uiBut.type: * - UI_BTYPE_HSVCIRCLE: Use to store the luminosity. * - UI_BTYPE_LABEL: If `(a1 == 1.0f)` use a2 as a blending factor. * - UI_BTYPE_SEARCH_MENU: Use as number or columns. */ float a2; uchar col[4]; /** See \ref UI_but_func_identity_compare_set(). */ uiButIdentityCompareFunc identity_cmp_func; uiButHandleFunc func; void *func_arg1; void *func_arg2; uiButHandleNFunc funcN; void *func_argN; struct bContextStore *context; uiButCompleteFunc autocomplete_func; void *autofunc_arg; uiButHandleRenameFunc rename_func; void *rename_arg1; void *rename_orig; /** Run an action when holding the button down. */ uiButHandleHoldFunc hold_func; void *hold_argN; const char *tip; uiButToolTipFunc tip_func; void *tip_arg; uiFreeArgFunc tip_arg_free; /** info on why button is disabled, displayed in tooltip */ const char *disabled_info; BIFIconID icon; /** Copied from the #uiBlock.emboss */ eUIEmbossType emboss; /** direction in a pie menu, used for collision detection. */ RadialDirection pie_dir; /** could be made into a single flag */ bool changed; /** so buttons can support unit systems which are not RNA */ uchar unit_type; short iconadd; /** #UI_BTYPE_BLOCK data */ uiBlockCreateFunc block_create_func; /** #UI_BTYPE_PULLDOWN / #UI_BTYPE_MENU data */ uiMenuCreateFunc menu_create_func; uiMenuStepFunc menu_step_func; /* RNA data */ struct PointerRNA rnapoin; struct PropertyRNA *rnaprop; int rnaindex; /* Operator data */ struct wmOperatorType *optype; struct PointerRNA *opptr; wmOperatorCallContext opcontext; /** When non-zero, this is the key used to activate a menu items (`a-z` always lower case). */ uchar menu_key; ListBase extra_op_icons; /** #uiButExtraOpIcon */ /* Drag-able data, type is WM_DRAG_... */ char dragtype; short dragflag; void *dragpoin; struct ImBuf *imb; float imb_scale; /** Active button data (set when the user is hovering or interacting with a button). */ struct uiHandleButtonData *active; /** Custom button data (borrowed, not owned). */ void *custom_data; char *editstr; double *editval; float *editvec; uiButPushedStateFunc pushed_state_func; const void *pushed_state_arg; /** Little indicator (e.g., counter) displayed on top of some icons. */ struct IconTextOverlay icon_overlay_text; /* pointer back */ uiBlock *block; }; /** Derived struct for #UI_BTYPE_NUM */ typedef struct uiButNumber { uiBut but; float step_size; float precision; } uiButNumber; /** Derived struct for #UI_BTYPE_COLOR */ typedef struct uiButColor { uiBut but; bool is_pallete_color; int palette_color_index; } uiButColor; /** Derived struct for #UI_BTYPE_TAB */ typedef struct uiButTab { uiBut but; struct MenuType *menu; } uiButTab; /** Derived struct for #UI_BTYPE_SEARCH_MENU */ typedef struct uiButSearch { uiBut but; uiButSearchCreateFn popup_create_fn; uiButSearchUpdateFn items_update_fn; uiButSearchListenFn listen_fn; void *item_active; void *arg; uiFreeArgFunc arg_free_fn; uiButSearchContextMenuFn item_context_menu_fn; uiButSearchTooltipFn item_tooltip_fn; const char *item_sep_string; struct PointerRNA rnasearchpoin; struct PropertyRNA *rnasearchprop; /** * The search box only provides suggestions, it does not force * the string to match one of the search items when applying. */ bool results_are_suggestions; } uiButSearch; /** Derived struct for #UI_BTYPE_DECORATOR */ typedef struct uiButDecorator { uiBut but; struct PointerRNA rnapoin; struct PropertyRNA *rnaprop; int rnaindex; } uiButDecorator; /** Derived struct for #UI_BTYPE_PROGRESS_BAR. */ typedef struct uiButProgressbar { uiBut but; /* 0..1 range */ float progress; } uiButProgressbar; typedef struct uiButViewItem { uiBut but; /* C-Handle to the view item this button was created for. */ uiViewItemHandle *view_item; } uiButViewItem; /** Derived struct for #UI_BTYPE_HSVCUBE. */ typedef struct uiButHSVCube { uiBut but; eButGradientType gradient_type; } uiButHSVCube; /** Derived struct for #UI_BTYPE_COLORBAND. */ typedef struct uiButColorBand { uiBut but; struct ColorBand *edit_coba; } uiButColorBand; /** Derived struct for #UI_BTYPE_CURVEPROFILE. */ typedef struct uiButCurveProfile { uiBut but; struct CurveProfile *edit_profile; } uiButCurveProfile; /** Derived struct for #UI_BTYPE_CURVE. */ typedef struct uiButCurveMapping { uiBut but; struct CurveMapping *edit_cumap; eButGradientType gradient_type; } uiButCurveMapping; /** Derived struct for #UI_BTYPE_HOTKEY_EVENT. */ typedef struct uiButHotkeyEvent { uiBut but; short modifier_key; } uiButHotkeyEvent; /** * Additional, superimposed icon for a button, invoking an operator. */ typedef struct uiButExtraOpIcon { struct uiButExtraOpIcon *next, *prev; BIFIconID icon; struct wmOperatorCallParams *optype_params; bool highlighted; bool disabled; } uiButExtraOpIcon; typedef struct ColorPicker { struct ColorPicker *next, *prev; /** Color in HSV or HSL, in color picking color space. Used for HSV cube, * circle and slider widgets. The color picking space is perceptually * linear for intuitive editing. */ float hsv_perceptual[3]; /** Initial color data (to detect changes). */ float hsv_perceptual_init[3]; bool is_init; /** HSV or HSL color in scene linear color space value used for number * buttons. This is scene linear so that there is a clear correspondence * to the scene linear RGB values. */ float hsv_scene_linear[3]; /** Cubic saturation for the color wheel. */ bool use_color_cubic; bool use_color_lock; bool use_luminosity_lock; float luminosity_lock_value; } ColorPicker; typedef struct ColorPickerData { ListBase list; } ColorPickerData; struct PieMenuData { /** store title and icon to allow access when pie levels are created */ const char *title; int icon; float pie_dir[2]; float pie_center_init[2]; float pie_center_spawned[2]; float last_pos[2]; double duration_gesture; int flags; /** Initial event used to fire the pie menu, store here so we can query for release */ short event_type; float alphafac; }; /** #uiBlock.content_hints */ enum eBlockContentHints { /** In a menu block, if there is a single sub-menu button, we add some * padding to the right to put nicely aligned triangle icons there. */ UI_BLOCK_CONTAINS_SUBMENU_BUT = (1 << 0), }; /** * A group of button references, used by property search to keep track of sets of buttons that * should be searched together. For example, in property split layouts number buttons and their * labels (and even their decorators) are separate buttons, but they must be searched and * highlighted together. */ typedef struct uiButtonGroup { void *next, *prev; ListBase buttons; /* #LinkData with #uiBut data field. */ short flag; } uiButtonGroup; /* #uiButtonGroup.flag. */ typedef enum uiButtonGroupFlag { /** While this flag is set, don't create new button groups for layout item calls. */ UI_BUTTON_GROUP_LOCK = (1 << 0), /** The buttons in this group are inside a panel header. */ UI_BUTTON_GROUP_PANEL_HEADER = (1 << 1), } uiButtonGroupFlag; ENUM_OPERATORS(uiButtonGroupFlag, UI_BUTTON_GROUP_PANEL_HEADER); typedef struct uiBlockDynamicListener { struct uiBlockDynamicListener *next, *prev; void (*listener_func)(const struct wmRegionListenerParams *params); } uiBlockDynamicListener; struct uiBlock { uiBlock *next, *prev; ListBase buttons; struct Panel *panel; uiBlock *oldblock; /** Used for `UI_butstore_*` runtime function. */ ListBase butstore; ListBase button_groups; /* #uiButtonGroup. */ ListBase layouts; struct uiLayout *curlayout; ListBase contexts; /** A block can store "views" on data-sets. Currently tree-views (#AbstractTreeView) only. * Others are imaginable, e.g. table-views, grid-views, etc. These are stored here to support * state that is persistent over redraws (e.g. collapsed tree-view items). */ ListBase views; ListBase dynamic_listeners; /* #uiBlockDynamicListener */ char name[UI_MAX_NAME_STR]; float winmat[4][4]; rctf rect; float aspect; /** Unique hash used to implement popup menu memory. */ uint puphash; uiButHandleFunc func; void *func_arg1; void *func_arg2; uiButHandleNFunc funcN; void *func_argN; uiMenuHandleFunc butm_func; void *butm_func_arg; uiBlockHandleFunc handle_func; void *handle_func_arg; /** Custom interaction data. */ uiBlockInteraction_CallbackData custom_interaction_callbacks; /** Custom extra event handling. */ int (*block_event_func)(const struct bContext *C, struct uiBlock *, const struct wmEvent *); /** Custom extra draw function for custom blocks. */ void (*drawextra)(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect); void *drawextra_arg1; void *drawextra_arg2; int flag; short alignnr; /** Hints about the buttons of this block. Used to avoid iterating over * buttons to find out if some criteria is met by any. Instead, check this * criteria when adding the button and set a flag here if it's met. */ short content_hints; /* #eBlockContentHints */ char direction; /** UI_BLOCK_THEME_STYLE_* */ char theme_style; /** Copied to #uiBut.emboss */ eUIEmbossType emboss; bool auto_open; char _pad[5]; double auto_open_last; const char *lockstr; bool lock; /** To keep blocks while drawing and free them afterwards. */ bool active; /** To avoid tool-tip after click. */ bool tooltipdisabled; /** True when #UI_block_end has been called. */ bool endblock; /** for doing delayed */ eBlockBoundsCalc bounds_type; /** Offset to use when calculating bounds (in pixels). */ int bounds_offset[2]; /** for doing delayed */ int bounds, minbounds; /** Pull-downs, to detect outside, can differ per case how it is created. */ rctf safety; /** #uiSafetyRct list */ ListBase saferct; uiPopupBlockHandle *handle; /** use so presets can find the operator, * across menus and from nested popups which fail for operator context. */ struct wmOperator *ui_operator; /** XXX hack for dynamic operator enums */ void *evil_C; /** unit system, used a lot for numeric buttons so include here * rather than fetching through the scene every time. */ struct UnitSettings *unit; /** \note only accessed by color picker templates. */ ColorPickerData color_pickers; /** Block for color picker with gamma baked in. */ bool is_color_gamma_picker; /** * Display device name used to display this block, * used by color widgets to transform colors from/to scene linear. */ char display_device[64]; struct PieMenuData pie_data; }; typedef struct uiSafetyRct { struct uiSafetyRct *next, *prev; rctf parent; rctf safety; } uiSafetyRct; /* interface.c */ void ui_fontscale(float *points, float aspect); extern void ui_block_to_region_fl(const struct ARegion *region, uiBlock *block, float *r_x, float *r_y); extern void ui_block_to_window_fl(const struct ARegion *region, uiBlock *block, float *x, float *y); extern void ui_block_to_window(const struct ARegion *region, uiBlock *block, int *x, int *y); extern void ui_block_to_region_rctf(const struct ARegion *region, uiBlock *block, rctf *rct_dst, const rctf *rct_src); extern void ui_block_to_window_rctf(const struct ARegion *region, uiBlock *block, rctf *rct_dst, const rctf *rct_src); extern float ui_block_to_window_scale(const struct ARegion *region, uiBlock *block); /** * For mouse cursor. */ extern void ui_window_to_block_fl(const struct ARegion *region, uiBlock *block, float *x, float *y); extern void ui_window_to_block(const struct ARegion *region, uiBlock *block, int *x, int *y); extern void ui_window_to_block_rctf(const struct ARegion *region, uiBlock *block, rctf *rct_dst, const rctf *rct_src); extern void ui_window_to_region(const struct ARegion *region, int *x, int *y); extern void ui_window_to_region_rcti(const struct ARegion *region, rcti *rect_dst, const rcti *rct_src); extern void ui_window_to_region_rctf(const struct ARegion *region, rctf *rect_dst, const rctf *rct_src); extern void ui_region_to_window(const struct ARegion *region, int *x, int *y); /** * Popups will add a margin to #ARegion.winrct for shadow, * for interactivity (point-inside tests for eg), we want the winrct without the margin added. */ extern void ui_region_winrct_get_no_margin(const struct ARegion *region, struct rcti *r_rect); /** * Reallocate the button (new address is returned) for a new button type. * This should generally be avoided and instead the correct type be created right away. * * \note Only the #uiBut data can be kept. If the old button used a derived type (e.g. #uiButTab), * the data that is not inside #uiBut will be lost. */ uiBut *ui_but_change_type(uiBut *but, eButType new_type); extern double ui_but_value_get(uiBut *but); extern void ui_but_value_set(uiBut *but, double value); /** * For picker, while editing HSV. */ extern void ui_but_hsv_set(uiBut *but); /** * For buttons pointing to color for example. */ extern void ui_but_v3_get(uiBut *but, float vec[3]); /** * For buttons pointing to color for example. */ extern void ui_but_v3_set(uiBut *but, const float vec[3]); extern void ui_hsvcircle_vals_from_pos( const rcti *rect, float mx, float my, float *r_val_rad, float *r_val_dist); /** * Cursor in HSV circle, in float units -1 to 1, to map on radius. */ extern void ui_hsvcircle_pos_from_vals( const ColorPicker *cpicker, const rcti *rect, const float *hsv, float *xpos, float *ypos); extern void ui_hsvcube_pos_from_vals( const struct uiButHSVCube *hsv_but, const rcti *rect, const float *hsv, float *xp, float *yp); /** * \param float_precision: For number buttons the precision * to use or -1 to fallback to the button default. * \param use_exp_float: Use exponent representation of floats * when out of reasonable range (outside of 1e3/1e-3). */ extern void ui_but_string_get_ex(uiBut *but, char *str, size_t maxlen, int float_precision, bool use_exp_float, bool *r_use_exp_float) ATTR_NONNULL(1, 2); extern void ui_but_string_get(uiBut *but, char *str, size_t maxlen) ATTR_NONNULL(); /** * A version of #ui_but_string_get_ex for dynamic buffer sizes * (where #ui_but_string_get_max_length returns 0). * * \param r_str_size: size of the returned string (including terminator). */ extern char *ui_but_string_get_dynamic(uiBut *but, int *r_str_size); /** * \param str: will be overwritten. */ extern void ui_but_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen) ATTR_NONNULL(); extern bool ui_but_string_set(struct bContext *C, uiBut *but, const char *str) ATTR_NONNULL(); extern bool ui_but_string_eval_number(struct bContext *C, const uiBut *but, const char *str, double *value) ATTR_NONNULL(); extern int ui_but_string_get_max_length(uiBut *but); /** * Clear & exit the active button's string.. */ extern void ui_but_active_string_clear_and_exit(struct bContext *C, uiBut *but) ATTR_NONNULL(); /** * Use handling code to set a string for the button. Handles the case where the string is set for a * search button while the search menu is open, so the results are updated accordingly. * This is basically the same as pasting the string into the button. */ extern void ui_but_set_string_interactive(struct bContext *C, uiBut *but, const char *value); extern uiBut *ui_but_drag_multi_edit_get(uiBut *but); void ui_def_but_icon(uiBut *but, int icon, int flag); /** * Avoid using this where possible since it's better not to ask for an icon in the first place. */ void ui_def_but_icon_clear(uiBut *but); void ui_but_extra_operator_icons_free(uiBut *but); extern void ui_but_rna_menu_convert_to_panel_type(struct uiBut *but, const char *panel_type); extern void ui_but_rna_menu_convert_to_menu_type(struct uiBut *but, const char *menu_type); extern 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(struct bContext *C, struct wmOperatorType *ot, const uiBut *but); /** * Check if the operator \a ot poll is successful with the context given by \a but (optionally). * \param but: The button that might store context. Can be NULL for convenience (e.g. if there is * no button to take context from, but we still want to poll the operator). */ bool ui_but_context_poll_operator_ex(struct bContext *C, const uiBut *but, const struct wmOperatorCallParams *optype_params); extern void ui_but_update(uiBut *but); extern void ui_but_update_edited(uiBut *but); extern PropertyScaleType ui_but_scale_type(const uiBut *but) ATTR_WARN_UNUSED_RESULT; extern bool ui_but_is_float(const uiBut *but) ATTR_WARN_UNUSED_RESULT; extern bool ui_but_is_bool(const uiBut *but) ATTR_WARN_UNUSED_RESULT; extern bool ui_but_is_unit(const uiBut *but) ATTR_WARN_UNUSED_RESULT; /** * Check if this button is similar enough to be grouped with another. */ extern bool ui_but_is_compatible(const uiBut *but_a, const uiBut *but_b) ATTR_WARN_UNUSED_RESULT; extern bool ui_but_is_rna_valid(uiBut *but) ATTR_WARN_UNUSED_RESULT; /** * Checks if the button supports cycling next/previous menu items (ctrl+mouse-wheel). */ extern bool ui_but_supports_cycling(const uiBut *but) ATTR_WARN_UNUSED_RESULT; /** * Check if the button is pushed, this is only meaningful for some button types. * * \return (0 == UNSELECT), (1 == SELECT), (-1 == DO-NOTHING) */ extern int ui_but_is_pushed_ex(uiBut *but, double *value) ATTR_WARN_UNUSED_RESULT; extern int ui_but_is_pushed(uiBut *but) ATTR_WARN_UNUSED_RESULT; void ui_but_override_flag(struct Main *bmain, uiBut *but); extern void ui_block_bounds_calc(uiBlock *block); extern struct ColorManagedDisplay *ui_block_cm_display_get(uiBlock *block); void ui_block_cm_to_display_space_v3(uiBlock *block, float pixel[3]); /* interface_regions.c */ struct uiKeyNavLock { /** Set when we're using keyboard-input. */ bool is_keynav; /** Only used to check if we've moved the cursor. */ int event_xy[2]; }; typedef uiBlock *(*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1); struct uiPopupBlockCreate { uiBlockCreateFunc create_func; uiBlockHandleCreateFunc handle_create_func; void *arg; uiFreeArgFunc arg_free; int event_xy[2]; /** Set when popup is initialized from a button. */ struct ARegion *butregion; uiBut *but; }; struct uiPopupBlockHandle { /* internal */ struct ARegion *region; /** Use only for #UI_BLOCK_MOVEMOUSE_QUIT popups. */ float towards_xy[2]; double towardstime; bool dotowards; bool popup; void (*popup_func)(struct bContext *C, void *arg, int event); void (*cancel_func)(struct bContext *C, void *arg); void *popup_arg; /** Store data for refreshing popups. */ struct uiPopupBlockCreate popup_create_vars; /** True if we can re-create the popup using #uiPopupBlockHandle.popup_create_vars. */ bool can_refresh; bool refresh; struct wmTimer *scrolltimer; float scrolloffset; struct uiKeyNavLock keynav_state; /* for operator popups */ struct wmOperator *popup_op; struct ScrArea *ctx_area; struct ARegion *ctx_region; /* return values */ int butretval; int menuretval; int retvalue; float retvec[4]; /** Menu direction. */ 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 */ }; /* -------------------------------------------------------------------- */ /* interface_region_*.c */ /* interface_region_tooltip.c */ /* exposed as public API in UI_interface.h */ /* interface_region_color_picker.c */ 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]); /** * Returns true if the button is for a color with gamma baked in, * or if it's a color picker for such a button. */ bool ui_but_is_color_gamma(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(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but); ColorPicker *ui_block_colorpicker_create(struct uiBlock *block); /* interface_region_search.c */ /** * Search-box for string button. */ struct ARegion *ui_searchbox_create_generic(struct bContext *C, struct ARegion *butregion, uiButSearch *search_but); struct ARegion *ui_searchbox_create_operator(struct bContext *C, struct ARegion *butregion, uiButSearch *search_but); struct ARegion *ui_searchbox_create_menu(struct bContext *C, struct ARegion *butregion, uiButSearch *search_but); /** * x and y in screen-coords. */ bool ui_searchbox_inside(struct ARegion *region, const int xy[2]) ATTR_NONNULL(1, 2); int ui_searchbox_find_index(struct ARegion *region, const char *name); /** * Region is the search box itself. */ void ui_searchbox_update(struct bContext *C, struct ARegion *region, uiBut *but, bool reset); int ui_searchbox_autocomplete(struct bContext *C, struct ARegion *region, uiBut *but, char *str); bool ui_searchbox_event(struct bContext *C, struct ARegion *region, uiBut *but, struct ARegion *butregion, const struct wmEvent *event); /** * String validated to be of correct length (but->hardmax). */ bool ui_searchbox_apply(uiBut *but, struct ARegion *region); void ui_searchbox_free(struct bContext *C, struct ARegion *region); /** * XXX weak: search_func adds all partial matches. */ void ui_but_search_refresh(uiButSearch *but); /* interface_region_menu_popup.c */ int ui_but_menu_step(uiBut *but, int direction); bool ui_but_menu_step_poll(const uiBut *but); uiBut *ui_popup_menu_memory_get(struct uiBlock *block); void ui_popup_menu_memory_set(uiBlock *block, struct uiBut *but); /** * Called for creating new popups and refreshing existing ones. */ uiBlock *ui_popup_block_refresh(struct bContext *C, uiPopupBlockHandle *handle, struct ARegion *butregion, uiBut *but); uiPopupBlockHandle *ui_popup_block_create(struct bContext *C, struct ARegion *butregion, uiBut *but, uiBlockCreateFunc create_func, uiBlockHandleCreateFunc handle_create_func, void *arg, uiFreeArgFunc arg_free); uiPopupBlockHandle *ui_popup_menu_create(struct bContext *C, struct ARegion *butregion, uiBut *but, uiMenuCreateFunc menu_func, void *arg); /* interface_region_popover.c */ uiPopupBlockHandle *ui_popover_panel_create(struct bContext *C, struct ARegion *butregion, uiBut *but, uiMenuCreateFunc menu_func, void *arg); /* interface_region_menu_pie.c */ /** * Set up data for defining a new pie menu level and add button that invokes it. */ void ui_pie_menu_level_create(uiBlock *block, struct wmOperatorType *ot, const char *propname, struct IDProperty *properties, const EnumPropertyItem *items, int totitem, wmOperatorCallContext context, wmOperatorCallContext flag); /* interface_region_popup.c */ /** * Translate any popup regions (so we can drag them). */ void ui_popup_translate(struct ARegion *region, const int mdiff[2]); void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle); void ui_popup_block_scrolltest(struct uiBlock *block); /* end interface_region_*.c */ /* interface_panel.c */ /** * Handle region panel events like opening and closing panels, changing categories, etc. * * \note Could become a modal key-map. */ extern int ui_handler_panel_region(struct bContext *C, const struct wmEvent *event, struct ARegion *region, const uiBut *active_but); /** * Draw a panel integrated in buttons-window, tool/property lists etc. */ extern void ui_draw_aligned_panel(const struct uiStyle *style, const uiBlock *block, const rcti *rect, bool show_pin, bool show_background, bool region_search_filter_active); void ui_panel_tag_search_filter_match(struct Panel *panel); /* interface_draw.c */ extern void ui_draw_dropshadow( const rctf *rct, float radius, float aspect, float alpha, int select); /** * Draws in resolution of 48x4 colors. */ void ui_draw_gradient(const rcti *rect, const float hsv[3], eButGradientType type, float alpha); /* 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(struct ARegion *region, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect); void ui_draw_but_WAVEFORM(struct ARegion *region, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect); void ui_draw_but_VECTORSCOPE(struct ARegion *region, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect); void ui_draw_but_COLORBAND(uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect); void ui_draw_but_UNITVEC(uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect, float radius); void ui_draw_but_CURVE(struct ARegion *region, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect); /** * Draws the curve profile widget. Somewhat similar to ui_draw_but_CURVE. */ void ui_draw_but_CURVEPROFILE(struct ARegion *region, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect); void ui_draw_but_IMAGE(struct ARegion *region, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect); void ui_draw_but_TRACKPREVIEW(struct ARegion *region, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect); /* interface_undo.c */ /** * Start the undo stack. * * \note The current state should be pushed immediately after calling this. */ struct uiUndoStack_Text *ui_textedit_undo_stack_create(void); void ui_textedit_undo_stack_destroy(struct uiUndoStack_Text *undo_stack); /** * Push the information in the arguments to a new state in the undo stack. * * \note Currently the total length of the undo stack is not limited. */ void ui_textedit_undo_push(struct uiUndoStack_Text *undo_stack, const char *text, int cursor_index); const char *ui_textedit_undo(struct uiUndoStack_Text *undo_stack, int direction, int *r_cursor_index); /* interface_handlers.c */ extern void ui_handle_afterfunc_add_operator(struct wmOperatorType *ot, wmOperatorCallContext opcontext); /** * Assumes event type is MOUSEPAN. */ extern void ui_pan_to_scroll(const struct wmEvent *event, int *type, int *val); /** * Exported to interface.c: #UI_but_active_only() * \note The region is only for the button. * The context needs to be set by the caller. */ extern void ui_but_activate_event(struct bContext *C, struct ARegion *region, uiBut *but); /** * Simulate moving the mouse over a button (or navigating to it with arrow keys). * * exported so menus can start with a highlighted button, * even if the mouse isn't over it */ extern void ui_but_activate_over(struct bContext *C, struct ARegion *region, uiBut *but); extern void ui_but_execute_begin(struct bContext *C, struct ARegion *region, uiBut *but, void **active_back); extern void ui_but_execute_end(struct bContext *C, struct ARegion *region, uiBut *but, void *active_back); extern void ui_but_active_free(const struct bContext *C, uiBut *but); /** * In some cases we may want to update the view (#View2D) in-between layout definition and drawing. * E.g. to make sure a button is visible while editing. */ extern void ui_but_update_view_for_active(const struct bContext *C, const uiBlock *block); extern int ui_but_menu_direction(uiBut *but); extern void ui_but_text_password_hide(char password_str[128], uiBut *but, bool restore); /** * Finds the pressed button in an aligned row (typically an expanded enum). * * \param direction: Use when there may be multiple buttons pressed. */ extern 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(struct 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(void); 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); struct wmIMEData *ui_but_ime_data_get(uiBut *but); #endif /* interface_widgets.c */ /* Widget shader parameters, must match the shader layout. */ typedef 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]; } uiWidgetBaseParameters; enum { ROUNDBOX_TRIA_NONE = 0, ROUNDBOX_TRIA_ARROWS, ROUNDBOX_TRIA_SCROLL, ROUNDBOX_TRIA_MENU, ROUNDBOX_TRIA_CHECK, ROUNDBOX_TRIA_HOLD_ACTION_ARROW, ROUNDBOX_TRIA_MAX, /* don't use */ }; struct GPUBatch *ui_batch_roundbox_widget_get(void); struct GPUBatch *ui_batch_roundbox_shadow_get(void); void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect); void ui_draw_popover_back(struct ARegion *region, struct uiStyle *style, uiBlock *block, rcti *rect); void ui_draw_pie_center(uiBlock *block); const struct uiWidgetColors *ui_tooltip_get_theme(void); 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 struct uiStyle *style, uiBlock *block, rcti *rect); /** * Conversion from old to new buttons, so still messy. */ extern void ui_draw_but(const struct bContext *C, struct ARegion *region, struct uiStyle *style, uiBut *but, rcti *rect); /** * Info about what the separator character separates, used to decide between different drawing * styles. E.g. we never want a shortcut string to be clipped, but other hint strings can be * clipped. */ typedef enum { UI_MENU_ITEM_SEPARATOR_NONE, /** Separator is used to indicate shortcut string of this item. Shortcut string will not get * clipped. */ UI_MENU_ITEM_SEPARATOR_SHORTCUT, /** Separator is used to indicate some additional hint to display for this item. Hint string will * get clipped before the normal text. */ UI_MENU_ITEM_SEPARATOR_HINT, } uiMenuItemSeparatorType; /** * Helper call to draw a menu item without a button. * * \param but_flag: Button flags (#uiBut.flag) indicating the state of the item, typically * #UI_ACTIVE, #UI_BUT_DISABLED, #UI_BUT_INACTIVE. * \param separator_type: The kind of separator which controls if and how the string is clipped. * \param r_xmax: The right hand position of the text, this takes into the icon, padding and text * clipping when there is not enough room to display the full text. */ void ui_draw_menu_item(const struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int but_flag, uiMenuItemSeparatorType separator_type, int *r_xmax); void ui_draw_preview_item(const struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int but_flag, eFontStyle_Align text_align); /** * Version of #ui_draw_preview_item() that does not draw the menu background and item text based on * state. It just draws the preview and text directly. */ void ui_draw_preview_item_stateless(const struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, const uchar text_col[4], eFontStyle_Align text_align); #define UI_TEXT_MARGIN_X 0.4f #define UI_POPUP_MARGIN (UI_DPI_FAC * 12) /** * Margin at top of screen for popups. * Note this value must be sufficient to draw a popover arrow to avoid cropping it. */ #define UI_POPUP_MENU_TOP (int)(10 * UI_DPI_FAC) #define UI_PIXEL_AA_JITTER 8 extern const float ui_pixel_jitter[UI_PIXEL_AA_JITTER][2]; /* interface_style.c */ /** * Called on each startup.blend read, * reading without #uiFont will create one. */ void uiStyleInit(void); /* interface_icons.c */ void ui_icon_ensure_deferred(const struct bContext *C, int icon_id, bool big); int ui_id_icon_get(const struct bContext *C, struct ID *id, bool big); /* interface_icons_event.c */ void icon_draw_rect_input( float x, float y, int w, int h, float alpha, short event_type, short event_value); /* resources.c */ void ui_resources_init(void); void ui_resources_free(void); /* interface_layout.c */ void ui_layout_add_but(uiLayout *layout, uiBut *but); void ui_layout_remove_but(uiLayout *layout, const uiBut *but); /** * \return true if the button was successfully replaced. */ bool ui_layout_replace_but_ptr(uiLayout *layout, const void *old_but_ptr, uiBut *new_but); /** * \note May reallocate \a but, so the possibly new address is returned. May also override the * #UI_BUT_DISABLED flag depending on if a search pointer-property pair was provided/found. */ uiBut *ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop, bool results_are_suggestions); /** * Check all buttons defined in this layout, * and set any button flagged as UI_BUT_LIST_ITEM as active/selected. * Needed to handle correctly text colors of active (selected) list item. */ void ui_layout_list_set_labels_active(uiLayout *layout); /* menu callback */ void ui_item_menutype_func(struct bContext *C, struct uiLayout *layout, void *arg_mt); void ui_item_paneltype_func(struct bContext *C, struct uiLayout *layout, void *arg_pt); /* interface_button_group.c */ /** * Every function that adds a set of buttons must create another group, * then #ui_def_but adds buttons to the current group (the last). */ 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 void *old_but_ptr, uiBut *new_but); void ui_block_free_button_groups(uiBlock *block); /* interface_drag.cc */ void ui_but_drag_free(uiBut *but); bool ui_but_drag_is_draggable(const uiBut *but); void ui_but_drag_start(struct bContext *C, uiBut *but); /* interface_align.c */ bool ui_but_can_align(const uiBut *but) ATTR_WARN_UNUSED_RESULT; int ui_but_align_opposite_to_area_align_get(const struct ARegion *region) ATTR_WARN_UNUSED_RESULT; /** * Compute the alignment of all 'align groups' of buttons in given block. * * This is using an order-independent algorithm, * i.e. alignment of buttons should be OK regardless of order in which * they are added to the block. */ void ui_block_align_calc(uiBlock *block, const struct ARegion *region); /* interface_anim.c */ void ui_but_anim_flag(uiBut *but, const struct AnimationEvalContext *anim_eval_context); void ui_but_anim_copy_driver(struct bContext *C); void ui_but_anim_paste_driver(struct bContext *C); /** * \a str can be NULL to only perform check if \a but has an expression at all. * \return if button has an expression. */ bool ui_but_anim_expression_get(uiBut *but, char *str, size_t maxlen); bool ui_but_anim_expression_set(uiBut *but, const char *str); /** * Create new expression for button (i.e. a "scripted driver"), if it can be created. */ bool ui_but_anim_expression_create(uiBut *but, const char *str); void ui_but_anim_autokey(struct bContext *C, uiBut *but, struct Scene *scene, float cfra); void ui_but_anim_decorate_cb(struct bContext *C, void *arg_but, void *arg_dummy); void ui_but_anim_decorate_update_from_flag(uiButDecorator *but); /* interface_query.c */ 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; /** * Can we mouse over the button or is it hidden/disabled/layout. * \note ctrl is kind of a hack currently, * so that non-embossed UI_BTYPE_TEXT button behaves as a label when ctrl is not pressed. */ 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, struct ARegion *region, const struct wmEvent *event) ATTR_WARN_UNUSED_RESULT; bool ui_but_contains_point_px(const uiBut *but, const struct ARegion *region, const int xy[2]) ATTR_NONNULL(1, 2, 3) ATTR_WARN_UNUSED_RESULT; uiBut *ui_list_find_mouse_over(const struct ARegion *region, const struct wmEvent *event) ATTR_WARN_UNUSED_RESULT; uiBut *ui_list_find_from_row(const struct ARegion *region, const uiBut *row_but) ATTR_WARN_UNUSED_RESULT; uiBut *ui_list_row_find_mouse_over(const struct ARegion *region, const int xy[2]) ATTR_NONNULL(1, 2) ATTR_WARN_UNUSED_RESULT; uiBut *ui_list_row_find_from_index(const struct ARegion *region, int index, uiBut *listbox) ATTR_WARN_UNUSED_RESULT; uiBut *ui_view_item_find_mouse_over(const struct ARegion *region, const int xy[2]) ATTR_NONNULL(1, 2); uiBut *ui_view_item_find_active(const struct ARegion *region); typedef bool (*uiButFindPollFn)(const uiBut *but, const void *customdata); /** * x and y are only used in case event is NULL. */ uiBut *ui_but_find_mouse_over_ex(const struct 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 struct ARegion *region, const struct wmEvent *event) ATTR_WARN_UNUSED_RESULT; uiBut *ui_but_find_rect_over(const struct ARegion *region, const rcti *rect_px) ATTR_WARN_UNUSED_RESULT; uiBut *ui_list_find_mouse_over_ex(const struct 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; size_t ui_but_drawstr_without_sep_char(const uiBut *but, char *str, size_t str_maxlen) ATTR_NONNULL(1, 2); 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 struct ARegion *region, const int xy[2], bool only_clip) ATTR_NONNULL(1, 2); uiBlock *ui_block_find_mouse_over(const struct ARegion *region, const struct wmEvent *event, bool only_clip); uiBut *ui_region_find_first_but_test_flag(struct ARegion *region, int flag_include, int flag_exclude); uiBut *ui_region_find_active_but(struct ARegion *region) ATTR_WARN_UNUSED_RESULT; bool ui_region_contains_point_px(const struct ARegion *region, const int xy[2]) ATTR_NONNULL(1, 2) ATTR_WARN_UNUSED_RESULT; bool ui_region_contains_rect_px(const struct ARegion *region, const rcti *rect_px); /** * Check if the cursor is over any popups. */ struct ARegion *ui_screen_region_find_mouse_over_ex(struct bScreen *screen, const int xy[2]) ATTR_NONNULL(1, 2); struct ARegion *ui_screen_region_find_mouse_over(struct bScreen *screen, const struct wmEvent *event); /* interface_context_menu.c */ bool ui_popup_context_menu_for_button(struct bContext *C, uiBut *but, const struct wmEvent *event); /** * menu to show when right clicking on the panel header */ void ui_popup_context_menu_for_panel(struct bContext *C, struct ARegion *region, struct Panel *panel); /* interface_eyedropper.c */ struct wmKeyMap *eyedropper_modal_keymap(struct wmKeyConfig *keyconf); struct wmKeyMap *eyedropper_colorband_modal_keymap(struct wmKeyConfig *keyconf); /* interface_eyedropper_color.c */ void UI_OT_eyedropper_color(struct wmOperatorType *ot); /* interface_eyedropper_colorband.c */ void UI_OT_eyedropper_colorramp(struct wmOperatorType *ot); void UI_OT_eyedropper_colorramp_point(struct wmOperatorType *ot); /* interface_eyedropper_datablock.c */ void UI_OT_eyedropper_id(struct wmOperatorType *ot); /* interface_eyedropper_depth.c */ void UI_OT_eyedropper_depth(struct wmOperatorType *ot); /* interface_eyedropper_driver.c */ void UI_OT_eyedropper_driver(struct wmOperatorType *ot); /* interface_eyedropper_gpencil_color.c */ void UI_OT_eyedropper_gpencil_color(struct wmOperatorType *ot); /* interface_template_asset_view.cc */ struct uiListType *UI_UL_asset_view(void); /** * For use with #ui_rna_collection_search_update_fn. */ typedef 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; } uiRNACollectionSearch; void ui_rna_collection_search_update_fn( const struct bContext *C, void *arg, const char *str, uiSearchItems *items, bool is_first); /* interface_ops.c */ bool ui_jump_to_target_button_poll(struct bContext *C); /* interface_queries.c */ void ui_interface_tag_script_reload_queries(void); /* interface_view.cc */ void ui_block_free_views(struct uiBlock *block); void ui_block_views_listen(const uiBlock *block, const struct wmRegionListenerParams *listener_params); uiViewHandle *ui_block_view_find_matching_in_old_block(const uiBlock *new_block, const uiViewHandle *new_view); uiButViewItem *ui_block_view_find_matching_view_item_but_in_old_block( const uiBlock *new_block, const uiViewItemHandle *new_item_handle); /* interface_templates.c */ struct uiListType *UI_UL_cache_file_layers(void); struct ID *ui_template_id_liboverride_hierarchy_make(struct bContext *C, struct Main *bmain, struct ID *owner_id, struct ID *id, const char **r_undo_push_label); #ifdef __cplusplus } #endif