UI:
[blender-staging.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 /* Struct Declarations */
34
35 struct ID;
36 struct Main;
37 struct ListBase;
38 struct ARegion;
39 struct ScrArea;
40 struct wmWindow;
41 struct wmWindowManager;
42 struct wmOperator;
43 struct AutoComplete;
44 struct bContext;
45 struct Panel;
46 struct PanelType;
47 struct PointerRNA;
48 struct PropertyRNA;
49 struct ReportList;
50 struct rcti;
51 struct rctf;
52 struct uiStyle;
53 struct uiFontStyle;
54 struct ColorBand;
55 struct CurveMapping;
56
57 typedef struct uiBut uiBut;
58 typedef struct uiBlock uiBlock;
59 typedef struct uiPopupBlockHandle uiPopupBlockHandle;
60 typedef struct uiLayout uiLayout;
61
62 /* Defines */
63
64 /* uiBlock->dt */
65 #define UI_EMBOSS               0       /* use widget style for drawing */
66 #define UI_EMBOSSN              1       /* Nothing, only icon and/or text */
67 #define UI_EMBOSSP              2       /* Pulldown menu style */
68 #define UI_EMBOSST              3       /* Table */
69
70 /* uiBlock->direction */
71 #define UI_TOP          1
72 #define UI_DOWN         2
73 #define UI_LEFT         4
74 #define UI_RIGHT        8
75 #define UI_DIRECTION    15
76 #define UI_CENTER               16
77 #define UI_SHIFT_FLIPPED        32
78
79 /* uiBlock->autofill (not yet used) */
80 #define UI_BLOCK_COLLUMNS       1
81 #define UI_BLOCK_ROWS           2
82
83 /* uiBlock->flag (controls) */
84 #define UI_BLOCK_LOOP                   1
85 #define UI_BLOCK_REDRAW                 2
86 #define UI_BLOCK_RET_1                  4               /* XXX 2.5 not implemented */
87 #define UI_BLOCK_NUMSELECT              8
88 #define UI_BLOCK_ENTER_OK               16
89 #define UI_BLOCK_NOSHADOW               32
90 #define UI_BLOCK_UNUSED                 64
91 #define UI_BLOCK_MOVEMOUSE_QUIT 128
92 #define UI_BLOCK_KEEP_OPEN              256
93 #define UI_BLOCK_POPUP                  512
94
95 /* uiPopupBlockHandle->menuretval */
96 #define UI_RETURN_CANCEL        1       /* cancel all menus cascading */
97 #define UI_RETURN_OK        2       /* choice made */
98 #define UI_RETURN_OUT       4       /* left the menu */
99
100         /* block->flag bits 12-15 are identical to but->flag bits */
101
102 /* panel controls */
103 #define UI_PNL_TRANSP   1
104 #define UI_PNL_SOLID    2
105
106 #define UI_PNL_CLOSE    32
107 #define UI_PNL_STOW             64
108 #define UI_PNL_TO_MOUSE 128
109 #define UI_PNL_UNSTOW   256
110 #define UI_PNL_SCALE    512
111
112 /* warning the first 6 flags are internal */
113 /* but->flag */
114 #define UI_TEXT_LEFT    64
115 #define UI_ICON_LEFT    128
116 #define UI_ICON_SUBMENU 256
117         /* control for button type block */
118 #define UI_MAKE_TOP             512
119 #define UI_MAKE_DOWN    1024
120 #define UI_MAKE_LEFT    2048
121 #define UI_MAKE_RIGHT   4096
122
123         /* button align flag, for drawing groups together */
124 #define UI_BUT_ALIGN            (15<<14)
125 #define UI_BUT_ALIGN_TOP        (1<<14)
126 #define UI_BUT_ALIGN_LEFT       (1<<15)
127 #define UI_BUT_ALIGN_RIGHT      (1<<16)
128 #define UI_BUT_ALIGN_DOWN       (1<<17)
129
130 #define UI_BUT_DISABLED         (1<<18)
131 #define UI_BUT_UNUSED           (1<<19)
132 #define UI_BUT_ANIMATED         (1<<20)
133 #define UI_BUT_ANIMATED_KEY     (1<<21)
134 #define UI_BUT_DRIVEN           (1<<22)
135 #define UI_BUT_INACTIVE         (1<<23)
136
137 #define UI_PANEL_WIDTH                  340
138 #define UI_COMPACT_PANEL_WIDTH  160
139
140 /* Button types, bits stored in 1 value... and a short even!
141 - bits 0-4:  bitnr (0-31)
142 - bits 5-7:  pointer type
143 - bit  8:    for 'bit'
144 - bit  9-15: button type (now 6 bits, 64 types)
145 */
146
147 #define CHA     32
148 #define SHO     64
149 #define INT     96
150 #define FLO     128
151 #define FUN     192
152 #define BIT     256
153
154 #define BUTPOIN (128+64+32)
155
156 #define BUT     (1<<9)
157 #define ROW     (2<<9)
158 #define TOG     (3<<9)
159 #define SLI     (4<<9)
160 #define NUM     (5<<9)
161 #define TEX     (6<<9)
162 #define TOG3    (7<<9)
163 #define TOGR    (8<<9)
164 #define TOGN    (9<<9)
165 #define LABEL   (10<<9)
166 #define MENU    (11<<9)
167 #define ICONROW (12<<9)
168 #define ICONTOG (13<<9)
169 #define NUMSLI  (14<<9)
170 #define COL             (15<<9)
171 #define IDPOIN  (16<<9)
172 #define HSVSLI  (17<<9)
173 #define SCROLL  (18<<9)
174 #define BLOCK   (19<<9)
175 #define BUTM    (20<<9)
176 #define SEPR    (21<<9)
177 #define LINK    (22<<9)
178 #define INLINK  (23<<9)
179 #define KEYEVT  (24<<9)
180 #define ICONTEXTROW (25<<9)
181 #define HSVCUBE         (26<<9)
182 #define PULLDOWN        (27<<9)
183 #define ROUNDBOX        (28<<9)
184 #define CHARTAB         (29<<9)
185 #define BUT_COLORBAND (30<<9)
186 #define BUT_NORMAL      (31<<9)
187 #define BUT_CURVE       (32<<9)
188 #define BUT_TOGDUAL (33<<9)
189 #define ICONTOGN        (34<<9)
190 #define FTPREVIEW       (35<<9)
191 #define NUMABS          (36<<9)
192 #define TOGBUT          (37<<9)
193 #define OPTION          (38<<9)
194 #define OPTIONN         (39<<9)
195 #define SEARCH_MENU     (40<<9)
196 #define BUTTYPE (63<<9)
197
198 /* Drawing
199  *
200  * Functions to draw various shapes, taking theme settings into account.
201  * Used for code that draws its own UI style elements. */
202
203 void uiEmboss(float x1, float y1, float x2, float y2, int sel);
204 void uiRoundBox(float minx, float miny, float maxx, float maxy, float rad);
205 void uiSetRoundBox(int type);
206 int uiGetRoundBox(void);
207 void uiRoundRect(float minx, float miny, float maxx, float maxy, float rad);
208 void uiDrawMenuBox(float minx, float miny, float maxx, float maxy, short flag, short direction);
209 void uiDrawBoxShadow(unsigned char alpha, float minx, float miny, float maxx, float maxy);
210
211 /* Menu Callbacks */
212
213 typedef void (*uiMenuCreateFunc)(struct bContext *C, struct uiLayout *layout, void *arg1);
214 typedef void (*uiMenuHandleFunc)(struct bContext *C, void *arg, int event);
215
216 /* Popup Menus
217  *
218  * Functions used to create popup menus. For more extended menus the
219  * uiPupMenuBegin/End functions can be used to define own items with
220  * the uiItem functions inbetween. If it is a simple confirmation menu
221  * or similar, popups can be created with a single function call. */
222
223 typedef struct uiPopupMenu uiPopupMenu;
224
225 uiPopupMenu *uiPupMenuBegin(struct bContext *C, const char *title, int icon);
226 void uiPupMenuEnd(struct bContext *C, struct uiPopupMenu *head);
227 struct uiLayout *uiPupMenuLayout(uiPopupMenu *head);
228
229 void uiPupMenuOkee(struct bContext *C, char *opname, char *str, ...);
230 void uiPupMenuSaveOver(struct bContext *C, struct wmOperator *op, char *filename);
231 void uiPupMenuNotice(struct bContext *C, char *str, ...);
232 void uiPupMenuError(struct bContext *C, char *str, ...);
233 void uiPupMenuReports(struct bContext *C, struct ReportList *reports);
234
235 void uiPupMenuSetActive(int val);
236
237 /* Popup Blocks
238  *
239  * Functions used to create popup blocks. These are like popup menus
240  * but allow using all button types and creating an own layout. */
241
242 typedef uiBlock* (*uiBlockCreateFunc)(struct bContext *C, struct ARegion *ar, void *arg1);
243
244 void uiPupBlock(struct bContext *C, uiBlockCreateFunc func, void *arg);
245 void uiPupBlockO(struct bContext *C, uiBlockCreateFunc func, void *arg, char *opname, int opcontext);
246 void uiPupBlockOperator(struct bContext *C, uiBlockCreateFunc func, struct wmOperator *op, int opcontext);
247
248 /* Blocks
249  *
250  * Functions for creating, drawing and freeing blocks. A Block is a
251  * container of buttons and used for various purposes.
252  * 
253  * Begin/Define Buttons/End/Draw is the typical order in which these
254  * function should be called, though for popup blocks Draw is left out.
255  * Freeing blocks is done by the screen/ module automatically.
256  *
257  * */
258
259 uiBlock *uiBeginBlock(const struct bContext *C, struct ARegion *region, const char *name, short dt);
260 void uiEndBlock(const struct bContext *C, uiBlock *block);
261 void uiDrawBlock(const struct bContext *C, struct uiBlock *block);
262
263 uiBlock *uiGetBlock(char *name, struct ARegion *ar);
264
265 void uiBlockSetEmboss(uiBlock *block, short dt);
266
267 void uiFreeBlock(const struct bContext *C, uiBlock *block);
268 void uiFreeBlocks(const struct bContext *C, struct ListBase *lb);
269 void uiFreeInactiveBlocks(const struct bContext *C, struct ListBase *lb);
270
271 void uiBlockSetRegion(uiBlock *block, struct ARegion *region);
272
273 void uiBlockSetButLock(uiBlock *block, int val, char *lockstr);
274 void uiBlockClearButLock(uiBlock *block);
275
276 /* automatic aligning, horiz or verical */
277 void uiBlockBeginAlign(uiBlock *block);
278 void uiBlockEndAlign(uiBlock *block);
279
280 void uiBoundsBlock(struct uiBlock *block, int addval);
281 void uiTextBoundsBlock(uiBlock *block, int addval);
282 void uiPopupBoundsBlock(uiBlock *block, int addval, int mx, int my);
283 void uiMenuPopupBoundsBlock(uiBlock *block, int addvall, int mx, int my);
284
285 int             uiBlocksGetYMin         (struct ListBase *lb);
286
287 void    uiBlockSetDirection     (uiBlock *block, int direction);
288 void    uiBlockFlipOrder        (uiBlock *block);
289 void    uiBlockSetFlag          (uiBlock *block, int flag);
290 void    uiBlockClearFlag        (uiBlock *block, int flag);
291 void    uiBlockSetXOfs          (uiBlock *block, int xofs);
292
293 int             uiButGetRetVal          (uiBut *but);
294
295 void    uiButSetFlag            (uiBut *but, int flag);
296 void    uiButClearFlag          (uiBut *but, int flag);
297
298 /* Buttons
299  *
300  * Functions to define various types of buttons in a block. Postfixes:
301  * - F: float
302  * - I: int
303  * - S: short
304  * - C: char
305  * - R: RNA
306  * - O: operator */
307
308 uiBut *uiDefBut(uiBlock *block, 
309                                            int type, int retval, char *str, 
310                                            short x1, short y1, 
311                                            short x2, short y2, 
312                                            void *poin, 
313                                            float min, float max, 
314                                            float a1, float a2,  char *tip);
315 uiBut *uiDefButF(uiBlock *block, int type, int retval, char *str, short x1, short y1, short x2, short y2, float *poin, float min, float max, float a1, float a2,  char *tip);
316 uiBut *uiDefButBitF(uiBlock *block, int type, int bit, int retval, char *str, short x1, short y1, short x2, short y2, float *poin, float min, float max, float a1, float a2,  char *tip);
317 uiBut *uiDefButI(uiBlock *block, int type, int retval, char *str, short x1, short y1, short x2, short y2, int *poin, float min, float max, float a1, float a2,  char *tip);
318 uiBut *uiDefButBitI(uiBlock *block, int type, int bit, int retval, char *str, short x1, short y1, short x2, short y2, int *poin, float min, float max, float a1, float a2,  char *tip);
319 uiBut *uiDefButS(uiBlock *block, int type, int retval, char *str, short x1, short y1, short x2, short y2, short *poin, float min, float max, float a1, float a2,  char *tip);
320 uiBut *uiDefButBitS(uiBlock *block, int type, int bit, int retval, char *str, short x1, short y1, short x2, short y2, short *poin, float min, float max, float a1, float a2,  char *tip);
321 uiBut *uiDefButC(uiBlock *block, int type, int retval, char *str, short x1, short y1, short x2, short y2, char *poin, float min, float max, float a1, float a2,  char *tip);
322 uiBut *uiDefButBitC(uiBlock *block, int type, int bit, int retval, char *str, short x1, short y1, short x2, short y2, char *poin, float min, float max, float a1, float a2,  char *tip);
323 uiBut *uiDefButR(uiBlock *block, int type, int retval, char *str, short x1, short y1, short x2, short y2, struct PointerRNA *ptr, const char *propname, int index, float min, float max, float a1, float a2,  char *tip);
324 uiBut *uiDefButO(uiBlock *block, int type, char *opname, int opcontext, char *str, short x1, short y1, short x2, short y2, char *tip);
325
326 uiBut *uiDefIconBut(uiBlock *block, 
327                                            int type, int retval, int icon, 
328                                            short x1, short y1, 
329                                            short x2, short y2, 
330                                            void *poin, 
331                                            float min, float max, 
332                                            float a1, float a2,  char *tip);
333 uiBut *uiDefIconButF(uiBlock *block, int type, int retval, int icon, short x1, short y1, short x2, short y2, float *poin, float min, float max, float a1, float a2,  char *tip);
334 uiBut *uiDefIconButBitF(uiBlock *block, int type, int bit, int retval, int icon, short x1, short y1, short x2, short y2, float *poin, float min, float max, float a1, float a2,  char *tip);
335 uiBut *uiDefIconButI(uiBlock *block, int type, int retval, int icon, short x1, short y1, short x2, short y2, int *poin, float min, float max, float a1, float a2,  char *tip);
336 uiBut *uiDefIconButBitI(uiBlock *block, int type, int bit, int retval, int icon, short x1, short y1, short x2, short y2, int *poin, float min, float max, float a1, float a2,  char *tip);
337 uiBut *uiDefIconButS(uiBlock *block, int type, int retval, int icon, short x1, short y1, short x2, short y2, short *poin, float min, float max, float a1, float a2,  char *tip);
338 uiBut *uiDefIconButBitS(uiBlock *block, int type, int bit, int retval, int icon, short x1, short y1, short x2, short y2, short *poin, float min, float max, float a1, float a2,  char *tip);
339 uiBut *uiDefIconButC(uiBlock *block, int type, int retval, int icon, short x1, short y1, short x2, short y2, char *poin, float min, float max, float a1, float a2,  char *tip);
340 uiBut *uiDefIconButBitC(uiBlock *block, int type, int bit, int retval, int icon, short x1, short y1, short x2, short y2, char *poin, float min, float max, float a1, float a2,  char *tip);
341 uiBut *uiDefIconButR(uiBlock *block, int type, int retval, int icon, short x1, short y1, short x2, short y2, struct PointerRNA *ptr, const char *propname, int index, float min, float max, float a1, float a2,  char *tip);
342 uiBut *uiDefIconButO(uiBlock *block, int type, char *opname, int opcontext, int icon, short x1, short y1, short x2, short y2, char *tip);
343
344 uiBut *uiDefIconTextBut(uiBlock *block,
345                                                 int type, int retval, int icon, char *str, 
346                                                 short x1, short y1,
347                                                 short x2, short y2,
348                                                 void *poin,
349                                                 float min, float max,
350                                                 float a1, float a2,  char *tip);
351 uiBut *uiDefIconTextButF(uiBlock *block, int type, int retval, int icon, char *str, short x1, short y1, short x2, short y2, float *poin, float min, float max, float a1, float a2,  char *tip);
352 uiBut *uiDefIconTextButBitF(uiBlock *block, int type, int bit, int retval, int icon, char *str, short x1, short y1, short x2, short y2, float *poin, float min, float max, float a1, float a2,  char *tip);
353 uiBut *uiDefIconTextButI(uiBlock *block, int type, int retval, int icon, char *str, short x1, short y1, short x2, short y2, int *poin, float min, float max, float a1, float a2,  char *tip);
354 uiBut *uiDefIconTextButBitI(uiBlock *block, int type, int bit, int retval, int icon, char *str, short x1, short y1, short x2, short y2, int *poin, float min, float max, float a1, float a2,  char *tip);
355 uiBut *uiDefIconTextButS(uiBlock *block, int type, int retval, int icon, char *str, short x1, short y1, short x2, short y2, short *poin, float min, float max, float a1, float a2,  char *tip);
356 uiBut *uiDefIconTextButBitS(uiBlock *block, int type, int bit, int retval, int icon, char *str, short x1, short y1, short x2, short y2, short *poin, float min, float max, float a1, float a2,  char *tip);
357 uiBut *uiDefIconTextButC(uiBlock *block, int type, int retval, int icon, char *str, short x1, short y1, short x2, short y2, char *poin, float min, float max, float a1, float a2,  char *tip);
358 uiBut *uiDefIconTextButBitC(uiBlock *block, int type, int bit, int retval, int icon, char *str, short x1, short y1, short x2, short y2, char *poin, float min, float max, float a1, float a2,  char *tip);
359 uiBut *uiDefIconTextButR(uiBlock *block, int type, int retval, int icon, char *str, short x1, short y1, short x2, short y2, struct PointerRNA *ptr, const char *propname, int index, float min, float max, float a1, float a2,  char *tip);
360 uiBut *uiDefIconTextButO(uiBlock *block, int type, char *opname, int opcontext, int icon, char *str, short x1, short y1, short x2, short y2, char *tip);
361
362 /* for passing inputs to ButO buttons */
363 struct PointerRNA *uiButGetOperatorPtrRNA(uiBut *but);
364
365 /* Special Buttons
366  *
367  * Butons with a more specific purpose:
368  * - IDPoinBut: for creating buttons that work on a pointer to an ID block.
369  * - MenuBut: buttons that popup a menu (in headers usually).
370  * - PulldownBut: like MenuBut, but creating a uiBlock (for compatibility).
371  * - BlockBut: buttons that popup a block with more buttons.
372  * - KeyevtBut: buttons that can be used to turn key events into values.
373  * - PickerButtons: buttons like the color picker (for code sharing).
374  * - AutoButR: RNA property button with type automatically defined. */
375
376 #define UI_ID_RENAME            1
377 #define UI_ID_BROWSE            2
378 #define UI_ID_ADD_NEW           4
379 #define UI_ID_OPEN                      8
380 #define UI_ID_ALONE                     16
381 #define UI_ID_DELETE            32
382 #define UI_ID_LOCAL                     64
383 #define UI_ID_AUTO_NAME         128
384 #define UI_ID_FAKE_USER         256
385 #define UI_ID_PIN                       512
386 #define UI_ID_BROWSE_RENDER     1024
387 #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)
388
389 typedef void (*uiIDPoinFuncFP)(struct bContext *C, char *str, struct ID **idpp);
390 typedef void (*uiIDPoinFunc)(struct bContext *C, struct ID *id, int event);
391
392 uiBut *uiDefIDPoinBut(uiBlock *block, uiIDPoinFuncFP func, short blocktype, int retval, char *str,
393                                                 short x1, short y1, short x2, short y2, void *idpp, char *tip);
394 int uiDefIDPoinButs(uiBlock *block, struct Main *main, struct ID *parid, struct ID *id, int id_code, short *pin_p, int x, int y, uiIDPoinFunc func, int events);
395
396 uiBut *uiDefPulldownBut(uiBlock *block, uiBlockCreateFunc func, void *arg, char *str, short x1, short y1, short x2, short y2, char *tip);
397 uiBut *uiDefMenuBut(uiBlock *block, uiMenuCreateFunc func, void *arg, char *str, short x1, short y1, short x2, short y2, char *tip);
398 uiBut *uiDefIconTextMenuBut(uiBlock *block, uiMenuCreateFunc func, void *arg, int icon, char *str, short x1, short y1, short x2, short y2, char *tip);
399
400 uiBut *uiDefBlockBut(uiBlock *block, uiBlockCreateFunc func, void *func_arg1, char *str, short x1, short y1, short x2, short y2, char *tip);
401 uiBut *uiDefIconBlockBut(uiBlock *block, uiBlockCreateFunc func, void *arg, int retval, int icon, short x1, short y1, short x2, short y2, char *tip);
402 uiBut *uiDefIconTextBlockBut(uiBlock *block, uiBlockCreateFunc func, void *arg, int icon, char *str, short x1, short y1, short x2, short y2, char *tip);
403
404 void uiDefKeyevtButS(uiBlock *block, int retval, char *str, short x1, short y1, short x2, short y2, short *spoin, char *tip);
405
406 uiBut *uiDefSearchBut(uiBlock *block, void *arg, int retval, int icon, int maxlen, short x1, short y1, short x2, short y2, char *tip);
407
408 void uiBlockPickerButtons(struct uiBlock *block, float *col, float *hsv, float *old, char *hexcol, char mode, short retval);
409 void uiBlockColorbandButtons(struct uiBlock *block, struct ColorBand *coba, struct rctf *butr, int event);
410
411 uiBut *uiDefAutoButR(uiBlock *block, struct PointerRNA *ptr, struct PropertyRNA *prop, int index, char *name, int icon, int x1, int y1, int x2, int y2);
412 void uiDefAutoButsRNA(const struct bContext *C, uiLayout *layout, struct PointerRNA *ptr);
413
414 /* Links
415  *
416  * Game engine logic brick links. Non-functional currently in 2.5,
417  * code to handle and draw these is disabled internally. */
418
419 void uiSetButLink(struct uiBut *but,  void **poin,  void ***ppoin,  short *tot,  int from, int to);
420
421 void uiComposeLinks(uiBlock *block);
422 uiBut *uiFindInlink(uiBlock *block, void *poin);
423
424 /* Callbacks
425  *
426  * uiBlockSetHandleFunc/ButmFunc are for handling events through a callback.
427  * HandleFunc gets the retval passed on, and ButmFunc gets a2. The latter is
428  * mostly for compatibility with older code.
429  *
430  * uiButSetCompleteFunc is for tab completion.
431  *
432  * uiButSearchFunc is for name buttons, showing a popup with matches
433  *
434  * uiBlockSetFunc and uiButSetFunc are callbacks run when a button is used,
435  * in case events, operators or RNA are not sufficient to handle the button.
436  *
437  * uiButSetNFunc will free the argument with MEM_freeN. */
438
439 typedef struct uiSearchItems uiSearchItems;
440
441 typedef void (*uiButHandleFunc)(struct bContext *C, void *arg1, void *arg2);
442 typedef void (*uiButHandleRenameFunc)(struct bContext *C, void *arg, char *origstr);
443 typedef void (*uiButHandleNFunc)(struct bContext *C, void *argN, void *arg2);
444 typedef void (*uiButCompleteFunc)(struct bContext *C, char *str, void *arg);
445 typedef void (*uiButSearchFunc)(const struct bContext *C, void *arg, char *str, uiSearchItems *items);
446 typedef void (*uiBlockHandleFunc)(struct bContext *C, void *arg, int event);
447                 
448                 /* use inside searchfunc to add items */
449 int             uiSearchItemAdd(uiSearchItems *items, const char *name, void *poin);
450                 /* bfunc gets search item *poin as arg2, or if NULL the old string */
451 void    uiButSetSearchFunc      (uiBut *but,            uiButSearchFunc sfunc, void *arg1, uiButHandleFunc bfunc);
452                 /* height in pixels, it's using hardcoded values still */
453 int             uiSearchBoxhHeight(void);
454
455 void    uiBlockSetHandleFunc(uiBlock *block,    uiBlockHandleFunc func, void *arg);
456 void    uiBlockSetButmFunc      (uiBlock *block,        uiMenuHandleFunc func, void *arg);
457
458 void    uiBlockSetFunc          (uiBlock *block,        uiButHandleFunc func, void *arg1, void *arg2);
459 void    uiBlockSetRenameFunc(uiBlock *block,    uiButHandleRenameFunc func, void *arg1);
460 void    uiButSetFunc            (uiBut *but,            uiButHandleFunc func, void *arg1, void *arg2);
461 void    uiButSetNFunc           (uiBut *but,            uiButHandleNFunc func, void *argN, void *arg2);
462
463 void    uiButSetCompleteFunc(uiBut *but,                uiButCompleteFunc func, void *arg);
464
465 void    uiBlockSetDrawExtraFunc(uiBlock *block, void (*func)(const struct bContext *C, void *, struct rcti *rect));
466
467 /* Autocomplete
468  *
469  * Tab complete helper functions, for use in uiButCompleteFunc callbacks.
470  * Call begin once, then multiple times do_name with all possibilities,
471  * and finally end to finish and get the completed name. */
472
473 typedef struct AutoComplete AutoComplete;
474
475 AutoComplete *autocomplete_begin(char *startname, int maxlen);
476 void autocomplete_do_name(AutoComplete *autocpl, const char *name);
477 void autocomplete_end(AutoComplete *autocpl, char *autoname);
478
479 /* Panels
480  *
481  * Functions for creating, freeing and drawing panels. The API here
482  * could use a good cleanup, though how they will function in 2.5 is
483  * not clear yet so we postpone that. */
484
485 void uiBeginPanels(const struct bContext *C, struct ARegion *ar);
486 void uiEndPanels(const struct bContext *C, struct ARegion *ar);
487
488 struct Panel *uiBeginPanel(struct ARegion *ar, uiBlock *block, struct PanelType *pt, int *open);
489 void uiEndPanel(uiBlock *block, int width, int height);
490
491 /* Handlers
492  *
493  * Handlers that can be registered in regions, areas and windows for
494  * handling WM events. Mostly this is done automatic by modules such
495  * as screen/ if ED_KEYMAP_UI is set, or internally in popup functions. */
496
497 void UI_add_region_handlers(struct ListBase *handlers);
498 void UI_add_area_handlers(struct ListBase *handlers);
499 void UI_add_popup_handlers(struct bContext *C, struct ListBase *handlers, uiPopupBlockHandle *menu);
500
501 /* Legacy code
502  * Callbacks and utils to get 2.48 work */
503
504 void test_idbutton_cb(struct bContext *C, void *namev, void *arg2);
505 void test_scriptpoin_but(struct bContext *C, char *name, struct ID **idpp);
506 void test_actionpoin_but(struct bContext *C, char *name, struct ID **idpp);
507 void test_obpoin_but(struct bContext *C, char *name, struct ID **idpp);
508 void test_meshobpoin_but(struct bContext *C, char *name, struct ID **idpp);
509 void test_meshpoin_but(struct bContext *C, char *name, struct ID **idpp);
510 void test_matpoin_but(struct bContext *C, char *name, struct ID **idpp);
511 void test_scenepoin_but(struct bContext *C, char *name, struct ID **idpp);
512 void test_grouppoin_but(struct bContext *C, char *name, struct ID **idpp);
513 void test_texpoin_but(struct bContext *C, char *name, struct ID **idpp);
514 void test_imapoin_but(struct bContext *C, char *name, struct ID **idpp);
515 void autocomplete_bone(struct bContext *C, char *str, void *arg_v);
516 void autocomplete_vgroup(struct bContext *C, char *str, void *arg_v);
517
518 struct rctf;
519 void curvemap_buttons(uiBlock *block, struct CurveMapping *cumap, char labeltype, short event, short redraw, struct rctf *rect);
520 void colorband_buttons(uiBlock *block, struct ColorBand *coba, struct rctf *rect, int small);
521
522
523 /* Module
524  *
525  * init and exit should be called before using this module. init_userdef must
526  * be used to reinitialize some internal state if user preferences change. */
527
528 void UI_init(void);
529 void UI_init_userdef(void);
530 void UI_exit(void);
531
532 /* XXX hide this */
533
534 uiBut *uiDefMenuButO(uiBlock *block, char *opname, char *name);
535 uiBut *uiDefMenuSep(uiBlock *block);
536 uiBut *uiDefMenuSub(uiBlock *block, uiBlockCreateFunc func, char *name);
537 uiBut *uiDefMenuTogR(uiBlock *block, struct PointerRNA *ptr, char *propname, char *propvalue, char *name);
538
539 /* Layout
540  *
541  * More automated layout of buttons. Has three levels:
542  * - Layout: contains a number templates, within a bounded width or height.
543  * - Template: predefined layouts for buttons with a number of slots, each
544  *   slot can contain multiple items.
545  * - Item: item to put in a template slot, being either an RNA property,
546  *   operator, label or menu. Also regular buttons can be used when setting
547  *   uiBlockCurLayout. */
548
549 /* layout */
550 #define UI_LAYOUT_HORIZONTAL    0
551 #define UI_LAYOUT_VERTICAL              1
552
553 #define UI_LAYOUT_PANEL                 0
554 #define UI_LAYOUT_HEADER                1
555 #define UI_LAYOUT_MENU                  2
556  
557 #define UI_UNIT_X                               20
558 #define UI_UNIT_Y                               20
559
560 #define UI_LAYOUT_ALIGN_EXPAND  0
561 #define UI_LAYOUT_ALIGN_LEFT    1
562 #define UI_LAYOUT_ALIGN_CENTER  2
563 #define UI_LAYOUT_ALIGN_RIGHT   3
564
565 uiLayout *uiBlockLayout(uiBlock *block, int dir, int type, int x, int y, int size, int em, struct uiStyle *style);
566 void uiBlockSetCurLayout(uiBlock *block, uiLayout *layout);
567 void uiBlockLayoutResolve(const struct bContext *C, uiBlock *block, int *x, int *y);
568
569 uiBlock *uiLayoutGetBlock(uiLayout *layout);
570
571 void uiLayoutSetOperatorContext(uiLayout *layout, int opcontext);
572 void uiLayoutSetFunc(uiLayout *layout, uiMenuHandleFunc handlefunc, void *argv);
573 void uiLayoutSetContextPointer(uiLayout *layout, char *name, struct PointerRNA *ptr);
574
575 void uiLayoutSetActive(uiLayout *layout, int active);
576 void uiLayoutSetEnabled(uiLayout *layout, int enabled);
577 void uiLayoutSetRedAlert(uiLayout *layout, int redalert);
578 void uiLayoutSetAlignment(uiLayout *layout, int alignment);
579 void uiLayoutSetKeepAspect(uiLayout *layout, int keepaspect);
580 void uiLayoutSetScaleX(uiLayout *layout, float scale);
581 void uiLayoutSetScaleY(uiLayout *layout, float scale);
582
583 int uiLayoutGetActive(uiLayout *layout);
584 int uiLayoutGetEnabled(uiLayout *layout);
585 int uiLayoutGetRedAlert(uiLayout *layout);
586 int uiLayoutGetAlignment(uiLayout *layout);
587 int uiLayoutGetKeepAspect(uiLayout *layout);
588 float uiLayoutGetScaleX(uiLayout *layout);
589 float uiLayoutGetScaleY(uiLayout *layout);
590
591 /* layout specifiers */
592 uiLayout *uiLayoutRow(uiLayout *layout, int align);
593 uiLayout *uiLayoutColumn(uiLayout *layout, int align);
594 uiLayout *uiLayoutColumnFlow(uiLayout *layout, int number, int align);
595 uiLayout *uiLayoutBox(uiLayout *layout);
596 uiLayout *uiLayoutFree(uiLayout *layout, int align);
597 uiLayout *uiLayoutSplit(uiLayout *layout, float percentage);
598
599 uiBlock *uiLayoutFreeBlock(uiLayout *layout);
600
601 /* templates */
602 void uiTemplateHeader(uiLayout *layout, struct bContext *C);
603 void uiTemplateID(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, char *propname,
604         char *newop, char *openop, char *unlinkop);
605 uiLayout *uiTemplateModifier(uiLayout *layout, struct PointerRNA *ptr);
606 uiLayout *uiTemplateConstraint(uiLayout *layout, struct PointerRNA *ptr);
607 void uiTemplatePreview(uiLayout *layout, struct ID *id);
608 void uiTemplateColorRamp(uiLayout *layout, struct ColorBand *coba, int expand);
609 void uiTemplateCurveMapping(uiLayout *layout, struct CurveMapping *cumap, int type);
610
611 /* items */
612 void uiItemO(uiLayout *layout, char *name, int icon, char *opname);
613 void uiItemEnumO(uiLayout *layout, char *name, int icon, char *opname, char *propname, int value);
614 void uiItemsEnumO(uiLayout *layout, char *opname, char *propname);
615 void uiItemBooleanO(uiLayout *layout, char *name, int icon, char *opname, char *propname, int value);
616 void uiItemIntO(uiLayout *layout, char *name, int icon, char *opname, char *propname, int value);
617 void uiItemFloatO(uiLayout *layout, char *name, int icon, char *opname, char *propname, float value);
618 void uiItemStringO(uiLayout *layout, char *name, int icon, char *opname, char *propname, char *value);
619 void uiItemFullO(uiLayout *layout, char *name, int icon, char *idname, struct IDProperty *properties, int context);
620
621 void uiItemR(uiLayout *layout, char *name, int icon, struct PointerRNA *ptr, char *propname, int expand, int slider, int toggle);
622 void uiItemFullR(uiLayout *layout, char *name, int icon, struct PointerRNA *ptr, struct PropertyRNA *prop, int index, int value, int expand, int slider, int toggle);
623 void uiItemEnumR(uiLayout *layout, char *name, int icon, struct PointerRNA *ptr, char *propname, int value);
624 void uiItemsEnumR(uiLayout *layout, struct PointerRNA *ptr, char *propname);
625
626 void uiItemL(uiLayout *layout, char *name, int icon); /* label */
627 void uiItemM(uiLayout *layout, struct bContext *C, char *name, int icon, char *menuname); /* menu */
628 void uiItemV(uiLayout *layout, char *name, int icon, int argval); /* value */
629 void uiItemS(uiLayout *layout); /* separator */
630
631 void uiItemMenuF(uiLayout *layout, char *name, int icon, uiMenuCreateFunc func);
632 void uiItemMenuEnumO(uiLayout *layout, char *name, int icon, char *opname, char *propname);
633 void uiItemMenuEnumR(uiLayout *layout, char *name, int icon, struct PointerRNA *ptr, char *propname);
634
635 /* Animation */
636
637 void uiAnimContextProperty(const struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA **prop, int *index);
638
639 /* Styled text draw */
640 void uiStyleFontSet(struct uiFontStyle *fs);
641 void uiStyleFontDraw(struct uiFontStyle *fs, struct rcti *rect, char *str);
642
643 int UI_GetStringWidth(char *str); // XXX temp
644 void UI_DrawString(float x, float y, char *str); // XXX temp
645
646 #endif /*  UI_INTERFACE_H */
647