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