e8cca243a9314e53cdb7236f3b7ebf486666df37
[blender-staging.git] / source / blender / editors / include / UI_interface.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file UI_interface.h
29  *  \ingroup editorui
30  */
31
32 #ifndef __UI_INTERFACE_H__
33 #define __UI_INTERFACE_H__
34
35 #include "BLI_compiler_attrs.h"
36 #include "BLI_sys_types.h" /* size_t */
37 #include "RNA_types.h"
38 #include "DNA_userdef_types.h"
39
40 /* Struct Declarations */
41
42 struct ID;
43 struct Main;
44 struct ListBase;
45 struct ARegion;
46 struct ARegionType;
47 struct ScrArea;
48 struct wmEvent;
49 struct wmWindow;
50 struct wmWindowManager;
51 struct wmOperator;
52 struct AutoComplete;
53 struct bContext;
54 struct bContextStore;
55 struct Panel;
56 struct PanelType;
57 struct PointerRNA;
58 struct PropertyRNA;
59 struct ReportList;
60 struct rcti;
61 struct rctf;
62 struct uiList;
63 struct uiStyle;
64 struct uiFontStyle;
65 struct uiWidgetColors;
66 struct ColorBand;
67 struct CurveMapping;
68 struct Image;
69 struct ImageUser;
70 struct wmOperatorType;
71 struct uiWidgetColors;
72 struct Tex;
73 struct MTex;
74 struct ImBuf;
75 struct bNodeTree;
76 struct bNode;
77 struct bNodeSocket;
78 struct wmDropBox;
79 struct wmDrag;
80 struct wmEvent;
81
82 typedef struct uiBut uiBut;
83 typedef struct uiBlock uiBlock;
84 typedef struct uiPopupBlockHandle uiPopupBlockHandle;
85 typedef struct uiLayout uiLayout;
86
87 /* Defines */
88
89 /* char for splitting strings, aligning shortcuts in menus, users never see */
90 #define UI_SEP_CHAR   '|'
91 #define UI_SEP_CHAR_S "|"
92
93 /* names */
94 #define UI_MAX_DRAW_STR 400
95 #define UI_MAX_NAME_STR 128
96
97 /* use for clamping popups within the screen */
98 #define UI_SCREEN_MARGIN 10
99
100 /* uiBlock->dt and uiBut->dt */
101 #define UI_EMBOSS       0   /* use widget style for drawing */
102 #define UI_EMBOSSN      1   /* Nothing, only icon and/or text */
103 #define UI_EMBOSSP      2   /* Pulldown menu style */
104 #define UI_EMBOSST      3   /* Table */
105 #define UI_EMBOSSR      4   /* Pie Menu */
106
107 /* uiBlock->direction */
108 #define UI_DIRECTION       (UI_TOP | UI_DOWN | UI_LEFT | UI_RIGHT)
109 #define UI_TOP             (1 << 0)
110 #define UI_DOWN            (1 << 1)
111 #define UI_LEFT            (1 << 2)
112 #define UI_RIGHT           (1 << 3)
113 #define UI_CENTER          (1 << 4)
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_REDRAW         (1 << 1)
124 #define UI_BLOCK_SEARCH_MENU    (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_NO_FLIP        (1 << 11)
134 #define UI_BLOCK_POPUP_MEMORY   (1 << 12)
135 #define UI_BLOCK_CLIP_EVENTS    (1 << 13)  /* stop handling mouse events */
136
137 /* block->flag bits 14-17 are identical to but->drawflag bits */
138
139 #define UI_BLOCK_LIST_ITEM   (1 << 19)
140 #define UI_BLOCK_RADIAL      (1 << 20)
141
142 /* uiPopupBlockHandle->menuretval */
143 #define UI_RETURN_CANCEL     (1 << 0)   /* cancel all menus cascading */
144 #define UI_RETURN_OK         (1 << 1)   /* choice made */
145 #define UI_RETURN_OUT        (1 << 2)   /* left the menu */
146 #define UI_RETURN_OUT_PARENT (1 << 3)   /* let the parent handle this event */
147 #define UI_RETURN_UPDATE     (1 << 4)   /* update the button that opened */
148 #define UI_RETURN_POPUP_OK   (1 << 5)   /* popup is ok to be handled */
149
150 /* panel controls */
151 #define UI_PNL_SOLID    (1 << 1)
152 #define UI_PNL_CLOSE    (1 << 5)
153 #define UI_PNL_SCALE    (1 << 9)
154
155 /* but->flag - general state flags. */
156 enum {
157         /* warning, the first 6 flags are internal */
158         UI_ICON_SUBMENU      = (1 << 6),
159         UI_ICON_PREVIEW      = (1 << 7),
160
161         UI_BUT_NODE_LINK     = (1 << 8),
162         UI_BUT_NODE_ACTIVE   = (1 << 9),
163         UI_BUT_DRAG_LOCK     = (1 << 10),
164         UI_BUT_DISABLED      = (1 << 11),
165         UI_BUT_COLOR_LOCK    = (1 << 12),
166         UI_BUT_ANIMATED      = (1 << 13),
167         UI_BUT_ANIMATED_KEY  = (1 << 14),
168         UI_BUT_DRIVEN        = (1 << 15),
169         UI_BUT_REDALERT      = (1 << 16),
170         UI_BUT_INACTIVE      = (1 << 17),
171         UI_BUT_LAST_ACTIVE   = (1 << 18),
172         UI_BUT_UNDO          = (1 << 19),
173         UI_BUT_IMMEDIATE     = (1 << 20),
174         UI_BUT_NO_UTF8       = (1 << 21),
175
176         UI_BUT_VEC_SIZE_LOCK = (1 << 22),  /* used to flag if color hsv-circle should keep luminance */
177         UI_BUT_COLOR_CUBIC   = (1 << 23),  /* cubic saturation for the color wheel */
178         UI_BUT_LIST_ITEM     = (1 << 24),  /* This but is "inside" a list item (currently used to change theme colors). */
179         UI_BUT_DRAG_MULTI    = (1 << 25),  /* edit this button as well as the active button (not just dragging) */
180         UI_BUT_SCA_LINK_GREY = (1 << 26),  /* used to flag if sca links shoud be grey out */
181         UI_BUT_HAS_SEP_CHAR  = (1 << 27),  /* but->str contains UI_SEP_CHAR, used for key shortcuts */
182         UI_BUT_TIP_FORCE     = (1 << 28),  /* force show tooltips when holding option/alt if U's USER_TOOLTIPS is off */
183 };
184
185 #define UI_PANEL_WIDTH          340
186 #define UI_COMPACT_PANEL_WIDTH  160
187
188 #define UI_PANEL_CATEGORY_MARGIN_WIDTH (U.widget_unit * 1.0f)
189
190 /* but->drawflag - these flags should only affect how the button is drawn. */
191 /* Note: currently, these flags _are not passed_ to the widget's state() or draw() functions
192  *       (except for the 'align' ones)!
193  */
194 enum {
195         /* Text and icon alignment (by default, they are centered). */
196         UI_BUT_TEXT_LEFT         = (1 << 1),
197         UI_BUT_ICON_LEFT         = (1 << 2),
198         UI_BUT_TEXT_RIGHT        = (1 << 3),
199         /* Prevent the button to show any tooltip. */
200         UI_BUT_NO_TOOLTIP        = (1 << 4),
201         /* button align flag, for drawing groups together (also used in uiBlock->flag!) */
202         UI_BUT_ALIGN_TOP         = (1 << 14),
203         UI_BUT_ALIGN_LEFT        = (1 << 15),
204         UI_BUT_ALIGN_RIGHT       = (1 << 16),
205         UI_BUT_ALIGN_DOWN        = (1 << 17),
206         UI_BUT_ALIGN             = (UI_BUT_ALIGN_TOP | UI_BUT_ALIGN_LEFT | UI_BUT_ALIGN_RIGHT | UI_BUT_ALIGN_DOWN),
207 };
208
209 /* scale fixed button widths by this to account for DPI */
210
211 #define UI_DPI_FAC ((U.pixelsize * (float)U.dpi) / 72.0f)
212 #define UI_DPI_WINDOW_FAC (((float)U.dpi) / 72.0f)
213 /* 16 to copy ICON_DEFAULT_HEIGHT */
214 #define UI_DPI_ICON_SIZE ((float)16 * UI_DPI_FAC)
215
216 /* Button types, bits stored in 1 value... and a short even!
217  * - bits 0-4:  bitnr (0-31)
218  * - bits 5-7:  pointer type
219  * - bit  8:    for 'bit'
220  * - bit  9-15: button type (now 6 bits, 64 types)
221  * */
222 typedef enum {
223         UI_BUT_POIN_CHAR = 32,
224         UI_BUT_POIN_SHORT = 64,
225         UI_BUT_POIN_INT = 96,
226         UI_BUT_POIN_FLOAT = 128,
227 /*      UI_BUT_POIN_FUNCTION = 192, */ /*UNUSED*/
228         UI_BUT_POIN_BIT = 256  /* OR'd with a bit index*/
229 } eButPointerType;
230
231 /* requires (but->poin != NULL) */
232 #define UI_BUT_POIN_TYPES (UI_BUT_POIN_FLOAT | UI_BUT_POIN_SHORT | UI_BUT_POIN_CHAR)
233
234 /* assigned to but->type, OR'd with the flags above when passing args */
235 typedef enum {
236         BUT           = (1 << 9),
237         ROW           = (2 << 9),
238         TOG           = (3 << 9),
239         NUM           = (5 << 9),
240         TEX           = (6 << 9),
241         TOGN          = (9 << 9),
242         LABEL         = (10 << 9),
243         MENU          = (11 << 9),  /* Dropdown list, actually! */
244         ICONTOG       = (13 << 9),
245         NUMSLI        = (14 << 9),
246         COLOR         = (15 << 9),
247         SCROLL        = (18 << 9),
248         BLOCK         = (19 << 9),
249         BUTM          = (20 << 9),
250         SEPR          = (21 << 9),
251         LINK          = (22 << 9),
252         INLINK        = (23 << 9),
253         KEYEVT        = (24 << 9),
254         HSVCUBE       = (26 << 9),
255         PULLDOWN      = (27 << 9),  /* Menu, actually! */
256         ROUNDBOX      = (28 << 9),
257         BUT_COLORBAND = (30 << 9),
258         BUT_NORMAL    = (31 << 9),
259         BUT_CURVE     = (32 << 9),
260         ICONTOGN      = (34 << 9),
261         LISTBOX       = (35 << 9),
262         LISTROW       = (36 << 9),
263         TOGBUT        = (37 << 9),
264         OPTION        = (38 << 9),
265         OPTIONN       = (39 << 9),
266         TRACKPREVIEW  = (40 << 9),
267         /* buttons with value >= SEARCH_MENU don't get undo pushes */
268         SEARCH_MENU   = (41 << 9),
269         BUT_EXTRA     = (42 << 9),
270         HSVCIRCLE     = (43 << 9),
271         HOTKEYEVT     = (46 << 9),
272         BUT_IMAGE     = (47 << 9),
273         HISTOGRAM     = (48 << 9),
274         WAVEFORM      = (49 << 9),
275         VECTORSCOPE   = (50 << 9),
276         PROGRESSBAR   = (51 << 9),
277         SEARCH_MENU_UNLINK   = (52 << 9),
278         NODESOCKET    = (53 << 9),
279         SEPRLINE      = (54 << 9),
280         GRIP          = (55 << 9),
281 } eButType;
282
283 #define BUTTYPE     (63 << 9)
284
285 /* gradient types, for color picker HSVCUBE etc */
286 #define UI_GRAD_SV      0
287 #define UI_GRAD_HV      1
288 #define UI_GRAD_HS      2
289 #define UI_GRAD_H       3
290 #define UI_GRAD_S       4
291 #define UI_GRAD_V       5
292
293 #define UI_GRAD_V_ALT   9
294 #define UI_GRAD_L_ALT   10
295
296 #define UI_PALETTE_COLOR 20
297
298 /* Drawing
299  *
300  * Functions to draw various shapes, taking theme settings into account.
301  * Used for code that draws its own UI style elements. */
302
303 void uiRoundBox(float minx, float miny, float maxx, float maxy, float rad);
304 void uiSetRoundBox(int type);
305 int uiGetRoundBox(void);
306 void uiRoundRect(float minx, float miny, float maxx, float maxy, float rad);
307 void uiDrawBoxShadow(unsigned char alpha, float minx, float miny, float maxx, float maxy);
308 void uiDrawBox(int mode, float minx, float miny, float maxx, float maxy, float rad);
309 void uiDrawBoxShade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadetop, float shadedown);
310 void uiDrawBoxVerticalShade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadeLeft, float shadeRight);
311
312 /* state for scrolldrawing */
313 #define UI_SCROLL_PRESSED       (1 << 0)
314 #define UI_SCROLL_ARROWS        (1 << 1)
315 #define UI_SCROLL_NO_OUTLINE    (1 << 2)
316 void uiWidgetScrollDraw(struct uiWidgetColors *wcol, const struct rcti *rect, const struct rcti *slider, int state);
317
318 /* Callbacks
319  *
320  * uiBlockSetHandleFunc/ButmFunc are for handling events through a callback.
321  * HandleFunc gets the retval passed on, and ButmFunc gets a2. The latter is
322  * mostly for compatibility with older code.
323  *
324  * uiButSetCompleteFunc is for tab completion.
325  *
326  * uiButSearchFunc is for name buttons, showing a popup with matches
327  *
328  * uiBlockSetFunc and uiButSetFunc are callbacks run when a button is used,
329  * in case events, operators or RNA are not sufficient to handle the button.
330  *
331  * uiButSetNFunc will free the argument with MEM_freeN. */
332
333 typedef struct uiSearchItems uiSearchItems;
334
335 typedef void (*uiButHandleFunc)(struct bContext *C, void *arg1, void *arg2);
336 typedef void (*uiButHandleRenameFunc)(struct bContext *C, void *arg, char *origstr);
337 typedef void (*uiButHandleNFunc)(struct bContext *C, void *argN, void *arg2);
338 typedef int (*uiButCompleteFunc)(struct bContext *C, char *str, void *arg);
339 typedef void (*uiButSearchFunc)(const struct bContext *C, void *arg, const char *str, uiSearchItems *items);
340 typedef void (*uiBlockHandleFunc)(struct bContext *C, void *arg, int event);
341
342 /* Menu Callbacks */
343
344 typedef void (*uiMenuCreateFunc)(struct bContext *C, struct uiLayout *layout, void *arg1);
345 typedef void (*uiMenuHandleFunc)(struct bContext *C, void *arg, int event);
346
347 /* Popup Menus
348  *
349  * Functions used to create popup menus. For more extended menus the
350  * uiPupMenuBegin/End functions can be used to define own items with
351  * the uiItem functions in between. If it is a simple confirmation menu
352  * or similar, popups can be created with a single function call. */
353
354 typedef struct uiPopupMenu uiPopupMenu;
355
356 struct uiPopupMenu *uiPupMenuBegin(struct bContext *C, const char *title, int icon) ATTR_NONNULL();
357 void uiPupMenuEnd(struct bContext *C, struct uiPopupMenu *head);
358 struct uiLayout *uiPupMenuLayout(uiPopupMenu *head);
359
360 void uiPupMenuReports(struct bContext *C, struct ReportList *reports) ATTR_NONNULL();
361 int uiPupMenuInvoke(struct bContext *C, const char *idname, struct ReportList *reports) ATTR_NONNULL(1, 2);
362
363 /* Pie menus */
364 typedef struct uiPieMenu uiPieMenu;
365
366 int uiPieMenuInvoke(struct bContext *C, const char *idname, const struct wmEvent *event);
367 int uiPieOperatorEnumInvoke(struct bContext *C, const char *title, const char *opname,
368                              const char *propname, const struct wmEvent *event);
369 int uiPieEnumInvoke(struct bContext *C, const char *title, const char *path, const struct wmEvent *event);
370
371 struct uiPieMenu *uiPieMenuBegin(struct bContext *C, const char *title, int icon, const struct wmEvent *event) ATTR_NONNULL();
372 void uiPieMenuEnd(struct bContext *C, uiPieMenu *pie);
373 struct uiLayout *uiPieMenuLayout(struct uiPieMenu *pie);
374 /* Popup Blocks
375  *
376  * Functions used to create popup blocks. These are like popup menus
377  * but allow using all button types and creating an own layout. */
378
379 typedef uiBlock * (*uiBlockCreateFunc)(struct bContext *C, struct ARegion *ar, void *arg1);
380 typedef void (*uiBlockCancelFunc)(struct bContext *C, void *arg1);
381
382 void uiPupBlock(struct bContext *C, uiBlockCreateFunc func, void *arg);
383 void uiPupBlockO(struct bContext *C, uiBlockCreateFunc func, void *arg, const char *opname, int opcontext);
384 void uiPupBlockEx(struct bContext *C, uiBlockCreateFunc func, uiBlockHandleFunc popup_func, uiBlockCancelFunc cancel_func, void *arg);
385 /* void uiPupBlockOperator(struct bContext *C, uiBlockCreateFunc func, struct wmOperator *op, int opcontext); */ /* UNUSED */
386
387 void uiPupBlockClose(struct bContext *C, uiBlock *block);
388
389 /* Blocks
390  *
391  * Functions for creating, drawing and freeing blocks. A Block is a
392  * container of buttons and used for various purposes.
393  * 
394  * Begin/Define Buttons/End/Draw is the typical order in which these
395  * function should be called, though for popup blocks Draw is left out.
396  * Freeing blocks is done by the screen/ module automatically.
397  *
398  * */
399
400 uiBlock *uiBeginBlock(const struct bContext *C, struct ARegion *region, const char *name, short dt);
401 void uiEndBlock_ex(const struct bContext *C, uiBlock *block, const int xy[2]);
402 void uiEndBlock(const struct bContext *C, uiBlock *block);
403 void uiDrawBlock(const struct bContext *C, struct uiBlock *block);
404 void uiBlockUpdateFromOld(const struct bContext *C, struct uiBlock *block);
405
406 uiBlock *uiGetBlock(const char *name, struct ARegion *ar);
407
408 void uiBlockSetEmboss(uiBlock *block, char dt);
409
410 void uiFreeBlock(const struct bContext *C, uiBlock *block);
411 void uiFreeBlocks(const struct bContext *C, struct ListBase *lb);
412 void uiFreeInactiveBlocks(const struct bContext *C, struct ListBase *lb);
413 void uiFreeActiveButtons(const struct bContext *C, struct bScreen *screen);
414
415 void uiBlockSetRegion(uiBlock *block, struct ARegion *region);
416
417 void uiBlockSetButLock(uiBlock *block, bool val, const char *lockstr);
418 void uiBlockClearButLock(uiBlock *block);
419
420 /* automatic aligning, horiz or verical */
421 void uiBlockBeginAlign(uiBlock *block);
422 void uiBlockEndAlign(uiBlock *block);
423
424 /* block bounds/position calculation */
425 typedef enum {
426         UI_BLOCK_BOUNDS_NONE = 0,
427         UI_BLOCK_BOUNDS = 1,
428         UI_BLOCK_BOUNDS_TEXT,
429         UI_BLOCK_BOUNDS_POPUP_MOUSE,
430         UI_BLOCK_BOUNDS_POPUP_MENU,
431         UI_BLOCK_BOUNDS_POPUP_CENTER,
432         UI_BLOCK_BOUNDS_PIE_CENTER,
433 } eBlockBoundsCalc;
434
435 void uiBoundsBlock(struct uiBlock *block, int addval);
436 void uiTextBoundsBlock(uiBlock *block, int addval);
437 void uiPopupBoundsBlock(uiBlock *block, int addval, int mx, int my);
438 void uiMenuPopupBoundsBlock(uiBlock *block, int addvall, int mx, int my);
439 void uiCenteredBoundsBlock(uiBlock *block, int addval);
440 void uiExplicitBoundsBlock(uiBlock *block, int minx, int miny, int maxx, int maxy);
441
442 int     uiBlocksGetYMin(struct ListBase *lb);
443
444 void    uiBlockSetDirection(uiBlock *block, char direction);
445 void    uiBlockFlipOrder(uiBlock *block);
446 void    uiBlockSetFlag(uiBlock *block, int flag);
447 void    uiBlockClearFlag(uiBlock *block, int flag);
448
449 int     uiButGetRetVal(uiBut *but);
450
451 void    uiButSetDragID(uiBut *but, struct ID *id);
452 void    uiButSetDragRNA(uiBut *but, struct PointerRNA *ptr);
453 void    uiButSetDragPath(uiBut *but, const char *path);
454 void    uiButSetDragName(uiBut *but, const char *name);
455 void    uiButSetDragValue(uiBut *but);
456 void    uiButSetDragImage(uiBut *but, const char *path, int icon, struct ImBuf *ima, float scale);
457
458 bool    UI_but_active_drop_name(struct bContext *C);
459 bool    UI_but_active_drop_color(struct bContext *C);
460
461 void    uiButSetFlag(uiBut *but, int flag);
462 void    uiButClearFlag(uiBut *but, int flag);
463
464 void    uiButSetDrawFlag(uiBut *but, int flag);
465 void    uiButClearDrawFlag(uiBut *but, int flag);
466
467 void    uiButSetMenuFromPulldown(uiBut *but);
468
469 /* special button case, only draw it when used actively, for outliner etc */
470 bool    uiButActiveOnly(const struct bContext *C, struct ARegion *ar, uiBlock *block, uiBut *but);
471
472 void    uiButExecute(const struct bContext *C, uiBut *but);
473
474
475 /* Buttons
476  *
477  * Functions to define various types of buttons in a block. Postfixes:
478  * - F: float
479  * - I: int
480  * - S: short
481  * - C: char
482  * - R: RNA
483  * - O: operator */
484
485 uiBut *uiDefBut(uiBlock *block, 
486                 int type, int retval, const char *str,
487                 int x1, int y1,
488                 short x2, short y2,
489                 void *poin,
490                 float min, float max,
491                 float a1, float a2, const char *tip);
492 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);
493 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);
494 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);
495 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);
496 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);
497 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);
498 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);
499 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);
500 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);
501 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);
502 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);
503 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);
504
505 uiBut *uiDefIconBut(uiBlock *block, 
506                     int type, int retval, int icon,
507                     int x1, int y1,
508                     short x2, short y2,
509                     void *poin,
510                     float min, float max,
511                     float a1, float a2,  const char *tip);
512 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);
513 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);
514 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);
515 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);
516 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);
517 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);
518 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);
519 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);
520 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);
521 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);
522 uiBut *uiDefIconButO(uiBlock *block, int type, const char *opname, int opcontext, int icon, int x, int y, short width, short height, const char *tip);
523 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);
524
525 uiBut *uiDefIconTextBut(uiBlock *block,
526                         int type, int retval, int icon, const char *str,
527                         int x1, int y1,
528                         short x2, short y2,
529                         void *poin,
530                         float min, float max,
531                         float a1, float a2, const char *tip);
532 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);
533 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);
534 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);
535 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);
536 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);
537 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);
538 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);
539 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);
540 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);
541 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);
542 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);
543 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);
544
545 /* for passing inputs to ButO buttons */
546 struct PointerRNA *uiButGetOperatorPtrRNA(uiBut *but);
547
548 void uiButSetUnitType(uiBut *but, const int unit_type);
549 int uiButGetUnitType(const uiBut *but);
550
551 enum {
552         BUT_GET_RNAPROP_IDENTIFIER = 1,
553         BUT_GET_RNASTRUCT_IDENTIFIER,
554         BUT_GET_RNAENUM_IDENTIFIER,
555         BUT_GET_LABEL,
556         BUT_GET_RNA_LABEL,
557         BUT_GET_RNAENUM_LABEL,
558         BUT_GET_RNA_LABEL_CONTEXT, /* Context specified in CTX_XXX_ macros are just unreachable! */
559         BUT_GET_TIP,
560         BUT_GET_RNA_TIP,
561         BUT_GET_RNAENUM_TIP,
562         BUT_GET_OP_KEYMAP,
563         BUT_GET_PROP_KEYMAP
564 };
565
566 typedef struct uiStringInfo {
567         int type;
568         char *strinfo;
569 } uiStringInfo; 
570
571 /* Note: Expects pointers to uiStringInfo structs as parameters.
572  *       Will fill them with translated strings, when possible.
573  *       Strings in uiStringInfo must be MEM_freeN'ed by caller. */
574 void uiButGetStrInfo(struct bContext *C, uiBut *but, ...) ATTR_SENTINEL(0);
575
576 /* Edit i18n stuff. */
577 /* Name of the main py op from i18n addon. */
578 #define EDTSRC_I18N_OP_NAME "UI_OT_edittranslation"
579
580 /* Special Buttons
581  *
582  * Buttons with a more specific purpose:
583  * - MenuBut: buttons that popup a menu (in headers usually).
584  * - PulldownBut: like MenuBut, but creating a uiBlock (for compatibility).
585  * - BlockBut: buttons that popup a block with more buttons.
586  * - KeyevtBut: buttons that can be used to turn key events into values.
587  * - PickerButtons: buttons like the color picker (for code sharing).
588  * - AutoButR: RNA property button with type automatically defined. */
589
590 #define UI_ID_RENAME        (1 << 0)
591 #define UI_ID_BROWSE        (1 << 1)
592 #define UI_ID_ADD_NEW       (1 << 2)
593 #define UI_ID_OPEN          (1 << 3)
594 #define UI_ID_ALONE         (1 << 4)
595 #define UI_ID_DELETE        (1 << 5)
596 #define UI_ID_LOCAL         (1 << 6)
597 #define UI_ID_AUTO_NAME     (1 << 7)
598 #define UI_ID_FAKE_USER     (1 << 8)
599 #define UI_ID_PIN           (1 << 9)
600 #define UI_ID_BROWSE_RENDER (1 << 10)
601 #define UI_ID_PREVIEWS      (1 << 11)
602 #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)
603
604 int uiIconFromID(struct ID *id);
605 int uiIconFromReportType(int type);
606
607 uiBut *uiDefPulldownBut(uiBlock *block, uiBlockCreateFunc func, void *arg, const char *str, int x, int y, short width, short height, const char *tip);
608 uiBut *uiDefMenuBut(uiBlock *block, uiMenuCreateFunc func, void *arg, const char *str, int x, int y, short width, short height, const char *tip);
609 uiBut *uiDefIconTextMenuBut(uiBlock *block, uiMenuCreateFunc func, void *arg, int icon, const char *str, int x, int y, short width, short height, const char *tip);
610 uiBut *uiDefIconMenuBut(uiBlock *block, uiMenuCreateFunc func, void *arg, int icon, int x, int y, short width, short height, const char *tip);
611
612 uiBut *uiDefBlockBut(uiBlock *block, uiBlockCreateFunc func, void *func_arg1, const char *str, int x, int y, short width, short height, const char *tip);
613 uiBut *uiDefBlockButN(uiBlock *block, uiBlockCreateFunc func, void *argN, const char *str, int x, int y, short width, short height, const char *tip);
614
615 uiBut *uiDefIconBlockBut(uiBlock *block, uiBlockCreateFunc func, void *arg, int retval, int icon, int x, int y, short width, short height, const char *tip);
616 uiBut *uiDefIconTextBlockBut(uiBlock *block, uiBlockCreateFunc func, void *arg, int icon, const char *str, int x, int y, short width, short height, const char *tip);
617
618 uiBut *uiDefKeyevtButS(uiBlock *block, int retval, const char *str, int x, int y, short width, short height, short *spoin, const char *tip);
619 uiBut *uiDefHotKeyevtButS(uiBlock *block, int retval, const char *str, int x, int y, short width, short height, short *keypoin, short *modkeypoin, const char *tip);
620
621 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);
622 uiBut *uiDefSearchButO_ptr(uiBlock *block, struct wmOperatorType *ot, IDProperty *properties,
623                            void *arg, int retval, int icon, int maxlen, int x, int y,
624                            short width, short height, float a1, float a2, const char *tip);
625
626 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);
627 int uiDefAutoButsRNA(uiLayout *layout, struct PointerRNA *ptr, bool (*check_prop)(struct PointerRNA *, struct PropertyRNA *), const char label_align);
628
629 /* Links
630  *
631  * Game engine logic brick links. Non-functional currently in 2.5,
632  * code to handle and draw these is disabled internally. */
633
634 void uiSetButLink(struct uiBut *but,  void **poin,  void ***ppoin,  short *tot,  int from, int to);
635
636 void uiComposeLinks(uiBlock *block);
637 uiBut *uiFindInlink(uiBlock *block, void *poin);
638
639 /* use inside searchfunc to add items */
640 bool    uiSearchItemAdd(uiSearchItems *items, const char *name, void *poin, int iconid);
641 /* bfunc gets search item *poin as arg2, or if NULL the old string */
642 void    uiButSetSearchFunc(uiBut *but,        uiButSearchFunc sfunc, void *arg1, uiButHandleFunc bfunc, void *active);
643 /* height in pixels, it's using hardcoded values still */
644 int     uiSearchBoxHeight(void);
645 int     uiSearchBoxWidth(void);
646 /* check if a string is in an existing search box */
647 int     uiSearchItemFindIndex(uiSearchItems *items, const char *name);
648
649 void    uiBlockSetHandleFunc(uiBlock *block,    uiBlockHandleFunc func, void *arg);
650 void    uiBlockSetButmFunc(uiBlock *block,    uiMenuHandleFunc func, void *arg);
651 void    uiBlockSetFunc(uiBlock *block,    uiButHandleFunc func, void *arg1, void *arg2);
652 void    uiBlockSetNFunc(uiBlock *block,    uiButHandleNFunc funcN, void *argN, void *arg2);
653
654 void    uiButSetRenameFunc(uiBut *but,        uiButHandleRenameFunc func, void *arg1);
655 void    uiButSetFunc(uiBut *but,        uiButHandleFunc func, void *arg1, void *arg2);
656 void    uiButSetNFunc(uiBut *but,        uiButHandleNFunc funcN, void *argN, void *arg2);
657
658 void    uiButSetCompleteFunc(uiBut *but,        uiButCompleteFunc func, void *arg);
659
660 void    uiBlockSetDrawExtraFunc(uiBlock *block,
661                                 void (*func)(const struct bContext *C, void *, void *, void *, struct rcti *rect),
662                                 void *arg1, void *arg2);
663
664 bool UI_textbutton_activate_rna(const struct bContext *C, struct ARegion *ar,
665                                 const void *rna_poin_data, const char *rna_prop_id);
666 bool UI_textbutton_activate_but(const struct bContext *C, uiBut *but);
667
668 void uiButSetFocusOnEnter(struct wmWindow *win, uiBut *but);
669
670 /* Autocomplete
671  *
672  * Tab complete helper functions, for use in uiButCompleteFunc callbacks.
673  * Call begin once, then multiple times do_name with all possibilities,
674  * and finally end to finish and get the completed name. */
675
676 typedef struct AutoComplete AutoComplete;
677
678 #define AUTOCOMPLETE_NO_MATCH 0
679 #define AUTOCOMPLETE_FULL_MATCH 1
680 #define AUTOCOMPLETE_PARTIAL_MATCH 2
681
682 AutoComplete *autocomplete_begin(const char *startname, size_t maxlen);
683 void autocomplete_do_name(AutoComplete *autocpl, const char *name);
684 int autocomplete_end(AutoComplete *autocpl, char *autoname);
685
686 /* Panels
687  *
688  * Functions for creating, freeing and drawing panels. The API here
689  * could use a good cleanup, though how they will function in 2.5 is
690  * not clear yet so we postpone that. */
691
692 void uiBeginPanels(const struct bContext *C, struct ARegion *ar);
693 void uiEndPanels(const struct bContext *C, struct ARegion *ar, int *x, int *y);
694 void uiDrawPanels(const struct bContext *C, struct ARegion *ar);
695
696 struct Panel *uiPanelFindByType(struct ARegion *ar, struct PanelType *pt);
697 struct Panel *uiBeginPanel(struct ScrArea *sa, struct ARegion *ar, uiBlock *block,
698                            struct PanelType *pt, struct Panel *pa, bool *r_open);
699 void uiEndPanel(uiBlock *block, int width, int height);
700 void uiScalePanels(struct ARegion *ar, float new_width);
701
702 bool                       UI_panel_category_is_visible(struct ARegion *ar);
703 void                       UI_panel_category_add(struct ARegion *ar, const char *name);
704 struct PanelCategoryDyn   *UI_panel_category_find(struct ARegion *ar, const char *idname);
705 struct PanelCategoryStack *UI_panel_category_active_find(struct ARegion *ar, const char *idname);
706 const char                *UI_panel_category_active_get(struct ARegion *ar, bool set_fallback);
707 void                       UI_panel_category_active_set(struct ARegion *ar, const char *idname);
708 struct PanelCategoryDyn   *UI_panel_category_find_mouse_over_ex(struct ARegion *ar, const int x, const int y);
709 struct PanelCategoryDyn   *UI_panel_category_find_mouse_over(struct ARegion *ar, const struct wmEvent *event);
710 void                       UI_panel_category_clear_all(struct ARegion *ar);
711 void                       UI_panel_category_draw_all(struct ARegion *ar, const char *category_id_active);
712
713 /* Handlers
714  *
715  * Handlers that can be registered in regions, areas and windows for
716  * handling WM events. Mostly this is done automatic by modules such
717  * as screen/ if ED_KEYMAP_UI is set, or internally in popup functions. */
718
719 void UI_add_region_handlers(struct ListBase *handlers);
720 void UI_add_popup_handlers(struct bContext *C, struct ListBase *handlers, uiPopupBlockHandle *popup, const bool accept_dbl_click);
721 void UI_remove_popup_handlers(struct ListBase *handlers, uiPopupBlockHandle *popup);
722 void UI_remove_popup_handlers_all(struct bContext *C, struct ListBase *handlers);
723
724 /* Module
725  *
726  * init and exit should be called before using this module. init_userdef must
727  * be used to reinitialize some internal state if user preferences change. */
728
729 void UI_init(void);
730 void UI_init_userdef(void);
731 void UI_reinit_font(void);
732 void UI_exit(void);
733
734 /* Layout
735  *
736  * More automated layout of buttons. Has three levels:
737  * - Layout: contains a number templates, within a bounded width or height.
738  * - Template: predefined layouts for buttons with a number of slots, each
739  *   slot can contain multiple items.
740  * - Item: item to put in a template slot, being either an RNA property,
741  *   operator, label or menu. Also regular buttons can be used when setting
742  *   uiBlockCurLayout. */
743
744 /* layout */
745 #define UI_LAYOUT_HORIZONTAL    0
746 #define UI_LAYOUT_VERTICAL      1
747
748 #define UI_LAYOUT_PANEL         0
749 #define UI_LAYOUT_HEADER        1
750 #define UI_LAYOUT_MENU          2
751 #define UI_LAYOUT_TOOLBAR       3
752 #define UI_LAYOUT_PIEMENU       4
753
754 #define UI_UNIT_X               ((void)0, U.widget_unit)
755 #define UI_UNIT_Y               ((void)0, U.widget_unit)
756
757 #define UI_LAYOUT_ALIGN_EXPAND  0
758 #define UI_LAYOUT_ALIGN_LEFT    1
759 #define UI_LAYOUT_ALIGN_CENTER  2
760 #define UI_LAYOUT_ALIGN_RIGHT   3
761
762 #define UI_ITEM_O_RETURN_PROPS  (1 << 0)
763 #define UI_ITEM_R_EXPAND        (1 << 1)
764 #define UI_ITEM_R_SLIDER        (1 << 2)
765 #define UI_ITEM_R_TOGGLE        (1 << 3)
766 #define UI_ITEM_R_ICON_ONLY     (1 << 4)
767 #define UI_ITEM_R_EVENT         (1 << 5)
768 #define UI_ITEM_R_FULL_EVENT    (1 << 6)
769 #define UI_ITEM_R_NO_BG         (1 << 7)
770 #define UI_ITEM_R_IMMEDIATE     (1 << 8)
771
772 /* uiLayoutOperatorButs flags */
773 #define UI_LAYOUT_OP_SHOW_TITLE 1
774 #define UI_LAYOUT_OP_SHOW_EMPTY 2
775
776 /* used for transp checkers */
777 #define UI_ALPHA_CHECKER_DARK 100
778 #define UI_ALPHA_CHECKER_LIGHT 160
779
780 /* flags to set which corners will become rounded:
781  *
782  * 1------2
783  * |      |
784  * 8------4 */
785
786 enum {
787         UI_CNR_TOP_LEFT     = (1 << 0),
788         UI_CNR_TOP_RIGHT    = (1 << 1),
789         UI_CNR_BOTTOM_RIGHT = (1 << 2),
790         UI_CNR_BOTTOM_LEFT  = (1 << 3),
791         /* just for convenience */
792         UI_CNR_NONE         = 0,
793         UI_CNR_ALL          = (UI_CNR_TOP_LEFT | UI_CNR_TOP_RIGHT | UI_CNR_BOTTOM_RIGHT | UI_CNR_BOTTOM_LEFT)
794 };
795
796 /* not apart of the corner flags but mixed in some functions  */
797 #define UI_RB_ALPHA (UI_CNR_ALL + 1)
798
799 uiLayout *uiBlockLayout(uiBlock *block, int dir, int type, int x, int y, int size, int em, int padding, struct uiStyle *style);
800 void uiBlockSetCurLayout(uiBlock *block, uiLayout *layout);
801 void uiBlockLayoutResolve(uiBlock *block, int *x, int *y);
802
803 uiBlock *uiLayoutGetBlock(uiLayout *layout);
804
805 void uiLayoutSetFunc(uiLayout *layout, uiMenuHandleFunc handlefunc, void *argv);
806 void uiLayoutSetContextPointer(uiLayout *layout, const char *name, struct PointerRNA *ptr);
807 void uiLayoutContextCopy(uiLayout *layout, struct bContextStore *context);
808 const char *uiLayoutIntrospect(uiLayout *layout); // XXX - testing
809 void uiLayoutOperatorButs(const struct bContext *C, struct uiLayout *layout, struct wmOperator *op,
810                           bool (*check_prop)(struct PointerRNA *, struct PropertyRNA *),
811                           const char label_align, const short flag);
812 struct MenuType *uiButGetMenuType(uiBut *but);
813
814 void uiLayoutSetOperatorContext(uiLayout *layout, int opcontext);
815 void uiLayoutSetActive(uiLayout *layout, bool active);
816 void uiLayoutSetEnabled(uiLayout *layout, bool enabled);
817 void uiLayoutSetRedAlert(uiLayout *layout, bool redalert);
818 void uiLayoutSetAlignment(uiLayout *layout, char alignment);
819 void uiLayoutSetKeepAspect(uiLayout *layout, bool keepaspect);
820 void uiLayoutSetScaleX(uiLayout *layout, float scale);
821 void uiLayoutSetScaleY(uiLayout *layout, float scale);
822
823 int uiLayoutGetOperatorContext(uiLayout *layout);
824 bool uiLayoutGetActive(uiLayout *layout);
825 bool uiLayoutGetEnabled(uiLayout *layout);
826 bool uiLayoutGetRedAlert(uiLayout *layout);
827 int uiLayoutGetAlignment(uiLayout *layout);
828 bool uiLayoutGetKeepAspect(uiLayout *layout);
829 int uiLayoutGetWidth(uiLayout *layout);
830 float uiLayoutGetScaleX(uiLayout *layout);
831 float uiLayoutGetScaleY(uiLayout *layout);
832
833 /* layout specifiers */
834 uiLayout *uiLayoutRow(uiLayout *layout, int align);
835 uiLayout *uiLayoutColumn(uiLayout *layout, int align);
836 uiLayout *uiLayoutColumnFlow(uiLayout *layout, int number, int align);
837 uiLayout *uiLayoutBox(uiLayout *layout);
838 uiLayout *uiLayoutListBox(uiLayout *layout, struct uiList *ui_list, struct PointerRNA *ptr, struct PropertyRNA *prop,
839                           struct PointerRNA *actptr, struct PropertyRNA *actprop);
840 uiLayout *uiLayoutAbsolute(uiLayout *layout, int align);
841 uiLayout *uiLayoutSplit(uiLayout *layout, float percentage, int align);
842 uiLayout *uiLayoutOverlap(uiLayout *layout);
843 uiBlock *uiLayoutAbsoluteBlock(uiLayout *layout);
844 uiLayout *uiLayoutRadial(uiLayout *layout);
845
846 /* templates */
847 void uiTemplateHeader(uiLayout *layout, struct bContext *C);
848 void uiTemplateID(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname,
849                   const char *newop, const char *openop, const char *unlinkop);
850 void uiTemplateIDBrowse(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname,
851                         const char *newop, const char *openop, const char *unlinkop);
852 void uiTemplateIDPreview(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname,
853                          const char *newop, const char *openop, const char *unlinkop, int rows, int cols);
854 void uiTemplateAnyID(uiLayout *layout, struct PointerRNA *ptr, const char *propname, 
855                      const char *proptypename, const char *text);
856 void uiTemplatePathBuilder(uiLayout *layout, struct PointerRNA *ptr, const char *propname, 
857                            struct PointerRNA *root_ptr, const char *text);
858 uiLayout *uiTemplateModifier(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr);
859 uiLayout *uiTemplateConstraint(uiLayout *layout, struct PointerRNA *ptr);
860 void uiTemplatePreview(uiLayout *layout, struct bContext *C, struct ID *id, int show_buttons, struct ID *parent,
861                        struct MTex *slot, const char *preview_id);
862 void uiTemplateColorRamp(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int expand);
863 void uiTemplateIconView(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
864 void uiTemplateHistogram(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
865 void uiTemplateWaveform(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
866 void uiTemplateVectorscope(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
867 void uiTemplateCurveMapping(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int type,
868                             int levels, int brush, int neg_slope);
869 void uiTemplateColorPicker(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int value_slider, int lock, int lock_luminosity, int cubic);
870 void uiTemplatePalette(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int color);
871 void uiTemplateLayers(uiLayout *layout, struct PointerRNA *ptr, const char *propname,
872                       PointerRNA *used_ptr, const char *used_propname, int active_layer);
873 void uiTemplateGameStates(uiLayout *layout, struct PointerRNA *ptr, const char *propname,
874                       PointerRNA *used_ptr, const char *used_propname, int active_state);
875 void uiTemplateImage(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname, struct PointerRNA *userptr, int compact);
876 void uiTemplateImageSettings(uiLayout *layout, struct PointerRNA *imfptr, int color_management);
877 void uiTemplateImageLayers(uiLayout *layout, struct bContext *C, struct Image *ima, struct ImageUser *iuser);
878 void uiTemplateRunningJobs(uiLayout *layout, struct bContext *C);
879 void uiOperatorSearch_But(uiBut *but);
880 void uiTemplateOperatorSearch(uiLayout *layout);
881 void uiTemplateHeader3D(uiLayout *layout, struct bContext *C);
882 void uiTemplateEditModeSelection(uiLayout *layout, struct bContext *C);
883 void uiTemplateReportsBanner(uiLayout *layout, struct bContext *C);
884 void uiTemplateKeymapItemProperties(uiLayout *layout, struct PointerRNA *ptr);
885 void uiTemplateComponentMenu(uiLayout *layout, struct PointerRNA *ptr, const char *propname, const char *name);
886 void uiTemplateNodeSocket(uiLayout *layout, struct bContext *C, float *color);
887
888 /* Default UIList class name, keep in sync with its declaration in bl_ui/__init__.py */
889 #define UI_UL_DEFAULT_CLASS_NAME "UI_UL_list"
890 void uiTemplateList(uiLayout *layout, struct bContext *C, const char *listtype_name, const char *list_id,
891                     struct PointerRNA *dataptr, const char *propname, struct PointerRNA *active_dataptr,
892                     const char *active_propname, int rows, int maxrows, int layout_type, int columns);
893 void uiTemplateNodeLink(uiLayout *layout, struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *input);
894 void uiTemplateNodeView(uiLayout *layout, struct bContext *C, struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *input);
895 void uiTemplateTextureUser(uiLayout *layout, struct bContext *C);
896 void uiTemplateTextureShow(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop);
897
898 void uiTemplateMovieClip(struct uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname, int compact);
899 void uiTemplateTrack(struct uiLayout *layout, struct PointerRNA *ptr, const char *propname);
900 void uiTemplateMarker(struct uiLayout *layout, struct PointerRNA *ptr, const char *propname, PointerRNA *userptr, PointerRNA *trackptr, int cmpact);
901 void uiTemplateMovieclipInformation(struct uiLayout *layout, struct PointerRNA *ptr, const char *propname, struct PointerRNA *userptr);
902
903 void uiTemplateColorspaceSettings(struct uiLayout *layout, struct PointerRNA *ptr, const char *propname);
904 void uiTemplateColormanagedViewSettings(struct uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname);
905
906 /* items */
907 void uiItemO(uiLayout *layout, const char *name, int icon, const char *opname);
908 void uiItemEnumO_ptr(uiLayout *layout, struct wmOperatorType *ot, const char *name, int icon, const char *propname, int value);
909 void uiItemEnumO(uiLayout *layout, const char *opname, const char *name, int icon, const char *propname, int value);
910 void uiItemEnumO_value(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, int value);
911 void uiItemEnumO_string(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, const char *value);
912 void uiItemsEnumO(uiLayout *layout, const char *opname, const char *propname);
913 void uiItemBooleanO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, int value);
914 void uiItemIntO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, int value);
915 void uiItemFloatO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, float value);
916 void uiItemStringO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, const char *value);
917
918 PointerRNA uiItemFullO_ptr(uiLayout *layout, struct wmOperatorType *ot, const char *name, int icon, IDProperty *properties, int context, int flag);
919 PointerRNA uiItemFullO(uiLayout *layout, const char *idname, const char *name, int icon, struct IDProperty *properties, int context, int flag);
920
921 void uiItemR(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int flag, const char *name, int icon);
922 void uiItemFullR(uiLayout *layout, struct PointerRNA *ptr, struct PropertyRNA *prop, int index, int value, int flag, const char *name, int icon);
923 void uiItemEnumR(uiLayout *layout, const char *name, int icon, struct PointerRNA *ptr, const char *propname, int value);
924 void uiItemEnumR_string(uiLayout *layout, struct PointerRNA *ptr, const char *propname, const char *value, const char *name, int icon);
925 void uiItemsEnumR(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
926 void uiItemPointerR(uiLayout *layout, struct PointerRNA *ptr, const char *propname, struct PointerRNA *searchptr, const char *searchpropname, const char *name, int icon);
927 void uiItemsFullEnumO(uiLayout *layout, const char *opname, const char *propname, struct IDProperty *properties, int context, int flag);
928
929 void uiItemL(uiLayout *layout, const char *name, int icon); /* label */
930 void uiItemLDrag(uiLayout *layout, struct PointerRNA *ptr, const char *name, int icon); /* label icon for dragging */
931 void uiItemM(uiLayout *layout, struct bContext *C, const char *menuname, const char *name, int icon); /* menu */
932 void uiItemV(uiLayout *layout, const char *name, int icon, int argval); /* value */
933 void uiItemS(uiLayout *layout); /* separator */
934
935 void uiItemMenuF(uiLayout *layout, const char *name, int icon, uiMenuCreateFunc func, void *arg);
936 void uiItemMenuEnumO(uiLayout *layout, struct bContext *C, const char *opname, const char *propname, const char *name, int icon);
937 void uiItemMenuEnumR(uiLayout *layout, struct PointerRNA *ptr, const char *propname, const char *name, int icon);
938
939 /* UI Operators */
940 typedef struct uiDragColorHandle {
941         float color[3];
942         bool gamma_corrected;
943 } uiDragColorHandle;
944
945 void UI_buttons_operatortypes(void);
946 void UI_drop_color_copy(struct wmDrag *drag, struct wmDropBox *drop);
947 int UI_drop_color_poll(struct bContext *C, struct wmDrag *drag, const struct wmEvent *event);
948
949 /* Helpers for Operators */
950 uiBut *uiContextActiveButton(const struct bContext *C);
951 void uiContextActiveProperty(const struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA **prop, int *index);
952 void uiContextActivePropertyHandle(struct bContext *C);
953 struct wmOperator *uiContextActiveOperator(const struct bContext *C);
954 void uiContextAnimUpdate(const struct bContext *C);
955 void uiFileBrowseContextProperty(const struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA **prop);
956 void uiIDContextProperty(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA **prop);
957
958 /* Styled text draw */
959 void uiStyleFontSet(struct uiFontStyle *fs);
960 void uiStyleFontDrawExt(struct uiFontStyle *fs, const struct rcti *rect, const char *str,
961                         size_t len, float *r_xofs, float *r_yofs);
962 void uiStyleFontDraw(struct uiFontStyle *fs, const struct rcti *rect, const char *str);
963 void uiStyleFontDrawRotated(struct uiFontStyle *fs, const struct rcti *rect, const char *str);
964
965 int UI_GetStringWidth(const char *str); // XXX temp
966 void UI_DrawString(float x, float y, const char *str); // XXX temp
967 void UI_DrawTriIcon(float x, float y, char dir);
968
969 uiStyle *UI_GetStyle(void);             /* use for fonts etc */
970 uiStyle *UI_GetStyleDraw(void); /* DPI scaled settings for drawing */
971
972 /* linker workaround ack! */
973 void UI_template_fix_linking(void);
974
975 /* UI_OT_editsource helpers */
976 bool UI_editsource_enable_check(void);
977 void UI_editsource_active_but_test(uiBut *but);
978
979 /* UI_butstore_ helpers */
980 typedef struct uiButStore uiButStore;
981 typedef struct uiButStoreElem uiButStoreElem;
982
983 uiButStore *UI_butstore_create(uiBlock *block);
984 void UI_butstore_clear(uiBlock *block);
985 void UI_butstore_update(uiBlock *block);
986 void UI_butstore_free(uiBlock *block, uiButStore *bs);
987 bool UI_butstore_is_valid(uiButStore *bs);
988 bool UI_butstore_is_registered(uiBlock *block, uiBut *but);
989 void UI_butstore_register(uiButStore *bs_handle, uiBut **but_p);
990 void UI_butstore_unregister(uiButStore *bs_handle, uiBut **but_p);
991
992
993 /* Float precision helpers */
994 #define UI_PRECISION_FLOAT_MAX 7
995
996 int uiFloatPrecisionCalc(int prec, double value);
997
998 #endif  /* __UI_INTERFACE_H__ */