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