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