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