Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / include / UI_interface.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file UI_interface.h
29  *  \ingroup editorui
30  */
31
32 #ifndef __UI_INTERFACE_H__
33 #define __UI_INTERFACE_H__
34
35 #include "BLI_compiler_attrs.h"
36 #include "BLI_sys_types.h" /* size_t */
37 #include "RNA_types.h"
38
39 /* Struct Declarations */
40
41 struct ID;
42 struct IDProperty;
43 struct ListBase;
44 struct ARegion;
45 struct ARegionType;
46 struct ScrArea;
47 struct bScreen;
48 struct wmEvent;
49 struct wmWindow;
50 struct wmOperator;
51 struct AutoComplete;
52 struct bContext;
53 struct bContextStore;
54 struct Panel;
55 struct PanelType;
56 struct PointerRNA;
57 struct PropertyRNA;
58 struct ReportList;
59 struct rcti;
60 struct uiList;
61 struct uiStyle;
62 struct uiFontStyle;
63 struct uiWidgetColors;
64 struct Image;
65 struct ImageUser;
66 struct wmKeyConfig;
67 struct wmOperatorType;
68 struct MTex;
69 struct ImBuf;
70 struct bNodeTree;
71 struct bNode;
72 struct bNodeSocket;
73 struct wmDropBox;
74 struct wmDrag;
75 struct wmEvent;
76 struct wmGizmo;
77 struct wmMsgBus;
78 struct wmKeyMap;
79 struct wmKeyMapItem;
80
81 typedef struct uiBut uiBut;
82 typedef struct uiBlock uiBlock;
83 typedef struct uiPopupBlockHandle uiPopupBlockHandle;
84 typedef struct uiLayout uiLayout;
85
86 /* Defines */
87
88 /* char for splitting strings, aligning shortcuts in menus, users never see */
89 #define UI_SEP_CHAR   '|'
90 #define UI_SEP_CHAR_S "|"
91
92 /* names */
93 #define UI_MAX_DRAW_STR 400
94 #define UI_MAX_NAME_STR 128
95 #define UI_MAX_SHORTCUT_STR 64
96
97 /* use for clamping popups within the screen */
98 #define UI_SCREEN_MARGIN 10
99
100 /* uiBlock->dt and uiBut->dt */
101 enum {
102         UI_EMBOSS               = 0,  /* use widget style for drawing */
103         UI_EMBOSS_NONE          = 1,  /* Nothing, only icon and/or text */
104         UI_EMBOSS_PULLDOWN      = 2,  /* Pulldown menu style */
105         UI_EMBOSS_RADIAL        = 3,  /* Pie Menu */
106
107         UI_EMBOSS_UNDEFINED     = 255, /* For layout engine, use emboss from block. */
108 };
109
110 /* uiBlock->direction */
111 enum {
112         UI_DIR_UP           = (1 << 0),
113         UI_DIR_DOWN         = (1 << 1),
114         UI_DIR_LEFT         = (1 << 2),
115         UI_DIR_RIGHT        = (1 << 3),
116         UI_DIR_CENTER_X     = (1 << 4),
117         UI_DIR_CENTER_Y     = (1 << 5),
118
119         UI_DIR_ALL          = (UI_DIR_UP | UI_DIR_DOWN | UI_DIR_LEFT | UI_DIR_RIGHT),
120 };
121
122 #if 0
123 /* uiBlock->autofill (not yet used) */
124 #define UI_BLOCK_COLLUMNS  1
125 #define UI_BLOCK_ROWS      2
126 #endif
127
128 /* uiBlock->flag (controls) */
129 #define UI_BLOCK_LOOP           (1 << 0)
130 #define UI_BLOCK_IS_FLIP        (1 << 1)
131 #define UI_BLOCK_NO_FLIP        (1 << 2)
132 #define UI_BLOCK_NUMSELECT      (1 << 3)
133 #define UI_BLOCK_NO_WIN_CLIP    (1 << 4)   /* don't apply window clipping */ /* was UI_BLOCK_ENTER_OK */
134 #define UI_BLOCK_CLIPBOTTOM     (1 << 5)
135 #define UI_BLOCK_CLIPTOP        (1 << 6)
136 #define UI_BLOCK_MOVEMOUSE_QUIT (1 << 7)
137 #define UI_BLOCK_KEEP_OPEN      (1 << 8)
138 #define UI_BLOCK_POPUP          (1 << 9)
139 #define UI_BLOCK_OUT_1          (1 << 10)
140 #define UI_BLOCK_SEARCH_MENU    (1 << 11)
141 #define UI_BLOCK_POPUP_MEMORY   (1 << 12)
142 #define UI_BLOCK_CLIP_EVENTS    (1 << 13)  /* stop handling mouse events */
143
144 /* block->flag bits 14-17 are identical to but->drawflag bits */
145
146 #define UI_BLOCK_POPUP_HOLD  (1 << 18)
147 #define UI_BLOCK_LIST_ITEM   (1 << 19)
148 #define UI_BLOCK_RADIAL      (1 << 20)
149 #define UI_BLOCK_POPOVER     (1 << 21)
150 #define UI_BLOCK_POPOVER_ONCE (1 << 22)
151 /** Always show keymaps, even for non-menus. */
152 #define UI_BLOCK_SHOW_SHORTCUT_ALWAYS (1 << 23)
153
154 /* uiPopupBlockHandle->menuretval */
155 #define UI_RETURN_CANCEL     (1 << 0)   /* cancel all menus cascading */
156 #define UI_RETURN_OK         (1 << 1)   /* choice made */
157 #define UI_RETURN_OUT        (1 << 2)   /* left the menu */
158 #define UI_RETURN_OUT_PARENT (1 << 3)   /* let the parent handle this event */
159 #define UI_RETURN_UPDATE     (1 << 4)   /* update the button that opened */
160 #define UI_RETURN_POPUP_OK   (1 << 5)   /* popup is ok to be handled */
161
162 /* panel controls */
163 #define UI_PNL_SOLID    (1 << 1)
164 #define UI_PNL_CLOSE    (1 << 5)
165 #define UI_PNL_SCALE    (1 << 9)
166
167 /* but->flag - general state flags. */
168 enum {
169         /* warning, the first 6 flags are internal */
170         UI_BUT_ICON_SUBMENU    = (1 << 6),
171         UI_BUT_ICON_PREVIEW    = (1 << 7),
172
173         UI_BUT_NODE_LINK       = (1 << 8),
174         UI_BUT_NODE_ACTIVE     = (1 << 9),
175         UI_BUT_DRAG_LOCK       = (1 << 10),
176         UI_BUT_DISABLED        = (1 << 11),  /* grayed out and uneditable */
177         UI_BUT_COLOR_LOCK      = (1 << 12),
178         UI_BUT_ANIMATED        = (1 << 13),
179         UI_BUT_ANIMATED_KEY    = (1 << 14),
180         UI_BUT_DRIVEN          = (1 << 15),
181         UI_BUT_REDALERT        = (1 << 16),
182         UI_BUT_INACTIVE        = (1 << 17),  /* grayed out but still editable */
183         UI_BUT_LAST_ACTIVE     = (1 << 18),
184         UI_BUT_UNDO            = (1 << 19),
185         UI_BUT_IMMEDIATE       = (1 << 20),
186         UI_BUT_NO_UTF8         = (1 << 21),
187
188         UI_BUT_VEC_SIZE_LOCK   = (1 << 22),  /* used to flag if color hsv-circle should keep luminance */
189         UI_BUT_COLOR_CUBIC     = (1 << 23),  /* cubic saturation for the color wheel */
190         UI_BUT_LIST_ITEM       = (1 << 24),  /* This but is "inside" a list item (currently used to change theme colors). */
191         UI_BUT_DRAG_MULTI      = (1 << 25),  /* edit this button as well as the active button (not just dragging) */
192
193         UI_BUT_HAS_SEP_CHAR    = (1 << 27),  /* but->str contains UI_SEP_CHAR, used for key shortcuts */
194         UI_BUT_UPDATE_DELAY    = (1 << 28),  /* don't run updates while dragging (needed in rare cases). */
195         UI_BUT_TEXTEDIT_UPDATE = (1 << 29),  /* when widget is in textedit mode, update value on each char stroke */
196         UI_BUT_VALUE_CLEAR     = (1 << 30),  /* show 'x' icon to clear/unlink value of text or search button */
197
198         UI_BUT_OVERRIDEN       = (1 << 31),  /* RNA property of the button is overriden from linked reference data. */
199 };
200
201 #define UI_PANEL_WIDTH          340
202 #define UI_COMPACT_PANEL_WIDTH  160
203
204 #define UI_PANEL_CATEGORY_MARGIN_WIDTH (U.widget_unit * 1.0f)
205
206 /* but->drawflag - these flags should only affect how the button is drawn. */
207 /* Note: currently, these flags _are not passed_ to the widget's state() or draw() functions
208  *       (except for the 'align' ones)!
209  */
210 enum {
211         /* Text and icon alignment (by default, they are centered). */
212         UI_BUT_TEXT_LEFT         = (1 << 1),
213         UI_BUT_ICON_LEFT         = (1 << 2),
214         UI_BUT_TEXT_RIGHT        = (1 << 3),
215         /* Prevent the button to show any tooltip. */
216         UI_BUT_NO_TOOLTIP        = (1 << 4),
217
218         /* Button align flag, for drawing groups together.
219          * Used in 'uiBlock.flag', take care! */
220         UI_BUT_ALIGN_TOP         = (1 << 14),
221         UI_BUT_ALIGN_LEFT        = (1 << 15),
222         UI_BUT_ALIGN_RIGHT       = (1 << 16),
223         UI_BUT_ALIGN_DOWN        = (1 << 17),
224         UI_BUT_ALIGN             = (UI_BUT_ALIGN_TOP | UI_BUT_ALIGN_LEFT | UI_BUT_ALIGN_RIGHT | UI_BUT_ALIGN_DOWN),
225         /* end bits shared with 'uiBlock.flag' */
226
227         /* Warning - HACK! Needed for buttons which are not TOP/LEFT aligned, but have some top/left corner stitched to some
228          *                 other TOP/LEFT-aligned button, because of 'corrective' hack in widget_roundbox_set()... */
229         UI_BUT_ALIGN_STITCH_TOP  = (1 << 18),
230         UI_BUT_ALIGN_STITCH_LEFT = (1 << 19),
231         UI_BUT_ALIGN_ALL         = (UI_BUT_ALIGN | UI_BUT_ALIGN_STITCH_TOP | UI_BUT_ALIGN_STITCH_LEFT),
232
233         UI_BUT_BOX_ITEM          = (1 << 20), /* This but is "inside" a box item (currently used to change theme colors). */
234
235         UI_BUT_ACTIVE_LEFT       = (1 << 21), /* Active left part of number button */
236         UI_BUT_ACTIVE_RIGHT      = (1 << 22), /* Active right part of number button */
237
238         UI_BUT_HAS_SHORTCUT      = (1 << 23), /* Button has shortcut text */
239 };
240
241 /* scale fixed button widths by this to account for DPI */
242
243 #define UI_DPI_FAC (U.dpi_fac)
244 /* 16 to copy ICON_DEFAULT_HEIGHT */
245 #define UI_DPI_ICON_SIZE ((float)16 * UI_DPI_FAC)
246
247 /* Button types, bits stored in 1 value... and a short even!
248  * - bits 0-4:  bitnr (0-31)
249  * - bits 5-7:  pointer type
250  * - bit  8:    for 'bit'
251  * - bit  9-15: button type (now 6 bits, 64 types)
252  * */
253 typedef enum {
254         UI_BUT_POIN_CHAR = 32,
255         UI_BUT_POIN_SHORT = 64,
256         UI_BUT_POIN_INT = 96,
257         UI_BUT_POIN_FLOAT = 128,
258 /*      UI_BUT_POIN_FUNCTION = 192, */ /*UNUSED*/
259         UI_BUT_POIN_BIT = 256  /* OR'd with a bit index*/
260 } eButPointerType;
261
262 /* requires (but->poin != NULL) */
263 #define UI_BUT_POIN_TYPES (UI_BUT_POIN_FLOAT | UI_BUT_POIN_SHORT | UI_BUT_POIN_CHAR)
264
265 /* assigned to but->type, OR'd with the flags above when passing args */
266 typedef enum {
267         UI_BTYPE_BUT                    = (1 << 9),
268         UI_BTYPE_ROW                    = (2 << 9),
269         UI_BTYPE_TEXT                   = (3 << 9),
270         UI_BTYPE_MENU                   = (4 << 9),  /* dropdown list */
271         UI_BTYPE_BUT_MENU               = (5 << 9),
272         UI_BTYPE_NUM                    = (6 << 9),  /* number button */
273         UI_BTYPE_NUM_SLIDER             = (7 << 9),  /* number slider */
274         UI_BTYPE_TOGGLE                 = (8 << 9),
275         UI_BTYPE_TOGGLE_N               = (9 << 9),
276         UI_BTYPE_ICON_TOGGLE            = (10 << 9),
277         UI_BTYPE_ICON_TOGGLE_N          = (11 << 9),
278         UI_BTYPE_BUT_TOGGLE             = (12 << 9),  /* same as regular toggle, but no on/off state displayed */
279         UI_BTYPE_CHECKBOX               = (13 << 9),  /* similar to toggle, display a 'tick' */
280         UI_BTYPE_CHECKBOX_N             = (14 << 9),
281         UI_BTYPE_COLOR                  = (15 << 9),
282         UI_BTYPE_TAB                    = (16 << 9),
283         UI_BTYPE_POPOVER                = (17 << 9),
284         UI_BTYPE_SCROLL                 = (18 << 9),
285         UI_BTYPE_BLOCK                  = (19 << 9),
286         UI_BTYPE_LABEL                  = (20 << 9),
287         UI_BTYPE_KEY_EVENT              = (24 << 9),
288         UI_BTYPE_HSVCUBE                = (26 << 9),
289         UI_BTYPE_PULLDOWN               = (27 << 9),  /* menu (often used in headers), **_MENU /w different draw-type */
290         UI_BTYPE_ROUNDBOX               = (28 << 9),
291         UI_BTYPE_COLORBAND              = (30 << 9),
292         UI_BTYPE_UNITVEC                = (31 << 9),  /* sphere widget (used to input a unit-vector, aka normal) */
293         UI_BTYPE_CURVE                  = (32 << 9),
294         UI_BTYPE_LISTBOX                = (36 << 9),
295         UI_BTYPE_LISTROW                = (37 << 9),
296         UI_BTYPE_HSVCIRCLE              = (38 << 9),
297         UI_BTYPE_TRACK_PREVIEW          = (40 << 9),
298
299         /* buttons with value >= UI_BTYPE_SEARCH_MENU don't get undo pushes */
300         UI_BTYPE_SEARCH_MENU            = (41 << 9),
301         UI_BTYPE_EXTRA                  = (42 << 9),
302         UI_BTYPE_HOTKEY_EVENT           = (46 << 9),
303         UI_BTYPE_IMAGE                  = (47 << 9),  /* non-interactive image, used for splash screen */
304         UI_BTYPE_HISTOGRAM              = (48 << 9),
305         UI_BTYPE_WAVEFORM               = (49 << 9),
306         UI_BTYPE_VECTORSCOPE            = (50 << 9),
307         UI_BTYPE_PROGRESS_BAR           = (51 << 9),
308         UI_BTYPE_NODE_SOCKET            = (53 << 9),
309         UI_BTYPE_SEPR                   = (54 << 9),
310         UI_BTYPE_SEPR_LINE              = (55 << 9),
311         UI_BTYPE_SEPR_SPACER            = (56 << 9),  /* Dynamically fill available space. */
312         UI_BTYPE_GRIP                   = (57 << 9),  /* resize handle (resize uilist) */
313 } eButType;
314
315 #define BUTTYPE     (63 << 9)
316
317 /* gradient types, for color picker UI_BTYPE_HSVCUBE etc */
318 #define UI_GRAD_SV      0
319 #define UI_GRAD_HV      1
320 #define UI_GRAD_HS      2
321 #define UI_GRAD_H       3
322 #define UI_GRAD_S       4
323 #define UI_GRAD_V       5
324
325 #define UI_GRAD_V_ALT   9
326 #define UI_GRAD_L_ALT   10
327
328 #define UI_PALETTE_COLOR 20
329
330 /* Drawing
331  *
332  * Functions to draw various shapes, taking theme settings into account.
333  * Used for code that draws its own UI style elements. */
334
335 void UI_draw_anti_tria(float x1, float y1, float x2, float y2, float x3, float y3, const float color[4]);
336 void UI_draw_anti_fan(float tri_array[][2], unsigned int length, const float color[4]);
337
338 void UI_draw_roundbox_corner_set(int type);
339 void UI_draw_roundbox_aa(bool filled, float minx, float miny, float maxx, float maxy, float rad, const float color[4]);
340 void UI_draw_roundbox_4fv(bool filled, float minx, float miny, float maxx, float maxy, float rad, const float col[4]);
341 void UI_draw_roundbox_3ubAlpha(bool filled, float minx, float miny, float maxx, float maxy, float rad, const unsigned char col[3], unsigned char alpha);
342 void UI_draw_roundbox_3fvAlpha(bool filled, float minx, float miny, float maxx, float maxy, float rad, const float col[3], float alpha);
343 void UI_draw_roundbox_shade_x(bool filled, float minx, float miny, float maxx, float maxy, float rad, float shadetop, float shadedown, const float col[4]);
344
345 #if 0 /* unused */
346 int  UI_draw_roundbox_corner_get(void);
347 void UI_draw_roundbox_shade_y(bool filled, float minx, float miny, float maxx, float maxy, float rad, float shadeleft, float shaderight, const float col[4]);
348 #endif
349
350 void UI_draw_box_shadow(unsigned char alpha, float minx, float miny, float maxx, float maxy);
351 void UI_draw_text_underline(int pos_x, int pos_y, int len, int height, const float color[4]);
352
353 void UI_draw_safe_areas(uint pos, float x1, float x2, float y1, float y2,
354         const float title_aspect[2], const float action_aspect[2]);
355
356 /* state for scrolldrawing */
357 #define UI_SCROLL_PRESSED       (1 << 0)
358 #define UI_SCROLL_ARROWS        (1 << 1)
359 #define UI_SCROLL_NO_OUTLINE    (1 << 2)
360 void UI_draw_widget_scroll(struct uiWidgetColors *wcol, const struct rcti *rect, const struct rcti *slider, int state);
361
362 /* Shortening string helper. */
363 float UI_text_clip_middle_ex(
364         struct uiFontStyle *fstyle, char *str, float okwidth, const float minwidth,
365         const size_t max_len, const char rpart_sep);
366
367 /* Callbacks
368  *
369  * UI_block_func_handle_set/ButmFunc are for handling events through a callback.
370  * HandleFunc gets the retval passed on, and ButmFunc gets a2. The latter is
371  * mostly for compatibility with older code.
372  *
373  * UI_but_func_complete_set is for tab completion.
374  *
375  * uiButSearchFunc is for name buttons, showing a popup with matches
376  *
377  * UI_block_func_set and UI_but_func_set are callbacks run when a button is used,
378  * in case events, operators or RNA are not sufficient to handle the button.
379  *
380  * UI_but_funcN_set will free the argument with MEM_freeN. */
381
382 typedef struct uiSearchItems uiSearchItems;
383
384 typedef void (*uiButHandleFunc)(struct bContext *C, void *arg1, void *arg2);
385 typedef void (*uiButHandleRenameFunc)(struct bContext *C, void *arg, char *origstr);
386 typedef void (*uiButHandleNFunc)(struct bContext *C, void *argN, void *arg2);
387 typedef void (*uiButHandleHoldFunc)(struct bContext *C, struct ARegion *butregion, uiBut *but);
388 typedef int (*uiButCompleteFunc)(struct bContext *C, char *str, void *arg);
389 typedef struct ARegion *(*uiButSearchCreateFunc)(struct bContext *C, struct ARegion *butregion, uiBut *but);
390 typedef void (*uiButSearchFunc)(const struct bContext *C, void *arg, const char *str, uiSearchItems *items);
391 /* Must return allocated string. */
392 typedef char *(*uiButToolTipFunc)(struct bContext *C, void *argN, const char *tip);
393
394 typedef void (*uiBlockHandleFunc)(struct bContext *C, void *arg, int event);
395
396 /* Menu Callbacks */
397
398 typedef void (*uiMenuCreateFunc)(struct bContext *C, struct uiLayout *layout, void *arg1);
399 typedef void (*uiMenuHandleFunc)(struct bContext *C, void *arg, int event);
400 /**
401  * Used for cycling menu values without opening the menu (Ctrl-Wheel).
402  * \param direction: forward or backwards [1 / -1].
403  * \param arg1: uiBut.poin (as with #uiMenuCreateFunc).
404  * \return true when the button was changed.
405  */
406 typedef bool (*uiMenuStepFunc)(struct bContext *C, int direction, void *arg1);
407
408
409 /* interface_query.c */
410 bool UI_but_is_tool(const uiBut *but);
411 #define UI_but_is_decorator(but) \
412         ((but)->func == ui_but_anim_decorate_cb)
413
414 bool UI_block_is_empty(const uiBlock *block);
415
416
417 /* interface_region_menu_popup.c */
418 /* Popup Menus
419  *
420  * Functions used to create popup menus. For more extended menus the
421  * UI_popup_menu_begin/End functions can be used to define own items with
422  * the uiItem functions in between. If it is a simple confirmation menu
423  * or similar, popups can be created with a single function call. */
424
425 typedef struct uiPopupMenu uiPopupMenu;
426
427 uiPopupMenu *UI_popup_menu_begin(
428         struct bContext *C, const char *title, int icon) ATTR_NONNULL();
429 uiPopupMenu *UI_popup_menu_begin_ex(
430         struct bContext *C, const char *title, const char *block_name,
431         int icon) ATTR_NONNULL();
432 void UI_popup_menu_end(struct bContext *C, struct uiPopupMenu *head);
433 bool UI_popup_menu_end_or_cancel(struct bContext *C, struct uiPopupMenu *head);
434 struct uiLayout *UI_popup_menu_layout(uiPopupMenu *head);
435
436 void UI_popup_menu_reports(struct bContext *C, struct ReportList *reports) ATTR_NONNULL();
437 int UI_popup_menu_invoke(struct bContext *C, const char *idname, struct ReportList *reports) ATTR_NONNULL(1, 2);
438
439 void UI_popup_menu_retval_set(const uiBlock *block, const int retval, const bool enable);
440 void UI_popup_menu_but_set(uiPopupMenu *pup, struct ARegion *butregion, uiBut *but);
441
442 /* interface_region_popover.c */
443
444 typedef struct uiPopover uiPopover;
445
446 int UI_popover_panel_invoke(
447         struct bContext *C, const char *idname,
448         bool keep_open, struct ReportList *reports);
449
450 uiPopover *UI_popover_begin(struct bContext *C, int menu_width) ATTR_NONNULL(1);
451 void UI_popover_end(struct bContext *C, struct uiPopover *head, struct wmKeyMap *keymap);
452 struct uiLayout *UI_popover_layout(uiPopover *head);
453 void UI_popover_once_clear(uiPopover *pup);
454
455 /* interface_region_menu_pie.c */
456 /* Pie menus */
457 typedef struct uiPieMenu uiPieMenu;
458
459 int UI_pie_menu_invoke(struct bContext *C, const char *idname, const struct wmEvent *event);
460 int UI_pie_menu_invoke_from_operator_enum(
461         struct bContext *C, const char *title, const char *opname,
462         const char *propname, const struct wmEvent *event);
463 int UI_pie_menu_invoke_from_rna_enum(
464         struct bContext *C, const char *title,
465         const char *path, const struct wmEvent *event);
466
467 struct uiPieMenu *UI_pie_menu_begin(
468         struct bContext *C, const char *title, int icon,
469         const struct wmEvent *event) ATTR_NONNULL();
470 void UI_pie_menu_end(struct bContext *C, uiPieMenu *pie);
471 struct uiLayout *UI_pie_menu_layout(struct uiPieMenu *pie);
472
473 /* interface_region_menu_popup.c */
474
475 /* Popup Blocks
476  *
477  * Functions used to create popup blocks. These are like popup menus
478  * but allow using all button types and creating an own layout. */
479 typedef uiBlock * (*uiBlockCreateFunc)(struct bContext *C, struct ARegion *ar, void *arg1);
480 typedef void (*uiBlockCancelFunc)(struct bContext *C, void *arg1);
481
482 void UI_popup_block_invoke(struct bContext *C, uiBlockCreateFunc func, void *arg);
483 void UI_popup_block_invoke_ex(struct bContext *C, uiBlockCreateFunc func, void *arg, const char *opname, int opcontext);
484 void UI_popup_block_ex(struct bContext *C, uiBlockCreateFunc func, uiBlockHandleFunc popup_func, uiBlockCancelFunc cancel_func, void *arg, struct wmOperator *op);
485 /* void uiPupBlockOperator(struct bContext *C, uiBlockCreateFunc func, struct wmOperator *op, int opcontext); */ /* UNUSED */
486
487 void UI_popup_block_close(struct bContext *C, struct wmWindow *win, uiBlock *block);
488
489 /* Blocks
490  *
491  * Functions for creating, drawing and freeing blocks. A Block is a
492  * container of buttons and used for various purposes.
493  *
494  * Begin/Define Buttons/End/Draw is the typical order in which these
495  * function should be called, though for popup blocks Draw is left out.
496  * Freeing blocks is done by the screen/ module automatically.
497  *
498  * */
499
500 uiBlock *UI_block_begin(const struct bContext *C, struct ARegion *region, const char *name, short dt);
501 void UI_block_end_ex(const struct bContext *C, uiBlock *block, const int xy[2], int r_xy[2]);
502 void UI_block_end(const struct bContext *C, uiBlock *block);
503 void UI_block_draw(const struct bContext *C, struct uiBlock *block);
504 void UI_blocklist_update_window_matrix(const struct bContext *C, const struct ListBase *lb);
505 void UI_blocklist_draw(const struct bContext *C, const struct ListBase *lb);
506 void UI_block_update_from_old(const struct bContext *C, struct uiBlock *block);
507
508 void UI_block_emboss_set(uiBlock *block, char dt);
509
510 void UI_block_free(const struct bContext *C, uiBlock *block);
511 void UI_blocklist_free(const struct bContext *C, struct ListBase *lb);
512 void UI_blocklist_free_inactive(const struct bContext *C, struct ListBase *lb);
513 void UI_screen_free_active_but(const struct bContext *C, struct bScreen *screen);
514
515 void UI_block_region_set(uiBlock *block, struct ARegion *region);
516
517 void UI_block_lock_set(uiBlock *block, bool val, const char *lockstr);
518 void UI_block_lock_clear(uiBlock *block);
519
520 /* automatic aligning, horiz or verical */
521 void UI_block_align_begin(uiBlock *block);
522 void UI_block_align_end(uiBlock *block);
523
524 /* block bounds/position calculation */
525 typedef enum {
526         UI_BLOCK_BOUNDS_NONE = 0,
527         UI_BLOCK_BOUNDS = 1,
528         UI_BLOCK_BOUNDS_TEXT,
529         UI_BLOCK_BOUNDS_POPUP_MOUSE,
530         UI_BLOCK_BOUNDS_POPUP_MENU,
531         UI_BLOCK_BOUNDS_POPUP_CENTER,
532         UI_BLOCK_BOUNDS_PIE_CENTER,
533 } eBlockBoundsCalc;
534
535 void UI_block_bounds_set_normal(struct uiBlock *block, int addval);
536 void UI_block_bounds_set_text(uiBlock *block, int addval);
537 void UI_block_bounds_set_popup(uiBlock *block, int addval, int mx, int my);
538 void UI_block_bounds_set_menu(uiBlock *block, int addvall, int mx, int my);
539 void UI_block_bounds_set_centered(uiBlock *block, int addval);
540 void UI_block_bounds_set_explicit(uiBlock *block, int minx, int miny, int maxx, int maxy);
541
542 int     UI_blocklist_min_y_get(struct ListBase *lb);
543
544 void    UI_block_direction_set(uiBlock *block, char direction);
545 void    UI_block_order_flip(uiBlock *block);
546 void    UI_block_flag_enable(uiBlock *block, int flag);
547 void    UI_block_flag_disable(uiBlock *block, int flag);
548 void    UI_block_translate(uiBlock *block, int x, int y);
549
550 int     UI_but_return_value_get(uiBut *but);
551
552 void    UI_but_drag_set_id(uiBut *but, struct ID *id);
553 void    UI_but_drag_set_rna(uiBut *but, struct PointerRNA *ptr);
554 void    UI_but_drag_set_path(uiBut *but, const char *path, const bool use_free);
555 void    UI_but_drag_set_name(uiBut *but, const char *name);
556 void    UI_but_drag_set_value(uiBut *but);
557 void    UI_but_drag_set_image(
558         uiBut *but, const char *path, int icon, struct ImBuf *ima, float scale, const bool use_free);
559
560 bool    UI_but_active_drop_name(struct bContext *C);
561 bool    UI_but_active_drop_color(struct bContext *C);
562
563 void    UI_but_flag_enable(uiBut *but, int flag);
564 void    UI_but_flag_disable(uiBut *but, int flag);
565 bool    UI_but_flag_is_set(uiBut *but, int flag);
566
567 void    UI_but_drawflag_enable(uiBut *but, int flag);
568 void    UI_but_drawflag_disable(uiBut *but, int flag);
569
570 void    UI_but_type_set_menu_from_pulldown(uiBut *but);
571
572 /* special button case, only draw it when used actively, for outliner etc */
573 bool    UI_but_active_only(const struct bContext *C, struct ARegion *ar, uiBlock *block, uiBut *but);
574
575 void    UI_but_execute(const struct bContext *C, uiBut *but);
576
577 bool UI_but_online_manual_id(
578         const uiBut *but,
579         char *r_str, size_t maxlength)
580         ATTR_WARN_UNUSED_RESULT;
581 bool UI_but_online_manual_id_from_active(
582         const struct bContext *C,
583         char *r_str, size_t maxlength)
584         ATTR_WARN_UNUSED_RESULT;
585
586 /* Buttons
587  *
588  * Functions to define various types of buttons in a block. Postfixes:
589  * - F: float
590  * - I: int
591  * - S: short
592  * - C: char
593  * - R: RNA
594  * - O: operator */
595
596 uiBut *uiDefBut(
597         uiBlock *block,
598         int type, int retval, const char *str,
599         int x1, int y1,
600         short x2, short y2,
601         void *poin,
602         float min, float max,
603         float a1, float a2, const char *tip);
604 uiBut *uiDefButF(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, float *poin, float min, float max, float a1, float a2, const char *tip);
605 uiBut *uiDefButBitF(uiBlock *block, int type, int bit, int retval, const char *str, int x, int y, short width, short height, float *poin, float min, float max, float a1, float a2, const char *tip);
606 uiBut *uiDefButI(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, int *poin, float min, float max, float a1, float a2, const char *tip);
607 uiBut *uiDefButBitI(uiBlock *block, int type, int bit, int retval, const char *str, int x, int y, short width, short height, int *poin, float min, float max, float a1, float a2, const char *tip);
608 uiBut *uiDefButS(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, short *poin, float min, float max, float a1, float a2, const char *tip);
609 uiBut *uiDefButBitS(uiBlock *block, int type, int bit, int retval, const char *str, int x, int y, short width, short height, short *poin, float min, float max, float a1, float a2, const char *tip);
610 uiBut *uiDefButC(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, char *poin, float min, float max, float a1, float a2, const char *tip);
611 uiBut *uiDefButBitC(uiBlock *block, int type, int bit, int retval, const char *str, int x, int y, short width, short height, char *poin, float min, float max, float a1, float a2, const char *tip);
612 uiBut *uiDefButR(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, struct PointerRNA *ptr, const char *propname, int index, float min, float max, float a1, float a2, const char *tip);
613 uiBut *uiDefButR_prop(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, struct PointerRNA *ptr, struct PropertyRNA *prop, int index, float min, float max, float a1, float a2, const char *tip);
614 uiBut *uiDefButO(uiBlock *block, int type, const char *opname, int opcontext, const char *str, int x, int y, short width, short height, const char *tip);
615 uiBut *uiDefButO_ptr(uiBlock *block, int type, struct wmOperatorType *ot, int opcontext, const char *str, int x, int y, short width, short height, const char *tip);
616
617 uiBut *uiDefIconBut(
618         uiBlock *block,
619         int type, int retval, int icon,
620         int x1, int y1,
621         short x2, short y2,
622         void *poin,
623         float min, float max,
624         float a1, float a2,  const char *tip);
625 uiBut *uiDefIconButF(uiBlock *block, int type, int retval, int icon, int x, int y, short width, short height, float *poin, float min, float max, float a1, float a2, const char *tip);
626 uiBut *uiDefIconButBitF(uiBlock *block, int type, int bit, int retval, int icon, int x, int y, short width, short height, float *poin, float min, float max, float a1, float a2, const char *tip);
627 uiBut *uiDefIconButI(uiBlock *block, int type, int retval, int icon, int x, int y, short width, short height, int *poin, float min, float max, float a1, float a2, const char *tip);
628 uiBut *uiDefIconButBitI(uiBlock *block, int type, int bit, int retval, int icon, int x, int y, short width, short height, int *poin, float min, float max, float a1, float a2, const char *tip);
629 uiBut *uiDefIconButS(uiBlock *block, int type, int retval, int icon, int x, int y, short width, short height, short *poin, float min, float max, float a1, float a2, const char *tip);
630 uiBut *uiDefIconButBitS(uiBlock *block, int type, int bit, int retval, int icon, int x, int y, short width, short height, short *poin, float min, float max, float a1, float a2, const char *tip);
631 uiBut *uiDefIconButC(uiBlock *block, int type, int retval, int icon, int x, int y, short width, short height, char *poin, float min, float max, float a1, float a2, const char *tip);
632 uiBut *uiDefIconButBitC(uiBlock *block, int type, int bit, int retval, int icon, int x, int y, short width, short height, char *poin, float min, float max, float a1, float a2, const char *tip);
633 uiBut *uiDefIconButR(uiBlock *block, int type, int retval, int icon, int x, int y, short width, short height, struct PointerRNA *ptr, const char *propname, int index, float min, float max, float a1, float a2, const char *tip);
634 uiBut *uiDefIconButR_prop(uiBlock *block, int type, int retval, int icon, int x, int y, short width, short height, struct PointerRNA *ptr, PropertyRNA *prop, int index, float min, float max, float a1, float a2, const char *tip);
635 uiBut *uiDefIconButO(uiBlock *block, int type, const char *opname, int opcontext, int icon, int x, int y, short width, short height, const char *tip);
636 uiBut *uiDefIconButO_ptr(uiBlock *block, int type, struct wmOperatorType *ot, int opcontext, int icon, int x, int y, short width, short height, const char *tip);
637
638 uiBut *uiDefIconTextBut(
639         uiBlock *block,
640         int type, int retval, int icon, const char *str,
641         int x1, int y1,
642         short x2, short y2,
643         void *poin,
644         float min, float max,
645         float a1, float a2, const char *tip);
646 uiBut *uiDefIconTextButF(uiBlock *block, int type, int retval, int icon, const char *str, int x, int y, short width, short height, float *poin, float min, float max, float a1, float a2, const char *tip);
647 uiBut *uiDefIconTextButBitF(uiBlock *block, int type, int bit, int retval, int icon, const char *str, int x, int y, short width, short height, float *poin, float min, float max, float a1, float a2, const char *tip);
648 uiBut *uiDefIconTextButI(uiBlock *block, int type, int retval, int icon, const char *str, int x, int y, short width, short height, int *poin, float min, float max, float a1, float a2, const char *tip);
649 uiBut *uiDefIconTextButBitI(uiBlock *block, int type, int bit, int retval, int icon, const char *str, int x, int y, short width, short height, int *poin, float min, float max, float a1, float a2, const char *tip);
650 uiBut *uiDefIconTextButS(uiBlock *block, int type, int retval, int icon, const char *str, int x, int y, short width, short height, short *poin, float min, float max, float a1, float a2, const char *tip);
651 uiBut *uiDefIconTextButBitS(uiBlock *block, int type, int bit, int retval, int icon, const char *str, int x, int y, short width, short height, short *poin, float min, float max, float a1, float a2, const char *tip);
652 uiBut *uiDefIconTextButC(uiBlock *block, int type, int retval, int icon, const char *str, int x, int y, short width, short height, char *poin, float min, float max, float a1, float a2, const char *tip);
653 uiBut *uiDefIconTextButBitC(uiBlock *block, int type, int bit, int retval, int icon, const char *str, int x, int y, short width, short height, char *poin, float min, float max, float a1, float a2, const char *tip);
654 uiBut *uiDefIconTextButR(uiBlock *block, int type, int retval, int icon, const char *str, int x, int y, short width, short height, struct PointerRNA *ptr, const char *propname, int index, float min, float max, float a1, float a2, const char *tip);
655 uiBut *uiDefIconTextButR_prop(uiBlock *block, int type, int retval, int icon, const char *str, int x, int y, short width, short height, struct PointerRNA *ptr, struct PropertyRNA *prop, int index, float min, float max, float a1, float a2, const char *tip);
656 uiBut *uiDefIconTextButO(uiBlock *block, int type, const char *opname, int opcontext, int icon, const char *str, int x, int y, short width, short height, const char *tip);
657 uiBut *uiDefIconTextButO_ptr(uiBlock *block, int type, struct wmOperatorType *ot, int opcontext, int icon, const char *str, int x, int y, short width, short height, const char *tip);
658
659 /* for passing inputs to ButO buttons */
660 struct PointerRNA *UI_but_operator_ptr_get(uiBut *but);
661
662 void UI_but_unit_type_set(uiBut *but, const int unit_type);
663 int UI_but_unit_type_get(const uiBut *but);
664
665 enum {
666         BUT_GET_RNAPROP_IDENTIFIER = 1,
667         BUT_GET_RNASTRUCT_IDENTIFIER,
668         BUT_GET_RNAENUM_IDENTIFIER,
669         BUT_GET_LABEL,
670         BUT_GET_RNA_LABEL,
671         BUT_GET_RNAENUM_LABEL,
672         BUT_GET_RNA_LABEL_CONTEXT, /* Context specified in CTX_XXX_ macros are just unreachable! */
673         BUT_GET_TIP,
674         BUT_GET_RNA_TIP,
675         BUT_GET_RNAENUM_TIP,
676         BUT_GET_OP_KEYMAP,
677         BUT_GET_PROP_KEYMAP
678 };
679
680 typedef struct uiStringInfo {
681         int type;
682         char *strinfo;
683 } uiStringInfo;
684
685 /* Note: Expects pointers to uiStringInfo structs as parameters.
686  *       Will fill them with translated strings, when possible.
687  *       Strings in uiStringInfo must be MEM_freeN'ed by caller. */
688 void UI_but_string_info_get(struct bContext *C, uiBut *but, ...) ATTR_SENTINEL(0);
689
690 /* Edit i18n stuff. */
691 /* Name of the main py op from i18n addon. */
692 #define EDTSRC_I18N_OP_NAME "UI_OT_edittranslation"
693
694 /* Special Buttons
695  *
696  * Buttons with a more specific purpose:
697  * - MenuBut: buttons that popup a menu (in headers usually).
698  * - PulldownBut: like MenuBut, but creating a uiBlock (for compatibility).
699  * - BlockBut: buttons that popup a block with more buttons.
700  * - KeyevtBut: buttons that can be used to turn key events into values.
701  * - PickerButtons: buttons like the color picker (for code sharing).
702  * - AutoButR: RNA property button with type automatically defined. */
703
704 #define UI_ID_RENAME        (1 << 0)
705 #define UI_ID_BROWSE        (1 << 1)
706 #define UI_ID_ADD_NEW       (1 << 2)
707 #define UI_ID_OPEN          (1 << 3)
708 #define UI_ID_ALONE         (1 << 4)
709 #define UI_ID_DELETE        (1 << 5)
710 #define UI_ID_LOCAL         (1 << 6)
711 #define UI_ID_AUTO_NAME     (1 << 7)
712 #define UI_ID_FAKE_USER     (1 << 8)
713 #define UI_ID_PIN           (1 << 9)
714 #define UI_ID_PREVIEWS      (1 << 10)
715 #define UI_ID_OVERRIDE      (1 << 11)
716 #define UI_ID_FULL          (UI_ID_RENAME | UI_ID_BROWSE | UI_ID_ADD_NEW | UI_ID_OPEN | UI_ID_ALONE | UI_ID_DELETE | UI_ID_LOCAL)
717
718 /**
719  * Ways to limit what is displayed in ID-search popup.
720  * \note We may want to add LOCAL, LIBRARY ... as needed.
721  */
722 enum {
723         UI_TEMPLATE_ID_FILTER_ALL = 0,
724         UI_TEMPLATE_ID_FILTER_AVAILABLE = 1,
725 };
726
727 int UI_icon_from_id(struct ID *id);
728 int UI_icon_from_report_type(int type);
729
730 int UI_icon_from_event_type(short event_type, short event_value);
731 int UI_icon_from_keymap_item(const struct wmKeyMapItem *kmi, int r_icon_mod[4]);
732
733 uiBut *uiDefPulldownBut(uiBlock *block, uiBlockCreateFunc func, void *arg, const char *str, int x, int y, short width, short height, const char *tip);
734 uiBut *uiDefMenuBut(uiBlock *block, uiMenuCreateFunc func, void *arg, const char *str, int x, int y, short width, short height, const char *tip);
735 uiBut *uiDefIconTextMenuBut(uiBlock *block, uiMenuCreateFunc func, void *arg, int icon, const char *str, int x, int y, short width, short height, const char *tip);
736 uiBut *uiDefIconMenuBut(uiBlock *block, uiMenuCreateFunc func, void *arg, int icon, int x, int y, short width, short height, const char *tip);
737
738 uiBut *uiDefBlockBut(uiBlock *block, uiBlockCreateFunc func, void *func_arg1, const char *str, int x, int y, short width, short height, const char *tip);
739 uiBut *uiDefBlockButN(uiBlock *block, uiBlockCreateFunc func, void *argN, const char *str, int x, int y, short width, short height, const char *tip);
740
741 uiBut *uiDefIconBlockBut(uiBlock *block, uiBlockCreateFunc func, void *arg, int retval, int icon, int x, int y, short width, short height, const char *tip);
742 uiBut *uiDefIconTextBlockBut(uiBlock *block, uiBlockCreateFunc func, void *arg, int icon, const char *str, int x, int y, short width, short height, const char *tip);
743
744 uiBut *uiDefKeyevtButS(uiBlock *block, int retval, const char *str, int x, int y, short width, short height, short *spoin, const char *tip);
745 uiBut *uiDefHotKeyevtButS(uiBlock *block, int retval, const char *str, int x, int y, short width, short height, short *keypoin, short *modkeypoin, const char *tip);
746
747 uiBut *uiDefSearchBut(uiBlock *block, void *arg, int retval, int icon, int maxlen, int x, int y, short width, short height, float a1, float a2, const char *tip);
748 uiBut *uiDefSearchButO_ptr(
749         uiBlock *block, struct wmOperatorType *ot, struct IDProperty *properties,
750         void *arg, int retval, int icon, int maxlen, int x, int y,
751         short width, short height, float a1, float a2, const char *tip);
752
753
754 /* For uiDefAutoButsRNA */
755 typedef enum {
756         /* Keep current layout for aligning label with property button. */
757         UI_BUT_LABEL_ALIGN_NONE,
758         /* Align label and property button vertically. */
759         UI_BUT_LABEL_ALIGN_COLUMN,
760         /* Split layout into a column for the label and one for property button. */
761         UI_BUT_LABEL_ALIGN_SPLIT_COLUMN,
762 } eButLabelAlign;
763
764 /* Return info for uiDefAutoButsRNA */
765 typedef enum {
766         /* Returns when no buttons were added */
767         UI_PROP_BUTS_NONE_ADDED       = (1 << 0),
768         /* Returned when any property failed the custom check callback (check_prop) */
769         UI_PROP_BUTS_ANY_FAILED_CHECK = (1 << 1),
770 } eAutoPropButsReturn;
771
772 uiBut *uiDefAutoButR(uiBlock *block, struct PointerRNA *ptr, struct PropertyRNA *prop, int index, const char *name, int icon, int x1, int y1, int x2, int y2);
773 eAutoPropButsReturn uiDefAutoButsRNA(
774         uiLayout *layout, struct PointerRNA *ptr,
775         bool (*check_prop)(struct PointerRNA *ptr, struct PropertyRNA *prop, void *user_data), void *user_data,
776         eButLabelAlign label_align, const bool compact);
777
778 /* use inside searchfunc to add items */
779 bool    UI_search_item_add(uiSearchItems *items, const char *name, void *poin, int iconid);
780 /* bfunc gets search item *poin as arg2, or if NULL the old string */
781 void    UI_but_func_search_set(
782         uiBut *but, uiButSearchCreateFunc cfunc, uiButSearchFunc sfunc,
783         void *arg1, uiButHandleFunc bfunc, void *active);
784 /* height in pixels, it's using hardcoded values still */
785 int     UI_searchbox_size_y(void);
786 int     UI_searchbox_size_x(void);
787 /* check if a string is in an existing search box */
788 int     UI_search_items_find_index(uiSearchItems *items, const char *name);
789
790 void    UI_block_func_handle_set(uiBlock *block, uiBlockHandleFunc func, void *arg);
791 void    UI_block_func_butmenu_set(uiBlock *block, uiMenuHandleFunc func, void *arg);
792 void    UI_block_func_set(uiBlock *block, uiButHandleFunc func, void *arg1, void *arg2);
793 void    UI_block_funcN_set(uiBlock *block, uiButHandleNFunc funcN, void *argN, void *arg2);
794
795 void    UI_but_func_rename_set(uiBut *but, uiButHandleRenameFunc func, void *arg1);
796 void    UI_but_func_set(uiBut *but, uiButHandleFunc func, void *arg1, void *arg2);
797 void    UI_but_funcN_set(uiBut *but, uiButHandleNFunc funcN, void *argN, void *arg2);
798
799 void    UI_but_func_complete_set(uiBut *but, uiButCompleteFunc func, void *arg);
800
801 void    UI_but_func_drawextra_set(
802         uiBlock *block,
803         void (*func)(const struct bContext *C, void *, void *, void *, struct rcti *rect),
804         void *arg1, void *arg2);
805
806 void    UI_but_func_menu_step_set(uiBut *but, uiMenuStepFunc func);
807
808 void    UI_but_func_tooltip_set(uiBut *but, uiButToolTipFunc func, void *argN);
809 void    UI_but_tooltip_refresh(struct bContext *C, uiBut *but);
810 void    UI_but_tooltip_timer_remove(struct bContext *C, uiBut *but);
811
812 bool UI_textbutton_activate_rna(
813         const struct bContext *C, struct ARegion *ar,
814         const void *rna_poin_data, const char *rna_prop_id);
815 bool UI_textbutton_activate_but(const struct bContext *C, uiBut *but);
816
817 void UI_but_focus_on_enter_event(struct wmWindow *win, uiBut *but);
818
819 void UI_but_func_hold_set(uiBut *but, uiButHandleHoldFunc func, void *argN);
820
821 /* Autocomplete
822  *
823  * Tab complete helper functions, for use in uiButCompleteFunc callbacks.
824  * Call begin once, then multiple times do_name with all possibilities,
825  * and finally end to finish and get the completed name. */
826
827 typedef struct AutoComplete AutoComplete;
828
829 #define AUTOCOMPLETE_NO_MATCH 0
830 #define AUTOCOMPLETE_FULL_MATCH 1
831 #define AUTOCOMPLETE_PARTIAL_MATCH 2
832
833 AutoComplete *UI_autocomplete_begin(const char *startname, size_t maxlen);
834 void UI_autocomplete_update_name(AutoComplete *autocpl, const char *name);
835 int UI_autocomplete_end(AutoComplete *autocpl, char *autoname);
836
837 /* Panels
838  *
839  * Functions for creating, freeing and drawing panels. The API here
840  * could use a good cleanup, though how they will function in 2.5 is
841  * not clear yet so we postpone that. */
842
843 void UI_panels_begin(const struct bContext *C, struct ARegion *ar);
844 void UI_panels_end(const struct bContext *C, struct ARegion *ar, int *x, int *y);
845 void UI_panels_draw(const struct bContext *C, struct ARegion *ar);
846
847 struct Panel *UI_panel_find_by_type(struct ListBase *lb, struct PanelType *pt);
848 struct Panel *UI_panel_begin(
849         struct ScrArea *sa, struct ARegion *ar, struct ListBase *lb,
850         uiBlock *block, struct PanelType *pt, struct Panel *pa,
851         bool *r_open);
852 void UI_panel_end(uiBlock *block, int width, int height);
853 void UI_panels_scale(struct ARegion *ar, float new_width);
854 void UI_panel_label_offset(struct uiBlock *block, int *x, int *y);
855 int UI_panel_size_y(const struct Panel *pa);
856
857 bool                       UI_panel_category_is_visible(struct ARegion *ar);
858 void                       UI_panel_category_add(struct ARegion *ar, const char *name);
859 struct PanelCategoryDyn   *UI_panel_category_find(struct ARegion *ar, const char *idname);
860 struct PanelCategoryStack *UI_panel_category_active_find(struct ARegion *ar, const char *idname);
861 const char                *UI_panel_category_active_get(struct ARegion *ar, bool set_fallback);
862 void                       UI_panel_category_active_set(struct ARegion *ar, const char *idname);
863 struct PanelCategoryDyn   *UI_panel_category_find_mouse_over_ex(struct ARegion *ar, const int x, const int y);
864 struct PanelCategoryDyn   *UI_panel_category_find_mouse_over(struct ARegion *ar, const struct wmEvent *event);
865 void                       UI_panel_category_clear_all(struct ARegion *ar);
866 void                       UI_panel_category_draw_all(struct ARegion *ar, const char *category_id_active);
867
868 struct PanelType *UI_paneltype_find(int space_id, int region_id, const char *idname);
869
870 /* Handlers
871  *
872  * Handlers that can be registered in regions, areas and windows for
873  * handling WM events. Mostly this is done automatic by modules such
874  * as screen/ if ED_KEYMAP_UI is set, or internally in popup functions. */
875
876 void UI_region_handlers_add(struct ListBase *handlers);
877 void UI_popup_handlers_add(struct bContext *C, struct ListBase *handlers, uiPopupBlockHandle *popup, const char flag);
878 void UI_popup_handlers_remove(struct ListBase *handlers, uiPopupBlockHandle *popup);
879 void UI_popup_handlers_remove_all(struct bContext *C, struct ListBase *handlers);
880
881 /* Module
882  *
883  * init and exit should be called before using this module. init_userdef must
884  * be used to reinitialize some internal state if user preferences change. */
885
886 void UI_init(void);
887 void UI_init_userdef(struct Main *bmain);
888 void UI_reinit_font(void);
889 void UI_exit(void);
890
891 /* Layout
892  *
893  * More automated layout of buttons. Has three levels:
894  * - Layout: contains a number templates, within a bounded width or height.
895  * - Template: predefined layouts for buttons with a number of slots, each
896  *   slot can contain multiple items.
897  * - Item: item to put in a template slot, being either an RNA property,
898  *   operator, label or menu. Also regular buttons can be used when setting
899  *   uiBlockCurLayout. */
900
901 /* layout */
902 #define UI_LAYOUT_HORIZONTAL    0
903 #define UI_LAYOUT_VERTICAL      1
904
905 #define UI_LAYOUT_PANEL         0
906 #define UI_LAYOUT_HEADER        1
907 #define UI_LAYOUT_MENU          2
908 #define UI_LAYOUT_TOOLBAR       3
909 #define UI_LAYOUT_PIEMENU       4
910
911 #define UI_UNIT_X               ((void)0, U.widget_unit)
912 #define UI_UNIT_Y               ((void)0, U.widget_unit)
913
914 #define UI_LAYOUT_ALIGN_EXPAND  0
915 #define UI_LAYOUT_ALIGN_LEFT    1
916 #define UI_LAYOUT_ALIGN_CENTER  2
917 #define UI_LAYOUT_ALIGN_RIGHT   3
918
919 #define UI_ITEM_O_RETURN_PROPS  (1 << 0)
920 #define UI_ITEM_R_EXPAND        (1 << 1)
921 #define UI_ITEM_R_SLIDER        (1 << 2)
922 #define UI_ITEM_R_TOGGLE        (1 << 3)
923 #define UI_ITEM_R_ICON_ONLY     (1 << 4)
924 #define UI_ITEM_R_EVENT         (1 << 5)
925 #define UI_ITEM_R_FULL_EVENT    (1 << 6)
926 #define UI_ITEM_R_NO_BG         (1 << 7)
927 #define UI_ITEM_R_IMMEDIATE     (1 << 8)
928 #define UI_ITEM_O_DEPRESS       (1 << 9)
929 #define UI_ITEM_R_COMPACT       (1 << 10)
930
931 #define UI_HEADER_OFFSET ((void)0, 0.2f * UI_UNIT_X)
932
933 /* uiLayoutOperatorButs flags */
934 enum {
935         UI_TEMPLATE_OP_PROPS_SHOW_TITLE       = (1 << 0),
936         UI_TEMPLATE_OP_PROPS_SHOW_EMPTY       = (1 << 1),
937         UI_TEMPLATE_OP_PROPS_COMPACT          = (1 << 2),
938         UI_TEMPLATE_OP_PROPS_HIDE_ADVANCED    = (1 << 3),
939 };
940
941 /* used for transp checkers */
942 #define UI_ALPHA_CHECKER_DARK 100
943 #define UI_ALPHA_CHECKER_LIGHT 160
944
945 /* flags to set which corners will become rounded:
946  *
947  * 1------2
948  * |      |
949  * 8------4 */
950
951 enum {
952         UI_CNR_TOP_LEFT     = (1 << 0),
953         UI_CNR_TOP_RIGHT    = (1 << 1),
954         UI_CNR_BOTTOM_RIGHT = (1 << 2),
955         UI_CNR_BOTTOM_LEFT  = (1 << 3),
956         /* just for convenience */
957         UI_CNR_NONE         = 0,
958         UI_CNR_ALL          = (UI_CNR_TOP_LEFT | UI_CNR_TOP_RIGHT | UI_CNR_BOTTOM_RIGHT | UI_CNR_BOTTOM_LEFT)
959 };
960
961 uiLayout *UI_block_layout(uiBlock *block, int dir, int type, int x, int y, int size, int em, int padding, struct uiStyle *style);
962 void UI_block_layout_set_current(uiBlock *block, uiLayout *layout);
963 void UI_block_layout_resolve(uiBlock *block, int *x, int *y);
964
965 void UI_region_message_subscribe(struct ARegion *ar, struct wmMsgBus *mbus);
966
967 uiBlock *uiLayoutGetBlock(uiLayout *layout);
968
969 void uiLayoutSetFunc(uiLayout *layout, uiMenuHandleFunc handlefunc, void *argv);
970 void uiLayoutSetContextPointer(uiLayout *layout, const char *name, struct PointerRNA *ptr);
971 void uiLayoutContextCopy(uiLayout *layout, struct bContextStore *context);
972 struct MenuType *UI_but_menutype_get(uiBut *but);
973 struct PanelType *UI_but_paneltype_get(uiBut *but);
974 void UI_menutype_draw(struct bContext *C, struct MenuType *mt, struct uiLayout *layout);
975 void UI_paneltype_draw(struct bContext *C, struct PanelType *pt, struct uiLayout *layout);
976
977 /* Only for convenience. */
978 void uiLayoutSetContextFromBut(uiLayout *layout, uiBut *but);
979
980 void uiLayoutSetOperatorContext(uiLayout *layout, int opcontext);
981 void uiLayoutSetActive(uiLayout *layout, bool active);
982 void uiLayoutSetEnabled(uiLayout *layout, bool enabled);
983 void uiLayoutSetRedAlert(uiLayout *layout, bool redalert);
984 void uiLayoutSetAlignment(uiLayout *layout, char alignment);
985 void uiLayoutSetKeepAspect(uiLayout *layout, bool keepaspect);
986 void uiLayoutSetScaleX(uiLayout *layout, float scale);
987 void uiLayoutSetScaleY(uiLayout *layout, float scale);
988 void uiLayoutSetEmboss(uiLayout *layout, char emboss);
989 void uiLayoutSetPropSep(uiLayout *layout, bool is_sep);
990 void uiLayoutSetPropDecorate(uiLayout *layout, bool is_sep);
991
992 int uiLayoutGetOperatorContext(uiLayout *layout);
993 bool uiLayoutGetActive(uiLayout *layout);
994 bool uiLayoutGetEnabled(uiLayout *layout);
995 bool uiLayoutGetRedAlert(uiLayout *layout);
996 int uiLayoutGetAlignment(uiLayout *layout);
997 bool uiLayoutGetKeepAspect(uiLayout *layout);
998 int uiLayoutGetWidth(uiLayout *layout);
999 float uiLayoutGetScaleX(uiLayout *layout);
1000 float uiLayoutGetScaleY(uiLayout *layout);
1001 int uiLayoutGetEmboss(uiLayout *layout);
1002 bool uiLayoutGetPropSep(uiLayout *layout);
1003 bool uiLayoutGetPropDecorate(uiLayout *layout);
1004
1005 /* layout specifiers */
1006 uiLayout *uiLayoutRow(uiLayout *layout, bool align);
1007 uiLayout *uiLayoutColumn(uiLayout *layout, bool align);
1008 uiLayout *uiLayoutColumnFlow(uiLayout *layout, int number, bool align);
1009 uiLayout *uiLayoutGridFlow(
1010         uiLayout *layout, bool row_major, int columns_len, bool even_columns, bool even_rows, bool align);
1011 uiLayout *uiLayoutBox(uiLayout *layout);
1012 uiLayout *uiLayoutListBox(
1013         uiLayout *layout, struct uiList *ui_list, struct PointerRNA *ptr, struct PropertyRNA *prop,
1014         struct PointerRNA *actptr, struct PropertyRNA *actprop);
1015 uiLayout *uiLayoutAbsolute(uiLayout *layout, bool align);
1016 uiLayout *uiLayoutSplit(uiLayout *layout, float percentage, bool align);
1017 uiLayout *uiLayoutOverlap(uiLayout *layout);
1018 uiBlock *uiLayoutAbsoluteBlock(uiLayout *layout);
1019 uiLayout *uiLayoutRadial(uiLayout *layout);
1020
1021 /* templates */
1022 void uiTemplateHeader(uiLayout *layout, struct bContext *C);
1023 void uiTemplateID(
1024         uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname,
1025         const char *newop, const char *openop, const char *unlinkop,
1026         int filter, const bool live_icon);
1027 void uiTemplateIDBrowse(
1028         uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname,
1029         const char *newop, const char *openop, const char *unlinkop, int filter);
1030 void uiTemplateIDPreview(
1031         uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname,
1032         const char *newop, const char *openop, const char *unlinkop, int rows, int cols, int filter);
1033 void uiTemplateIDTabs(
1034         uiLayout *layout, struct bContext *C,
1035         PointerRNA *ptr, const char *propname,
1036         const char *newop, const char *openop, const char *menu,
1037         int filter);
1038 void uiTemplateAnyID(
1039         uiLayout *layout, struct PointerRNA *ptr, const char *propname,
1040         const char *proptypename, const char *text);
1041 void uiTemplateSearch(
1042         uiLayout *layout, struct bContext *C,
1043         struct PointerRNA *ptr, const char *propname,
1044         struct PointerRNA *searchptr, const char *searchpropname,
1045         const char *newop, const char *unlinkop);
1046 void uiTemplateSearchPreview(
1047         uiLayout *layout, struct bContext *C,
1048         struct PointerRNA *ptr, const char *propname,
1049         struct PointerRNA *searchptr, const char *searchpropname,
1050         const char *newop, const char *unlinkop,
1051         const int rows, const int cols);
1052 void uiTemplatePathBuilder(
1053         uiLayout *layout, struct PointerRNA *ptr, const char *propname,
1054         struct PointerRNA *root_ptr, const char *text);
1055 uiLayout *uiTemplateModifier(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr);
1056 uiLayout *uiTemplateGpencilModifier(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr);
1057 void uiTemplateGpencilColorPreview(
1058         uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname,
1059         int rows, int cols, float scale, int filter);
1060
1061 uiLayout *uiTemplateShaderFx(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr);
1062
1063 void uiTemplateOperatorRedoProperties(uiLayout *layout, const struct bContext *C);
1064
1065 uiLayout *uiTemplateConstraint(uiLayout *layout, struct PointerRNA *ptr);
1066 void uiTemplatePreview(
1067         uiLayout *layout, struct bContext *C, struct ID *id, bool show_buttons, struct ID *parent,
1068         struct MTex *slot, const char *preview_id);
1069 void uiTemplateColorRamp(uiLayout *layout, struct PointerRNA *ptr, const char *propname, bool expand);
1070 void uiTemplateIcon(uiLayout *layout, int icon_value, float icon_scale);
1071 void uiTemplateIconView(uiLayout *layout, struct PointerRNA *ptr, const char *propname, bool show_labels, float icon_scale);
1072 void uiTemplateHistogram(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
1073 void uiTemplateWaveform(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
1074 void uiTemplateVectorscope(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
1075 void uiTemplateCurveMapping(
1076         uiLayout *layout, struct PointerRNA *ptr, const char *propname, int type,
1077         bool levels, bool brush, bool neg_slope, bool tone);
1078 void uiTemplateColorPicker(uiLayout *layout, struct PointerRNA *ptr, const char *propname, bool value_slider, bool lock, bool lock_luminosity, bool cubic);
1079 void uiTemplatePalette(uiLayout *layout, struct PointerRNA *ptr, const char *propname, bool color);
1080 void uiTemplateCryptoPicker(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
1081 void uiTemplateLayers(
1082         uiLayout *layout, struct PointerRNA *ptr, const char *propname,
1083         PointerRNA *used_ptr, const char *used_propname, int active_layer);
1084 void uiTemplateImage(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname, struct PointerRNA *userptr, bool compact, bool multiview);
1085 void uiTemplateImageSettings(uiLayout *layout, struct PointerRNA *imfptr, bool color_management);
1086 void uiTemplateImageStereo3d(uiLayout *layout, struct PointerRNA *stereo3d_format_ptr);
1087 void uiTemplateImageViews(uiLayout *layout, struct PointerRNA *imaptr);
1088 void uiTemplateImageFormatViews(uiLayout *layout, PointerRNA *imfptr, PointerRNA *ptr);
1089 void uiTemplateImageLayers(uiLayout *layout, struct bContext *C, struct Image *ima, struct ImageUser *iuser);
1090 void uiTemplateImageInfo(uiLayout *layout, struct bContext *C, struct Image *ima, struct ImageUser *iuser);
1091 void uiTemplateRunningJobs(uiLayout *layout, struct bContext *C);
1092 void UI_but_func_operator_search(uiBut *but);
1093 void uiTemplateOperatorSearch(uiLayout *layout);
1094 eAutoPropButsReturn uiTemplateOperatorPropertyButs(
1095         const struct bContext *C, uiLayout *layout, struct wmOperator *op,
1096         const eButLabelAlign label_align, const short flag);
1097 void uiTemplateHeader3D_mode(uiLayout *layout, struct bContext *C);
1098 void uiTemplateHeader3D(uiLayout *layout, struct bContext *C);
1099 void uiTemplateEditModeSelection(uiLayout *layout, struct bContext *C);
1100 void uiTemplateReportsBanner(uiLayout *layout, struct bContext *C);
1101 void uiTemplateInputStatus(uiLayout *layout, struct bContext *C);
1102 void uiTemplateKeymapItemProperties(uiLayout *layout, struct PointerRNA *ptr);
1103 void uiTemplateComponentMenu(uiLayout *layout, struct PointerRNA *ptr, const char *propname, const char *name);
1104 void uiTemplateNodeSocket(uiLayout *layout, struct bContext *C, float *color);
1105 void uiTemplateCacheFile(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname);
1106
1107 /* Default UIList class name, keep in sync with its declaration in bl_ui/__init__.py */
1108 #define UI_UL_DEFAULT_CLASS_NAME "UI_UL_list"
1109 void uiTemplateList(
1110         uiLayout *layout, struct bContext *C, const char *listtype_name, const char *list_id,
1111         struct PointerRNA *dataptr, const char *propname, struct PointerRNA *active_dataptr,
1112         const char *active_propname, const char *item_dyntip_propname,
1113         int rows, int maxrows, int layout_type, int columns);
1114 void uiTemplateNodeLink(uiLayout *layout, struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *input);
1115 void uiTemplateNodeView(uiLayout *layout, struct bContext *C, struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *input);
1116 void uiTemplateTextureUser(uiLayout *layout, struct bContext *C);
1117 void uiTemplateTextureShow(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop);
1118
1119 void uiTemplateMovieClip(struct uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname, bool compact);
1120 void uiTemplateTrack(struct uiLayout *layout, struct PointerRNA *ptr, const char *propname);
1121 void uiTemplateMarker(struct uiLayout *layout, struct PointerRNA *ptr, const char *propname, PointerRNA *userptr, PointerRNA *trackptr, bool compact);
1122 void uiTemplateMovieclipInformation(struct uiLayout *layout, struct PointerRNA *ptr, const char *propname, struct PointerRNA *userptr);
1123
1124 void uiTemplateColorspaceSettings(struct uiLayout *layout, struct PointerRNA *ptr, const char *propname);
1125 void uiTemplateColormanagedViewSettings(struct uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname);
1126
1127 /* items */
1128 void uiItemO(uiLayout *layout, const char *name, int icon, const char *opname);
1129 void uiItemEnumO_ptr(uiLayout *layout, struct wmOperatorType *ot, const char *name, int icon, const char *propname, int value);
1130 void uiItemEnumO(uiLayout *layout, const char *opname, const char *name, int icon, const char *propname, int value);
1131 void uiItemEnumO_value(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, int value);
1132 void uiItemEnumO_string(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, const char *value);
1133 void uiItemsEnumO(uiLayout *layout, const char *opname, const char *propname);
1134 void uiItemBooleanO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, int value);
1135 void uiItemIntO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, int value);
1136 void uiItemFloatO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, float value);
1137 void uiItemStringO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, const char *value);
1138
1139 void uiItemFullO_ptr(
1140         uiLayout *layout, struct wmOperatorType *ot, const char *name, int icon,
1141         struct IDProperty *properties, int context, int flag,
1142         PointerRNA *r_opptr);
1143 void uiItemFullO(
1144         uiLayout *layout, const char *idname, const char *name, int icon,
1145         struct IDProperty *properties, int context, int flag,
1146         PointerRNA *r_opptr);
1147 void uiItemFullOMenuHold_ptr(
1148         uiLayout *layout, struct wmOperatorType *ot, const char *name, int icon,
1149         struct IDProperty *properties, int context, int flag,
1150         const char *menu_id,  /* extra menu arg. */
1151         PointerRNA *r_opptr);
1152
1153 void uiItemR(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int flag, const char *name, int icon);
1154 void uiItemFullR(uiLayout *layout, struct PointerRNA *ptr, struct PropertyRNA *prop, int index, int value, int flag, const char *name, int icon);
1155 void uiItemEnumR_prop(uiLayout *layout, const char *name, int icon, struct PointerRNA *ptr, PropertyRNA *prop, int value);
1156 void uiItemEnumR(uiLayout *layout, const char *name, int icon, struct PointerRNA *ptr, const char *propname, int value);
1157 void uiItemEnumR_string_prop(uiLayout *layout, struct PointerRNA *ptr, PropertyRNA *prop, const char *value, const char *name, int icon);
1158 void uiItemEnumR_string(uiLayout *layout, struct PointerRNA *ptr, const char *propname, const char *value, const char *name, int icon);
1159 void uiItemsEnumR(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
1160 void uiItemPointerR_prop(uiLayout *layout, struct PointerRNA *ptr, PropertyRNA *prop, struct PointerRNA *searchptr, PropertyRNA *searchprop, const char *name, int icon);
1161 void uiItemPointerR(uiLayout *layout, struct PointerRNA *ptr, const char *propname, struct PointerRNA *searchptr, const char *searchpropname, const char *name, int icon);
1162 void uiItemsFullEnumO(
1163         uiLayout *layout, const char *opname, const char *propname,
1164         struct IDProperty *properties, int context, int flag);
1165 void uiItemsFullEnumO_items(
1166         uiLayout *layout, struct wmOperatorType *ot, PointerRNA ptr, PropertyRNA *prop,
1167         struct IDProperty *properties, int context, int flag,
1168         const EnumPropertyItem *item_array, int totitem);
1169
1170 void uiItemL(uiLayout *layout, const char *name, int icon); /* label */
1171 void uiItemLDrag(uiLayout *layout, struct PointerRNA *ptr, const char *name, int icon); /* label icon for dragging */
1172 void uiItemM(uiLayout *layout, const char *menuname, const char *name, int icon); /* menu */
1173 void uiItemV(uiLayout *layout, const char *name, int icon, int argval); /* value */
1174 void uiItemS(uiLayout *layout); /* separator */
1175 void uiItemSpacer(uiLayout *layout); /* Special separator. */
1176
1177 void uiItemPopoverPanel_ptr(
1178         uiLayout *layout, struct bContext *C,
1179         struct PanelType *pt,
1180         const char *name, int icon);
1181 void uiItemPopoverPanel(
1182         uiLayout *layout, struct bContext *C,
1183         const char *panelname,
1184         const char *name, int icon);
1185 void uiItemPopoverPanelFromGroup(
1186         uiLayout *layout, struct bContext *C,
1187         int space_id, int region_id,
1188         const char *context, const char *category);
1189
1190 void uiItemMenuF(uiLayout *layout, const char *name, int icon, uiMenuCreateFunc func, void *arg);
1191 void uiItemMenuEnumO_ptr(uiLayout *layout, struct bContext *C, struct wmOperatorType *ot, const char *propname, const char *name, int icon);
1192 void uiItemMenuEnumO(uiLayout *layout, struct bContext *C, const char *opname, const char *propname, const char *name, int icon);
1193 void uiItemMenuEnumR_prop(uiLayout *layout, struct PointerRNA *ptr, PropertyRNA *prop, const char *name, int icon);
1194 void uiItemMenuEnumR(uiLayout *layout, struct PointerRNA *ptr, const char *propname, const char *name, int icon);
1195
1196 /* UI Operators */
1197 typedef struct uiDragColorHandle {
1198         float color[3];
1199         bool gamma_corrected;
1200 } uiDragColorHandle;
1201
1202 void ED_operatortypes_ui(void);
1203 void ED_keymap_ui(struct wmKeyConfig *keyconf);
1204
1205 void UI_drop_color_copy(struct wmDrag *drag, struct wmDropBox *drop);
1206 bool UI_drop_color_poll(struct bContext *C, struct wmDrag *drag, const struct wmEvent *event, const char **tooltip);
1207
1208 bool UI_context_copy_to_selected_list(
1209         struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop,
1210         struct ListBase *r_lb, bool *r_use_path_from_id, char **r_path);
1211
1212 /* Helpers for Operators */
1213 uiBut *UI_context_active_but_get(const struct bContext *C);
1214 uiBut *UI_context_active_but_prop_get(
1215         const struct bContext *C,
1216         struct PointerRNA *r_ptr, struct PropertyRNA **r_prop, int *r_index);
1217 void UI_context_active_but_prop_handle(struct bContext *C);
1218 struct wmOperator *UI_context_active_operator_get(const struct bContext *C);
1219 void UI_context_update_anim_flag(const struct bContext *C);
1220 void UI_context_active_but_prop_get_filebrowser(
1221         const struct bContext *C,
1222         struct PointerRNA *r_ptr, struct PropertyRNA **r_prop, bool *r_is_undo);
1223 void UI_context_active_but_prop_get_templateID(
1224         struct bContext *C,
1225         struct PointerRNA *r_ptr, struct PropertyRNA **r_prop);
1226 struct ID *UI_context_active_but_get_tab_ID(struct bContext *C);
1227
1228 uiBut *UI_region_active_but_get(struct ARegion *ar);
1229
1230 /* Styled text draw */
1231 void UI_fontstyle_set(const struct uiFontStyle *fs);
1232 void UI_fontstyle_draw_ex(
1233         const struct uiFontStyle *fs, const struct rcti *rect, const char *str,
1234         const unsigned char col[4], size_t len, float *r_xofs, float *r_yofs);
1235 void UI_fontstyle_draw(
1236         const struct uiFontStyle *fs, const struct rcti *rect, const char *str,
1237         const unsigned char col[4]);
1238 void UI_fontstyle_draw_rotated(
1239         const struct uiFontStyle *fs, const struct rcti *rect, const char *str,
1240         const unsigned char col[4]);
1241 void UI_fontstyle_draw_simple(
1242         const struct uiFontStyle *fs, float x, float y, const char *str,
1243         const unsigned char col[4]);
1244 void UI_fontstyle_draw_simple_backdrop(
1245         const struct uiFontStyle *fs, float x, float y, const char *str,
1246         const float col_fg[4], const float col_bg[4]);
1247
1248 int UI_fontstyle_string_width(const struct uiFontStyle *fs, const char *str);
1249 int UI_fontstyle_height_max(const struct uiFontStyle *fs);
1250
1251 void UI_draw_icon_tri(float x, float y, char dir, const float[4]);
1252
1253 struct uiStyle *UI_style_get(void);             /* use for fonts etc */
1254 struct uiStyle *UI_style_get_dpi(void); /* DPI scaled settings for drawing */
1255
1256 /* linker workaround ack! */
1257 void UI_template_fix_linking(void);
1258
1259 /* UI_OT_editsource helpers */
1260 bool UI_editsource_enable_check(void);
1261 void UI_editsource_active_but_test(uiBut *but);
1262
1263 /* UI_butstore_ helpers */
1264 typedef struct uiButStore uiButStore;
1265 typedef struct uiButStoreElem uiButStoreElem;
1266
1267 uiButStore *UI_butstore_create(uiBlock *block);
1268 void UI_butstore_clear(uiBlock *block);
1269 void UI_butstore_update(uiBlock *block);
1270 void UI_butstore_free(uiBlock *block, uiButStore *bs);
1271 bool UI_butstore_is_valid(uiButStore *bs);
1272 bool UI_butstore_is_registered(uiBlock *block, uiBut *but);
1273 void UI_butstore_register(uiButStore *bs_handle, uiBut **but_p);
1274 bool UI_butstore_register_update(uiBlock *block, uiBut *but_dst, const uiBut *but_src);
1275 void UI_butstore_unregister(uiButStore *bs_handle, uiBut **but_p);
1276
1277 /* ui_interface_region_tooltip.c */
1278 struct ARegion *UI_tooltip_create_from_button(struct bContext *C, struct ARegion *butregion, uiBut *but);
1279 struct ARegion *UI_tooltip_create_from_gizmo(struct bContext *C, struct wmGizmo *gz);
1280 void UI_tooltip_free(struct bContext *C, struct bScreen *sc, struct ARegion *ar);
1281
1282 /* How long before a tool-tip shows. */
1283 #define UI_TOOLTIP_DELAY 0.5
1284
1285 /* Float precision helpers */
1286 #define UI_PRECISION_FLOAT_MAX 6
1287 /* For float buttons the 'step' (or a1), is scaled */
1288 #define UI_PRECISION_FLOAT_SCALE 0.01f
1289
1290 /* Typical UI text */
1291 #define UI_FSTYLE_WIDGET (const uiFontStyle *)&(UI_style_get()->widget)
1292
1293 int UI_calc_float_precision(int prec, double value);
1294
1295 /* widget batched drawing */
1296 void UI_widgetbase_draw_cache_begin(void);
1297 void UI_widgetbase_draw_cache_flush(void);
1298 void UI_widgetbase_draw_cache_end(void);
1299
1300 /* Special drawing for toolbar, mainly workarounds for inflexible icon sizing. */
1301 #define USE_UI_TOOLBAR_HACK
1302
1303 /* Support click-drag motion which presses the button and closes a popover (like a menu). */
1304 #define USE_UI_POPOVER_ONCE
1305
1306 #endif  /* __UI_INTERFACE_H__ */