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