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