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