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