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