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