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