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