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