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