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