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