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