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