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