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