doxygen: editor entry
[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
70 typedef struct uiBut uiBut;
71 typedef struct uiBlock uiBlock;
72 typedef struct uiPopupBlockHandle uiPopupBlockHandle;
73 typedef struct uiLayout uiLayout;
74
75 /* Defines */
76
77 /* uiBlock->dt */
78 #define UI_EMBOSS               0       /* use widget style for drawing */
79 #define UI_EMBOSSN              1       /* Nothing, only icon and/or text */
80 #define UI_EMBOSSP              2       /* Pulldown menu style */
81 #define UI_EMBOSST              3       /* Table */
82
83 /* uiBlock->direction */
84 #define UI_DIRECTION    (UI_TOP|UI_DOWN|UI_LEFT|UI_RIGHT)
85 #define UI_TOP          1
86 #define UI_DOWN         2
87 #define UI_LEFT         4
88 #define UI_RIGHT        8
89
90 #define UI_CENTER               16
91 #define UI_SHIFT_FLIPPED        32
92
93 /* uiBlock->autofill (not yet used) */
94 // #define UI_BLOCK_COLLUMNS    1
95 // #define UI_BLOCK_ROWS                2
96
97 /* uiBlock->flag (controls) */
98 #define UI_BLOCK_LOOP                   1
99 #define UI_BLOCK_REDRAW                 2
100 #define UI_BLOCK_RET_1                  4               /* XXX 2.5 not implemented */
101 #define UI_BLOCK_NUMSELECT              8
102 /*#define UI_BLOCK_ENTER_OK             16*/ /*UNUSED*/
103 /*#define UI_BLOCK_NOSHADOW             32*/ /*UNUSED*/
104 /*#define UI_BLOCK_UNUSED                       64*/ /*UNUSED*/
105 #define UI_BLOCK_MOVEMOUSE_QUIT 128
106 #define UI_BLOCK_KEEP_OPEN              256
107 #define UI_BLOCK_POPUP                  512
108 #define UI_BLOCK_OUT_1                  1024
109 #define UI_BLOCK_NO_FLIP                2048
110 #define UI_BLOCK_POPUP_MEMORY   4096
111
112 /* uiPopupBlockHandle->menuretval */
113 #define UI_RETURN_CANCEL        1       /* cancel all menus cascading */
114 #define UI_RETURN_OK        2       /* choice made */
115 #define UI_RETURN_OUT       4       /* left the menu */
116 #define UI_RETURN_UPDATE    8       /* update the button that opened */
117
118         /* block->flag bits 12-15 are identical to but->flag bits */
119
120 /* panel controls */
121 #define UI_PNL_SOLID    2
122 #define UI_PNL_CLOSE    32
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            (UI_BUT_ALIGN_TOP|UI_BUT_ALIGN_LEFT|UI_BUT_ALIGN_RIGHT|UI_BUT_ALIGN_DOWN)
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_COLOR_LOCK       (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_REDALERT         (1<<23)
150 #define UI_BUT_INACTIVE         (1<<24)
151 #define UI_BUT_LAST_ACTIVE      (1<<25)
152 #define UI_BUT_UNDO                     (1<<26)
153 #define UI_BUT_IMMEDIATE        (1<<27)
154 #define UI_BUT_NO_TOOLTIP       (1<<28)
155 #define UI_BUT_NO_UTF8          (1<<29)
156
157 #define UI_BUT_VEC_SIZE_LOCK (1<<30) /* used to flag if color hsv-circle should keep luminance */
158 #define UI_BUT_COLOR_CUBIC      (1<<31) /* cubic saturation for the color wheel */
159
160 #define UI_PANEL_WIDTH                  340
161 #define UI_COMPACT_PANEL_WIDTH  160
162
163 /* Button types, bits stored in 1 value... and a short even!
164 - bits 0-4:  bitnr (0-31)
165 - bits 5-7:  pointer type
166 - bit  8:    for 'bit'
167 - bit  9-15: button type (now 6 bits, 64 types)
168 */
169
170 #define CHA     32
171 #define SHO     64
172 #define INT     96
173 #define FLO     128
174 /*#define FUN   192*/ /*UNUSED*/
175 #define BIT     256
176
177 #define BUTPOIN (128+64+32)
178
179 #define BUT     (1<<9)
180 #define ROW     (2<<9)
181 #define TOG     (3<<9)
182 #define SLI     (4<<9)
183 #define NUM     (5<<9)
184 #define TEX     (6<<9)
185 #define TOG3    (7<<9)
186 #define TOGR    (8<<9)
187 #define TOGN    (9<<9)
188 #define LABEL   (10<<9)
189 #define MENU    (11<<9)
190 #define ICONROW (12<<9)
191 #define ICONTOG (13<<9)
192 #define NUMSLI  (14<<9)
193 #define COL             (15<<9)
194 #define IDPOIN  (16<<9)
195 #define HSVSLI  (17<<9)
196 #define SCROLL  (18<<9)
197 #define BLOCK   (19<<9)
198 #define BUTM    (20<<9)
199 #define SEPR    (21<<9)
200 #define LINK    (22<<9)
201 #define INLINK  (23<<9)
202 #define KEYEVT  (24<<9)
203 #define ICONTEXTROW (25<<9)
204 #define HSVCUBE         (26<<9)
205 #define PULLDOWN        (27<<9)
206 #define ROUNDBOX        (28<<9)
207 #define CHARTAB         (29<<9)
208 #define BUT_COLORBAND (30<<9)
209 #define BUT_NORMAL      (31<<9)
210 #define BUT_CURVE       (32<<9)
211 #define BUT_TOGDUAL (33<<9)
212 #define ICONTOGN        (34<<9)
213 #define FTPREVIEW       (35<<9)
214 #define NUMABS          (36<<9)
215 #define TOGBUT          (37<<9)
216 #define OPTION          (38<<9)
217 #define OPTIONN         (39<<9)
218                 /* buttons with value >= SEARCH_MENU don't get undo pushes */
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 void uiButSetFocusOnEnter       (struct wmWindow *win, uiBut *but);
556
557 /* Autocomplete
558  *
559  * Tab complete helper functions, for use in uiButCompleteFunc callbacks.
560  * Call begin once, then multiple times do_name with all possibilities,
561  * and finally end to finish and get the completed name. */
562
563 typedef struct AutoComplete AutoComplete;
564
565 AutoComplete *autocomplete_begin(const char *startname, int maxlen);
566 void autocomplete_do_name(AutoComplete *autocpl, const char *name);
567 void autocomplete_end(AutoComplete *autocpl, char *autoname);
568
569 /* Panels
570  *
571  * Functions for creating, freeing and drawing panels. The API here
572  * could use a good cleanup, though how they will function in 2.5 is
573  * not clear yet so we postpone that. */
574
575 void uiBeginPanels(const struct bContext *C, struct ARegion *ar);
576 void uiEndPanels(const struct bContext *C, struct ARegion *ar);
577
578 struct Panel *uiBeginPanel(struct ScrArea *sa, struct ARegion *ar, uiBlock *block, struct PanelType *pt, int *open);
579 void uiEndPanel(uiBlock *block, int width, int height);
580
581 /* Handlers
582  *
583  * Handlers that can be registered in regions, areas and windows for
584  * handling WM events. Mostly this is done automatic by modules such
585  * as screen/ if ED_KEYMAP_UI is set, or internally in popup functions. */
586
587 void UI_add_region_handlers(struct ListBase *handlers);
588 void UI_add_area_handlers(struct ListBase *handlers);
589 void UI_add_popup_handlers(struct bContext *C, struct ListBase *handlers, uiPopupBlockHandle *popup);
590 void UI_remove_popup_handlers(struct ListBase *handlers, uiPopupBlockHandle *popup);
591
592 /* Module
593  *
594  * init and exit should be called before using this module. init_userdef must
595  * be used to reinitialize some internal state if user preferences change. */
596
597 void UI_init(void);
598 void UI_init_userdef(void);
599 void UI_exit(void);
600
601 /* Layout
602  *
603  * More automated layout of buttons. Has three levels:
604  * - Layout: contains a number templates, within a bounded width or height.
605  * - Template: predefined layouts for buttons with a number of slots, each
606  *   slot can contain multiple items.
607  * - Item: item to put in a template slot, being either an RNA property,
608  *   operator, label or menu. Also regular buttons can be used when setting
609  *   uiBlockCurLayout. */
610
611 /* layout */
612 #define UI_LAYOUT_HORIZONTAL    0
613 #define UI_LAYOUT_VERTICAL              1
614
615 #define UI_LAYOUT_PANEL                 0
616 #define UI_LAYOUT_HEADER                1
617 #define UI_LAYOUT_MENU                  2
618 #define UI_LAYOUT_TOOLBAR               3
619  
620 #define UI_UNIT_X                               20
621 #define UI_UNIT_Y                               20
622
623 #define UI_LAYOUT_ALIGN_EXPAND  0
624 #define UI_LAYOUT_ALIGN_LEFT    1
625 #define UI_LAYOUT_ALIGN_CENTER  2
626 #define UI_LAYOUT_ALIGN_RIGHT   3
627
628 #define UI_ITEM_O_RETURN_PROPS  1
629 #define UI_ITEM_R_EXPAND                2
630 #define UI_ITEM_R_SLIDER                4
631 #define UI_ITEM_R_TOGGLE                8
632 #define UI_ITEM_R_ICON_ONLY             16
633 #define UI_ITEM_R_EVENT                 32
634 #define UI_ITEM_R_FULL_EVENT    64
635 #define UI_ITEM_R_NO_BG                 128
636 #define UI_ITEM_R_IMMEDIATE             256
637
638 /* uiLayoutOperatorButs flags */
639 #define UI_LAYOUT_OP_SHOW_TITLE 1
640 #define UI_LAYOUT_OP_SHOW_EMPTY 2
641
642 /* for more readable function names */
643 #define ICON_NULL 0
644
645 uiLayout *uiBlockLayout(uiBlock *block, int dir, int type, int x, int y, int size, int em, struct uiStyle *style);
646 void uiBlockSetCurLayout(uiBlock *block, uiLayout *layout);
647 void uiBlockLayoutResolve(uiBlock *block, int *x, int *y);
648
649 uiBlock *uiLayoutGetBlock(uiLayout *layout);
650
651 void uiLayoutSetFunc(uiLayout *layout, uiMenuHandleFunc handlefunc, void *argv);
652 void uiLayoutSetContextPointer(uiLayout *layout, const char *name, struct PointerRNA *ptr);
653 const char *uiLayoutIntrospect(uiLayout *layout); // XXX - testing
654 void uiLayoutOperatorButs(const struct bContext *C, struct uiLayout *layout, struct wmOperator *op, int (*check_prop)(struct PropertyRNA *), const char label_align, const short flag);
655
656 void uiLayoutSetOperatorContext(uiLayout *layout, int opcontext);
657 void uiLayoutSetActive(uiLayout *layout, int active);
658 void uiLayoutSetEnabled(uiLayout *layout, int enabled);
659 void uiLayoutSetRedAlert(uiLayout *layout, int redalert);
660 void uiLayoutSetAlignment(uiLayout *layout, int alignment);
661 void uiLayoutSetKeepAspect(uiLayout *layout, int keepaspect);
662 void uiLayoutSetScaleX(uiLayout *layout, float scale);
663 void uiLayoutSetScaleY(uiLayout *layout, float scale);
664
665 int uiLayoutGetOperatorContext(uiLayout *layout);
666 int uiLayoutGetActive(uiLayout *layout);
667 int uiLayoutGetEnabled(uiLayout *layout);
668 int uiLayoutGetRedAlert(uiLayout *layout);
669 int uiLayoutGetAlignment(uiLayout *layout);
670 int uiLayoutGetKeepAspect(uiLayout *layout);
671 int uiLayoutGetWidth(uiLayout *layout);
672 float uiLayoutGetScaleX(uiLayout *layout);
673 float uiLayoutGetScaleY(uiLayout *layout);
674
675 /* layout specifiers */
676 uiLayout *uiLayoutRow(uiLayout *layout, int align);
677 uiLayout *uiLayoutColumn(uiLayout *layout, int align);
678 uiLayout *uiLayoutColumnFlow(uiLayout *layout, int number, int align);
679 uiLayout *uiLayoutBox(uiLayout *layout);
680 uiLayout *uiLayoutListBox(uiLayout *layout, struct PointerRNA *ptr, struct PropertyRNA *prop,
681         struct PointerRNA *actptr, struct PropertyRNA *actprop);
682 uiLayout *uiLayoutAbsolute(uiLayout *layout, int align);
683 uiLayout *uiLayoutSplit(uiLayout *layout, float percentage, int align);
684 uiLayout *uiLayoutOverlap(uiLayout *layout);
685
686 uiBlock *uiLayoutAbsoluteBlock(uiLayout *layout);
687
688 /* templates */
689 void uiTemplateHeader(uiLayout *layout, struct bContext *C, int menus);
690 void uiTemplateDopeSheetFilter(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr);
691 void uiTemplateID(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname,
692         const char *newop, const char *openop, const char *unlinkop);
693 void uiTemplateIDBrowse(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname,
694                                   const char *newop, const char *openop, const char *unlinkop);
695 void uiTemplateIDPreview(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname,
696         const char *newop, const char *openop, const char *unlinkop, int rows, int cols);
697 void uiTemplateAnyID(uiLayout *layout, struct PointerRNA *ptr, const char *propname, 
698         const char *proptypename, const char *text);
699 void uiTemplatePathBuilder(uiLayout *layout, struct PointerRNA *ptr, const char *propname, 
700         struct PointerRNA *root_ptr, const char *text);
701 uiLayout *uiTemplateModifier(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr);
702 uiLayout *uiTemplateConstraint(uiLayout *layout, struct PointerRNA *ptr);
703 void uiTemplatePreview(uiLayout *layout, struct ID *id, int show_buttons, struct ID *parent, struct MTex *slot);
704 void uiTemplateColorRamp(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int expand);
705 void uiTemplateHistogram(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
706 void uiTemplateWaveform(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
707 void uiTemplateVectorscope(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
708 void uiTemplateCurveMapping(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int type, int levels, int brush);
709 void uiTemplateColorWheel(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int value_slider, int lock, int lock_luminosity, int cubic);
710 void uiTemplateLayers(uiLayout *layout, struct PointerRNA *ptr, const char *propname,
711                           PointerRNA *used_ptr, const char *used_propname, int active_layer);
712 void uiTemplateImage(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname, struct PointerRNA *userptr, int compact);
713 void uiTemplateImageLayers(uiLayout *layout, struct bContext *C, struct Image *ima, struct ImageUser *iuser);
714 void uiTemplateRunningJobs(uiLayout *layout, struct bContext *C);
715 void uiTemplateOperatorSearch(uiLayout *layout);
716 void uiTemplateHeader3D(uiLayout *layout, struct bContext *C);
717 void uiTemplateTextureImage(uiLayout *layout, struct bContext *C, struct Tex *tex);
718 void uiTemplateReportsBanner(uiLayout *layout, struct bContext *C);
719
720 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);
721
722 /* items */
723 void uiItemO(uiLayout *layout, const char *name, int icon, const char *opname);
724 void uiItemEnumO(uiLayout *layout, const char *opname, const char *name, int icon, const char *propname, int value);
725 void uiItemEnumO_string(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, const char *value);
726 void uiItemsEnumO(uiLayout *layout, const char *opname, const char *propname);
727 void uiItemBooleanO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, int value);
728 void uiItemIntO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, int value);
729 void uiItemFloatO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, float value);
730 void uiItemStringO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, const char *value);
731 PointerRNA uiItemFullO(uiLayout *layout, const char *idname, const char *name, int icon, struct IDProperty *properties, int context, int flag);
732
733 void uiItemR(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int flag, const char *name, int icon);
734 void uiItemFullR(uiLayout *layout, struct PointerRNA *ptr, struct PropertyRNA *prop, int index, int value, int flag, const char *name, int icon);
735 void uiItemEnumR(uiLayout *layout, const char *name, int icon, struct PointerRNA *ptr, const char *propname, int value);
736 void uiItemEnumR_string(uiLayout *layout, struct PointerRNA *ptr, const char *propname, const char *value, const char *name, int icon);
737 void uiItemsEnumR(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
738 void uiItemPointerR(uiLayout *layout, struct PointerRNA *ptr, const char *propname, struct PointerRNA *searchptr, const char *searchpropname, const char *name, int icon);
739 void uiItemsFullEnumO(uiLayout *layout, const char *opname, const char *propname, struct IDProperty *properties, int context, int flag);
740
741 void uiItemL(uiLayout *layout, const char *name, int icon); /* label */
742 void uiItemLDrag(uiLayout *layout, struct PointerRNA *ptr, const char *name, int icon); /* label icon for dragging */
743 void uiItemM(uiLayout *layout, struct bContext *C, const char *menuname, const char *name, int icon); /* menu */
744 void uiItemV(uiLayout *layout, const char *name, int icon, int argval); /* value */
745 void uiItemS(uiLayout *layout); /* separator */
746
747 void uiItemMenuF(uiLayout *layout, const char *name, int icon, uiMenuCreateFunc func, void *arg);
748 void uiItemMenuEnumO(uiLayout *layout, const char *opname, const char *propname, const char *name, int icon);
749 void uiItemMenuEnumR(uiLayout *layout, struct PointerRNA *ptr, const char *propname, const char *name, int icon);
750
751 /* UI Operators */
752 void UI_buttons_operatortypes(void);
753
754 /* Helpers for Operators */
755 void uiContextActiveProperty(const struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA **prop, int *index);
756 void uiContextAnimUpdate(const struct bContext *C);
757 void uiFileBrowseContextProperty(const struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA **prop);
758 void uiIDContextProperty(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA **prop);
759
760 /* Styled text draw */
761 void uiStyleFontSet(struct uiFontStyle *fs);
762 void uiStyleFontDrawExt(struct uiFontStyle *fs, struct rcti *rect, const char *str,
763         float *r_xofs, float *r_yofs);
764 void uiStyleFontDraw(struct uiFontStyle *fs, struct rcti *rect, const char *str);
765 void uiStyleFontDrawRotated(struct uiFontStyle *fs, struct rcti *rect, const char *str);
766
767 int UI_GetStringWidth(const char *str); // XXX temp
768 void UI_DrawString(float x, float y, const char *str); // XXX temp
769 void UI_DrawTriIcon(float x, float y, char dir);
770
771 /* linker workaround ack! */
772 void UI_template_fix_linking(void);
773
774 #endif /*  UI_INTERFACE_H */
775