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