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