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