3a52e00b981d5bcf1f3cd9bdc7055fcdff05a080
[blender-staging.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 /* Struct Declarations */
34
35 struct ID;
36 struct Main;
37 struct ListBase;
38 struct ARegion;
39 struct ScrArea;
40 struct wmWindow;
41 struct wmWindowManager;
42 struct wmOperator;
43 struct AutoComplete;
44 struct bContext;
45 struct Panel;
46 struct PanelType;
47 struct PointerRNA;
48 struct PropertyRNA;
49 struct ReportList;
50 struct rcti;
51 struct rctf;
52 struct uiStyle;
53 struct uiFontStyle;
54 struct ColorBand;
55
56 typedef struct uiBut uiBut;
57 typedef struct uiBlock uiBlock;
58 typedef struct uiPopupBlockHandle uiPopupBlockHandle;
59 typedef struct uiLayout uiLayout;
60
61 /* Defines */
62
63 /* uiBlock->dt */
64 #define UI_EMBOSS               0       /* use widget style for drawing */
65 #define UI_EMBOSSN              1       /* Nothing, only icon and/or text */
66 #define UI_EMBOSSP              2       /* Pulldown menu style */
67 #define UI_EMBOSST              3       /* Table */
68
69 /* uiBlock->direction */
70 #define UI_TOP          1
71 #define UI_DOWN         2
72 #define UI_LEFT         4
73 #define UI_RIGHT        8
74 #define UI_DIRECTION    15
75 #define UI_CENTER               16
76 #define UI_SHIFT_FLIPPED        32
77
78 /* uiBlock->autofill (not yet used) */
79 #define UI_BLOCK_COLLUMNS       1
80 #define UI_BLOCK_ROWS           2
81
82 /* uiBlock->flag (controls) */
83 #define UI_BLOCK_LOOP                   1
84 #define UI_BLOCK_REDRAW                 2
85 #define UI_BLOCK_RET_1                  4               /* XXX 2.5 not implemented */
86 #define UI_BLOCK_NUMSELECT              8
87 #define UI_BLOCK_ENTER_OK               16
88 #define UI_BLOCK_NOSHADOW               32
89 #define UI_BLOCK_UNUSED                 64
90 #define UI_BLOCK_MOVEMOUSE_QUIT 128
91 #define UI_BLOCK_KEEP_OPEN              256
92 #define UI_BLOCK_POPUP                  512
93
94 /* uiPopupBlockHandle->menuretval */
95 #define UI_RETURN_CANCEL        1       /* cancel all menus cascading */
96 #define UI_RETURN_OK        2       /* choice made */
97 #define UI_RETURN_OUT       4       /* left the menu */
98
99         /* block->flag bits 12-15 are identical to but->flag bits */
100
101 /* panel controls */
102 #define UI_PNL_TRANSP   1
103 #define UI_PNL_SOLID    2
104
105 #define UI_PNL_CLOSE    32
106 #define UI_PNL_STOW             64
107 #define UI_PNL_TO_MOUSE 128
108 #define UI_PNL_UNSTOW   256
109 #define UI_PNL_SCALE    512
110
111 /* warning the first 6 flags are internal */
112 /* but->flag */
113 #define UI_TEXT_LEFT    64
114 #define UI_ICON_LEFT    128
115 #define UI_ICON_SUBMENU 256
116         /* control for button type block */
117 #define UI_MAKE_TOP             512
118 #define UI_MAKE_DOWN    1024
119 #define UI_MAKE_LEFT    2048
120 #define UI_MAKE_RIGHT   4096
121
122         /* button align flag, for drawing groups together */
123 #define UI_BUT_ALIGN            (15<<14)
124 #define UI_BUT_ALIGN_TOP        (1<<14)
125 #define UI_BUT_ALIGN_LEFT       (1<<15)
126 #define UI_BUT_ALIGN_RIGHT      (1<<16)
127 #define UI_BUT_ALIGN_DOWN       (1<<17)
128
129 #define UI_BUT_DISABLED         (1<<18)
130 #define UI_BUT_UNUSED           (1<<19)
131 #define UI_BUT_ANIMATED         (1<<20)
132 #define UI_BUT_ANIMATED_KEY     (1<<21)
133 #define UI_BUT_DRIVEN           (1<<22)
134
135 #define UI_PANEL_WIDTH                  340
136 #define UI_COMPACT_PANEL_WIDTH  160
137
138 /* Button types, bits stored in 1 value... and a short even!
139 - bits 0-4:  bitnr (0-31)
140 - bits 5-7:  pointer type
141 - bit  8:    for 'bit'
142 - bit  9-15: button type (now 6 bits, 64 types)
143 */
144
145 #define CHA     32
146 #define SHO     64
147 #define INT     96
148 #define FLO     128
149 #define FUN     192
150 #define BIT     256
151
152 #define BUTPOIN (128+64+32)
153
154 #define BUT     (1<<9)
155 #define ROW     (2<<9)
156 #define TOG     (3<<9)
157 #define SLI     (4<<9)
158 #define NUM     (5<<9)
159 #define TEX     (6<<9)
160 #define TOG3    (7<<9)
161 #define TOGR    (8<<9)
162 #define TOGN    (9<<9)
163 #define LABEL   (10<<9)
164 #define MENU    (11<<9)
165 #define ICONROW (12<<9)
166 #define ICONTOG (13<<9)
167 #define NUMSLI  (14<<9)
168 #define COL             (15<<9)
169 #define IDPOIN  (16<<9)
170 #define HSVSLI  (17<<9)
171 #define SCROLL  (18<<9)
172 #define BLOCK   (19<<9)
173 #define BUTM    (20<<9)
174 #define SEPR    (21<<9)
175 #define LINK    (22<<9)
176 #define INLINK  (23<<9)
177 #define KEYEVT  (24<<9)
178 #define ICONTEXTROW (25<<9)
179 #define HSVCUBE (26<<9)
180 #define PULLDOWN (27<<9)
181 #define ROUNDBOX (28<<9)
182 #define CHARTAB (29<<9)
183 #define BUT_COLORBAND (30<<9)
184 #define BUT_NORMAL (31<<9)
185 #define BUT_CURVE (32<<9)
186 #define BUT_TOGDUAL (33<<9)
187 #define ICONTOGN (34<<9)
188 #define FTPREVIEW (35<<9)
189 #define NUMABS  (36<<9)
190 #define TOGBUT  (37<<9)
191 #define BUTTYPE (63<<9)
192
193 /* Drawing
194  *
195  * Functions to draw various shapes, taking theme settings into account.
196  * Used for code that draws its own UI style elements. */
197
198 void uiEmboss(float x1, float y1, float x2, float y2, int sel);
199 void uiRoundBox(float minx, float miny, float maxx, float maxy, float rad);
200 void uiSetRoundBox(int type);
201 int uiGetRoundBox(void);
202 void uiRoundRect(float minx, float miny, float maxx, float maxy, float rad);
203 void uiDrawMenuBox(float minx, float miny, float maxx, float maxy, short flag, short direction);
204 void uiDrawBoxShadow(unsigned char alpha, float minx, float miny, float maxx, float maxy);
205
206 /* Menu Callbacks */
207
208 typedef void (*uiMenuCreateFunc)(struct bContext *C, struct uiLayout *layout, void *arg1);
209 typedef void (*uiMenuHandleFunc)(struct bContext *C, void *arg, int event);
210
211 /* Popup Menus
212  *
213  * Functions used to create popup menus. For more extended menus the
214  * uiPupMenuBegin/End functions can be used to define own items with
215  * the uiItem functions inbetween. If it is a simple confirmation menu
216  * or similar, popups can be created with a single function call. */
217
218 typedef struct uiPopupMenu uiPopupMenu;
219
220 uiPopupMenu *uiPupMenuBegin(struct bContext *C, const char *title, int icon);
221 void uiPupMenuEnd(struct bContext *C, struct uiPopupMenu *head);
222 struct uiLayout *uiPupMenuLayout(uiPopupMenu *head);
223
224 void uiPupMenuOkee(struct bContext *C, char *opname, char *str, ...);
225 void uiPupMenuSaveOver(struct bContext *C, struct wmOperator *op, char *filename);
226 void uiPupMenuNotice(struct bContext *C, char *str, ...);
227 void uiPupMenuError(struct bContext *C, char *str, ...);
228 void uiPupMenuReports(struct bContext *C, struct ReportList *reports);
229
230 void uiPupMenuSetActive(int val);
231
232 /* Popup Blocks
233  *
234  * Functions used to create popup blocks. These are like popup menus
235  * but allow using all button types and creating an own layout. */
236
237 typedef uiBlock* (*uiBlockCreateFunc)(struct bContext *C, struct ARegion *ar, void *arg1);
238
239 void uiPupBlock(struct bContext *C, uiBlockCreateFunc func, void *arg);
240 void uiPupBlockO(struct bContext *C, uiBlockCreateFunc func, void *arg, char *opname, int opcontext);
241
242 /* Blocks
243  *
244  * Functions for creating, drawing and freeing blocks. A Block is a
245  * container of buttons and used for various purposes.
246  * 
247  * Begin/Define Buttons/End/Draw is the typical order in which these
248  * function should be called, though for popup blocks Draw is left out.
249  * Freeing blocks is done by the screen/ module automatically.
250  *
251  * */
252
253 uiBlock *uiBeginBlock(const struct bContext *C, struct ARegion *region, const char *name, short dt);
254 void uiEndBlock(const struct bContext *C, uiBlock *block);
255 void uiDrawBlock(const struct bContext *C, struct uiBlock *block);
256
257 uiBlock *uiGetBlock(char *name, struct ARegion *ar);
258
259 void uiBlockSetEmboss(uiBlock *block, short dt);
260
261 void uiFreeBlock(const struct bContext *C, uiBlock *block);
262 void uiFreeBlocks(const struct bContext *C, struct ListBase *lb);
263 void uiFreeInactiveBlocks(const struct bContext *C, struct ListBase *lb);
264
265 void uiBlockSetRegion(uiBlock *block, struct ARegion *region);
266
267 void uiBlockSetButLock(uiBlock *block, int val, char *lockstr);
268 void uiBlockClearButLock(uiBlock *block);
269
270 /* automatic aligning, horiz or verical */
271 void uiBlockBeginAlign(uiBlock *block);
272 void uiBlockEndAlign(uiBlock *block);
273
274 void uiBoundsBlock(struct uiBlock *block, int addval);
275 void uiTextBoundsBlock(uiBlock *block, int addval);
276 void uiPopupBoundsBlock(uiBlock *block, int addval, int mx, int my);
277 void uiMenuPopupBoundsBlock(uiBlock *block, int addvall, int mx, int my);
278
279 int             uiBlocksGetYMin         (struct ListBase *lb);
280
281 void    uiBlockSetDirection     (uiBlock *block, int direction);
282 void    uiBlockFlipOrder        (uiBlock *block);
283 void    uiBlockSetFlag          (uiBlock *block, int flag);
284 void    uiBlockClearFlag        (uiBlock *block, int flag);
285 void    uiBlockSetXOfs          (uiBlock *block, int xofs);
286
287 int             uiButGetRetVal          (uiBut *but);
288
289 void    uiButSetFlag            (uiBut *but, int flag);
290 void    uiButClearFlag          (uiBut *but, int flag);
291
292 /* Buttons
293  *
294  * Functions to define various types of buttons in a block. Postfixes:
295  * - F: float
296  * - I: int
297  * - S: short
298  * - C: char
299  * - R: RNA
300  * - O: operator */
301
302 uiBut *uiDefBut(uiBlock *block, 
303                                            int type, int retval, char *str, 
304                                            short x1, short y1, 
305                                            short x2, short y2, 
306                                            void *poin, 
307                                            float min, float max, 
308                                            float a1, float a2,  char *tip);
309 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);
310 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);
311 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);
312 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);
313 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);
314 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);
315 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);
316 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);
317 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);
318 uiBut *uiDefButO(uiBlock *block, int type, char *opname, int opcontext, char *str, short x1, short y1, short x2, short y2, char *tip);
319
320 uiBut *uiDefIconBut(uiBlock *block, 
321                                            int type, int retval, int icon, 
322                                            short x1, short y1, 
323                                            short x2, short y2, 
324                                            void *poin, 
325                                            float min, float max, 
326                                            float a1, float a2,  char *tip);
327 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);
328 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);
329 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);
330 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);
331 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);
332 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);
333 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);
334 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);
335 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);
336 uiBut *uiDefIconButO(uiBlock *block, int type, char *opname, int opcontext, int icon, short x1, short y1, short x2, short y2, char *tip);
337
338 uiBut *uiDefIconTextBut(uiBlock *block,
339                                                 int type, int retval, int icon, char *str, 
340                                                 short x1, short y1,
341                                                 short x2, short y2,
342                                                 void *poin,
343                                                 float min, float max,
344                                                 float a1, float a2,  char *tip);
345 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);
346 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);
347 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);
348 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);
349 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);
350 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);
351 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);
352 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);
353 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);
354 uiBut *uiDefIconTextButO(uiBlock *block, int type, char *opname, int opcontext, int icon, char *str, short x1, short y1, short x2, short y2, char *tip);
355
356 /* for passing inputs to ButO buttons */
357 struct PointerRNA *uiButGetOperatorPtrRNA(uiBut *but);
358
359 /* Special Buttons
360  *
361  * Butons with a more specific purpose:
362  * - IDPoinBut: for creating buttons that work on a pointer to an ID block.
363  * - MenuBut: buttons that popup a menu (in headers usually).
364  * - PulldownBut: like MenuBut, but creating a uiBlock (for compatibility).
365  * - BlockBut: buttons that popup a block with more buttons.
366  * - KeyevtBut: buttons that can be used to turn key events into values.
367  * - PickerButtons: buttons like the color picker (for code sharing).
368  * - AutoButR: RNA property button with type automatically defined. */
369
370 #define UI_ID_RENAME            1
371 #define UI_ID_BROWSE            2
372 #define UI_ID_ADD_NEW           4
373 #define UI_ID_OPEN                      8
374 #define UI_ID_ALONE                     16
375 #define UI_ID_DELETE            32
376 #define UI_ID_LOCAL                     64
377 #define UI_ID_AUTO_NAME         128
378 #define UI_ID_FAKE_USER         256
379 #define UI_ID_PIN                       512
380 #define UI_ID_BROWSE_RENDER     1024
381 #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)
382
383 typedef void (*uiIDPoinFuncFP)(struct bContext *C, char *str, struct ID **idpp);
384 typedef void (*uiIDPoinFunc)(struct bContext *C, struct ID *id, int event);
385
386 uiBut *uiDefIDPoinBut(uiBlock *block, uiIDPoinFuncFP func, short blocktype, int retval, char *str,
387                                                 short x1, short y1, short x2, short y2, void *idpp, char *tip);
388 int uiDefIDPoinButs(uiBlock *block, struct Main *main, struct ID *parid, struct ID *id, int id_code, short *pin_p, int x, int y, uiIDPoinFunc func, int events);
389
390 uiBut *uiDefPulldownBut(uiBlock *block, uiBlockCreateFunc func, void *arg, char *str, short x1, short y1, short x2, short y2, char *tip);
391 uiBut *uiDefMenuBut(uiBlock *block, uiMenuCreateFunc func, void *arg, char *str, short x1, short y1, short x2, short y2, char *tip);
392 uiBut *uiDefIconTextMenuBut(uiBlock *block, uiMenuCreateFunc func, void *arg, int icon, char *str, short x1, short y1, short x2, short y2, char *tip);
393
394 uiBut *uiDefBlockBut(uiBlock *block, uiBlockCreateFunc func, void *func_arg1, char *str, short x1, short y1, short x2, short y2, char *tip);
395 uiBut *uiDefIconBlockBut(uiBlock *block, uiBlockCreateFunc func, void *arg, int retval, int icon, short x1, short y1, short x2, short y2, char *tip);
396 uiBut *uiDefIconTextBlockBut(uiBlock *block, uiBlockCreateFunc func, void *arg, int icon, char *str, short x1, short y1, short x2, short y2, char *tip);
397
398 void uiDefKeyevtButS(uiBlock *block, int retval, char *str, short x1, short y1, short x2, short y2, short *spoin, char *tip);
399
400 void uiBlockPickerButtons(struct uiBlock *block, float *col, float *hsv, float *old, char *hexcol, char mode, short retval);
401 void uiBlockColorbandButtons(struct uiBlock *block, struct ColorBand *coba, struct rctf *butr, int event);
402
403 uiBut *uiDefAutoButR(uiBlock *block, struct PointerRNA *ptr, struct PropertyRNA *prop, int index, char *name, int icon, int x1, int y1, int x2, int y2);
404 void uiDefAutoButsRNA(const struct bContext *C, uiLayout *layout, struct PointerRNA *ptr);
405
406 /* Links
407  *
408  * Game engine logic brick links. Non-functional currently in 2.5,
409  * code to handle and draw these is disabled internally. */
410
411 void uiSetButLink(struct uiBut *but,  void **poin,  void ***ppoin,  short *tot,  int from, int to);
412
413 void uiComposeLinks(uiBlock *block);
414 uiBut *uiFindInlink(uiBlock *block, void *poin);
415
416 /* Callbacks
417  *
418  * uiBlockSetHandleFunc/ButmFunc are for handling events through a callback.
419  * HandleFunc gets the retval passed on, and ButmFunc gets a2. The latter is
420  * mostly for compatibility with older code.
421  *
422  * uiButSetCompleteFunc is for tab completion.
423  *
424  * uiBlockSetFunc and uiButSetFunc are callbacks run when a button is used,
425  * in case events, operators or RNA are not sufficient to handle the button.
426  *
427  * uiButSetNFunc will free the argument with MEM_freeN. */
428
429 typedef void (*uiButHandleFunc)(struct bContext *C, void *arg1, void *arg2);
430 typedef void (*uiButHandleNFunc)(struct bContext *C, void *argN, void *arg2);
431 typedef void (*uiButCompleteFunc)(struct bContext *C, char *str, void *arg);
432 typedef void (*uiBlockHandleFunc)(struct bContext *C, void *arg, int event);
433
434 void    uiBlockSetHandleFunc(uiBlock *block,    uiBlockHandleFunc func, void *arg);
435 void    uiBlockSetButmFunc      (uiBlock *block,        uiMenuHandleFunc func, void *arg);
436
437 void    uiBlockSetFunc          (uiBlock *block,        uiButHandleFunc func, void *arg1, void *arg2);
438 void    uiButSetFunc            (uiBut *but,            uiButHandleFunc func, void *arg1, void *arg2);
439 void    uiButSetNFunc           (uiBut *but,            uiButHandleNFunc func, void *argN, void *arg2);
440
441 void    uiButSetCompleteFunc(uiBut *but,                uiButCompleteFunc func, void *arg);
442
443 void    uiBlockSetDrawExtraFunc(uiBlock *block, void (*func)(struct bContext *C, uiBlock *block));
444
445 /* Autocomplete
446  *
447  * Tab complete helper functions, for use in uiButCompleteFunc callbacks.
448  * Call begin once, then multiple times do_name with all possibilities,
449  * and finally end to finish and get the completed name. */
450
451 typedef struct AutoComplete AutoComplete;
452
453 AutoComplete *autocomplete_begin(char *startname, int maxlen);
454 void autocomplete_do_name(AutoComplete *autocpl, const char *name);
455 void autocomplete_end(AutoComplete *autocpl, char *autoname);
456
457 /* Panels
458  *
459  * Functions for creating, freeing and drawing panels. The API here
460  * could use a good cleanup, though how they will function in 2.5 is
461  * not clear yet so we postpone that. */
462
463 void uiBeginPanels(const struct bContext *C, struct ARegion *ar);
464 void uiEndPanels(const struct bContext *C, struct ARegion *ar);
465
466 struct Panel *uiBeginPanel(struct ARegion *ar, uiBlock *block, struct PanelType *pt, int *open);
467 void uiEndPanel(uiBlock *block, int width, int height);
468
469 /* Handlers
470  *
471  * Handlers that can be registered in regions, areas and windows for
472  * handling WM events. Mostly this is done automatic by modules such
473  * as screen/ if ED_KEYMAP_UI is set, or internally in popup functions. */
474
475 void UI_add_region_handlers(struct ListBase *handlers);
476 void UI_add_area_handlers(struct ListBase *handlers);
477 void UI_add_popup_handlers(struct bContext *C, struct ListBase *handlers, uiPopupBlockHandle *menu);
478
479 /* Legacy code
480  * Callbacks and utils to get 2.48 work */
481
482 void test_idbutton_cb(struct bContext *C, void *namev, void *arg2);
483 void test_scriptpoin_but(struct bContext *C, char *name, struct ID **idpp);
484 void test_actionpoin_but(struct bContext *C, char *name, struct ID **idpp);
485 void test_obpoin_but(struct bContext *C, char *name, struct ID **idpp);
486 void test_meshobpoin_but(struct bContext *C, char *name, struct ID **idpp);
487 void test_meshpoin_but(struct bContext *C, char *name, struct ID **idpp);
488 void test_matpoin_but(struct bContext *C, char *name, struct ID **idpp);
489 void test_scenepoin_but(struct bContext *C, char *name, struct ID **idpp);
490 void test_grouppoin_but(struct bContext *C, char *name, struct ID **idpp);
491 void test_texpoin_but(struct bContext *C, char *name, struct ID **idpp);
492 void test_imapoin_but(struct bContext *C, char *name, struct ID **idpp);
493 void autocomplete_bone(struct bContext *C, char *str, void *arg_v);
494 void autocomplete_vgroup(struct bContext *C, char *str, void *arg_v);
495
496 struct CurveMapping;
497 struct rctf;
498 void curvemap_buttons(uiBlock *block, struct CurveMapping *cumap, char labeltype, short event, short redraw, struct rctf *rect);
499
500
501 /* Module
502  *
503  * init and exit should be called before using this module. init_userdef must
504  * be used to reinitialize some internal state if user preferences change. */
505
506 void UI_init(void);
507 void UI_init_userdef(void);
508 void UI_exit(void);
509
510 /* XXX hide this */
511
512 uiBut *uiDefMenuButO(uiBlock *block, char *opname, char *name);
513 uiBut *uiDefMenuSep(uiBlock *block);
514 uiBut *uiDefMenuSub(uiBlock *block, uiBlockCreateFunc func, char *name);
515 uiBut *uiDefMenuTogR(uiBlock *block, struct PointerRNA *ptr, char *propname, char *propvalue, char *name);
516
517 /* Layout
518  *
519  * More automated layout of buttons. Has three levels:
520  * - Layout: contains a number templates, within a bounded width or height.
521  * - Template: predefined layouts for buttons with a number of slots, each
522  *   slot can contain multiple items.
523  * - Item: item to put in a template slot, being either an RNA property,
524  *   operator, label or menu. Also regular buttons can be used when setting
525  *   uiBlockCurLayout. */
526
527 /* layout */
528 #define UI_LAYOUT_HORIZONTAL    0
529 #define UI_LAYOUT_VERTICAL              1
530
531 #define UI_LAYOUT_PANEL                 0
532 #define UI_LAYOUT_HEADER                1
533 #define UI_LAYOUT_MENU                  2
534
535 #define UI_UNIT_X               20
536 #define UI_UNIT_Y               20
537
538 uiLayout *uiBlockLayout(uiBlock *block, int dir, int type, int x, int y, int size, int em, struct uiStyle *style);
539 void uiBlockSetCurLayout(uiBlock *block, uiLayout *layout);
540 void uiBlockLayoutResolve(const struct bContext *C, uiBlock *block, int *x, int *y);
541 float uiBlockAspect(uiBlock *block); /* temporary */
542
543 void uiLayoutContext(uiLayout *layout, int opcontext);
544 void uiLayoutFunc(uiLayout *layout, uiMenuHandleFunc handlefunc, void *argv);
545 uiBlock *uiLayoutBlock(uiLayout *layout);
546
547 /* layout specifiers */
548 uiLayout *uiLayoutRow(uiLayout *layout, int align);
549 uiLayout *uiLayoutColumn(uiLayout *layout, int align);
550 uiLayout *uiLayoutColumnFlow(uiLayout *layout, int number, int align);
551 uiLayout *uiLayoutBox(uiLayout *layout);
552 uiLayout *uiLayoutFree(uiLayout *layout, int align);
553 uiLayout *uiLayoutSplit(uiLayout *layout);
554
555 uiBlock *uiLayoutFreeBlock(uiLayout *layout);
556
557 /* templates */
558 void uiTemplateHeader(uiLayout *layout, struct bContext *C);
559 void uiTemplateHeaderID(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, char *propname,
560         char *newop, char *openop, char *unlinkop);
561 uiLayout *uiTemplateModifier(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr);
562
563 /* items */
564 void uiItemO(uiLayout *layout, char *name, int icon, char *opname);
565 void uiItemEnumO(uiLayout *layout, char *name, int icon, char *opname, char *propname, int value);
566 void uiItemsEnumO(uiLayout *layout, char *opname, char *propname);
567 void uiItemBooleanO(uiLayout *layout, char *name, int icon, char *opname, char *propname, int value);
568 void uiItemIntO(uiLayout *layout, char *name, int icon, char *opname, char *propname, int value);
569 void uiItemFloatO(uiLayout *layout, char *name, int icon, char *opname, char *propname, float value);
570 void uiItemStringO(uiLayout *layout, char *name, int icon, char *opname, char *propname, char *value);
571 void uiItemFullO(uiLayout *layout, char *name, int icon, char *idname, struct IDProperty *properties, int context);
572
573 void uiItemR(uiLayout *layout, char *name, int icon, struct PointerRNA *ptr, char *propname, int expand, int slider);
574 void uiItemFullR(uiLayout *layout, char *name, int icon, struct PointerRNA *ptr, struct PropertyRNA *prop, int index, int value, int expand, int slider);
575 void uiItemEnumR(uiLayout *layout, char *name, int icon, struct PointerRNA *ptr, char *propname, int value);
576 void uiItemsEnumR(uiLayout *layout, struct PointerRNA *ptr, char *propname);
577
578 void uiItemL(uiLayout *layout, char *name, int icon); /* label */
579 void uiItemM(uiLayout *layout, struct bContext *C, char *name, int icon, char *menuname); /* menu */
580 void uiItemV(uiLayout *layout, char *name, int icon, int argval); /* value */
581 void uiItemS(uiLayout *layout); /* separator */
582
583 void uiItemMenuF(uiLayout *layout, char *name, int icon, uiMenuCreateFunc func);
584 void uiItemMenuEnumO(uiLayout *layout, char *name, int icon, char *opname, char *propname);
585 void uiItemMenuEnumR(uiLayout *layout, char *name, int icon, struct PointerRNA *ptr, char *propname);
586
587 /* Animation */
588
589 void uiAnimContextProperty(const struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA **prop, int *index);
590
591 /* Styled text draw */
592 void uiStyleFontSet(struct uiFontStyle *fs);
593 void uiStyleFontDraw(struct uiFontStyle *fs, struct rcti *rect, char *str);
594
595 int UI_GetStringWidth(char *str); // XXX temp
596 void UI_DrawString(float x, float y, char *str); // XXX temp
597
598 #endif /*  UI_INTERFACE_H */
599