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