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