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