Blender V5.3
UI_interface_c.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include <bit>
12#include <functional>
13#include <optional>
14#include <string>
15#include <type_traits>
16
17#include "BLI_compiler_attrs.hh"
18#include "BLI_enum_flags.hh"
19#include "BLI_string_ref.hh"
21#include "BLI_sys_types.hh" /* size_t */
22
23#include "DNA_listBase.h"
24#include "DNA_userdef_types.h"
25
26#include "UI_interface_icons.hh"
27#include "UI_interface_types.hh"
28
29#include "WM_types.hh"
30
31#include "MEM_guardedalloc.h"
32
33namespace blender {
34
35/* Struct Declarations */
36
37struct ARegion;
38struct Depsgraph;
39struct EnumPropertyItem;
40struct FileSelectParams;
41struct ID;
42struct IDProperty;
43struct ImBuf;
44struct Image;
45struct ImageUser;
46struct MTex;
47struct Panel;
48struct PanelType;
49struct PanelCategoryDyn;
51struct PointerRNA;
52struct PropertyRNA;
53struct ReportList;
54struct ResultBLF;
55struct bContext;
56struct bContextStore;
57struct bNode;
58struct bNodeSocket;
59struct bNodeTree;
60struct bScreen;
61struct MenuType;
62struct rctf;
63struct rcti;
64struct uiFontStyle;
65struct uiList;
66struct uiStyle;
67struct uiWidgetColors;
68struct wmDrag;
69struct wmDropBox;
70struct wmEvent;
71struct wmGizmo;
72struct wmKeyConfig;
73struct wmKeyMap;
74struct wmKeyMapItem;
75struct wmMsgBus;
76struct wmOperator;
77struct wmOperatorType;
79struct wmWindow;
80struct TextboxState;
81namespace ed::asset {
83}
84
85namespace ui {
86class AbstractView;
88struct Layout;
89struct Button;
90struct ButtonSearch;
92struct TooltipData;
93struct PopupBlockHandle;
94struct Block;
95
101#define UI_SEP_CHAR '|'
102#define UI_SEP_CHAR_S "|"
103
107#define UI_VALUE_INDETERMINATE_CHAR BLI_STR_UTF8_EM_DASH
108
113#define UI_MENU_ARROW_SEP BLI_STR_UTF8_BLACK_RIGHT_POINTING_SMALL_TRIANGLE
114
121#define UI_REGION_OVERLAP_MARGIN (U.widget_unit / 3)
122
124#define UI_SCREEN_MARGIN 10
125
127enum class EmbossType : uint8_t {
131 None = 1,
143};
144
146enum {
147 UI_DIR_UP = 1 << 0,
148 UI_DIR_DOWN = 1 << 1,
149 UI_DIR_LEFT = 1 << 2,
150 UI_DIR_RIGHT = 1 << 3,
153
155};
156
158enum {
172 BLOCK_LOOP = 1 << 0,
227 BLOCK_POPUP = 1 << 7,
233 BLOCK_OUT_1 = 1 << 8,
256
257 /* #Block::flags bits 14-17 are identical to #Button::drawflag bits. */
258
279 BLOCK_PIE_MENU = 1 << 20,
287 BLOCK_POPOVER = 1 << 21,
326};
327
329enum {
333 RETURN_OK = 1 << 1,
335 RETURN_OUT = 1 << 2,
342};
343
346 /* WARNING: the first 8 flags are internal (see #UI_SELECT definition). */
347
350
351 BUT_NODE_LINK = 1 << 10,
353 BUT_DRAG_LOCK = 1 << 12,
355
357 BUT_DISABLED = 1 << 14,
358
359 BUT_ANIMATED = 1 << 15,
361 BUT_DRIVEN = 1 << 17,
362 BUT_REDALERT = 1 << 18,
364 BUT_INACTIVE = 1 << 19,
366 BUT_UNDO = 1 << 21,
367 BUT_NO_UTF8 = 1 << 22,
368
373
375 BUT_LIST_ITEM = 1 << 24,
377 BUT_DRAG_MULTI = 1 << 25,
380
394
397
412};
413
415enum {
420
421 /* --- Internal flags. --- */
423};
424
426#define UI_DEFAULT_TEXT_POINTS 11.0f
427
429#define UI_DEFAULT_TITLE_POINTS 11.0f
430
432#define UI_DEFAULT_TOOLTIP_POINTS 11.0f
433
434#define UI_PANEL_WIDTH 340
435#define UI_COMPACT_PANEL_WIDTH 160
436#define UI_SIDEBAR_PANEL_WIDTH 280
437#define UI_NAVIGATION_REGION_WIDTH UI_COMPACT_PANEL_WIDTH
438#define UI_NARROW_NAVIGATION_REGION_WIDTH 100
439
441#define UI_TOOLBAR_COLUMN (1.25f * ICON_DEFAULT_HEIGHT_TOOLBAR)
443#define UI_TOOLBAR_MARGIN (0.5f * ICON_DEFAULT_HEIGHT_TOOLBAR)
445#define UI_TOOLBAR_WIDTH UI_TOOLBAR_MARGIN + UI_TOOLBAR_COLUMN
446
447#define UI_PANEL_CATEGORY_MARGIN_WIDTH \
448 (((U.uiflag2 & USER_UIFLAG2_PANEL_TABS_COMPACT) ? 1.4f : 1.0f) * U.widget_unit)
449#define UI_PANEL_SEARCH_BLOCK_MARGIN_HEIGHT (1.25f * UI_UNIT_Y)
450
451/* Minimum width for a panel showing only category tabs. */
452#define UI_PANEL_CATEGORY_MIN_WIDTH ((U.uiflag2 & USER_UIFLAG2_PANEL_TABS_COMPACT) ? 32.0f : 26.0f)
453/* Minimum width for a panel showing content and category tabs. */
454#define UI_PANEL_CATEGORY_MIN_SNAP_WIDTH 90.0f
455/* Minimum panel draw width. */
456static constexpr int PANEL_MIN_DRAW_WIDTH = 20;
457
458/* Both these margins should be ignored if the panel doesn't show a background (check
459 * #panel_should_show_background()). */
460#define UI_PANEL_MARGIN_X (U.widget_unit * 0.4f)
461#define UI_PANEL_MARGIN_Y (U.widget_unit * 0.1f)
462
469enum {
484
485 /* Button align flag, for drawing groups together.
486 * Used in 'Block.flag', take care! */
487 BUT_ALIGN_TOP = 1 << 14,
488 BUT_ALIGN_LEFT = 1 << 15,
490 BUT_ALIGN_DOWN = 1 << 17,
492 /* end bits shared with 'Block.flag' */
493
503
505 BUT_BOX_ITEM = 1 << 20,
506
508 BUT_HOVER_LEFT = 1 << 21,
511
514
517
520
523
526};
527
529 None = 0,
532 Int,
534 // ButPointerType::Function = 192, /* UNUSED */
535 Bit = 1 << 7, /* OR'd with a bit index. */
536};
539#define BUT_POIN_TYPES (ButPointerType::Float | ButPointerType::Short | ButPointerType::Char)
540
609
611{
612 switch (pointer_type) {
614 return sizeof(char) * 8;
616 return sizeof(short) * 8;
618 return sizeof(int) * 8;
619 default:
620 break;
621 }
622 return 0;
623}
624
626template<typename T> constexpr ButPointerType but_pointer_type_for()
627{
628 constexpr ButPointerType ptr_type = (std::is_same_v<T, float>) ?
630 (std::is_integral_v<T> || std::is_enum_v<T>) ?
631 (sizeof(T) == 1) ? ButPointerType::Char :
632 (sizeof(T) == 2) ? ButPointerType::Short :
633 (sizeof(T) == 4) ? ButPointerType::Int :
636 static_assert(ptr_type != ButPointerType::None, "Incompatible uiDefBut pointer type");
637 return ptr_type;
638}
639
665
679
680/* Drawing
681 *
682 * Functions to draw various shapes, taking theme settings into account.
683 * Used for code that draws its own UI style elements. */
684
685void draw_roundbox_corner_set(int type);
686void draw_roundbox_aa(const rctf *rect, bool filled, float rad, const float color[4]);
687void draw_roundbox_4fv(const rctf *rect, bool filled, float rad, const float col[4]);
689 const rctf *rect, bool filled, float rad, const unsigned char col[3], unsigned char alpha);
691 const rctf *rect, bool filled, float rad, const float col[3], float alpha);
692void draw_roundbox_4fv_ex(const rctf *rect,
693 const float inner1[4],
694 const float inner2[4],
695 float shade_dir,
696 const float outline[4],
697 float outline_width,
698 float rad);
699
700#if 0 /* unused */
701int draw_roundbox_corner_get();
702#endif
703
704void draw_dropshadow(const rctf *rct, float radius, float width, float aspect, float alpha);
705
706void draw_text_underline(int pos_x, int pos_y, int len, int height, const float color[4]);
707
716void draw_safe_areas(uint pos,
717 const rctf *rect,
718 const float title_aspect[2],
719 const float action_aspect[2]);
720
722enum {
725};
729void draw_widget_scroll(uiWidgetColors *wcol, const rcti *rect, const rcti *slider, int state);
730
748float text_clip_middle_ex(const uiFontStyle *fstyle,
749 char *str,
750 float okwidth,
751 float minwidth,
752 size_t str_maxncpy,
753 char rpart_sep,
754 bool clip_right_if_tight = true,
755 bool shorten_template_variables = false);
756
758 const char *str,
759 char *clipped_str_buf,
760 const size_t clipped_str_buf_maxncpy,
761 const float max_line_width,
762 const int max_lines);
763
779
780struct SearchItems;
781
782using ButtonHandleFunc = void (*)(bContext *C, void *arg1, void *arg2);
783using ButtonHandleNFunc = void (*)(bContext *C, void *argN, void *arg2);
784using ButtonHandleHoldFunc = void (*)(bContext *C, ARegion *butregion, Button *but);
785using ButtonCompleteFunc = int (*)(bContext *C, char *str, void *arg);
786
791using ButtonArgNFree = void (*)(void *argN);
792using ButtonArgNCopy = void *(*)(const void *argN);
793
798using ButtonIdentityCompareFunc = bool (*)(const Button *a, const Button *b);
799
800/* Search types. */
802 ARegion *butregion,
803 ButtonSearch *search_but);
810 void (*)(const bContext *C, void *arg, const char *str, SearchItems *items, bool is_first);
812 void *arg,
813 void *active,
814 const wmEvent *event);
816 ARegion *(*)(bContext * C, ARegion *region, const rcti *item_rect, void *arg, void *active);
817using ButtonSearchListenFn = void (*)(const wmRegionListenerParams *params, void *arg);
818
819using BlockHandleFunc = void (*)(bContext *C, void *arg, int event);
820
821/* -------------------------------------------------------------------- */
830
844
847 const BlockInteraction_Params *params,
848 void *arg1);
850 const BlockInteraction_Params *params,
851 void *arg1,
852 void *user_data);
854 const BlockInteraction_Params *params,
855 void *arg1,
856 void *user_data);
857
864
866
868
869/* `interface_query.cc` */
870
871bool but_has_quick_tooltip(const Button *but);
872bool but_is_tool(const Button *but);
874bool but_is_utf8(const Button *but);
875#define button_is_decorator(but) ((but)->type == ButtonType::Decorator)
876
877bool block_is_empty_ex(const Block *block, bool skip_title);
878bool block_is_empty(const Block *block);
879bool block_can_add_separator(const Block *block);
883const Button *block_active_default_button_find(const Block *block);
888bool block_has_active_default_button(const Block *block);
889
895Button *but_find_mouse_over(const ARegion *region, const wmEvent *event) ATTR_WARN_UNUSED_RESULT;
896
897uiList *uilist_find_mouse_over(const ARegion *region, const wmEvent *event);
898
899/* `interface_region_menu_popup.cc` */
900
909struct PopupMenu;
910
911PopupMenu *popup_menu_begin(bContext *C, const char *title, int icon) ATTR_NONNULL();
918PopupMenu *popup_menu_begin_ex(bContext *C, const char *title, const char *block_name, int icon)
919 ATTR_NONNULL();
923void popup_menu_end(bContext *C, PopupMenu *pup);
924bool popup_menu_end_or_cancel(bContext *C, PopupMenu *pup);
925Layout *popup_menu_layout(PopupMenu *pup);
926
927void popup_menu_reports(bContext *C, ReportList *reports) ATTR_NONNULL();
928wmOperatorStatus popup_menu_invoke(bContext *C, const char *idname, ReportList *reports)
929 ATTR_NONNULL(1, 2);
930
936void popup_menu_close(const Block *block, bool is_cancel = false);
941void popup_menu_close_from_but(const Button *but, bool is_cancel = false);
942
947void popup_menu_retval_set(const Block *block, int retval, bool enable);
953void popup_dummy_panel_set(ARegion *region, Block *block, StringRef idname);
958ListBaseT<LayoutPanelState> &popup_persistent_layout_panel_states(StringRef idname);
962void popup_menu_but_set(PopupMenu *pup, ARegion *butregion, Button *but);
963
964/* `interface_region_popover.cc` */
965
966struct Popover;
967
969 bContext *C, const char *idname, bool keep_open, bool use_numselect, ReportList *reports);
970
980Popover *popover_begin(bContext *C, int ui_menu_width, bool from_active_button, bool use_numselect)
981 ATTR_NONNULL(1);
985void popover_end(bContext *C, Popover *pup, wmKeyMap *keymap);
986Layout *popover_layout(Popover *pup);
988
989/* `interface_region_menu_pie.cc` */
990
991/* Pie menus */
992struct PieMenu;
993
994wmOperatorStatus pie_menu_invoke(bContext *C, const char *idname, const wmEvent *event);
995
996PieMenu *pie_menu_begin(bContext *C, const char *title, int icon, const wmEvent *event)
997 ATTR_NONNULL();
998void pie_menu_end(bContext *C, PieMenu *pie);
1000
1001/* `interface_region_menu_popup.cc` */
1002
1003/* Popup Blocks
1004 *
1005 * Functions used to create popup blocks. These are like popup menus
1006 * but allow using all button types and creating their own layout. */
1007using BlockCreateFunc = Block *(*)(bContext * C, ARegion *region, void *arg1);
1008using BlockCancelFunc = void (*)(bContext *C, void *arg1);
1009
1011 BlockCreateFunc func,
1012 void *arg,
1013 FreeArgFunc arg_free,
1014 StructRNA *srna_owner = nullptr);
1023 BlockCreateFunc func,
1024 void *arg,
1025 FreeArgFunc arg_free,
1026 bool can_refresh,
1027 StructRNA *srna_owner = nullptr);
1029 BlockCreateFunc func,
1030 BlockHandleFunc popup_func,
1031 BlockCancelFunc cancel_func,
1032 void *arg,
1033 wmOperator *op);
1034
1043 bool cancel_default,
1044 FunctionRef<Button *()> confirm_fn,
1045 FunctionRef<Button *()> cancel_fn);
1054 wmOperatorType *ot,
1055 std::optional<StringRef> confirm_text,
1056 std::optional<StringRef> cancel_text,
1057 const int icon,
1058 bool cancel_default,
1059 PointerRNA *r_ptr);
1060
1061#if 0 /* UNUSED */
1062void uiPupBlockOperator(bContext *C,
1063 uiBlockCreateFunc func,
1064 wmOperator *op,
1065 wm::OpCallContext opcontext);
1066#endif
1067
1068void popup_block_close(bContext *C, wmWindow *win, Block *block);
1069
1070bool popup_block_name_exists(const bScreen *screen, StringRef name);
1071
1072bool popup_region_from_operator(const bScreen *screen, const ARegion *region);
1073
1074/* Blocks
1075 *
1076 * Functions for creating, drawing and freeing blocks. A Block is a
1077 * container of buttons and used for various purposes.
1078 *
1079 * Begin/Define Buttons/End/Draw is the typical order in which these
1080 * function should be called, though for popup blocks Draw is left out.
1081 * Freeing blocks is done by the screen/ module automatically.
1082 */
1083
1084Block *block_begin(const bContext *C, ARegion *region, std::string name, EmbossType emboss);
1085Block *block_begin(const bContext *C,
1086 Scene *scene,
1087 wmWindow *window,
1088 ARegion *region,
1089 std::string name,
1090 EmbossType emboss);
1091
1093void block_post_layout_callbacks_exec(const bContext *C, ARegion *region, Block *block);
1094
1102void block_end_ex(const bContext *C,
1103 Main *bmain,
1104 wmWindow *window,
1105 Scene *scene,
1106 ARegion *region,
1107 Depsgraph *depsgraph,
1108 Block *block,
1109 const int xy[2] = nullptr,
1110 int r_xy[2] = nullptr,
1111 bool postpone_callbacks = false);
1112void block_end(const bContext *C, Block *block, bool postpone_callbacks = false);
1116void block_draw(const bContext *C, Block *block);
1117void blocklist_update_window_matrix(const bContext *C, const ListBaseT<ui::Block> *lb);
1118void blocklist_update_view_for_buttons(const bContext *C, const ListBaseT<ui::Block> *lb);
1119void blocklist_draw(const bContext *C, const ListBaseT<ui::Block> *lb);
1120void block_update_from_old(const bContext *C, Block *block);
1121
1122enum {
1125};
1126void block_theme_style_set(Block *block, char theme_style);
1127EmbossType block_emboss_get(Block *block);
1128void block_emboss_set(Block *block, EmbossType emboss);
1129bool block_is_search_only(const Block *block);
1134void block_set_search_only(Block *block, bool search_only);
1135
1139void block_set_active_operator(Block *block, wmOperator *op, const bool free);
1140
1144void block_free(const bContext *C, Block *block);
1145
1146void block_listen(const Block *block, const wmRegionListenerParams *listener_params);
1147
1151void blocklist_free(const bContext *C, ARegion *region);
1152void blocklist_free_inactive(const bContext *C, ARegion *region);
1153
1159
1160void block_region_set(Block *block, ARegion *region);
1161
1162void block_lock_set(Block *block, bool val, const char *lockstr);
1163void block_lock_clear(Block *block);
1164
1165#define UI_BUTTON_SECTION_MERGE_DISTANCE (UI_UNIT_X * 3)
1166/* Separator line between regions if the #uiButtonSectionsAlign is not #None. */
1167#define UI_BUTTON_SECTION_SEPERATOR_LINE_WITH (U.pixelsize * 2)
1168
1169enum class ButtonSectionsAlign : int8_t { None = 1, Top, Bottom };
1179void region_button_sections_draw(const ARegion *region,
1180 int /*THemeColorID*/ colorid,
1181 ButtonSectionsAlign align);
1182bool region_button_sections_is_inside_x(const ARegion *region, const int mval_x);
1183
1187void block_align_begin(Block *block);
1188void block_align_end(Block *block);
1189
1200
1204void block_bounds_set_normal(Block *block, int addval);
1208void block_bounds_set_text(Block *block, int addval);
1212void block_bounds_set_popup(Block *block, int addval, const int bounds_offset[2]);
1216void block_bounds_set_menu(Block *block, int addval, const int bounds_offset[2]);
1220void block_bounds_set_centered(Block *block, int addval);
1221void block_bounds_set_explicit(Block *block, int minx, int miny, int maxx, int maxy);
1222
1223int blocklist_min_y_get(ListBaseT<ui::Block> *lb);
1224
1225void block_direction_set(Block *block, char direction);
1229void block_flag_enable(Block *block, int flag);
1230void block_flag_disable(Block *block, int flag);
1231void block_translate(Block *block, float x, float y);
1232
1234
1242
1243void button_flag_enable(Button *but, int64_t flag);
1244void button_flag_disable(Button *but, int64_t flag);
1245bool button_flag_is_set(Button *but, int64_t flag);
1246
1247void button_drawflag_enable(Button *but, int flag);
1248void button_drawflag_disable(Button *but, int flag);
1249
1250void button_dragflag_enable(Button *but, int flag);
1251void button_dragflag_disable(Button *but, int flag);
1252
1253void button_disable(Button *but, const char *disabled_hint);
1254
1256
1261void button_color_set(Button *but, const uchar color[4]);
1262
1263bool button_is_color_gamma(Button &but);
1265
1269void button_placeholder_set(Button *but, StringRef placeholder_text);
1270
1279 const bContext *C, ARegion *region, Block *block, Button *but, bool remove_on_failure);
1280bool button_active_only(const bContext *C, ARegion *region, Block *block, Button *but);
1285bool block_active_only_flagged_buttons(const bContext *C, ARegion *region, Block *block);
1286
1290void button_execute(const bContext *C, ARegion *region, Button *but);
1291
1292std::optional<std::string> button_online_manual_id(const Button *but) ATTR_WARN_UNUSED_RESULT;
1293std::optional<std::string> button_online_manual_id_from_active(const bContext *C)
1295bool button_is_userdef(const Button *but);
1296
1297void *button_func_argN_get(const Button *but);
1299 void *poin,
1300 void *argN,
1301 ButtonArgNFree func_argN_free_fn,
1302 ButtonArgNCopy func_argN_copy_fn);
1303
1304/* Buttons
1305 *
1306 * Functions to define various types of buttons in a block. Postfixes:
1307 * - V: Value
1308 * - R: RNA
1309 * - O: operator */
1310
1311Button *uiDefBut(Block *block,
1312 ButtonTypeWithPointerType but_and_ptr_type,
1313 StringRef str,
1314 int x,
1315 int y,
1316 short width,
1317 short height,
1318 void *poin,
1319 float min,
1320 float max,
1321 std::optional<StringRef> tip);
1322template<typename T>
1324 ButtonType type,
1325 StringRef str,
1326 int x,
1327 int y,
1328 short width,
1329 short height,
1330 T *poin,
1331 float min,
1332 float max,
1333 std::optional<StringRef> tip)
1334{
1335 return uiDefBut(
1336 block, {type, but_pointer_type_for<T>()}, str, x, y, width, height, poin, min, max, tip);
1337}
1338template<typename T>
1340 ButtonType type,
1341 int bit,
1342 StringRef str,
1343 int x,
1344 int y,
1345 short width,
1346 short height,
1347 T *poin,
1348 float min,
1349 float max,
1350 std::optional<StringRef> tip)
1351{
1352 const int bit_idx = std::has_single_bit(uint(bit)) ? std::countr_zero(uint(bit)) : -1;
1353 if (bit_idx == -1) {
1354 return nullptr;
1355 }
1356 return uiDefBut(block,
1357 {type, but_pointer_type_for<T>() | ButPointerType::Bit, bit_idx},
1358 str,
1359 x,
1360 y,
1361 width,
1362 height,
1363 poin,
1364 min,
1365 max,
1366 tip);
1367}
1368Button *uiDefButR(Block *block,
1369 ButtonType type,
1370 std::optional<StringRef> str,
1371 int x,
1372 int y,
1373 short width,
1374 short height,
1375 PointerRNA *ptr,
1376 StringRefNull propname,
1377 int index,
1378 float min,
1379 float max,
1380 std::optional<StringRef> tip);
1381Button *uiDefButR_prop(Block *block,
1382 ButtonType type,
1383 std::optional<StringRef> str,
1384 int x,
1385 int y,
1386 short width,
1387 short height,
1388 PointerRNA *ptr,
1389 PropertyRNA *prop,
1390 int index,
1391 float min,
1392 float max,
1393 std::optional<StringRef> tip);
1398
1402Button *uiDefButTextBoxR(Block *block,
1403 PointerRNA *ptr,
1404 StringRefNull propname,
1406 int x,
1407 int y,
1408 short width);
1409Button *uiDefButO(Block *block,
1410 ButtonType type,
1411 StringRefNull opname,
1412 wm::OpCallContext opcontext,
1413 const std::optional<StringRef> str,
1414 int x,
1415 int y,
1416 short width,
1417 short height,
1418 std::optional<StringRef> tip);
1419Button *uiDefButO_ptr(Block *block,
1420 ButtonType type,
1421 wmOperatorType *ot,
1422 wm::OpCallContext opcontext,
1423 StringRef str,
1424 int x,
1425 int y,
1426 short width,
1427 short height,
1428 std::optional<StringRef> tip);
1429
1430Button *uiDefIconBut(Block *block,
1431 ButtonTypeWithPointerType but_and_ptr_type,
1432 int icon,
1433 int x,
1434 int y,
1435 short width,
1436 short height,
1437 void *poin,
1438 float min,
1439 float max,
1440 std::optional<StringRef> tip);
1441template<typename T>
1443 ButtonType type,
1444 int icon,
1445 int x,
1446 int y,
1447 short width,
1448 short height,
1449 T *poin,
1450 float min,
1451 float max,
1452 std::optional<StringRef> tip)
1453{
1454 return uiDefIconBut(
1455 block, {type, but_pointer_type_for<T>()}, icon, x, y, width, height, poin, min, max, tip);
1456}
1457template<typename T>
1459 ButtonType type,
1460 int bit,
1461 int icon,
1462 int x,
1463 int y,
1464 short width,
1465 short height,
1466 T *poin,
1467 float min,
1468 float max,
1469 std::optional<StringRef> tip)
1470{
1471 const int bit_idx = std::has_single_bit(uint(bit)) ? std::countr_zero(uint(bit)) : -1;
1472 if (bit_idx == -1) {
1473 return nullptr;
1474 }
1475 return uiDefIconBut(block,
1476 {type, but_pointer_type_for<T>() | ButPointerType::Bit, bit_idx},
1477 icon,
1478 x,
1479 y,
1480 width,
1481 height,
1482 poin,
1483 min,
1484 max,
1485 tip);
1486}
1487Button *uiDefIconButR(Block *block,
1488 ButtonType type,
1489 int icon,
1490 int x,
1491 int y,
1492 short width,
1493 short height,
1494 PointerRNA *ptr,
1495 StringRefNull propname,
1496 int index,
1497 float min,
1498 float max,
1499 std::optional<StringRef> tip);
1500Button *uiDefIconButR_prop(Block *block,
1501 ButtonType type,
1502 int icon,
1503 int x,
1504 int y,
1505 short width,
1506 short height,
1507 PointerRNA *ptr,
1508 PropertyRNA *prop,
1509 int index,
1510 float min,
1511 float max,
1512 std::optional<StringRef> tip);
1513Button *uiDefIconButO(Block *block,
1514 ButtonType type,
1515 StringRefNull opname,
1516 wm::OpCallContext opcontext,
1517 int icon,
1518 int x,
1519 int y,
1520 short width,
1521 short height,
1522 std::optional<StringRef> tip);
1523Button *uiDefIconButO_ptr(Block *block,
1524 ButtonType type,
1525 wmOperatorType *ot,
1526 wm::OpCallContext opcontext,
1527 int icon,
1528 int x,
1529 int y,
1530 short width,
1531 short height,
1532 std::optional<StringRef> tip);
1533Button *uiDefIconPreviewBut(Block *block,
1534 ButtonType type,
1535 int icon,
1536 int x,
1537 int y,
1538 short width,
1539 short height,
1540 void *poin,
1541 float min,
1542 float max,
1543 std::optional<StringRef> tip);
1545 Block *block, void *imbuf, int x, int y, short width, short height, const uchar color[4]);
1546Button *uiDefButAlert(Block *block, AlertIcon icon, int x, int y, short width, short height);
1548Button *uiDefIconTextBut(Block *block,
1549 ButtonTypeWithPointerType but_and_ptr_type,
1550 int icon,
1551 StringRef str,
1552 int x,
1553 int y,
1554 short width,
1555 short height,
1556 void *poin,
1557 std::optional<StringRef> tip);
1558template<typename T>
1560 ButtonType type,
1561 int icon,
1562 StringRef str,
1563 int x,
1564 int y,
1565 short width,
1566 short height,
1567 T *poin,
1568 std::optional<StringRef> tip)
1569{
1570 return uiDefIconTextBut(
1571 block, {type, but_pointer_type_for<T>()}, icon, str, x, y, width, height, poin, tip);
1572}
1573Button *uiDefIconTextButR(Block *block,
1574 ButtonType type,
1575 int icon,
1576 std::optional<StringRefNull> str,
1577 int x,
1578 int y,
1579 short width,
1580 short height,
1581 PointerRNA *ptr,
1582 StringRefNull propname,
1583 int index,
1584 std::optional<StringRef> tip);
1585Button *uiDefIconTextButR_prop(Block *block,
1586 ButtonType type,
1587 int icon,
1588 std::optional<StringRef> str,
1589 int x,
1590 int y,
1591 short width,
1592 short height,
1593 PointerRNA *ptr,
1594 PropertyRNA *prop,
1595 int index,
1596 float min,
1597 float max,
1598 std::optional<StringRef> tip);
1599Button *uiDefIconTextButO(Block *block,
1600 ButtonType type,
1602 wm::OpCallContext opcontext,
1603 int icon,
1604 StringRef str,
1605 int x,
1606 int y,
1607 short width,
1608 short height,
1609 std::optional<StringRef> tip);
1610Button *uiDefIconTextButO_ptr(Block *block,
1611 ButtonType type,
1612 wmOperatorType *ot,
1613 wm::OpCallContext opcontext,
1614 int icon,
1615 StringRef str,
1616 int x,
1617 int y,
1618 short width,
1619 short height,
1620 std::optional<StringRef> tip);
1621
1622void button_enum_prop_value_set(Button *but, int retval);
1623void button_retval_set(Button *but, int retval);
1624
1625void button_operator_set(Button *but,
1626 wmOperatorType *optype,
1627 wm::OpCallContext opcontext,
1628 const PointerRNA *opptr = nullptr);
1634void button_operator_set_never_call(Button *but);
1635
1638
1639void button_context_ptr_set(Block *block, Button *but, StringRef name, const PointerRNA *ptr);
1640void button_context_int_set(Block *block, Button *but, StringRef name, int64_t value);
1641const PointerRNA *button_context_ptr_get(const Button *but,
1642 StringRef name,
1643 const StructRNA *type = nullptr);
1644std::optional<StringRefNull> button_context_string_get(const Button *but, StringRef name);
1645std::optional<int64_t> button_context_int_get(const Button *but, StringRef name);
1646const bContextStore *button_context_get(const Button *but);
1647
1648void button_unit_type_set(Button *but, int unit_type);
1649int button_unit_type_get(const Button *but);
1650
1651std::optional<EnumPropertyItem> button_rna_enum_item_get(bContext &C, Button &but);
1652
1653std::string button_string_get_rna_property_identifier(const Button &but);
1654std::string button_string_get_rna_struct_identifier(const Button &but);
1655std::string button_string_get_label(Button &but);
1656std::string button_context_menu_title_from_button(Button &but);
1661std::string button_string_get_tooltip_label(const Button &but);
1662std::string button_string_get_rna_label(Button &but);
1664std::string button_string_get_rna_label_context(const Button &but);
1665std::string button_string_get_tooltip(bContext &C, Button &but);
1666std::string button_string_get_rna_tooltip(bContext &C, Button &but);
1668std::string button_string_get_operator_keymap(bContext &C, Button &but);
1670std::string button_string_get_property_keymap(bContext &C, Button &but);
1671
1672std::string button_extra_icon_string_get_label(const ButtonExtraOpIcon &extra_icon);
1673std::string button_extra_icon_string_get_tooltip(bContext &C, const ButtonExtraOpIcon &extra_icon);
1675 const ButtonExtraOpIcon &extra_icon);
1676
1688
1693enum {
1696};
1697
1698/* ID utilities. */
1699
1700int icon_from_id(const ID *id);
1702int icon_from_report_type(int type);
1703int icon_colorid_from_report_type(int type);
1705
1706int icon_from_event_type(short event_type, short event_value);
1707int icon_from_keymap_item(const wmKeyMapItem *kmi, int r_icon_mod[KM_MOD_NUM]);
1708
1709Button *uiDefMenuBut(Block *block,
1710 MenuCreateFunc func,
1711 void *arg,
1712 StringRef str,
1713 int x,
1714 int y,
1715 short width,
1716 short height,
1717 std::optional<StringRef> tip);
1718Button *uiDefIconTextMenuBut(Block *block,
1719 MenuCreateFunc func,
1720 void *arg,
1721 int icon,
1722 StringRef str,
1723 int x,
1724 int y,
1725 short width,
1726 short height,
1727 std::optional<StringRef> tip);
1728Button *uiDefIconMenuBut(Block *block,
1729 MenuCreateFunc func,
1730 void *arg,
1731 int icon,
1732 int x,
1733 int y,
1734 short width,
1735 short height,
1736 std::optional<StringRef> tip);
1737
1738Button *uiDefBlockBut(Block *block,
1739 BlockCreateFunc func,
1740 void *arg,
1741 StringRef str,
1742 int x,
1743 int y,
1744 short width,
1745 short height,
1746 std::optional<StringRef> tip);
1747Button *uiDefBlockButN(Block *block,
1748 BlockCreateFunc func,
1749 void *argN,
1750 StringRef str,
1751 int x,
1752 int y,
1753 short width,
1754 short height,
1755 std::optional<StringRef> tip,
1756 ButtonArgNFree func_argN_free_fn = MEM_delete_void,
1757 ButtonArgNCopy func_argN_copy_fn = MEM_dupalloc_void);
1758
1762Button *uiDefIconBlockBut(Block *block,
1763 BlockCreateFunc func,
1764 void *arg,
1765 int icon,
1766 int x,
1767 int y,
1768 short width,
1769 short height,
1770 std::optional<StringRef> tip);
1771
1775Button *uiDefSearchBut(Block *block,
1776 void *arg,
1777 int icon,
1778 int maxncpy,
1779 int x,
1780 int y,
1781 short width,
1782 short height,
1783 std::optional<StringRef> tip);
1788Button *uiDefSearchButO_ptr(Block *block,
1789 wmOperatorType *ot,
1790 IDProperty *properties,
1791 void *arg,
1792 int icon,
1793 int maxncpy,
1794 int x,
1795 int y,
1796 short width,
1797 short height,
1798 std::optional<StringRef> tip);
1799
1809
1817
1819
1831Button *uiDefAutoButR(Block *block,
1832 PointerRNA *ptr,
1833 PropertyRNA *prop,
1834 int index,
1835 std::optional<StringRef> name,
1836 int icon,
1837 int x,
1838 int y,
1839 int width,
1840 int height,
1841 std::optional<ButtonType> button_type_override = std::nullopt);
1842void uiDefAutoButsArrayR(Block *block,
1843 PointerRNA *ptr,
1844 PropertyRNA *prop,
1845 const int icon,
1846 const int x,
1847 const int y,
1848 const int tot_width,
1849 const int height);
1857 PointerRNA *ptr,
1858 bool (*check_prop)(PointerRNA *ptr,
1859 PropertyRNA *prop,
1860 void *user_data),
1861 void *user_data,
1862 PropertyRNA *prop_activate_init,
1863 eButLabelAlign label_align,
1864 bool compact);
1865
1877
1892bool search_item_add(SearchItems *items,
1893 StringRef name,
1894 void *poin,
1895 int iconid,
1896 int64_t but_flag,
1897 uint8_t name_prefix_offset);
1898
1915 ButtonSearchCreateFn search_create_fn,
1916 ButtonSearchUpdateFn search_update_fn,
1917 void *arg,
1918 bool free_arg,
1919 FreeArgFunc search_arg_free_fn,
1920 ButtonHandleFunc search_exec_fn,
1921 void *active);
1929void button_func_search_set_sep_string(Button *but, const char *search_sep_string);
1931
1932#define UI_SEARCHBOX_BOUNDS (6.0f * UI_SCALE_FAC)
1933#define UI_SEARCHBOX_TRIA_H (12.0f * UI_SCALE_FAC)
1937int searchbox_size_y();
1938int searchbox_size_x();
1945int searchbox_size_x_guess(const bContext *C, const ButtonSearchUpdateFn update_fn, void *arg);
1949int search_items_find_index(const SearchItems *items, const char *name);
1950
1954void button_hint_drawstr_set(Button *but, const char *string);
1955void button_icon_scale_set(Button *but, float scale);
1956void button_icon_indicator_number_set(Button *but, const int indicator_number);
1957void button_icon_indicator_set(Button *but, const char *string);
1958void button_icon_indicator_color_set(Button *but, const uchar color[4]);
1959
1960void button_node_link_set(Button *but, bNodeSocket *socket, const float draw_color[4]);
1961
1969void button_pushbutton_draw_as_overlay_set(Button *but, bool value);
1970
1971void button_number_step_size_set(Button *but, float step_size);
1972void button_number_precision_set(Button *but, float precision);
1973
1974void button_number_slider_step_size_set(Button *but, float step_size);
1975void button_number_slider_precision_set(Button *but, float precision);
1976
1977void button_label_alpha_factor_set(Button *but, float alpha_factor);
1978void button_label_draw_icon_border_set(Button *but, bool use_icon_border);
1979
1980void button_search_preview_grid_size_set(Button *but, int rows, int cols);
1981
1982void button_view_item_draw_size_set(Button *but,
1983 const std::optional<int> draw_width = std::nullopt,
1984 const std::optional<int> draw_height = std::nullopt);
1985
1986void block_func_handle_set(Block *block, BlockHandleFunc func, void *arg);
1987void block_func_set(Block *block, ButtonHandleFunc func, void *arg1, void *arg2);
1988void block_funcN_set(Block *block,
1989 ButtonHandleNFunc funcN,
1990 void *argN,
1991 void *arg2,
1992 ButtonArgNFree func_argN_free_fn = MEM_delete_void,
1993 ButtonArgNCopy func_argN_copy_fn = MEM_dupalloc_void);
1994
1996 Button *but, std::function<void(bContext &C, StringRefNull oldname)> rename_func);
1998 Button *but, std::function<void(StringRefNull new_name)> rename_full_func);
1999void button_func_set(Button *but, ButtonHandleFunc func, void *arg1, void *arg2);
2000void button_funcN_set(Button *but,
2001 ButtonHandleNFunc funcN,
2002 void *argN,
2003 void *arg2,
2004 ButtonArgNFree func_argN_free_fn = MEM_delete_void,
2005 ButtonArgNCopy func_argN_copy_fn = MEM_dupalloc_void);
2006
2007void button_func_complete_set(Button *but, ButtonCompleteFunc func, void *arg);
2008
2009void button_func_drawextra_set(Block *block,
2010 std::function<void(const bContext *C, rcti *rect)> func);
2011
2012void button_func_menu_step_set(Button *but, MenuStepFunc func);
2013
2019void button_menu_disable_hover_open(Button *but);
2020
2021void button_func_tooltip_set(Button *but, ButtonToolTipFunc func, void *arg, FreeArgFunc free_arg);
2031void button_func_quick_tooltip_set(Button *but,
2032 std::function<std::string(const Button *but)> func);
2033
2035 TIP_STYLE_NORMAL = 0, /* Regular text. */
2036 TIP_STYLE_HEADER, /* Header text. */
2037 TIP_STYLE_MONO, /* Mono-spaced text. */
2038 TIP_STYLE_IMAGE, /* Image field. */
2039 TIP_STYLE_SPACER, /* Padding to separate sections. */
2040};
2041
2043 TIP_LC_MAIN = 0, /* Color of primary text. */
2044 TIP_LC_VALUE, /* Color for the value of buttons (also shortcuts). */
2045 TIP_LC_ACTIVE, /* Color of titles of active enum values. */
2046 TIP_LC_NORMAL, /* Color of regular text. */
2047 TIP_LC_DIMMED, /* Color for dimmed text. Use for Python snippets and other details. */
2048 TIP_LC_ALERT, /* Warning text color, eg: why operator can't run. */
2050};
2051
2057
2067
2070 void *arg,
2071 FreeArgFunc free_arg);
2072
2073template<typename Func> void button_func_tooltip_custom_set_cpp(Button &but, Func &&func)
2074{
2075 Func *allocated = MEM_new<Func>(__func__, std::forward<Func>(func));
2077 &but,
2078 [](bContext &C, ui::TooltipData &data, ui::Button * /*but*/, void *argN) {
2079 const Func &func = *static_cast<Func *>(argN);
2080 func(C, data);
2081 },
2082 allocated,
2083 [](void *arg) { MEM_delete<Func>(static_cast<Func *>(arg)); });
2084}
2085
2090void tooltip_text_field_add(TooltipData &data,
2091 std::string text,
2092 std::string suffix,
2093 const TooltipStyle style,
2094 const TooltipColorID color_id,
2095 const bool is_pad = false);
2096
2100void tooltip_image_field_add(TooltipData &data, const TooltipImage &image_data);
2101
2102void tooltip_color_field_add(TooltipData &data,
2103 const float4 &color,
2104 bool has_alpha,
2105 bool is_gamma,
2106 const ColorManagedDisplay *display,
2107 TooltipColorID color_id);
2108
2113void tooltip_uibut_python_add(TooltipData &data,
2114 bContext &C,
2115 Button &but,
2116 ButtonExtraOpIcon *extra_icon);
2117
2121void button_tooltip_refresh(bContext *C, Button *but);
2126void button_tooltip_timer_remove(bContext *C, Button *but);
2127
2135 ARegion *region,
2136 const void *rna_poin_data,
2137 const char *rna_prop_id);
2139 ARegion *region,
2140 const void *rna_poin_data,
2141 const char *rna_prop_id,
2142 Block &block);
2143
2144bool textbutton_activate_but(const bContext *C, Button *actbut);
2145
2150void button_focus_on_enter_event(wmWindow *win, Button *but);
2151
2152void button_func_hold_set(Button *but, ButtonHandleHoldFunc func, void *argN);
2153
2155 StringRefNull opname,
2156 wm::OpCallContext opcontext,
2157 int icon);
2158wmOperatorType *button_extra_operator_icon_optype_get(const ButtonExtraOpIcon *extra_icon);
2159PointerRNA *button_extra_operator_icon_opptr_get(const ButtonExtraOpIcon *extra_icon);
2160
2165int preview_tile_size_x(const int size_px = 96);
2166int preview_tile_size_y(const int size_px = 96);
2167int preview_tile_size_y_no_label(const int size_px = 96);
2168
2169/* Autocomplete
2170 *
2171 * Tab complete helper functions, for use in uiButCompleteFunc callbacks.
2172 * Call begin once, then multiple times do_name with all possibilities,
2173 * and finally end to finish and get the completed name. */
2174
2175struct AutoComplete;
2176
2177#define AUTOCOMPLETE_NO_MATCH 0
2178#define AUTOCOMPLETE_FULL_MATCH 1
2179#define AUTOCOMPLETE_PARTIAL_MATCH 2
2180
2181AutoComplete *autocomplete_begin(const char *startname, size_t maxncpy);
2182void autocomplete_update_name(AutoComplete *autocpl, StringRef name);
2183int autocomplete_end(AutoComplete *autocpl, char *autoname);
2184
2185/* Button drag-data (interface_drag.cc).
2186 *
2187 * Functions to set drag data for buttons. This enables dragging support, whereby the drag data is
2188 * "dragged", not the button itself. */
2189
2190void button_drag_set_id(Button *but, ID *id);
2197void button_drag_attach_image(Button *but, const ImBuf *imb, float scale);
2198
2206void button_drag_set_asset(Button *but,
2207 const asset_system::AssetRepresentation *asset,
2208 const AssetImportSettings &import_settings,
2209 int icon,
2210 int preview_icon);
2211
2212void button_drag_set_rna(Button *but, PointerRNA *ptr);
2217void button_drag_set_path(Button *but, const char *path);
2218void button_drag_set_name(Button *but, const char *name);
2219
2224void button_drag_set_image(Button *but, const char *path, int icon, const ImBuf *imb, float scale);
2225
2226/* Panels
2227 *
2228 * Functions for creating, freeing and drawing panels. The API here
2229 * could use a good cleanup, though how they will function in 2.5 is
2230 * not clear yet so we postpone that. */
2231
2232void panels_begin(const bContext *C, ARegion *region);
2233void panels_end(const bContext *C, ARegion *region, int *r_x, int *r_y);
2237void panels_draw(const bContext *C, ARegion *region);
2238
2239void panels_do_after_block_layout_fns(const bContext *C, ARegion *region);
2240
2241Panel *panel_find_by_type(ListBaseT<Panel> *lb, const PanelType *pt);
2245Panel *panel_begin(ARegion *region,
2246 ListBaseT<Panel> *lb,
2247 Block *block,
2248 PanelType *pt,
2249 Panel *panel,
2250 bool *r_open);
2256void panel_header_buttons_begin(Panel *panel);
2260void panel_header_buttons_end(Panel *panel);
2261void panel_end(Panel *panel, int width, int height);
2262
2264void panel_drawname_set(Panel *panel, StringRef name);
2265
2271void panel_context_pointer_set(Panel *panel, const char *name, PointerRNA *ptr);
2272
2277bool panel_is_closed(const Panel *panel);
2278bool panel_is_active(const Panel *panel);
2282void panel_label_offset(const Block *block, int *r_x, int *r_y);
2283bool panel_should_show_background(const ARegion *region, const PanelType *panel_type);
2284int panel_size_y(const Panel *panel);
2285bool panel_is_dragging(const Panel *panel);
2290bool panel_matches_search_filter(const Panel *panel);
2291bool panel_can_be_pinned(const Panel *panel);
2292
2293bool panel_category_is_visible(const ARegion *region);
2294bool panel_category_tabs_is_visible(const ARegion *region);
2295void panel_category_add(ARegion *region, const char *name, int icon = 0);
2296PanelCategoryDyn *panel_category_find(const ARegion *region, const char *idname);
2297int panel_category_index_find(ARegion *region, const char *idname);
2298PanelCategoryStack *panel_category_active_find(ARegion *region, const char *idname);
2299const char *panel_category_active_get(ARegion *region, bool set_fallback);
2300void panel_category_active_set(ARegion *region, const char *idname);
2302void panel_category_index_active_set(ARegion *region, const int index);
2303void panel_category_active_set_default(ARegion *region, const char *idname);
2304void panel_category_clear_all(ARegion *region);
2308void panel_category_tabs_draw_all(const bContext *C,
2309 ARegion *region,
2310 const char *category_id_active);
2312void panel_category_show_tab(const bContext &C, ARegion *region, StringRef category);
2313
2314void panel_stop_animation(const bContext *C, Panel *panel);
2315
2316/* Panel custom data. */
2317PointerRNA *panel_custom_data_get(const Panel *panel);
2318PointerRNA *region_panel_custom_data_under_cursor(const bContext *C, const wmEvent *event);
2319void panel_custom_data_set(Panel *panel, PointerRNA *custom_data);
2320
2321/* Poly-instantiated panels for representing a list of data. */
2326Panel *panel_add_instanced(const bContext *C,
2327 ARegion *region,
2328 ListBaseT<Panel> *panels,
2329 const char *panel_idname,
2330 PointerRNA *custom_data);
2337void panels_free_instanced(const bContext *C, ARegion *region);
2338
2339#define INSTANCED_PANEL_UNIQUE_STR_SIZE 16
2344void list_panel_unique_str(Panel *panel, char *r_name);
2345
2346using ListPanelIDFromDataFunc = void (*)(void *data_link, char *r_idname);
2356bool panel_list_matches_data(ARegion *region,
2357 ListBase *data,
2358 ListPanelIDFromDataFunc panel_idname_func);
2359
2360/* Handlers
2361 *
2362 * Handlers that can be registered in regions, areas and windows for
2363 * handling WM events. Mostly this is done automatic by modules such
2364 * as screen/ if ED_KEYMAP_UI is set, or internally in popup functions. */
2365
2366void region_handlers_add(ListBaseT<wmEventHandler> *handlers);
2368 ListBaseT<wmEventHandler> *handlers,
2369 PopupBlockHandle *popup,
2370 char flag);
2371void popup_handlers_remove(ListBaseT<wmEventHandler> *handlers, PopupBlockHandle *popup);
2372void popup_handlers_remove_all(bContext *C, ListBaseT<wmEventHandler> *handlers);
2373
2379void refresh_for_srna_unregister(Main *bmain, StructRNA *srna_to_unreg);
2380
2381/* Module
2382 *
2383 * init and exit should be called before using this module. init_userdef must
2384 * be used to reinitialize some internal state if user preferences change. */
2385
2386void init();
2387/* after reading userdef file */
2388void init_userdef();
2389void reinit_font();
2390void exit();
2391
2392/* When changing UI font, update text style weights with default font weight
2393 * if non-variable. Therefore fixed weight bold font will look bold. */
2394void update_text_styles();
2395
2396void invalidate_text_wrap_cache(const ARegion &region);
2397
2398#define UI_UNIT_X ((void)0, U.widget_unit)
2399#define UI_UNIT_Y ((void)0, U.widget_unit)
2400
2401#define UI_HEADER_OFFSET \
2402 ((void)0, ((U.uiflag & USER_AREA_CORNER_HANDLE) ? 16.0f : 8.0f) * UI_SCALE_FAC)
2403
2404#define UI_AZONESPOTW_LEFT UI_HEADER_OFFSET /* Width of left-side corner #AZone. */
2405#define UI_AZONESPOTW_RIGHT (8.0f * UI_SCALE_FAC) /* Width of right-side corner #AZone. */
2406#define UI_AZONESPOTH (0.6f * U.widget_unit) /* Height of corner action zone #AZone. */
2407
2408/* uiLayoutOperatorButs flags */
2409enum {
2414 /* Disable property split for the default layout (custom ui callbacks still have full control
2415 * over the layout and can enable it). */
2426};
2427
2428/* Used for transparent checkers shown under color buttons that have an alpha component. */
2429#define UI_ALPHA_CHECKER_DARK 100
2430#define UI_ALPHA_CHECKER_LIGHT 160
2431
2432/* flags to set which corners will become rounded:
2433 *
2434 * 1------2
2435 * | |
2436 * 8------4 */
2437
2438enum {
2443 /* just for convenience */
2446};
2447
2448void region_message_subscribe(ARegion *region, wmMsgBus *mbus);
2449
2457MenuType *button_menutype_get(const Button *but);
2461PanelType *button_paneltype_get(const Button *but);
2465std::optional<StringRefNull> button_asset_shelf_type_idname_get(const Button *but);
2466
2467/* templates */
2468void template_header(Layout *layout, bContext *C);
2469void template_id(Layout *layout,
2470 const bContext *C,
2471 PointerRNA *ptr,
2472 StringRefNull propname,
2473 const char *newop,
2474 const char *openop,
2475 const char *unlinkop,
2477 bool live_icon = false,
2478 std::optional<StringRef> text = std::nullopt);
2480 Layout &layout, bContext *C, PointerRNA *ptr, StringRefNull propname, short idcode);
2481void template_id_browse(Layout *layout,
2482 bContext *C,
2483 PointerRNA *ptr,
2484 StringRefNull propname,
2485 const char *newop,
2486 const char *openop,
2487 const char *unlinkop,
2489 const char *text = nullptr);
2490void template_id_preview(Layout *layout,
2491 bContext *C,
2492 PointerRNA *ptr,
2493 StringRefNull propname,
2494 const char *newop,
2495 const char *openop,
2496 const char *unlinkop,
2497 int rows,
2498 int cols,
2500 bool hide_buttons = false);
2501void template_matrix(Layout *layout, PointerRNA *ptr, StringRefNull propname);
2505void template_id_tabs(Layout *layout,
2506 bContext *C,
2507 PointerRNA *ptr,
2508 StringRefNull propname,
2509 const char *newop,
2510 const char *menu,
2520void template_any_id(Layout *layout,
2521 PointerRNA *ptr,
2522 StringRefNull propname,
2523 StringRefNull proptypename,
2524 std::optional<StringRef> text);
2525
2535void template_action(Layout *layout,
2536 const bContext *C,
2537 ID *id,
2538 const char *newop,
2539 const char *unlinkop,
2540 std::optional<StringRef> text);
2541
2546void template_search(Layout *layout,
2547 const bContext *C,
2548 PointerRNA *ptr,
2549 StringRefNull propname,
2550 PointerRNA *searchptr,
2551 const char *searchpropname,
2552 const char *newop,
2553 const char *unlinkop,
2554 std::optional<StringRef> text = std::nullopt);
2555void template_search_preview(Layout *layout,
2556 bContext *C,
2557 PointerRNA *ptr,
2558 StringRefNull propname,
2559 PointerRNA *searchptr,
2560 const char *searchpropname,
2561 const char *newop,
2562 const char *unlinkop,
2563 int rows,
2564 int cols,
2565 std::optional<StringRef> text = std::nullopt);
2566
2580void template_filepath(Layout *layout,
2581 const bContext *C,
2582 PointerRNA *ptr,
2583 const StringRefNull propname,
2584 const char *pathselect_op,
2585 const char *filter_glob,
2586 const std::optional<StringRef> name,
2587 const std::optional<StringRef> placeholder,
2588 bool split_name = false);
2589
2597void template_path_builder(Layout *layout,
2598 PointerRNA *ptr,
2599 StringRefNull propname,
2600 PointerRNA *root_ptr,
2601 std::optional<StringRefNull> text);
2602void template_modifiers(Layout *layout, bContext *C);
2603void template_strip_modifiers(Layout *layout, bContext *C);
2604void template_scene_compositor_effects(Layout *layout, bContext *C);
2605
2609void template_shader_fx(Layout *layout, bContext *C);
2613void template_constraints(Layout *layout, bContext *C, bool use_bone_constraints);
2614
2615void template_greasepencil_color_preview(Layout *layout,
2616 bContext *C,
2617 PointerRNA *ptr,
2618 StringRefNull propname,
2619 int rows,
2620 int cols,
2621 float scale,
2622 int filter);
2623
2624void template_operator_redo_properties(Layout *layout, const bContext *C);
2625
2626void template_constraint_header(Layout *layout, PointerRNA *ptr);
2627void template_preview(Layout *layout,
2628 bContext *C,
2629 ID *id,
2630 bool show_buttons,
2631 ID *parent,
2632 MTex *slot,
2633 const char *preview_id);
2634void template_color_ramp(Layout *layout, PointerRNA *ptr, StringRefNull propname, bool expand);
2638void template_icon(Layout *layout, int icon_value, float icon_scale);
2642void template_icon_view(Layout *layout,
2643 PointerRNA *ptr,
2644 StringRefNull propname,
2645 bool show_labels,
2646 float icon_scale,
2647 float icon_scale_popup);
2648void template_histogram(Layout *layout, PointerRNA *ptr, StringRefNull propname);
2649void template_waveform(Layout *layout, PointerRNA *ptr, StringRefNull propname);
2650void template_vectorscope(Layout *layout, PointerRNA *ptr, StringRefNull propname);
2651void template_curve_mapping(Layout *layout,
2652 PointerRNA *ptr,
2653 StringRefNull propname,
2654 int type,
2655 bool levels,
2656 bool brush,
2657 bool neg_slope,
2658 bool tone,
2659 bool presets);
2664void template_curve_profile(Layout *layout, PointerRNA *ptr, StringRefNull propname);
2668void template_color_picker(Layout *layout,
2669 PointerRNA *ptr,
2670 StringRefNull propname,
2671 bool value_slider,
2672 bool lock,
2673 bool lock_luminosity,
2674 bool cubic);
2675void template_palette(Layout *layout, PointerRNA *ptr, StringRefNull propname);
2676void template_crypto_picker(Layout *layout, PointerRNA *ptr, StringRefNull propname, int icon);
2681void template_layers(Layout *layout,
2682 PointerRNA *ptr,
2683 StringRefNull propname,
2684 PointerRNA *used_ptr,
2685 const char *used_propname,
2686 int active_layer);
2687
2688} // namespace ui
2689
2690void uiTemplateImage(ui::Layout *layout,
2691 bContext *C,
2692 PointerRNA *ptr,
2693 StringRefNull propname,
2694 PointerRNA *userptr,
2695 bool compact,
2696 bool multiview);
2697void uiTemplateImageSettings(ui::Layout *layout,
2698 bContext *C,
2699 PointerRNA *imfptr,
2700 bool color_management,
2701 const char *panel_idname = nullptr);
2702void uiTemplateImageStereo3d(ui::Layout *layout, PointerRNA *stereo3d_format_ptr);
2703void uiTemplateImageViews(ui::Layout *layout, PointerRNA *imaptr);
2704void uiTemplateImageFormatViews(ui::Layout *layout, PointerRNA *imfptr, PointerRNA *ptr);
2705void uiTemplateImageLayers(ui::Layout *layout, bContext *C, Image *ima, ImageUser *iuser);
2706void uiTemplateImageInfo(ui::Layout *layout, bContext *C, Image *ima, ImageUser *iuser);
2707
2708namespace ui {
2709void template_running_jobs(Layout *layout, bContext *C);
2710void button_func_operator_search(Button *but);
2711void uiTemplateOperatorSearch(Layout *layout);
2712
2713void button_func_menu_search(Button *but, const char *single_menu_idname = nullptr);
2714void uiTemplateMenuSearch(Layout *layout);
2715
2722 const bContext *C, Layout *layout, wmOperator *op, eButLabelAlign label_align, short flag);
2723} // namespace ui
2726namespace ui {
2727void uiTemplateReportsBanner(Layout *layout, bContext *C);
2728void uiTemplateInputStatus(Layout *layout, bContext *C);
2729void uiTemplateStatusInfo(Layout *layout, bContext *C);
2730void uiTemplateKeymapItemProperties(Layout *layout, PointerRNA *ptr);
2731
2733 StringRefNull text,
2734 const wmKeyMapItem *kmi,
2735 bool text_fallback);
2736
2737/* Draw keymap item for status bar. Returns number of items consumed,
2738 * as X/Y/Z items may get merged to use less space. */
2740 wmOperator *op,
2741 const wmKeyMap *keymap,
2742 const EnumPropertyItem *item);
2743
2744void template_component_menu(Layout *layout,
2745 PointerRNA *ptr,
2746 StringRefNull propname,
2747 StringRef name);
2748void template_node_socket(Layout *layout, bContext *C, const float color[4]);
2749
2754void template_cache_file(Layout *layout,
2755 const bContext *C,
2756 PointerRNA *ptr,
2757 StringRefNull propname);
2758
2764bool template_cache_file_pointer(PointerRNA *ptr, StringRefNull propname, PointerRNA *r_file_ptr);
2765
2769void template_cache_file_velocity(Layout *layout, PointerRNA *fileptr);
2770
2774void template_cache_file_time_settings(Layout *layout, PointerRNA *fileptr);
2775
2779void template_uilist_flags(Layout *layout, const bContext *C, PointerRNA *fileptr);
2780
2782#define UI_UL_DEFAULT_CLASS_NAME "UI_UL_list"
2791
2792void template_uilist(Layout *layout,
2793 const bContext *C,
2794 const char *listtype_name,
2795 const char *list_id,
2796 PointerRNA *dataptr,
2797 StringRefNull propname,
2798 PointerRNA *active_dataptr,
2799 StringRefNull active_propname,
2800 const char *item_dyntip_propname,
2801 int rows,
2802 int maxrows,
2803 int layout_type,
2804 enum TemplateListFlags flags);
2805} // namespace ui
2806
2808 ui::Layout *layout, bContext *C, bNodeTree *ntree, bNode *node, bNodeSocket *input);
2810 ui::Layout *layout, bContext *C, bNodeTree *ntree, bNode *node, bNodeSocket *input);
2811
2813
2818 const bContext *C,
2819 PointerRNA *ptr,
2820 PropertyRNA *prop);
2821
2823 ui::Layout *layout, bContext *C, PointerRNA *ptr, StringRefNull propname, bool compact);
2824void uiTemplateTrack(ui::Layout *layout, PointerRNA *ptr, StringRefNull propname);
2825void uiTemplateMarker(ui::Layout *layout,
2826 PointerRNA *ptr,
2827 StringRefNull propname,
2828 PointerRNA *userptr,
2829 PointerRNA *trackptr,
2830 bool compact);
2832 PointerRNA *ptr,
2833 StringRefNull propname,
2834 PointerRNA *userptr);
2835namespace ui {
2836
2837void template_colorspace_settings(Layout *layout, PointerRNA *ptr, StringRefNull propname);
2838void template_colormanaged_view_settings(Layout *layout,
2839 bContext *C,
2840 PointerRNA *ptr,
2841 StringRefNull propname);
2842
2844 All,
2845 Project,
2847};
2848int template_recent_files(Layout *layout,
2849 int rows,
2851 float project_ratio = 0.5f);
2852int template_recent_projects(Layout *layout, int rows);
2853void template_project_splash(Layout *layout, bContext *C);
2854void template_file_select_path(Layout *layout, bContext *C, FileSelectParams *params);
2855
2857 Layout &layout, const bContext &C, StringRefNull asset_shelf_id, StringRef name, int icon);
2858
2860 Layout *layout, bContext *C, Layout *context_layout, PointerRNA *ptr, StringRefNull propname);
2861
2862void template_bone_collection_tree(Layout *layout, bContext *C);
2863void template_grease_pencil_layer_tree(Layout *layout, bContext *C);
2864
2865void template_project_asset_libraries_tree(Layout *layout, bContext *C);
2866
2867void template_tree_interface(Layout *layout, const bContext *C, PointerRNA *ptr);
2871void template_node_inputs(Layout *layout, bContext *C, PointerRNA *ptr);
2872
2876void template_compositor_strip_inputs(Layout *layout, bContext *C, PointerRNA *ptr);
2877
2878void template_collection_importer(Layout *layout, bContext *C);
2879void template_collection_exporters(Layout *layout, bContext *C);
2880} // namespace ui
2881
2883void template_tree(ui::Layout *layout, bContext *C);
2884}
2885
2886namespace ui {
2891bool uilist_item_index_is_filtered_visible(const struct uiList *ui_list, int item_idx);
2892
2893/* UI Operators */
2899
2900void operatortypes_ui();
2904void keymap_ui(wmKeyConfig *keyconf);
2905void dropboxes_ui();
2906void uilisttypes_ui();
2907
2908void drop_color_copy(bContext *C, wmDrag *drag, wmDropBox *drop);
2909bool drop_color_poll(bContext *C, wmDrag *drag, const wmEvent *event);
2910
2912 PointerRNA *ptr,
2913 PropertyRNA *prop,
2914 Vector<PointerRNA> *r_lb,
2915 bool *r_use_path_from_id,
2916 std::optional<std::string> *r_path);
2918 PointerRNA *ptr_link,
2919 PropertyRNA *prop,
2920 const char *path,
2921 bool use_path_from_id,
2922 PointerRNA *r_ptr,
2923 PropertyRNA **r_prop);
2924
2925/* Helpers for Operators */
2939 PointerRNA *r_ptr,
2940 PropertyRNA **r_prop,
2941 int *r_index);
2942
2949 PointerRNA *r_ptr,
2950 PropertyRNA **r_prop,
2951 int *r_index);
2952
2953void context_active_but_prop_handle(bContext *C, bool handle_undo);
2954void context_active_but_clear(bContext *C, wmWindow *win, ARegion *region);
2955
2962 PointerRNA *r_ptr,
2963 PropertyRNA **r_prop,
2964 bool *r_is_undo,
2965 bool *r_is_userdef);
2972 PointerRNA *r_ptr,
2973 PropertyRNA **r_prop);
2975
2976Button *region_active_but_get(const ARegion *region);
2977Button *region_but_find_rect_over(const ARegion *region, const rcti *rect_px);
2978Block *region_block_find_mouse_over(const ARegion *region, const int xy[2], bool only_clip);
2982ARegion *region_searchbox_region_get(const ARegion *button_region);
2983
2989
2990/* Styled text draw */
2991void fontstyle_set(const uiFontStyle *fs);
2992void fontstyle_draw_ex(const uiFontStyle *fs,
2993 const rcti *rect,
2994 const char *str,
2995 size_t str_len,
2996 const uchar col[4],
2997 const FontStyleDrawParams *fs_params,
2998 int *r_xofs,
2999 int *r_yofs,
3000 ResultBLF *r_info);
3001
3002void fontstyle_draw(const uiFontStyle *fs,
3003 const rcti *rect,
3004 const char *str,
3005 size_t str_len,
3006 const uchar col[4],
3007 const FontStyleDrawParams *fs_params);
3008
3010 const rcti *rect,
3011 const char *str,
3012 const uchar col[4],
3013 FontStyleAlign align,
3014 int *r_xofs,
3015 int *r_yofs,
3016 ResultBLF *r_info);
3021 const rcti *rect,
3022 const char *str,
3023 const uchar col[4],
3024 FontStyleAlign align);
3025
3029void fontstyle_draw_rotated(const uiFontStyle *fs,
3030 const rcti *rect,
3031 const char *str,
3032 const uchar col[4]);
3040 const uiFontStyle *fs, float x, float y, const char *str, const uchar col[4]);
3045 float x,
3046 float y,
3047 StringRef str,
3048 const float col_fg[4],
3049 const float col_bg[4]);
3050
3052 ATTR_NONNULL(1, 2);
3064 StringRef str,
3065 float aspect) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
3066int fontstyle_height_max(const uiFontStyle *fs);
3067
3071void draw_icon_tri(float x, float y, char dir, const float[4], float aspect = 1.0f);
3072
3076const uiStyle *style_get(); /* use for fonts etc */
3080const uiStyle *style_get_dpi();
3081
3082/* #UI_OT_editsource helpers. */
3085
3096void but_ensure_in_view(const bContext *C, ARegion *region, const Button *but);
3097
3098/* UI_butstore_ helpers */
3099struct ButStore;
3100
3108void butstore_clear(Block *block);
3112void butstore_update(Block *block);
3113void butstore_free(Block *block, ButStore *bs_handle);
3114bool butstore_is_valid(ButStore *bs_handle);
3115bool butstore_is_registered(Block *block, Button *but);
3116void butstore_register(ButStore *bs_handle, Button **but_p);
3120bool butstore_register_update(Block *block, Button *but_dst, const Button *but_src);
3121void butstore_unregister(ButStore *bs_handle, Button **but_p);
3122
3123/* interface_region_tooltip.cc */
3124
3129 ARegion *butregion,
3130 Button *but,
3131 bool is_quick_tip);
3133 ARegion *butregion,
3134 Button *but,
3135 ButtonExtraOpIcon *extra_icon,
3136 bool is_quick_tip);
3139 FunctionRef<void(TooltipData &data)> create_fn,
3140 const float init_position[2]);
3141
3142void tooltip_free(bContext *C, bScreen *screen, ARegion *region);
3143
3152 const ARegion *searchbox_region,
3153 const rcti *item_rect,
3154 ID *id);
3155
3156/* How long before a tool-tip shows. */
3157#define UI_TOOLTIP_DELAY 0.5
3158#define UI_TOOLTIP_DELAY_QUICK 0.2
3159
3160/* Float precision helpers */
3161
3162/* Maximum number of digits of precision (not number of decimal places)
3163 * to display for float values. Note that the UI_FLOAT_VALUE_DISPLAY_*
3164 * defines that follow depend on this. */
3165#define UI_PRECISION_FLOAT_MAX 6
3166
3167/* Values exceeding this range are displayed as "inf" / "-inf".
3168 * This range is almost FLT_MAX to -FLT_MAX, but each is truncated
3169 * to our display precision, set by UI_PRECISION_FLOAT_MAX. Each
3170 * is approximately `FLT_MAX / 1.000001` but that calculation does
3171 * not give us the explicit zeros needed for this exact range. */
3172#define UI_FLOAT_VALUE_DISPLAY_MAX 3.402820000e+38F
3173#define UI_FLOAT_VALUE_DISPLAY_MIN -3.402820000e+38F
3174
3175/* For float buttons the 'step', is scaled */
3176#define UI_PRECISION_FLOAT_SCALE 0.01f
3177
3178/* Typical UI text */
3179#define UI_FSTYLE_WIDGET (const uiFontStyle *)&(ui::style_get()->widget)
3180#define UI_FSTYLE_TOOLTIP (const uiFontStyle *)&(ui::style_get()->tooltip)
3181
3186int calc_float_precision(int prec, double value);
3187
3188/* widget batched drawing */
3192
3193/* Use for resetting the theme. */
3194namespace theme {
3195
3202void init_default();
3203
3204} // namespace theme
3205
3206void style_init_default();
3207
3209
3211#define USE_UI_TOOLBAR_HACK
3212
3214#define USE_UI_POPOVER_ONCE
3215
3216bool view_item_matches(const AbstractViewItem &a, const AbstractViewItem &b);
3222bool view_item_can_rename(const AbstractViewItem &item);
3223void view_item_begin_rename(AbstractViewItem &item);
3224
3225bool view_item_supports_drag(const AbstractViewItem &item);
3227bool view_item_popup_keep_open(const AbstractViewItem &item);
3233bool view_item_drag_start(bContext &C, AbstractViewItem &item);
3234
3239AbstractView *region_view_find_at(const ARegion *region,
3240 const int xy[2],
3241 int pad,
3242 Block **r_block = nullptr);
3243void region_view_scroll_at_borders(bContext *C, wmDropBox &dropbox, const wmEvent *event);
3247AbstractViewItem *region_views_find_item_at(const ARegion &region, const int xy[2]);
3248AbstractViewItem *region_views_find_active_item(const ARegion *region, const AbstractView *view);
3249Button *region_views_find_active_item_but(const ARegion *region);
3250void region_views_clear_search_highlight(const ARegion *region);
3251
3252bool region_panels_fits_only_categories(const ARegion *region);
3257bool panel_region_visible_width_ensure(ARegion *region);
3258
3259void register_scene_compositor_effects_panel(ARegionType *region_type);
3260
3267
3277std::optional<int2> try_activate_rna_button(bContext *C,
3278 ARegion *region,
3279 ActivationButtonState target_state,
3280 PointerRNA *ptr,
3281 PropertyRNA *prop,
3282 bool warp_cursor_at_button = false,
3283 int index = 0);
3284} // namespace ui
3285} // namespace blender
#define ATTR_WARN_UNUSED_RESULT
#define ATTR_NONNULL(...)
These structs are the foundation for all linked lists in the library system.
struct uiStyle uiStyle
struct uiWidgetColors uiWidgetColors
struct uiFontStyle uiFontStyle
Read Blender memory allocation and freeing.
#define C
Definition RandGen.cpp:29
#define KM_MOD_NUM
Definition WM_types.hh:310
int pad[32 - sizeof(int)]
volatile int lock
btScalar max
#define str(s)
#define index(i)
unsigned int uchar
float3x3 scale(float3x3 mat, float2 scale)
const int state
void MEM_delete_void(void *vmemh)
Definition mallocn.cc:109
void * MEM_dupalloc_void(const void *vmemh)
Definition mallocn.cc:139
ccl_device_inline dual1 len(const ccl_private dual< T > &a)
Definition math_dual.h:263
#define T
void free(Subdiv *subdiv)
Definition subdiv.cc:192
void template_tree(ui::Layout *layout, bContext *C)
std::string ptr_type(const ResourceString &str)
void interface_tag_script_reload()
void template_greasepencil_color_preview(Layout *layout, bContext *C, PointerRNA *ptr, StringRefNull propname, int rows, int cols, float scale, int filter)
void butstore_free(Block *block, ButStore *bs_handle)
void fontstyle_draw_multiline_clipped_ex(const uiFontStyle *fs, const rcti *rect, const char *str, const uchar col[4], FontStyleAlign align, int *r_xofs, int *r_yofs, ResultBLF *r_info)
std::optional< int2 > try_activate_rna_button(bContext *C, ARegion *region, ActivationButtonState target_state, PointerRNA *ptr, PropertyRNA *prop, bool warp_cursor_at_button=false, int index=0)
void butstore_clear(Block *block)
void button_search_preview_grid_size_set(Button *but, int rows, int cols)
void block_interaction_set(Block *block, BlockInteraction_CallbackData *callbacks)
void panel_drawname_set(Panel *panel, StringRef name)
Button * uiDefIconTextBut(Block *block, ButtonTypeWithPointerType but_and_ptr_type, int icon, StringRef str, int x, int y, short width, short height, void *poin, std::optional< StringRef > tip)
void block_lock_set(Block *block, bool val, const char *lockstr)
bool button_active_drop_color(bContext *C)
int icon_from_event_type(short event_type, short event_value)
void template_file_select_path(Layout *layout, bContext *C, FileSelectParams *params)
int icon_from_report_type(int type)
void panel_context_pointer_set(Panel *panel, const char *name, PointerRNA *ptr)
void tooltip_color_field_add(TooltipData &data, const float4 &color, bool has_alpha, bool is_gamma, const ColorManagedDisplay *display, TooltipColorID color_id)
Button * uiDefSearchButO_ptr(Block *block, wmOperatorType *ot, IDProperty *properties, void *arg, int icon, int maxncpy, int x, int y, short width, short height, std::optional< StringRef > tip)
std::string button_extra_icon_string_get_tooltip(bContext &C, const ButtonExtraOpIcon &extra_icon)
int panel_size_y(const Panel *panel)
void template_shader_fx(Layout *layout, bContext *C)
PieMenu * pie_menu_begin(bContext *C, const char *title, int icon, const wmEvent *event) ATTR_NONNULL()
void panel_category_add(ARegion *region, const char *name, int icon=0)
void template_modifiers(Layout *layout, bContext *C)
void block_direction_set(Block *block, char direction)
void butstore_update(Block *block)
void blocklist_free(const bContext *C, ARegion *region)
bool region_button_sections_is_inside_x(const ARegion *region, const int mval_x)
std::string button_string_get_tooltip(bContext &C, Button &but)
int button_unit_type_get(const Button *but)
void template_curve_profile(Layout *layout, PointerRNA *ptr, StringRefNull propname)
void UI_screen_free_active_but_highlight(const bContext *C, bScreen *screen)
void(*)(bContext *C, Layout *layout, void *arg1) MenuCreateFunc
Button * uiDefButR(Block *block, ButtonType type, std::optional< StringRef > str, int x, int y, short width, short height, PointerRNA *ptr, StringRefNull propname, int index, float min, float max, std::optional< StringRef > tip)
void template_color_picker(Layout *layout, PointerRNA *ptr, StringRefNull propname, bool value_slider, bool lock, bool lock_luminosity, bool cubic)
Button * uiDefIconButR(Block *block, ButtonType type, int icon, int x, int y, short width, short height, PointerRNA *ptr, StringRefNull propname, int index, float min, float max, std::optional< StringRef > tip)
void drop_color_copy(bContext *C, wmDrag *drag, wmDropBox *drop)
Button * uiDefIconTextButR(Block *block, ButtonType type, int icon, std::optional< StringRefNull > str, int x, int y, short width, short height, PointerRNA *ptr, StringRefNull propname, int index, std::optional< StringRef > tip)
ARegion * tooltip_create_from_button_or_extra_icon(bContext *C, ARegion *butregion, Button *but, ButtonExtraOpIcon *extra_icon, bool is_quick_tip)
void button_menu_disable_hover_open(Button *but)
void template_action(Layout *layout, const bContext *C, ID *id, const char *newop, const char *unlinkop, std::optional< StringRef > text)
Button * button_active_drop_name_button(const bContext *C)
void button_func_search_set_results_are_suggestions(Button *but, bool value)
void popup_block_close(bContext *C, wmWindow *win, Block *block)
void panels_begin(const bContext *C, ARegion *region)
Layout * pie_menu_layout(PieMenu *pie)
void template_filepath(Layout *layout, const bContext *C, PointerRNA *ptr, const StringRefNull propname, const char *pathselect_op, const char *filter_glob, const std::optional< StringRef > name, const std::optional< StringRef > placeholder, bool split_name=false)
void template_ID_session_uid(Layout &layout, bContext *C, PointerRNA *ptr, StringRefNull propname, short idcode)
int icon_colorid_from_report_type(int type)
wmOperatorType * button_extra_operator_icon_optype_get(const ButtonExtraOpIcon *extra_icon)
bool region_panels_fits_only_categories(const ARegion *region)
void button_func_tooltip_custom_set_cpp(Button &but, Func &&func)
std::optional< std::string > button_online_manual_id_from_active(const bContext *C) ATTR_WARN_UNUSED_RESULT
void template_palette(Layout *layout, PointerRNA *ptr, StringRefNull propname)
ID * context_active_but_get_tab_ID(bContext *C)
std::optional< std::string > button_online_manual_id(const Button *but) ATTR_WARN_UNUSED_RESULT
Button * region_but_find_rect_over(const ARegion *region, const rcti *rect_px)
Button * uiDefAutoButR(Block *block, PointerRNA *ptr, PropertyRNA *prop, int index, std::optional< StringRef > name, int icon, int x, int y, int width, int height, std::optional< ButtonType > button_type_override=std::nullopt)
void template_scene_compositor_effects(Layout *layout, bContext *C)
void(*)(bContext *C, void *argN, void *arg2) ButtonHandleNFunc
void region_views_clear_search_highlight(const ARegion *region)
void button_dragflag_disable(Button *but, int flag)
void button_label_draw_icon_border_set(Button *but, bool use_icon_border)
void panel_category_clear_all(ARegion *region)
void(*)(bContext *C, void *arg1, void *arg2) ButtonHandleFunc
void block_set_search_only(Block *block, bool search_only)
int textbox_but_height(const TextboxState &state)
AbstractViewItem * region_views_find_item_at(const ARegion &region, const int xy[2])
void button_func_menu_step_set(Button *but, MenuStepFunc func)
void butstore_register(ButStore *bs_handle, Button **but_p)
void button_func_set(Button *but, std::function< void(bContext &)> func)
PointerRNA * region_panel_custom_data_under_cursor(const bContext *C, const wmEvent *event)
void butstore_unregister(ButStore *bs_handle, Button **but_p)
void widgetbase_draw_cache_begin()
bool panel_can_be_pinned(const Panel *panel)
bool panel_region_visible_width_ensure(ARegion *region)
void button_drag_attach_image(Button *but, const ImBuf *imb, float scale)
void template_constraint_header(Layout *layout, PointerRNA *ptr)
bool context_copy_to_selected_list(bContext *C, PointerRNA *ptr, PropertyRNA *prop, Vector< PointerRNA > *r_lb, bool *r_use_path_from_id, std::optional< std::string > *r_path)
bool panel_should_show_background(const ARegion *region, const PanelType *panel_type)
Button * context_active_but_get_respect_popup(const bContext *C)
void blocklist_update_window_matrix(const bContext *C, const ListBaseT< ui::Block > *lb)
int calc_float_precision(int prec, double value)
void button_func_search_set_sep_string(Button *but, const char *search_sep_string)
const uiStyle * style_get()
void fontstyle_draw_multiline_clipped(const uiFontStyle *fs, const rcti *rect, const char *str, const uchar col[4], FontStyleAlign align)
bool template_cache_file_pointer(PointerRNA *ptr, StringRefNull propname, PointerRNA *r_file_ptr)
void block_translate(Block *block, float x, float y)
Definition interface.cc:408
@ TEMPLATE_OP_PROPS_ALLOW_UNDO_PUSH
@ TEMPLATE_OP_PROPS_HIDE_ADVANCED
@ TEMPLATE_OP_PROPS_NO_SPLIT_LAYOUT
int icon_from_keymap_item(const wmKeyMapItem *kmi, int r_icon_mod[KM_MOD_NUM])
void template_search_preview(Layout *layout, bContext *C, PointerRNA *ptr, StringRefNull propname, PointerRNA *searchptr, const char *searchpropname, const char *newop, const char *unlinkop, int rows, int cols, std::optional< StringRef > text=std::nullopt)
void panels_draw(const bContext *C, ARegion *region)
void block_bounds_set_normal(Block *block, int addval)
Definition interface.cc:651
void popup_block_template_confirm_op(Layout *layout, wmOperatorType *ot, std::optional< StringRef > confirm_text, std::optional< StringRef > cancel_text, const int icon, bool cancel_default, PointerRNA *r_ptr)
bool but_has_quick_tooltip(const Button *but)
void popup_block_ex(bContext *C, BlockCreateFunc func, BlockHandleFunc popup_func, BlockCancelFunc cancel_func, void *arg, wmOperator *op)
int blocklist_min_y_get(ListBaseT< ui::Block > *lb)
char but_pointer_bit_max_index(ButPointerType pointer_type)
std::string button_string_get_rna_label(Button &but)
void style_init_default()
Definition resources.cc:67
void uiTemplateReportsBanner(Layout *layout, bContext *C)
void button_retval_set(Button *but, int retval)
void button_unit_type_set(Button *but, int unit_type)
Button * uiDefIconTextButO_ptr(Block *block, ButtonType type, wmOperatorType *ot, wm::OpCallContext opcontext, int icon, StringRef str, int x, int y, short width, short height, std::optional< StringRef > tip)
std::string button_context_menu_title_from_button(Button &but)
void uiTemplateOperatorSearch(Layout *layout)
int template_recent_projects(Layout *layout, int rows)
bool textbutton_activate_rna(const bContext *C, ARegion *region, const void *rna_poin_data, const char *rna_prop_id)
void button_context_ptr_set(Block *block, Button *but, StringRef name, const PointerRNA *ptr)
void block_lock_clear(Block *block)
void template_histogram(Layout *layout, PointerRNA *ptr, StringRefNull propname)
std::string button_string_get_rna_label_context(const Button &but)
bool panel_list_matches_data(ARegion *region, ListBase *data, ListPanelIDFromDataFunc panel_idname_func)
void context_active_but_prop_get_filebrowser(const bContext *C, PointerRNA *r_ptr, PropertyRNA **r_prop, bool *r_is_undo, bool *r_is_userdef)
PanelCategoryDyn * panel_category_find(const ARegion *region, const char *idname)
void UI_region_free_active_but_all(bContext *C, ARegion *region)
void popup_menu_but_set(PopupMenu *pup, ARegion *butregion, Button *but)
wmOperatorStatus popup_menu_invoke(bContext *C, const char *idname, ReportList *reports) ATTR_NONNULL(1
void update_text_styles()
void button_icon_indicator_color_set(Button *but, const uchar color[4])
void(*)(bContext *C, const BlockInteraction_Params *params, void *arg1, void *user_data) BlockInteractionEndFn
void operatortypes_ui()
PopupMenu * popup_menu_begin_ex(bContext *C, const char *title, const char *block_name, int icon) ATTR_NONNULL()
bool button_is_userdef(const Button *but)
void panels_do_after_block_layout_fns(const bContext *C, ARegion *region)
int fontstyle_string_width(const uiFontStyle *fs, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1
void fontstyle_draw_ex(const uiFontStyle *fs, const rcti *rect, const char *str, size_t str_len, const uchar col[4], const FontStyleDrawParams *fs_params, int *r_xofs, int *r_yofs, ResultBLF *r_info)
Button * but_find_mouse_over(const ARegion *region, const wmEvent *event) ATTR_WARN_UNUSED_RESULT
uiList * uilist_find_mouse_over(const ARegion *region, const wmEvent *event)
bool(*)(const Button *a, const Button *b) ButtonIdentityCompareFunc
void text_button_func_rename_full_set(Button *but, std::function< void(StringRefNull new_name)> rename_full_func)
void *(*)(bContext *C, const BlockInteraction_Params *params, void *arg1) BlockInteractionBeginFn
int preview_tile_size_y_no_label(const int size_px=96)
bool drop_color_poll(bContext *C, wmDrag *drag, const wmEvent *event)
void init_userdef()
void block_update_from_old(const bContext *C, Block *block)
void template_id_preview(Layout *layout, bContext *C, PointerRNA *ptr, StringRefNull propname, const char *newop, const char *openop, const char *unlinkop, int rows, int cols, int filter=TEMPLATE_ID_FILTER_ALL, bool hide_buttons=false)
bool button_active_drop_name(const bContext *C)
void uiTemplateKeymapItemProperties(Layout *layout, PointerRNA *ptr)
std::optional< StringRefNull > button_asset_shelf_type_idname_get(const Button *but)
void template_uilist_flags(Layout *layout, const bContext *C, PointerRNA *fileptr)
void template_strip_modifiers(Layout *layout, bContext *C)
bool view_item_can_rename(const AbstractViewItem &item)
void button_poin_menu_argN_set(Button *but, void *poin, void *argN, ButtonArgNFree func_argN_free_fn, ButtonArgNCopy func_argN_copy_fn)
std::string button_string_get_rna_property_identifier(const Button &but)
void button_operator_set_never_call(Button *but)
void template_matrix(Layout *layout, PointerRNA *ptr, StringRefNull propname)
PointerRNA * button_operator_ptr_ensure(Button *but)
void block_align_begin(Block *block)
wmOperator * context_active_operator_get(const bContext *C)
void template_project_splash(Layout *layout, bContext *C)
void(*)(void *arg) FreeArgFunc
void button_func_identity_compare_set(Button *but, ButtonIdentityCompareFunc cmp_fn)
int template_recent_files(Layout *layout, int rows, RecentFilesFilter filter=RecentFilesFilter::All, float project_ratio=0.5f)
void button_number_step_size_set(Button *but, float step_size)
int panel_category_index_find(ARegion *region, const char *idname)
void draw_safe_areas(uint pos, const rctf *rect, const float title_aspect[2], const float action_aspect[2])
void template_header(Layout *layout, bContext *C)
void text_button_func_rename_set(Button *but, std::function< void(bContext &C, StringRefNull oldname)> rename_func)
void button_drag_set_image(Button *but, const char *path, int icon, const ImBuf *imb, float scale)
void block_free(const bContext *C, Block *block)
void fontstyle_draw_simple_backdrop(const uiFontStyle *fs, float x, float y, StringRef str, const float col_fg[4], const float col_bg[4])
bool view_item_supports_drag(const AbstractViewItem &item)
void block_post_layout_callbacks_exec(const bContext *C, ARegion *region, Block *block)
void button_func_menu_search(Button *but, const char *single_menu_idname=nullptr)
void tooltip_free(bContext *C, bScreen *screen, ARegion *region)
void button_drag_set_name(Button *but, const char *name)
PopupMenu * popup_menu_begin(bContext *C, const char *title, int icon) ATTR_NONNULL()
void(*)(void *data_link, char *r_idname) ListPanelIDFromDataFunc
void fontstyle_set(const uiFontStyle *fs)
void autocomplete_update_name(AutoComplete *autocpl, StringRef name)
wmOperatorType * button_operatortype_get_from_enum_menu(Button *but, PropertyRNA **r_prop)
bool butstore_register_update(Block *block, Button *but_dst, const Button *but_src)
bool block_can_add_separator(const Block *block)
void invalidate_text_wrap_cache(const ARegion &region)
void button_color_set(Button *but, const uchar color[4])
void draw_dropshadow(const rctf *rct, float radius, float width, float aspect, float alpha)
Button * uiDefIconPreviewBut(Block *block, ButtonType type, int icon, int x, int y, short width, short height, void *poin, float min, float max, std::optional< StringRef > tip)
void keymap_ui(wmKeyConfig *keyconf)
User Interface Keymap.
std::optional< EnumPropertyItem > button_rna_enum_item_get(bContext &C, Button &but)
void block_end_ex(const bContext *C, Main *bmain, wmWindow *window, Scene *scene, ARegion *region, Depsgraph *depsgraph, Block *block, const int xy[2]=nullptr, int r_xy[2]=nullptr, bool postpone_callbacks=false)
void button_icon_scale_set(Button *but, float scale)
bool popup_menu_end_or_cancel(bContext *C, PopupMenu *pup)
void block_flag_enable(Block *block, int flag)
void button_enum_prop_value_set(Button *but, int retval)
void block_listen(const Block *block, const wmRegionListenerParams *listener_params)
void view_item_begin_rename(AbstractViewItem &item)
ARegion *(*)(bContext *C, ARegion *region, const rcti *item_rect, void *arg, void *active) ButtonSearchTooltipFn
void template_running_jobs(Layout *layout, bContext *C)
int icon_from_id(const ID *id)
void blocklist_draw(const bContext *C, const ListBaseT< ui::Block > *lb)
std::string button_string_get_tooltip_label(const Button &but)
ARegion * region_searchbox_region_get(const ARegion *button_region)
const ColorManagedDisplay * button_cm_display_get(Button &but)
void panel_category_active_set(ARegion *region, const char *idname)
void template_collection_importer(Layout *layout, bContext *C)
void template_uilist(Layout *layout, const bContext *C, const char *listtype_name, const char *list_id, PointerRNA *dataptr, StringRefNull propname, PointerRNA *active_dataptr, StringRefNull active_propname, const char *item_dyntip_propname, int rows, int maxrows, int layout_type, enum TemplateListFlags flags)
void register_scene_compositor_effects_panel(ARegionType *region_type)
float text_clip_middle_ex(const uiFontStyle *fstyle, char *str, float okwidth, float minwidth, size_t str_maxncpy, char rpart_sep, bool clip_right_if_tight=true, bool shorten_template_variables=false)
bool panel_is_closed(const Panel *panel)
void panels_end(const bContext *C, ARegion *region, int *r_x, int *r_y)
void panel_end(Panel *panel, int width, int height)
void(*)(bContext *C, ARegion *butregion, Button *but) ButtonHandleHoldFunc
Button * uiDefIconButV(Block *block, ButtonType type, int icon, int x, int y, short width, short height, T *poin, float min, float max, std::optional< StringRef > tip)
void button_focus_on_enter_event(wmWindow *win, Button *but)
Button * uiDefIconButO(Block *block, ButtonType type, StringRefNull opname, wm::OpCallContext opcontext, int icon, int x, int y, short width, short height, std::optional< StringRef > tip)
bool panel_matches_search_filter(const Panel *panel)
Block * region_block_find_mouse_over(const ARegion *region, const int xy[2], bool only_clip)
Button * uiDefBlockBut(Block *block, BlockCreateFunc func, void *arg, StringRef str, int x, int y, short width, short height, std::optional< StringRef > tip)
const uiStyle * style_get_dpi()
PanelType * button_paneltype_get(const Button *but)
void template_id(Layout *layout, const bContext *C, PointerRNA *ptr, StringRefNull propname, const char *newop, const char *openop, const char *unlinkop, int filter=TEMPLATE_ID_FILTER_ALL, bool live_icon=false, std::optional< StringRef > text=std::nullopt)
bool(*)(bContext *C, int direction, void *arg1) MenuStepFunc
AutoPropButsReturn uiDefAutoButsRNA(Layout *layout, PointerRNA *ptr, bool(*check_prop)(PointerRNA *ptr, PropertyRNA *prop, void *user_data), void *user_data, PropertyRNA *prop_activate_init, eButLabelAlign label_align, bool compact)
void widgetbase_draw_cache_end()
void button_label_alpha_factor_set(Button *but, float alpha_factor)
Button * uiDefIconButR_prop(Block *block, ButtonType type, int icon, int x, int y, short width, short height, PointerRNA *ptr, PropertyRNA *prop, int index, float min, float max, std::optional< StringRef > tip)
void tooltip_uibut_python_add(TooltipData &data, bContext &C, Button &but, ButtonExtraOpIcon *extra_icon)
void popup_handlers_remove_all(bContext *C, ListBaseT< wmEventHandler > *handlers)
void popup_block_invoke(bContext *C, BlockCreateFunc func, void *arg, FreeArgFunc arg_free, StructRNA *srna_owner=nullptr)
void template_project_asset_libraries_tree(Layout *layout, bContext *C)
void button_func_quick_tooltip_set(Button *but, std::function< std::string(const Button *but)> func)
void block_bounds_set_explicit(Block *block, int minx, int miny, int maxx, int maxy)
Definition interface.cc:699
@ BLOCK_NO_DRAW_OVERRIDDEN_STATE
int searchbox_size_x_guess(const bContext *C, const ButtonSearchUpdateFn update_fn, void *arg)
bool but_is_utf8(const Button *but)
void button_func_tooltip_custom_set(Button *but, ButtonToolTipCustomFunc func, void *arg, FreeArgFunc free_arg)
void panel_header_buttons_end(Panel *panel)
void fontstyle_draw(const uiFontStyle *fs, const rcti *rect, const char *str, size_t str_len, const uchar col[4], const FontStyleDrawParams *fs_params)
void uiDefAutoButsArrayR(Block *block, PointerRNA *ptr, PropertyRNA *prop, const int icon, const int x, const int y, const int tot_width, const int height)
wmOperatorStatus popover_panel_invoke(bContext *C, const char *idname, bool keep_open, bool use_numselect, ReportList *reports)
void popover_end(bContext *C, Popover *pup, wmKeyMap *keymap)
void template_colorspace_settings(Layout *layout, PointerRNA *ptr, StringRefNull propname)
void template_light_linking_collection(Layout *layout, bContext *C, Layout *context_layout, PointerRNA *ptr, StringRefNull propname)
void template_crypto_picker(Layout *layout, PointerRNA *ptr, StringRefNull propname, int icon)
void draw_icon_tri(float x, float y, char dir, const float[4], float aspect=1.0f)
void button_drawflag_enable(Button *but, int flag)
EmbossType block_emboss_get(Block *block)
bool view_item_matches(const AbstractViewItem &a, const AbstractViewItem &b)
void template_id_browse(Layout *layout, bContext *C, PointerRNA *ptr, StringRefNull propname, const char *newop, const char *openop, const char *unlinkop, int filter=TEMPLATE_ID_FILTER_ALL, const char *text=nullptr)
void block_bounds_set_text(Block *block, int addval)
Definition interface.cc:661
bool block_active_only_flagged_buttons(const bContext *C, ARegion *region, Block *block)
void panel_category_show_tab(const bContext &C, ARegion *region, StringRef category)
void panel_category_active_set_default(ARegion *region, const char *idname)
bool butstore_is_registered(Block *block, Button *but)
Button * uiDefIconTextMenuBut(Block *block, MenuCreateFunc func, void *arg, int icon, StringRef str, int x, int y, short width, short height, std::optional< StringRef > tip)
void region_view_scroll_at_borders(bContext *C, wmDropBox &dropbox, const wmEvent *event)
void template_cache_file(Layout *layout, const bContext *C, PointerRNA *ptr, StringRefNull propname)
void button_number_precision_set(Button *but, float precision)
void button_hint_drawstr_set(Button *but, const char *string)
static constexpr int PANEL_MIN_DRAW_WIDTH
std::optional< StringRefNull > button_context_string_get(const Button *but, StringRef name)
void button_drag_set_rna(Button *but, PointerRNA *ptr)
void template_cache_file_time_settings(Layout *layout, PointerRNA *fileptr)
std::string button_string_get_label(Button &but)
void button_disable(Button *but, const char *disabled_hint)
void uiTemplateInputStatus(Layout *layout, bContext *C)
void tooltip_image_field_add(TooltipData &data, const TooltipImage &image_data)
void button_func_tooltip_set(Button *but, ButtonToolTipFunc func, void *arg, FreeArgFunc free_arg)
void draw_widget_scroll(uiWidgetColors *wcol, const rcti *rect, const rcti *slider, int state)
wmOperatorStatus void popup_menu_close(const Block *block, bool is_cancel=false)
ARegion * tooltip_create_from_func(bContext *C, FunctionRef< void(TooltipData &data)> create_fn, const float init_position[2])
void template_node_socket(Layout *layout, bContext *C, const float color[4])
AbstractViewItem * region_views_find_active_item(const ARegion *region, const AbstractView *view)
void template_bone_collection_tree(Layout *layout, bContext *C)
bool button_flag_is_set(Button *but, int64_t flag)
bool template_event_from_keymap_item(Layout *layout, StringRefNull text, const wmKeyMapItem *kmi, bool text_fallback)
void button_flag_enable(Button *but, int64_t flag)
bool block_has_active_default_button(const Block *block)
void popup_handlers_add(bContext *C, ListBaseT< wmEventHandler > *handlers, PopupBlockHandle *popup, char flag)
void template_cache_file_velocity(Layout *layout, PointerRNA *fileptr)
Block * block_begin(const bContext *C, ARegion *region, std::string name, EmbossType emboss)
Layout * popup_menu_layout(PopupMenu *pup)
void(*)(bContext *C, void *arg, int event) BlockHandleFunc
void widgetbase_draw_cache_flush()
PanelCategoryStack * panel_category_active_find(ARegion *region, const char *idname)
Button * uiDefBut(Block *block, ButtonTypeWithPointerType but_and_ptr_type, StringRef str, int x, int y, short width, short height, void *poin, float min, float max, std::optional< StringRef > tip)
Button * uiDefButO(Block *block, ButtonType type, StringRefNull opname, wm::OpCallContext opcontext, const std::optional< StringRef > str, int x, int y, short width, short height, std::optional< StringRef > tip)
int(*)(bContext *C, char *str, void *arg) ButtonCompleteFunc
void template_component_menu(Layout *layout, PointerRNA *ptr, StringRefNull propname, StringRef name)
ARegion *(*)(bContext *C, ARegion *butregion, ButtonSearch *search_but) ButtonSearchCreateFn
bool editsource_enable_check()
Block *(*)(bContext *C, ARegion *region, void *arg1) BlockCreateFunc
void uiTemplateOperatorPropertyButs(const bContext *C, Layout *layout, wmOperator *op, eButLabelAlign label_align, short flag)
void draw_roundbox_corner_set(int type)
std::optional< int64_t > button_context_int_get(const Button *but, StringRef name)
void popup_handlers_remove(ListBaseT< wmEventHandler > *handlers, PopupBlockHandle *popup)
void(*)(bContext *C, const BlockInteraction_Params *params, void *arg1, void *user_data) BlockInteractionUpdateFn
void context_active_but_prop_get_templateID(const bContext *C, PointerRNA *r_ptr, PropertyRNA **r_prop)
void *(*)(const void *argN) ButtonArgNCopy
std::string button_string_get_rna_struct_identifier(const Button &but)
bool butstore_is_valid(ButStore *bs_handle)
Button * uiDefSearchBut(Block *block, void *arg, int icon, int maxncpy, int x, int y, short width, short height, std::optional< StringRef > tip)
void button_placeholder_set(Button *but, StringRef placeholder_text)
void button_drag_set_asset(Button *but, const asset_system::AssetRepresentation *asset, const AssetImportSettings &import_settings, int icon, int preview_icon)
void button_func_operator_search(Button *but)
Button * uiDefButR_prop(Block *block, ButtonType type, std::optional< StringRef > str, int x, int y, short width, short height, PointerRNA *ptr, PropertyRNA *prop, int index, float min, float max, std::optional< StringRef > tip)
void button_number_slider_precision_set(Button *but, float precision)
void template_search(Layout *layout, const bContext *C, PointerRNA *ptr, StringRefNull propname, PointerRNA *searchptr, const char *searchpropname, const char *newop, const char *unlinkop, std::optional< StringRef > text=std::nullopt)
bool panel_category_tabs_is_visible(const ARegion *region)
void block_theme_style_set(Block *block, char theme_style)
ListBaseT< LayoutPanelState > & popup_persistent_layout_panel_states(StringRef idname)
void blocklist_free_inactive(const bContext *C, ARegion *region)
Button * region_active_but_prop_get(const ARegion *region, PointerRNA *r_ptr, PropertyRNA **r_prop, int *r_index)
void button_context_int_set(Block *block, Button *but, StringRef name, int64_t value)
void panels_free_instanced(const bContext *C, ARegion *region)
bool button_active_only_ex(const bContext *C, ARegion *region, Block *block, Button *but, bool remove_on_failure)
Layout * popover_layout(Popover *pup)
bool popup_region_from_operator(const bScreen *screen, const ARegion *region)
void button_node_link_set(Button *but, bNodeSocket *socket, const float draw_color[4])
int search_items_find_index(const SearchItems *items, const char *name)
void template_collection_exporters(Layout *layout, bContext *C)
bool block_is_search_only(const Block *block)
std::string button_string_get_operator_keymap(bContext &C, Button &but)
void block_align_end(Block *block)
void template_operator_redo_properties(Layout *layout, const bContext *C)
Panel * panel_begin(ARegion *region, ListBaseT< Panel > *lb, Block *block, PanelType *pt, Panel *panel, bool *r_open)
void button_drag_set_path(Button *but, const char *path)
void panel_label_offset(const Block *block, int *r_x, int *r_y)
void popup_menu_retval_set(const Block *block, int retval, bool enable)
Button * uiDefButAlert(Block *block, AlertIcon icon, int x, int y, short width, short height)
void region_button_sections_draw(const ARegion *region, int colorid, ButtonSectionsAlign align)
bool button_active_only(const bContext *C, ARegion *region, Block *block, Button *but)
Button * uiDefMenuBut(Block *block, MenuCreateFunc func, void *arg, StringRef str, int x, int y, short width, short height, std::optional< StringRef > tip)
void button_funcN_set(Button *but, ButtonHandleNFunc funcN, void *argN, void *arg2, ButtonArgNFree func_argN_free_fn=MEM_delete_void, ButtonArgNCopy func_argN_copy_fn=MEM_dupalloc_void)
void but_ensure_in_view(const bContext *C, ARegion *region, const Button *but)
void button_tooltip_refresh(bContext *C, Button *but)
wmOperatorStatus pie_menu_invoke(bContext *C, const char *idname, const wmEvent *event)
bool panel_is_active(const Panel *panel)
void tooltip_text_field_add(TooltipData &data, std::string text, std::string suffix, const TooltipStyle style, const TooltipColorID color_id, const bool is_pad=false)
Button * uiDefIconTextButO(Block *block, ButtonType type, StringRefNull, wm::OpCallContext opcontext, int icon, StringRef str, int x, int y, short width, short height, std::optional< StringRef > tip)
void template_icon(Layout *layout, int icon_value, float icon_scale)
void template_constraints(Layout *layout, bContext *C, bool use_bone_constraints)
bool search_item_add(SearchItems *items, StringRef name, void *poin, int iconid, int64_t but_flag, uint8_t name_prefix_offset)
void button_tooltip_timer_remove(bContext *C, Button *but)
PointerRNA * button_extra_operator_icon_opptr_get(const ButtonExtraOpIcon *extra_icon)
void draw_roundbox_aa(const rctf *rect, bool filled, float rad, const float color[4])
void block_emboss_set(Block *block, EmbossType emboss)
void block_func_set(Block *block, ButtonHandleFunc func, void *arg1, void *arg2)
bool popup_block_template_confirm_is_supported(const Block *block)
void context_active_but_prop_handle(bContext *C, bool handle_undo)
void fontstyle_draw_simple(const uiFontStyle *fs, float x, float y, const char *str, const uchar col[4])
std::string button_extra_icon_string_get_label(const ButtonExtraOpIcon &extra_icon)
void draw_roundbox_4fv_ex(const rctf *rect, const float inner1[4], const float inner2[4], float shade_dir, const float outline[4], float outline_width, float rad)
Button * uiDefIconTextButR_prop(Block *block, ButtonType type, int icon, std::optional< StringRef > str, int x, int y, short width, short height, PointerRNA *ptr, PropertyRNA *prop, int index, float min, float max, std::optional< StringRef > tip)
void popup_menu_reports(bContext *C, ReportList *reports) ATTR_NONNULL()
void list_panel_unique_str(Panel *panel, char *r_name)
void block_flag_disable(Block *block, int flag)
Button * uiDefIconMenuBut(Block *block, MenuCreateFunc func, void *arg, int icon, int x, int y, short width, short height, std::optional< StringRef > tip)
void refresh_for_srna_unregister(Main *bmain, StructRNA *srna_to_unreg)
void template_color_ramp(Layout *layout, PointerRNA *ptr, StringRefNull propname, bool expand)
void block_draw(const bContext *C, Block *block)
std::string button_string_get_rna_tooltip(bContext &C, Button &but)
void button_flag_disable(Button *but, int64_t flag)
void block_end(const bContext *C, Block *block, bool postpone_callbacks=false)
void uiTemplateStatusInfo(Layout *layout, bContext *C)
void template_colormanaged_view_settings(Layout *layout, bContext *C, PointerRNA *ptr, StringRefNull propname)
bool view_item_popup_keep_open(const AbstractViewItem &item)
void template_any_id(Layout *layout, PointerRNA *ptr, StringRefNull propname, StringRefNull proptypename, std::optional< StringRef > text)
void template_compositor_strip_inputs(Layout *layout, bContext *C, PointerRNA *ptr)
Button * uiDefButO_ptr(Block *block, ButtonType type, wmOperatorType *ot, wm::OpCallContext opcontext, StringRef str, int x, int y, short width, short height, std::optional< StringRef > tip)
void reinit_font()
void button_icon_indicator_number_set(Button *but, const int indicator_number)
void panel_custom_data_set(Panel *panel, PointerRNA *custom_data)
void editsource_active_but_test(Button *but)
void template_waveform(Layout *layout, PointerRNA *ptr, StringRefNull propname)
bool block_is_empty_ex(const Block *block, bool skip_title)
Panel * panel_add_instanced(const bContext *C, ARegion *region, ListBaseT< Panel > *panels, const char *panel_idname, PointerRNA *custom_data)
void draw_roundbox_3fv_alpha(const rctf *rect, bool filled, float rad, const float col[3], float alpha)
Button * uiDefButBit(Block *block, ButtonType type, int bit, StringRef str, int x, int y, short width, short height, T *poin, float min, float max, std::optional< StringRef > tip)
Button * region_views_find_active_item_but(const ARegion *region)
bool uilist_item_index_is_filtered_visible(const struct uiList *ui_list, int item_idx)
Button * uiDefButTextBoxR(Block *block, PointerRNA *ptr, StringRefNull propname, TextboxState *state, int x, int y, short width)
std::string button_extra_icon_string_get_operator_keymap(const bContext &C, const ButtonExtraOpIcon &extra_icon)
void block_func_handle_set(Block *block, BlockHandleFunc func, void *arg)
Popover * popover_begin(bContext *C, int ui_menu_width, bool from_active_button, bool use_numselect) ATTR_NONNULL(1)
int fontstyle_height_max(const uiFontStyle *fs)
void draw_roundbox_3ub_alpha(const rctf *rect, bool filled, float rad, const unsigned char col[3], unsigned char alpha)
void(*)(bContext *C, void *arg1) BlockCancelFunc
void uiTemplateMenuSearch(Layout *layout)
void block_bounds_set_popup(Block *block, int addval, const int bounds_offset[2])
Definition interface.cc:667
bool block_is_empty(const Block *block)
void button_operator_set(Button *but, wmOperatorType *optype, wm::OpCallContext opcontext, const PointerRNA *opptr=nullptr)
void block_set_active_operator(Block *block, wmOperator *op, const bool free)
void button_drawflag_disable(Button *but, int flag)
void context_update_anim_flag(const bContext *C)
void panel_header_buttons_begin(Panel *panel)
bool button_is_color_gamma(Button &but)
void popup_block_invoke_ex(bContext *C, BlockCreateFunc func, void *arg, FreeArgFunc arg_free, bool can_refresh, StructRNA *srna_owner=nullptr)
std::string button_string_get_property_keymap(bContext &C, Button &but)
Button * uiDefIconBut(Block *block, ButtonTypeWithPointerType but_and_ptr_type, int icon, int x, int y, short width, short height, void *poin, float min, float max, std::optional< StringRef > tip)
Button * region_active_but_get(const ARegion *region)
void block_region_set(Block *block, ARegion *region)
const bContextStore * button_context_get(const Button *but)
void button_icon_indicator_set(Button *but, const char *string)
void template_grease_pencil_layer_tree(Layout *layout, bContext *C)
void block_bounds_set_menu(Block *block, int addval, const int bounds_offset[2])
Definition interface.cc:681
void button_number_slider_step_size_set(Button *but, float step_size)
void * button_func_argN_get(const Button *but)
ENUM_OPERATORS(ButPointerType)
void fontstyle_draw_rotated(const uiFontStyle *fs, const rcti *rect, const char *str, const uchar col[4])
void panel_stop_animation(const bContext *C, Panel *panel)
Button * context_active_but_prop_get(const bContext *C, PointerRNA *r_ptr, PropertyRNA **r_prop, int *r_index)
int preview_tile_size_y(const int size_px=96)
PointerRNA * button_extra_operator_icon_add(Button *but, StringRefNull opname, wm::OpCallContext opcontext, int icon)
void(*)(bContext &C, TooltipData &data, Button *but, void *argN) ButtonToolTipCustomFunc
MenuType * button_menutype_get(const Button *but)
PointerRNA * panel_custom_data_get(const Panel *panel)
void draw_text_underline(int pos_x, int pos_y, int len, int height, const float color[4])
void region_message_subscribe(ARegion *region, wmMsgBus *mbus)
Button * context_active_but_get(const bContext *C)
constexpr ButPointerType but_pointer_type_for()
void(*)(const bContext *C, void *arg, const char *str, SearchItems *items, bool is_first) ButtonSearchUpdateFn
void panel_category_tabs_draw_all(const bContext *C, ARegion *region, const char *category_id_active)
ARegion * tooltip_create_from_search_item_generic(bContext *C, const ARegion *searchbox_region, const rcti *item_rect, ID *id)
Button * uiDefBlockButN(Block *block, BlockCreateFunc func, void *argN, StringRef str, int x, int y, short width, short height, std::optional< StringRef > tip, ButtonArgNFree func_argN_free_fn=MEM_delete_void, ButtonArgNCopy func_argN_copy_fn=MEM_dupalloc_void)
Button * uiDefIconButBit(Block *block, ButtonType type, int bit, int icon, int x, int y, short width, short height, T *poin, float min, float max, std::optional< StringRef > tip)
Button * uiDefButV(Block *block, ButtonType type, StringRef str, int x, int y, short width, short height, T *poin, float min, float max, std::optional< StringRef > tip)
void popup_dummy_panel_set(ARegion *region, Block *block, StringRef idname)
bool panel_category_is_visible(const ARegion *region)
void panel_category_index_active_set(ARegion *region, const int index)
void button_func_complete_set(Button *but, ButtonCompleteFunc func, void *arg)
std::string(*)(bContext *C, void *argN, StringRef tip) ButtonToolTipFunc
void template_path_builder(Layout *layout, PointerRNA *ptr, StringRefNull propname, PointerRNA *root_ptr, std::optional< StringRefNull > text)
ARegion * tooltip_create_from_gizmo(bContext *C, wmGizmo *gz)
void template_curve_mapping(Layout *layout, PointerRNA *ptr, StringRefNull propname, int type, bool levels, bool brush, bool neg_slope, bool tone, bool presets)
int button_return_value_get(Button *but)
void template_vectorscope(Layout *layout, PointerRNA *ptr, StringRefNull propname)
Button * uiDefIconBlockBut(Block *block, BlockCreateFunc func, void *arg, int icon, int x, int y, short width, short height, std::optional< StringRef > tip)
bool textbutton_activate_but(const bContext *C, Button *actbut)
void region_handlers_add(ListBaseT< wmEventHandler > *handlers)
void button_dragflag_enable(Button *but, int flag)
void button_func_hold_set(Button *but, ButtonHandleHoldFunc func, void *argN)
AutoComplete * autocomplete_begin(const char *startname, size_t maxncpy)
int int fontstyle_string_width_with_block_aspect(const uiFontStyle *fs, StringRef str, float aspect) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
bool view_item_drag_start(bContext &C, AbstractViewItem &item)
void template_asset_shelf_popover(Layout &layout, const bContext &C, StringRefNull asset_shelf_id, StringRef name, int icon)
int UI_text_colorid_from_report_type(int type)
ARegion * tooltip_create_from_button(bContext *C, ARegion *butregion, Button *but, bool is_quick_tip)
void blocklist_update_view_for_buttons(const bContext *C, const ListBaseT< ui::Block > *lb)
void(*)(void *argN) ButtonArgNFree
void popup_menu_end(bContext *C, PopupMenu *pup)
const PointerRNA * button_context_ptr_get(const Button *but, StringRef name, const StructRNA *type=nullptr)
Button * uiDefIconButO_ptr(Block *block, ButtonType type, wmOperatorType *ot, wm::OpCallContext opcontext, int icon, int x, int y, short width, short height, std::optional< StringRef > tip)
void template_tree_interface(Layout *layout, const bContext *C, PointerRNA *ptr)
void block_bounds_set_centered(Block *block, int addval)
Definition interface.cc:693
void popup_block_template_confirm(Block *block, bool cancel_default, FunctionRef< Button *()> confirm_fn, FunctionRef< Button *()> cancel_fn)
void popover_once_clear(Popover *pup)
void pie_menu_end(bContext *C, PieMenu *pie)
const char * panel_category_active_get(ARegion *region, bool set_fallback)
void button_func_search_set_context_menu(Button *but, ButtonSearchContextMenuFn context_menu_fn)
bool(*)(bContext *C, void *arg, void *active, const wmEvent *event) ButtonSearchContextMenuFn
void button_view_item_draw_size_set(Button *but, const std::optional< int > draw_width=std::nullopt, const std::optional< int > draw_height=std::nullopt)
void template_layers(Layout *layout, PointerRNA *ptr, StringRefNull propname, PointerRNA *used_ptr, const char *used_propname, int active_layer)
void button_func_search_set(Button *but, ButtonSearchCreateFn search_create_fn, ButtonSearchUpdateFn search_update_fn, void *arg, bool free_arg, FreeArgFunc search_arg_free_fn, ButtonHandleFunc search_exec_fn, void *active)
bool context_copy_to_selected_check(PointerRNA *ptr, PointerRNA *ptr_link, PropertyRNA *prop, const char *path, bool use_path_from_id, PointerRNA *r_ptr, PropertyRNA **r_prop)
void button_func_search_set_tooltip(Button *but, ButtonSearchTooltipFn tooltip_fn)
void template_id_tabs(Layout *layout, bContext *C, PointerRNA *ptr, StringRefNull propname, const char *newop, const char *menu, int filter=TEMPLATE_ID_FILTER_ALL)
const Button * block_active_default_button_find(const Block *block)
void block_funcN_set(Block *block, ButtonHandleNFunc funcN, void *argN, void *arg2, ButtonArgNFree func_argN_free_fn=MEM_delete_void, ButtonArgNCopy func_argN_copy_fn=MEM_dupalloc_void)
void template_preview(Layout *layout, bContext *C, ID *id, bool show_buttons, ID *parent, MTex *slot, const char *preview_id)
void draw_roundbox_4fv(const rctf *rect, bool filled, float rad, const float col[4])
Vector< StringRef > text_clip_multiline_middle(const uiFontStyle *fstyle, const char *str, char *clipped_str_buf, const size_t clipped_str_buf_maxncpy, const float max_line_width, const int max_lines)
@ BUT_ACTIVATE_ON_INIT_NO_SELECT
@ BUT_TEXTEDIT_AUTOCOMPLETE_KEEP_ACTIVE
ButStore * butstore_create(Block *block)
bool panel_is_dragging(const Panel *panel)
bool but_is_tool(const Button *but)
void(*)(const wmRegionListenerParams *params, void *arg) ButtonSearchListenFn
void button_pushbutton_draw_as_overlay_set(Button *but, bool value)
void button_func_search_set_listen(Button *but, ButtonSearchListenFn listen_fn)
Panel * panel_find_by_type(ListBaseT< Panel > *lb, const PanelType *pt)
void button_execute(const bContext *C, ARegion *region, Button *but)
void button_drag_set_id(Button *but, ID *id)
AbstractView * region_view_find_at(const ARegion *region, const int xy[2], int pad, Block **r_block=nullptr)
int autocomplete_end(AutoComplete *autocpl, char *autoname)
int preview_tile_size_x(const int size_px=96)
void template_icon_view(Layout *layout, PointerRNA *ptr, StringRefNull propname, bool show_labels, float icon_scale, float icon_scale_popup)
void template_node_inputs(Layout *layout, bContext *C, PointerRNA *ptr)
Button * uiDefButImage(Block *block, void *imbuf, int x, int y, short width, short height, const uchar color[4])
void button_type_set_menu_from_pulldown(Button *but)
bool popup_block_name_exists(const bScreen *screen, StringRef name)
void button_func_drawextra_set(Block *block, std::function< void(const bContext *C, rcti *rect)> func)
void context_active_but_clear(bContext *C, wmWindow *win, ARegion *region)
int template_status_bar_modal_item(Layout *layout, wmOperator *op, const wmKeyMap *keymap, const EnumPropertyItem *item)
void popup_menu_close_from_but(const Button *but, bool is_cancel=false)
BMesh Iterators.
void uiTemplateMovieclipInformation(ui::Layout *layout, PointerRNA *ptr, StringRefNull propname, PointerRNA *userptr)
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
__int64 int64_t
Definition BKE_text.h:90
void uiTemplateImage(ui::Layout *layout, bContext *C, PointerRNA *ptr, StringRefNull propname, PointerRNA *userptr, bool compact, bool multiview)
void uiTemplateImageFormatViews(ui::Layout *layout, PointerRNA *imfptr, PointerRNA *ptr)
unsigned int uint
Definition BKE_text.h:55
void uiTemplateTrack(ui::Layout *layout, PointerRNA *ptr, StringRefNull propname)
void uiTemplateTextureUser(ui::Layout *layout, bContext *C)
void uiTemplateNodeLink(ui::Layout *layout, bContext *C, bNodeTree *ntree, bNode *node, bNodeSocket *input)
void MEM_delete_void(void *vmemh)
void uiTemplateImageStereo3d(ui::Layout *layout, PointerRNA *stereo3d_format_ptr)
VecBase< float, 4 > float4
void uiTemplateMarker(ui::Layout *layout, PointerRNA *ptr, StringRefNull propname, PointerRNA *userptr, PointerRNA *trackptr, bool compact)
void * MEM_dupalloc_void(const void *vmemh) ATTR_WARN_UNUSED_RESULT
unsigned char uchar
Definition BKE_text.h:58
void uiTemplateEditModeSelection(ui::Layout *layout, bContext *C)
BMesh const char void * data
unsigned char uint8_t
Definition BKE_text.h:79
void uiTemplateImageLayers(ui::Layout *layout, bContext *C, Image *ima, ImageUser *iuser)
void uiTemplateImageInfo(ui::Layout *layout, bContext *C, Image *ima, ImageUser *iuser)
void uiTemplateImageViews(ui::Layout *layout, PointerRNA *imaptr)
void uiTemplateImageSettings(ui::Layout *layout, bContext *C, PointerRNA *imfptr, bool color_management, const char *panel_idname=nullptr)
void uiTemplateNodeView(ui::Layout *layout, bContext *C, bNodeTree *ntree, bNode *node, bNodeSocket *input)
void uiTemplateTextureShow(ui::Layout *layout, const bContext *C, PointerRNA *ptr, PropertyRNA *prop)
void template_header3D_mode(ui::Layout *layout, bContext *C)
void uiTemplateMovieClip(ui::Layout *layout, bContext *C, PointerRNA *ptr, StringRefNull propname, bool compact)
void ATTR_NONNULL(1, 2)
signed char int8_t
Definition BKE_text.h:76
ocio::Display ColorManagedDisplay
#define min(a, b)
Definition sort.cc:38
ButtonTypeWithPointerType(ButtonType bt, ButPointerType pt, int i)
ButtonTypeWithPointerType(ButtonType bt, ButPointerType pt)
TooltipImageBackground background