GSOC 2013 paint
[blender-staging.git] / source / blender / editors / include / UI_interface.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file UI_interface.h
29  *  \ingroup editorui
30  */
31
32 #ifndef __UI_INTERFACE_H__
33 #define __UI_INTERFACE_H__
34
35 #include "BLI_compiler_attrs.h"
36 #include "BLI_sys_types.h" /* size_t */
37 #include "RNA_types.h"
38 #include "DNA_userdef_types.h"
39
40 /* Struct Declarations */
41
42 struct ID;
43 struct Main;
44 struct ListBase;
45 struct ARegion;
46 struct ARegionType;
47 struct ScrArea;
48 struct wmEvent;
49 struct wmWindow;
50 struct wmWindowManager;
51 struct wmOperator;
52 struct AutoComplete;
53 struct bContext;
54 struct bContextStore;
55 struct Panel;
56 struct PanelType;
57 struct PointerRNA;
58 struct PropertyRNA;
59 struct ReportList;
60 struct rcti;
61 struct rctf;
62 struct uiList;
63 struct uiStyle;
64 struct uiFontStyle;
65 struct uiWidgetColors;
66 struct ColorBand;
67 struct CurveMapping;
68 struct Image;
69 struct ImageUser;
70 struct wmOperatorType;
71 struct uiWidgetColors;
72 struct Tex;
73 struct MTex;
74 struct ImBuf;
75 struct bNodeTree;
76 struct bNode;
77 struct bNodeSocket;
78 struct wmDropBox;
79 struct wmDrag;
80 struct wmEvent;
81
82 typedef struct uiBut uiBut;
83 typedef struct uiBlock uiBlock;
84 typedef struct uiPopupBlockHandle uiPopupBlockHandle;
85 typedef struct uiLayout uiLayout;
86
87 /* Defines */
88
89 /* char for splitting strings, aligning shortcuts in menus, users never see */
90 #define UI_SEP_CHAR   '|'
91 #define UI_SEP_CHAR_S "|"
92
93 /* names */
94 #define UI_MAX_DRAW_STR 400
95 #define UI_MAX_NAME_STR 128
96
97 /* use for clamping popups within the screen */
98 #define UI_SCREEN_MARGIN 10
99
100 /* uiBlock->dt and uiBut->dt */
101 #define UI_EMBOSS       0   /* use widget style for drawing */
102 #define UI_EMBOSSN      1   /* Nothing, only icon and/or text */
103 #define UI_EMBOSSP      2   /* Pulldown menu style */
104 #define UI_EMBOSST      3   /* Table */
105
106 /* uiBlock->direction */
107 #define UI_DIRECTION       (UI_TOP | UI_DOWN | UI_LEFT | UI_RIGHT)
108 #define UI_TOP             (1 << 0)
109 #define UI_DOWN            (1 << 1)
110 #define UI_LEFT            (1 << 2)
111 #define UI_RIGHT           (1 << 3)
112 #define UI_CENTER          (1 << 4)
113 #define UI_SHIFT_FLIPPED   (1 << 5)
114
115 #if 0
116 /* uiBlock->autofill (not yet used) */
117 #define UI_BLOCK_COLLUMNS  1
118 #define UI_BLOCK_ROWS      2
119 #endif
120
121 /* uiBlock->flag (controls) */
122 #define UI_BLOCK_LOOP           (1 << 0)
123 #define UI_BLOCK_REDRAW         (1 << 1)
124 #define UI_BLOCK_SEARCH_MENU    (1 << 2)
125 #define UI_BLOCK_NUMSELECT      (1 << 3)
126 #define UI_BLOCK_NO_WIN_CLIP    (1 << 4)   /* don't apply window clipping */ /* was UI_BLOCK_ENTER_OK */
127 #define UI_BLOCK_CLIPBOTTOM     (1 << 5)
128 #define UI_BLOCK_CLIPTOP        (1 << 6)
129 #define UI_BLOCK_MOVEMOUSE_QUIT (1 << 7)
130 #define UI_BLOCK_KEEP_OPEN      (1 << 8)
131 #define UI_BLOCK_POPUP          (1 << 9)
132 #define UI_BLOCK_OUT_1          (1 << 10)
133 #define UI_BLOCK_NO_FLIP        (1 << 11)
134 #define UI_BLOCK_POPUP_MEMORY   (1 << 12)
135 #define UI_BLOCK_CLIP_EVENTS    (1 << 13)  /* stop handling mouse events */
136
137 /* block->flag bits 14-17 are identical to but->drawflag bits */
138
139 #define UI_BLOCK_LIST_ITEM   (1 << 19)
140
141 /* uiPopupBlockHandle->menuretval */
142 #define UI_RETURN_CANCEL     (1 << 0)   /* cancel all menus cascading */
143 #define UI_RETURN_OK         (1 << 1)   /* choice made */
144 #define UI_RETURN_OUT        (1 << 2)   /* left the menu */
145 #define UI_RETURN_OUT_PARENT (1 << 3)   /* let the parent handle this event */
146 #define UI_RETURN_UPDATE     (1 << 4)   /* update the button that opened */
147 #define UI_RETURN_POPUP_OK   (1 << 5)   /* popup is ok to be handled */
148
149 /* panel controls */
150 #define UI_PNL_SOLID    (1 << 1)
151 #define UI_PNL_CLOSE    (1 << 5)
152 #define UI_PNL_SCALE    (1 << 9)
153
154 /* but->flag - general state flags. */
155 enum {
156         /* warning, the first 6 flags are internal */
157         UI_ICON_SUBMENU      = (1 << 6),
158         UI_ICON_PREVIEW      = (1 << 7),
159
160         UI_BUT_NODE_LINK     = (1 << 8),
161         UI_BUT_NODE_ACTIVE   = (1 << 9),
162         UI_BUT_DRAG_LOCK     = (1 << 10),
163         UI_BUT_DISABLED      = (1 << 11),
164         UI_BUT_COLOR_LOCK    = (1 << 12),
165         UI_BUT_ANIMATED      = (1 << 13),
166         UI_BUT_ANIMATED_KEY  = (1 << 14),
167         UI_BUT_DRIVEN        = (1 << 15),
168         UI_BUT_REDALERT      = (1 << 16),
169         UI_BUT_INACTIVE      = (1 << 17),
170         UI_BUT_LAST_ACTIVE   = (1 << 18),
171         UI_BUT_UNDO          = (1 << 19),
172         UI_BUT_IMMEDIATE     = (1 << 20),
173         UI_BUT_NO_UTF8       = (1 << 21),
174
175         UI_BUT_VEC_SIZE_LOCK = (1 << 22),  /* used to flag if color hsv-circle should keep luminance */
176         UI_BUT_COLOR_CUBIC   = (1 << 23),  /* cubic saturation for the color wheel */
177         UI_BUT_LIST_ITEM     = (1 << 24),  /* This but is "inside" a list item (currently used to change theme colors). */
178         UI_BUT_DRAG_MULTI    = (1 << 25),  /* edit this button as well as the active button (not just dragging) */
179         UI_BUT_SCA_LINK_GREY = (1 << 26),  /* used to flag if sca links shoud be grey out */
180         UI_BUT_HAS_SEP_CHAR  = (1 << 27),  /* but->str contains UI_SEP_CHAR, used for key shortcuts */
181 };
182
183 #define UI_PANEL_WIDTH          340
184 #define UI_COMPACT_PANEL_WIDTH  160
185
186 #define UI_PANEL_CATEGORY_MARGIN_WIDTH (U.widget_unit * 1.0f)
187
188 /* but->drawflag - these flags should only affect how the button is drawn. */
189 /* Note: currently, these flags _are not passed_ to the widget's state() or draw() functions
190  *       (except for the 'align' ones)!
191  */
192 enum {
193         /* Text and icon alignment (by default, they are centered). */
194         UI_BUT_TEXT_LEFT         = (1 << 1),
195         UI_BUT_ICON_LEFT         = (1 << 2),
196         UI_BUT_TEXT_RIGHT        = (1 << 3),
197         /* Prevent the button to show any tooltip. */
198         UI_BUT_NO_TOOLTIP        = (1 << 4),
199         /* button align flag, for drawing groups together (also used in uiBlock->flag!) */
200         UI_BUT_ALIGN_TOP         = (1 << 14),
201         UI_BUT_ALIGN_LEFT        = (1 << 15),
202         UI_BUT_ALIGN_RIGHT       = (1 << 16),
203         UI_BUT_ALIGN_DOWN        = (1 << 17),
204         UI_BUT_ALIGN             = (UI_BUT_ALIGN_TOP | UI_BUT_ALIGN_LEFT | UI_BUT_ALIGN_RIGHT | UI_BUT_ALIGN_DOWN),
205 };
206
207 /* scale fixed button widths by this to account for DPI */
208
209 #define UI_DPI_FAC ((U.pixelsize * (float)U.dpi) / 72.0f)
210 #define UI_DPI_WINDOW_FAC (((float)U.dpi) / 72.0f)
211 /* 16 to copy ICON_DEFAULT_HEIGHT */
212 #define UI_DPI_ICON_SIZE ((float)16 * UI_DPI_FAC)
213
214 /* Button types, bits stored in 1 value... and a short even!
215  * - bits 0-4:  bitnr (0-31)
216  * - bits 5-7:  pointer type
217  * - bit  8:    for 'bit'
218  * - bit  9-15: button type (now 6 bits, 64 types)
219  * */
220 typedef enum {
221         UI_BUT_POIN_CHAR = 32,
222         UI_BUT_POIN_SHORT = 64,
223         UI_BUT_POIN_INT = 96,
224         UI_BUT_POIN_FLOAT = 128,
225 /*      UI_BUT_POIN_FUNCTION = 192, */ /*UNUSED*/
226         UI_BUT_POIN_BIT = 256  /* OR'd with a bit index*/
227 } eButPointerType;
228
229 /* requires (but->poin != NULL) */
230 #define UI_BUT_POIN_TYPES (UI_BUT_POIN_FLOAT | UI_BUT_POIN_SHORT | UI_BUT_POIN_CHAR)
231
232 /* assigned to but->type, OR'd with the flags above when passing args */
233 typedef enum {
234         BUT           = (1 << 9),
235         ROW           = (2 << 9),
236         TOG           = (3 << 9),
237         NUM           = (5 << 9),
238         TEX           = (6 << 9),
239         TOGN          = (9 << 9),
240         LABEL         = (10 << 9),
241         MENU          = (11 << 9),  /* Dropdown list, actually! */
242         ICONTOG       = (13 << 9),
243         NUMSLI        = (14 << 9),
244         COLOR         = (15 << 9),
245         SCROLL        = (18 << 9),
246         BLOCK         = (19 << 9),
247         BUTM          = (20 << 9),
248         SEPR          = (21 << 9),
249         LINK          = (22 << 9),
250         INLINK        = (23 << 9),
251         KEYEVT        = (24 << 9),
252         HSVCUBE       = (26 << 9),
253         PULLDOWN      = (27 << 9),  /* Menu, actually! */
254         ROUNDBOX      = (28 << 9),
255         BUT_COLORBAND = (30 << 9),
256         BUT_NORMAL    = (31 << 9),
257         BUT_CURVE     = (32 << 9),
258         ICONTOGN      = (34 << 9),
259         LISTBOX       = (35 << 9),
260         LISTROW       = (36 << 9),
261         TOGBUT        = (37 << 9),
262         OPTION        = (38 << 9),
263         OPTIONN       = (39 << 9),
264         TRACKPREVIEW  = (40 << 9),
265         /* buttons with value >= SEARCH_MENU don't get undo pushes */
266         SEARCH_MENU   = (41 << 9),
267         BUT_EXTRA     = (42 << 9),
268         HSVCIRCLE     = (43 << 9),
269         HOTKEYEVT     = (46 << 9),
270         BUT_IMAGE     = (47 << 9),
271         HISTOGRAM     = (48 << 9),
272         WAVEFORM      = (49 << 9),
273         VECTORSCOPE   = (50 << 9),
274         PROGRESSBAR   = (51 << 9),
275         SEARCH_MENU_UNLINK   = (52 << 9),
276         NODESOCKET    = (53 << 9),
277         SEPRLINE      = (54 << 9),
278         GRIP          = (55 << 9),
279 } eButType;
280
281 #define BUTTYPE     (63 << 9)
282
283 /* gradient types, for color picker HSVCUBE etc */
284 #define UI_GRAD_SV      0
285 #define UI_GRAD_HV      1
286 #define UI_GRAD_HS      2
287 #define UI_GRAD_H       3
288 #define UI_GRAD_S       4
289 #define UI_GRAD_V       5
290
291 #define UI_GRAD_V_ALT   9
292 #define UI_GRAD_L_ALT   10
293
294 #define UI_PALETTE_COLOR 20
295 #define UI_PALETTE_COLOR_ACTIVE 1
296
297 /* Drawing
298  *
299  * Functions to draw various shapes, taking theme settings into account.
300  * Used for code that draws its own UI style elements. */
301
302 void uiRoundBox(float minx, float miny, float maxx, float maxy, float rad);
303 void uiSetRoundBox(int type);
304 int uiGetRoundBox(void);
305 void uiRoundRect(float minx, float miny, float maxx, float maxy, float rad);
306 void uiDrawBoxShadow(unsigned char alpha, float minx, float miny, float maxx, float maxy);
307 void uiDrawBox(int mode, float minx, float miny, float maxx, float maxy, float rad);
308 void uiDrawBoxShade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadetop, float shadedown);
309 void uiDrawBoxVerticalShade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadeLeft, float shadeRight);
310
311 /* state for scrolldrawing */
312 #define UI_SCROLL_PRESSED       (1 << 0)
313 #define UI_SCROLL_ARROWS        (1 << 1)
314 #define UI_SCROLL_NO_OUTLINE    (1 << 2)
315 void uiWidgetScrollDraw(struct uiWidgetColors *wcol, const struct rcti *rect, const struct rcti *slider, int state);
316
317 /* Callbacks
318  *
319  * uiBlockSetHandleFunc/ButmFunc are for handling events through a callback.
320  * HandleFunc gets the retval passed on, and ButmFunc gets a2. The latter is
321  * mostly for compatibility with older code.
322  *
323  * uiButSetCompleteFunc is for tab completion.
324  *
325  * uiButSearchFunc is for name buttons, showing a popup with matches
326  *
327  * uiBlockSetFunc and uiButSetFunc are callbacks run when a button is used,
328  * in case events, operators or RNA are not sufficient to handle the button.
329  *
330  * uiButSetNFunc will free the argument with MEM_freeN. */
331
332 typedef struct uiSearchItems uiSearchItems;
333
334 typedef void (*uiButHandleFunc)(struct bContext *C, void *arg1, void *arg2);
335 typedef void (*uiButHandleRenameFunc)(struct bContext *C, void *arg, char *origstr);
336 typedef void (*uiButHandleNFunc)(struct bContext *C, void *argN, void *arg2);
337 typedef int (*uiButCompleteFunc)(struct bContext *C, char *str, void *arg);
338 typedef void (*uiButSearchFunc)(const struct bContext *C, void *arg, const char *str, uiSearchItems *items);
339 typedef void (*uiBlockHandleFunc)(struct bContext *C, void *arg, int event);
340
341 /* Menu Callbacks */
342
343 typedef void (*uiMenuCreateFunc)(struct bContext *C, struct uiLayout *layout, void *arg1);
344 typedef void (*uiMenuHandleFunc)(struct bContext *C, void *arg, int event);
345
346 /* Popup Menus
347  *
348  * Functions used to create popup menus. For more extended menus the
349  * uiPupMenuBegin/End functions can be used to define own items with
350  * the uiItem functions in between. If it is a simple confirmation menu
351  * or similar, popups can be created with a single function call. */
352
353 typedef struct uiPopupMenu uiPopupMenu;
354
355 struct uiPopupMenu *uiPupMenuBegin(struct bContext *C, const char *title, int icon) ATTR_NONNULL();
356 void uiPupMenuEnd(struct bContext *C, struct uiPopupMenu *head);
357 struct uiLayout *uiPupMenuLayout(uiPopupMenu *head);
358
359 void uiPupMenuReports(struct bContext *C, struct ReportList *reports) ATTR_NONNULL();
360 bool uiPupMenuInvoke(struct bContext *C, const char *idname, struct ReportList *reports) ATTR_NONNULL(1, 2);
361
362 /* Popup Blocks
363  *
364  * Functions used to create popup blocks. These are like popup menus
365  * but allow using all button types and creating an own layout. */
366
367 typedef uiBlock * (*uiBlockCreateFunc)(struct bContext *C, struct ARegion *ar, void *arg1);
368 typedef void (*uiBlockCancelFunc)(struct bContext *C, void *arg1);
369
370 void uiPupBlock(struct bContext *C, uiBlockCreateFunc func, void *arg);
371 void uiPupBlockO(struct bContext *C, uiBlockCreateFunc func, void *arg, const char *opname, int opcontext);
372 void uiPupBlockEx(struct bContext *C, uiBlockCreateFunc func, uiBlockHandleFunc popup_func, uiBlockCancelFunc cancel_func, void *arg);
373 /* void uiPupBlockOperator(struct bContext *C, uiBlockCreateFunc func, struct wmOperator *op, int opcontext); */ /* UNUSED */
374
375 void uiPupBlockClose(struct bContext *C, uiBlock *block);
376
377 /* Blocks
378  *
379  * Functions for creating, drawing and freeing blocks. A Block is a
380  * container of buttons and used for various purposes.
381  * 
382  * Begin/Define Buttons/End/Draw is the typical order in which these
383  * function should be called, though for popup blocks Draw is left out.
384  * Freeing blocks is done by the screen/ module automatically.
385  *
386  * */
387
388 uiBlock *uiBeginBlock(const struct bContext *C, struct ARegion *region, const char *name, short dt);
389 void uiEndBlock_ex(const struct bContext *C, uiBlock *block, const int xy[2]);
390 void uiEndBlock(const struct bContext *C, uiBlock *block);
391 void uiDrawBlock(const struct bContext *C, struct uiBlock *block);
392 void uiBlockUpdateFromOld(const struct bContext *C, struct uiBlock *block);
393
394 uiBlock *uiGetBlock(const char *name, struct ARegion *ar);
395
396 void uiBlockSetEmboss(uiBlock *block, char dt);
397
398 void uiFreeBlock(const struct bContext *C, uiBlock *block);
399 void uiFreeBlocks(const struct bContext *C, struct ListBase *lb);
400 void uiFreeInactiveBlocks(const struct bContext *C, struct ListBase *lb);
401 void uiFreeActiveButtons(const struct bContext *C, struct bScreen *screen);
402
403 void uiBlockSetRegion(uiBlock *block, struct ARegion *region);
404
405 void uiBlockSetButLock(uiBlock *block, bool val, const char *lockstr);
406 void uiBlockClearButLock(uiBlock *block);
407
408 /* automatic aligning, horiz or verical */
409 void uiBlockBeginAlign(uiBlock *block);
410 void uiBlockEndAlign(uiBlock *block);
411
412 /* block bounds/position calculation */
413 typedef enum {
414         UI_BLOCK_BOUNDS_NONE = 0,
415         UI_BLOCK_BOUNDS = 1,
416         UI_BLOCK_BOUNDS_TEXT,
417         UI_BLOCK_BOUNDS_POPUP_MOUSE,
418         UI_BLOCK_BOUNDS_POPUP_MENU,
419         UI_BLOCK_BOUNDS_POPUP_CENTER
420 } eBlockBoundsCalc;
421
422 void uiBoundsBlock(struct uiBlock *block, int addval);
423 void uiTextBoundsBlock(uiBlock *block, int addval);
424 void uiPopupBoundsBlock(uiBlock *block, int addval, int mx, int my);
425 void uiMenuPopupBoundsBlock(uiBlock *block, int addvall, int mx, int my);
426 void uiCenteredBoundsBlock(uiBlock *block, int addval);
427 void uiExplicitBoundsBlock(uiBlock *block, int minx, int miny, int maxx, int maxy);
428
429 int     uiBlocksGetYMin(struct ListBase *lb);
430
431 void    uiBlockSetDirection(uiBlock *block, char direction);
432 void    uiBlockFlipOrder(uiBlock *block);
433 void    uiBlockSetFlag(uiBlock *block, int flag);
434 void    uiBlockClearFlag(uiBlock *block, int flag);
435
436 int     uiButGetRetVal(uiBut *but);
437
438 void    uiButSetDragID(uiBut *but, struct ID *id);
439 void    uiButSetDragRNA(uiBut *but, struct PointerRNA *ptr);
440 void    uiButSetDragPath(uiBut *but, const char *path);
441 void    uiButSetDragName(uiBut *but, const char *name);
442 void    uiButSetDragValue(uiBut *but);
443 void    uiButSetDragImage(uiBut *but, const char *path, int icon, struct ImBuf *ima, float scale);
444
445 bool    UI_but_active_drop_name(struct bContext *C);
446 bool    UI_but_active_drop_color(struct bContext *C);
447
448 void    uiButSetFlag(uiBut *but, int flag);
449 void    uiButClearFlag(uiBut *but, int flag);
450
451 void    uiButSetDrawFlag(uiBut *but, int flag);
452 void    uiButClearDrawFlag(uiBut *but, int flag);
453
454 void    uiButSetMenuFromPulldown(uiBut *but);
455
456 /* special button case, only draw it when used actively, for outliner etc */
457 bool    uiButActiveOnly(const struct bContext *C, struct ARegion *ar, uiBlock *block, uiBut *but);
458
459 void    uiButExecute(const struct bContext *C, uiBut *but);
460
461
462 /* Buttons
463  *
464  * Functions to define various types of buttons in a block. Postfixes:
465  * - F: float
466  * - I: int
467  * - S: short
468  * - C: char
469  * - R: RNA
470  * - O: operator */
471
472 uiBut *uiDefBut(uiBlock *block, 
473                 int type, int retval, const char *str,
474                 int x1, int y1,
475                 short x2, short y2,
476                 void *poin,
477                 float min, float max,
478                 float a1, float a2, const char *tip);
479 uiBut *uiDefButF(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, float *poin, float min, float max, float a1, float a2, const char *tip);
480 uiBut *uiDefButBitF(uiBlock *block, int type, int bit, int retval, const char *str, int x, int y, short width, short height, float *poin, float min, float max, float a1, float a2, const char *tip);
481 uiBut *uiDefButI(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, int *poin, float min, float max, float a1, float a2, const char *tip);
482 uiBut *uiDefButBitI(uiBlock *block, int type, int bit, int retval, const char *str, int x, int y, short width, short height, int *poin, float min, float max, float a1, float a2, const char *tip);
483 uiBut *uiDefButS(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, short *poin, float min, float max, float a1, float a2, const char *tip);
484 uiBut *uiDefButBitS(uiBlock *block, int type, int bit, int retval, const char *str, int x, int y, short width, short height, short *poin, float min, float max, float a1, float a2, const char *tip);
485 uiBut *uiDefButC(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, char *poin, float min, float max, float a1, float a2, const char *tip);
486 uiBut *uiDefButBitC(uiBlock *block, int type, int bit, int retval, const char *str, int x, int y, short width, short height, char *poin, float min, float max, float a1, float a2, const char *tip);
487 uiBut *uiDefButR(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, struct PointerRNA *ptr, const char *propname, int index, float min, float max, float a1, float a2, const char *tip);
488 uiBut *uiDefButR_prop(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, struct PointerRNA *ptr, struct PropertyRNA *prop, int index, float min, float max, float a1, float a2, const char *tip);
489 uiBut *uiDefButO(uiBlock *block, int type, const char *opname, int opcontext, const char *str, int x, int y, short width, short height, const char *tip);
490 uiBut *uiDefButO_ptr(uiBlock *block, int type, struct wmOperatorType *ot, int opcontext, const char *str, int x, int y, short width, short height, const char *tip);
491
492 uiBut *uiDefIconBut(uiBlock *block, 
493                     int type, int retval, int icon,
494                     int x1, int y1,
495                     short x2, short y2,
496                     void *poin,
497                     float min, float max,
498                     float a1, float a2,  const char *tip);
499 uiBut *uiDefIconButF(uiBlock *block, int type, int retval, int icon, int x, int y, short width, short height, float *poin, float min, float max, float a1, float a2, const char *tip);
500 uiBut *uiDefIconButBitF(uiBlock *block, int type, int bit, int retval, int icon, int x, int y, short width, short height, float *poin, float min, float max, float a1, float a2, const char *tip);
501 uiBut *uiDefIconButI(uiBlock *block, int type, int retval, int icon, int x, int y, short width, short height, int *poin, float min, float max, float a1, float a2, const char *tip);
502 uiBut *uiDefIconButBitI(uiBlock *block, int type, int bit, int retval, int icon, int x, int y, short width, short height, int *poin, float min, float max, float a1, float a2, const char *tip);
503 uiBut *uiDefIconButS(uiBlock *block, int type, int retval, int icon, int x, int y, short width, short height, short *poin, float min, float max, float a1, float a2, const char *tip);
504 uiBut *uiDefIconButBitS(uiBlock *block, int type, int bit, int retval, int icon, int x, int y, short width, short height, short *poin, float min, float max, float a1, float a2, const char *tip);
505 uiBut *uiDefIconButC(uiBlock *block, int type, int retval, int icon, int x, int y, short width, short height, char *poin, float min, float max, float a1, float a2, const char *tip);
506 uiBut *uiDefIconButBitC(uiBlock *block, int type, int bit, int retval, int icon, int x, int y, short width, short height, char *poin, float min, float max, float a1, float a2, const char *tip);
507 uiBut *uiDefIconButR(uiBlock *block, int type, int retval, int icon, int x, int y, short width, short height, struct PointerRNA *ptr, const char *propname, int index, float min, float max, float a1, float a2, const char *tip);
508 uiBut *uiDefIconButR_prop(uiBlock *block, int type, int retval, int icon, int x, int y, short width, short height, struct PointerRNA *ptr, PropertyRNA *prop, int index, float min, float max, float a1, float a2, const char *tip);
509 uiBut *uiDefIconButO(uiBlock *block, int type, const char *opname, int opcontext, int icon, int x, int y, short width, short height, const char *tip);
510 uiBut *uiDefIconButO_ptr(uiBlock *block, int type, struct wmOperatorType *ot, int opcontext, int icon, int x, int y, short width, short height, const char *tip);
511
512 uiBut *uiDefIconTextBut(uiBlock *block,
513                         int type, int retval, int icon, const char *str,
514                         int x1, int y1,
515                         short x2, short y2,
516                         void *poin,
517                         float min, float max,
518                         float a1, float a2, const char *tip);
519 uiBut *uiDefIconTextButF(uiBlock *block, int type, int retval, int icon, const char *str, int x, int y, short width, short height, float *poin, float min, float max, float a1, float a2, const char *tip);
520 uiBut *uiDefIconTextButBitF(uiBlock *block, int type, int bit, int retval, int icon, const char *str, int x, int y, short width, short height, float *poin, float min, float max, float a1, float a2, const char *tip);
521 uiBut *uiDefIconTextButI(uiBlock *block, int type, int retval, int icon, const char *str, int x, int y, short width, short height, int *poin, float min, float max, float a1, float a2, const char *tip);
522 uiBut *uiDefIconTextButBitI(uiBlock *block, int type, int bit, int retval, int icon, const char *str, int x, int y, short width, short height, int *poin, float min, float max, float a1, float a2, const char *tip);
523 uiBut *uiDefIconTextButS(uiBlock *block, int type, int retval, int icon, const char *str, int x, int y, short width, short height, short *poin, float min, float max, float a1, float a2, const char *tip);
524 uiBut *uiDefIconTextButBitS(uiBlock *block, int type, int bit, int retval, int icon, const char *str, int x, int y, short width, short height, short *poin, float min, float max, float a1, float a2, const char *tip);
525 uiBut *uiDefIconTextButC(uiBlock *block, int type, int retval, int icon, const char *str, int x, int y, short width, short height, char *poin, float min, float max, float a1, float a2, const char *tip);
526 uiBut *uiDefIconTextButBitC(uiBlock *block, int type, int bit, int retval, int icon, const char *str, int x, int y, short width, short height, char *poin, float min, float max, float a1, float a2, const char *tip);
527 uiBut *uiDefIconTextButR(uiBlock *block, int type, int retval, int icon, const char *str, int x, int y, short width, short height, struct PointerRNA *ptr, const char *propname, int index, float min, float max, float a1, float a2, const char *tip);
528 uiBut *uiDefIconTextButR_prop(uiBlock *block, int type, int retval, int icon, const char *str, int x, int y, short width, short height, struct PointerRNA *ptr, struct PropertyRNA *prop, int index, float min, float max, float a1, float a2, const char *tip);
529 uiBut *uiDefIconTextButO(uiBlock *block, int type, const char *opname, int opcontext, int icon, const char *str, int x, int y, short width, short height, const char *tip);
530 uiBut *uiDefIconTextButO_ptr(uiBlock *block, int type, struct wmOperatorType *ot, int opcontext, int icon, const char *str, int x, int y, short width, short height, const char *tip);
531
532 /* for passing inputs to ButO buttons */
533 struct PointerRNA *uiButGetOperatorPtrRNA(uiBut *but);
534
535 void uiButSetUnitType(uiBut *but, const int unit_type);
536 int uiButGetUnitType(const uiBut *but);
537
538 enum {
539         BUT_GET_RNAPROP_IDENTIFIER = 1,
540         BUT_GET_RNASTRUCT_IDENTIFIER,
541         BUT_GET_RNAENUM_IDENTIFIER,
542         BUT_GET_LABEL,
543         BUT_GET_RNA_LABEL,
544         BUT_GET_RNAENUM_LABEL,
545         BUT_GET_RNA_LABEL_CONTEXT, /* Context specified in CTX_XXX_ macros are just unreachable! */
546         BUT_GET_TIP,
547         BUT_GET_RNA_TIP,
548         BUT_GET_RNAENUM_TIP,
549         BUT_GET_OP_KEYMAP,
550         BUT_GET_PROP_KEYMAP
551 };
552
553 typedef struct uiStringInfo {
554         int type;
555         char *strinfo;
556 } uiStringInfo; 
557
558 /* Note: Expects pointers to uiStringInfo structs as parameters.
559  *       Will fill them with translated strings, when possible.
560  *       Strings in uiStringInfo must be MEM_freeN'ed by caller. */
561 void uiButGetStrInfo(struct bContext *C, uiBut *but, ...) ATTR_SENTINEL(0);
562
563 /* Edit i18n stuff. */
564 /* Name of the main py op from i18n addon. */
565 #define EDTSRC_I18N_OP_NAME "UI_OT_edittranslation"
566
567 /* Special Buttons
568  *
569  * Buttons with a more specific purpose:
570  * - MenuBut: buttons that popup a menu (in headers usually).
571  * - PulldownBut: like MenuBut, but creating a uiBlock (for compatibility).
572  * - BlockBut: buttons that popup a block with more buttons.
573  * - KeyevtBut: buttons that can be used to turn key events into values.
574  * - PickerButtons: buttons like the color picker (for code sharing).
575  * - AutoButR: RNA property button with type automatically defined. */
576
577 #define UI_ID_RENAME        (1 << 0)
578 #define UI_ID_BROWSE        (1 << 1)
579 #define UI_ID_ADD_NEW       (1 << 2)
580 #define UI_ID_OPEN          (1 << 3)
581 #define UI_ID_ALONE         (1 << 4)
582 #define UI_ID_DELETE        (1 << 5)
583 #define UI_ID_LOCAL         (1 << 6)
584 #define UI_ID_AUTO_NAME     (1 << 7)
585 #define UI_ID_FAKE_USER     (1 << 8)
586 #define UI_ID_PIN           (1 << 9)
587 #define UI_ID_BROWSE_RENDER (1 << 10)
588 #define UI_ID_PREVIEWS      (1 << 11)
589 #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)
590
591 int uiIconFromID(struct ID *id);
592 int uiIconFromReportType(int type);
593
594 uiBut *uiDefPulldownBut(uiBlock *block, uiBlockCreateFunc func, void *arg, const char *str, int x, int y, short width, short height, const char *tip);
595 uiBut *uiDefMenuBut(uiBlock *block, uiMenuCreateFunc func, void *arg, const char *str, int x, int y, short width, short height, const char *tip);
596 uiBut *uiDefIconTextMenuBut(uiBlock *block, uiMenuCreateFunc func, void *arg, int icon, const char *str, int x, int y, short width, short height, const char *tip);
597 uiBut *uiDefIconMenuBut(uiBlock *block, uiMenuCreateFunc func, void *arg, int icon, int x, int y, short width, short height, const char *tip);
598
599 uiBut *uiDefBlockBut(uiBlock *block, uiBlockCreateFunc func, void *func_arg1, const char *str, int x, int y, short width, short height, const char *tip);
600 uiBut *uiDefBlockButN(uiBlock *block, uiBlockCreateFunc func, void *argN, const char *str, int x, int y, short width, short height, const char *tip);
601
602 uiBut *uiDefIconBlockBut(uiBlock *block, uiBlockCreateFunc func, void *arg, int retval, int icon, int x, int y, short width, short height, const char *tip);
603 uiBut *uiDefIconTextBlockBut(uiBlock *block, uiBlockCreateFunc func, void *arg, int icon, const char *str, int x, int y, short width, short height, const char *tip);
604
605 uiBut *uiDefKeyevtButS(uiBlock *block, int retval, const char *str, int x, int y, short width, short height, short *spoin, const char *tip);
606 uiBut *uiDefHotKeyevtButS(uiBlock *block, int retval, const char *str, int x, int y, short width, short height, short *keypoin, short *modkeypoin, const char *tip);
607
608 uiBut *uiDefSearchBut(uiBlock *block, void *arg, int retval, int icon, int maxlen, int x, int y, short width, short height, float a1, float a2, const char *tip);
609 uiBut *uiDefSearchButO_ptr(uiBlock *block, struct wmOperatorType *ot, IDProperty *properties,
610                            void *arg, int retval, int icon, int maxlen, int x, int y,
611                            short width, short height, float a1, float a2, const char *tip);
612
613 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);
614 int uiDefAutoButsRNA(uiLayout *layout, struct PointerRNA *ptr, bool (*check_prop)(struct PointerRNA *, struct PropertyRNA *), const char label_align);
615
616 /* Links
617  *
618  * Game engine logic brick links. Non-functional currently in 2.5,
619  * code to handle and draw these is disabled internally. */
620
621 void uiSetButLink(struct uiBut *but,  void **poin,  void ***ppoin,  short *tot,  int from, int to);
622
623 void uiComposeLinks(uiBlock *block);
624 uiBut *uiFindInlink(uiBlock *block, void *poin);
625
626 /* use inside searchfunc to add items */
627 bool    uiSearchItemAdd(uiSearchItems *items, const char *name, void *poin, int iconid);
628 /* bfunc gets search item *poin as arg2, or if NULL the old string */
629 void    uiButSetSearchFunc(uiBut *but,        uiButSearchFunc sfunc, void *arg1, uiButHandleFunc bfunc, void *active);
630 /* height in pixels, it's using hardcoded values still */
631 int     uiSearchBoxHeight(void);
632 int     uiSearchBoxWidth(void);
633 /* check if a string is in an existing search box */
634 int     uiSearchItemFindIndex(uiSearchItems *items, const char *name);
635
636 void    uiBlockSetHandleFunc(uiBlock *block,    uiBlockHandleFunc func, void *arg);
637 void    uiBlockSetButmFunc(uiBlock *block,    uiMenuHandleFunc func, void *arg);
638 void    uiBlockSetFunc(uiBlock *block,    uiButHandleFunc func, void *arg1, void *arg2);
639 void    uiBlockSetNFunc(uiBlock *block,    uiButHandleNFunc funcN, void *argN, void *arg2);
640
641 void    uiButSetRenameFunc(uiBut *but,        uiButHandleRenameFunc func, void *arg1);
642 void    uiButSetFunc(uiBut *but,        uiButHandleFunc func, void *arg1, void *arg2);
643 void    uiButSetNFunc(uiBut *but,        uiButHandleNFunc funcN, void *argN, void *arg2);
644
645 void    uiButSetCompleteFunc(uiBut *but,        uiButCompleteFunc func, void *arg);
646
647 void    uiBlockSetDrawExtraFunc(uiBlock *block,
648                                 void (*func)(const struct bContext *C, void *, void *, void *, struct rcti *rect),
649                                 void *arg1, void *arg2);
650
651 bool UI_textbutton_activate_rna(const struct bContext *C, struct ARegion *ar,
652                                 const void *rna_poin_data, const char *rna_prop_id);
653 bool UI_textbutton_activate_but(const struct bContext *C, uiBut *but);
654
655 void uiButSetFocusOnEnter(struct wmWindow *win, uiBut *but);
656
657 /* Autocomplete
658  *
659  * Tab complete helper functions, for use in uiButCompleteFunc callbacks.
660  * Call begin once, then multiple times do_name with all possibilities,
661  * and finally end to finish and get the completed name. */
662
663 typedef struct AutoComplete AutoComplete;
664
665 #define AUTOCOMPLETE_NO_MATCH 0
666 #define AUTOCOMPLETE_FULL_MATCH 1
667 #define AUTOCOMPLETE_PARTIAL_MATCH 2
668
669 AutoComplete *autocomplete_begin(const char *startname, size_t maxlen);
670 void autocomplete_do_name(AutoComplete *autocpl, const char *name);
671 int autocomplete_end(AutoComplete *autocpl, char *autoname);
672
673 /* Panels
674  *
675  * Functions for creating, freeing and drawing panels. The API here
676  * could use a good cleanup, though how they will function in 2.5 is
677  * not clear yet so we postpone that. */
678
679 void uiBeginPanels(const struct bContext *C, struct ARegion *ar);
680 void uiEndPanels(const struct bContext *C, struct ARegion *ar, int *x, int *y);
681 void uiDrawPanels(const struct bContext *C, struct ARegion *ar);
682
683 struct Panel *uiPanelFindByType(struct ARegion *ar, struct PanelType *pt);
684 struct Panel *uiBeginPanel(struct ScrArea *sa, struct ARegion *ar, uiBlock *block,
685                            struct PanelType *pt, struct Panel *pa, bool *r_open);
686 void uiEndPanel(uiBlock *block, int width, int height);
687 void uiScalePanels(struct ARegion *ar, float new_width);
688
689 bool                       UI_panel_category_is_visible(struct ARegion *ar);
690 void                       UI_panel_category_add(struct ARegion *ar, const char *name);
691 struct PanelCategoryDyn   *UI_panel_category_find(struct ARegion *ar, const char *idname);
692 struct PanelCategoryStack *UI_panel_category_active_find(struct ARegion *ar, const char *idname);
693 const char                *UI_panel_category_active_get(struct ARegion *ar, bool set_fallback);
694 void                       UI_panel_category_active_set(struct ARegion *ar, const char *idname);
695 struct PanelCategoryDyn   *UI_panel_category_find_mouse_over_ex(struct ARegion *ar, const int x, const int y);
696 struct PanelCategoryDyn   *UI_panel_category_find_mouse_over(struct ARegion *ar, const struct wmEvent *event);
697 void                       UI_panel_category_clear_all(struct ARegion *ar);
698 void                       UI_panel_category_draw_all(struct ARegion *ar, const char *category_id_active);
699
700 /* Handlers
701  *
702  * Handlers that can be registered in regions, areas and windows for
703  * handling WM events. Mostly this is done automatic by modules such
704  * as screen/ if ED_KEYMAP_UI is set, or internally in popup functions. */
705
706 void UI_add_region_handlers(struct ListBase *handlers);
707 void UI_add_popup_handlers(struct bContext *C, struct ListBase *handlers, uiPopupBlockHandle *popup);
708 void UI_remove_popup_handlers(struct ListBase *handlers, uiPopupBlockHandle *popup);
709 void UI_remove_popup_handlers_all(struct bContext *C, struct ListBase *handlers);
710
711 /* Module
712  *
713  * init and exit should be called before using this module. init_userdef must
714  * be used to reinitialize some internal state if user preferences change. */
715
716 void UI_init(void);
717 void UI_init_userdef(void);
718 void UI_init_userdef_factory(void);
719 void UI_reinit_font(void);
720 void UI_exit(void);
721
722 /* Layout
723  *
724  * More automated layout of buttons. Has three levels:
725  * - Layout: contains a number templates, within a bounded width or height.
726  * - Template: predefined layouts for buttons with a number of slots, each
727  *   slot can contain multiple items.
728  * - Item: item to put in a template slot, being either an RNA property,
729  *   operator, label or menu. Also regular buttons can be used when setting
730  *   uiBlockCurLayout. */
731
732 /* layout */
733 #define UI_LAYOUT_HORIZONTAL    0
734 #define UI_LAYOUT_VERTICAL      1
735
736 #define UI_LAYOUT_PANEL         0
737 #define UI_LAYOUT_HEADER        1
738 #define UI_LAYOUT_MENU          2
739 #define UI_LAYOUT_TOOLBAR       3
740
741 #define UI_UNIT_X               ((void)0, U.widget_unit)
742 #define UI_UNIT_Y               ((void)0, U.widget_unit)
743
744 #define UI_LAYOUT_ALIGN_EXPAND  0
745 #define UI_LAYOUT_ALIGN_LEFT    1
746 #define UI_LAYOUT_ALIGN_CENTER  2
747 #define UI_LAYOUT_ALIGN_RIGHT   3
748
749 #define UI_ITEM_O_RETURN_PROPS  (1 << 0)
750 #define UI_ITEM_R_EXPAND        (1 << 1)
751 #define UI_ITEM_R_SLIDER        (1 << 2)
752 #define UI_ITEM_R_TOGGLE        (1 << 3)
753 #define UI_ITEM_R_ICON_ONLY     (1 << 4)
754 #define UI_ITEM_R_EVENT         (1 << 5)
755 #define UI_ITEM_R_FULL_EVENT    (1 << 6)
756 #define UI_ITEM_R_NO_BG         (1 << 7)
757 #define UI_ITEM_R_IMMEDIATE     (1 << 8)
758
759 /* uiLayoutOperatorButs flags */
760 #define UI_LAYOUT_OP_SHOW_TITLE 1
761 #define UI_LAYOUT_OP_SHOW_EMPTY 2
762
763 /* used for transp checkers */
764 #define UI_ALPHA_CHECKER_DARK 100
765 #define UI_ALPHA_CHECKER_LIGHT 160
766
767 /* flags to set which corners will become rounded:
768  *
769  * 1------2
770  * |      |
771  * 8------4 */
772
773 enum {
774         UI_CNR_TOP_LEFT     = (1 << 0),
775         UI_CNR_TOP_RIGHT    = (1 << 1),
776         UI_CNR_BOTTOM_RIGHT = (1 << 2),
777         UI_CNR_BOTTOM_LEFT  = (1 << 3),
778         /* just for convenience */
779         UI_CNR_NONE         = 0,
780         UI_CNR_ALL          = (UI_CNR_TOP_LEFT | UI_CNR_TOP_RIGHT | UI_CNR_BOTTOM_RIGHT | UI_CNR_BOTTOM_LEFT)
781 };
782
783 /* not apart of the corner flags but mixed in some functions  */
784 #define UI_RB_ALPHA (UI_CNR_ALL + 1)
785
786 uiLayout *uiBlockLayout(uiBlock *block, int dir, int type, int x, int y, int size, int em, int padding, struct uiStyle *style);
787 void uiBlockSetCurLayout(uiBlock *block, uiLayout *layout);
788 void uiBlockLayoutResolve(uiBlock *block, int *x, int *y);
789
790 uiBlock *uiLayoutGetBlock(uiLayout *layout);
791
792 void uiLayoutSetFunc(uiLayout *layout, uiMenuHandleFunc handlefunc, void *argv);
793 void uiLayoutSetContextPointer(uiLayout *layout, const char *name, struct PointerRNA *ptr);
794 void uiLayoutContextCopy(uiLayout *layout, struct bContextStore *context);
795 const char *uiLayoutIntrospect(uiLayout *layout); // XXX - testing
796 void uiLayoutOperatorButs(const struct bContext *C, struct uiLayout *layout, struct wmOperator *op,
797                           bool (*check_prop)(struct PointerRNA *, struct PropertyRNA *),
798                           const char label_align, const short flag);
799 struct MenuType *uiButGetMenuType(uiBut *but);
800
801 void uiLayoutSetOperatorContext(uiLayout *layout, int opcontext);
802 void uiLayoutSetActive(uiLayout *layout, bool active);
803 void uiLayoutSetEnabled(uiLayout *layout, bool enabled);
804 void uiLayoutSetRedAlert(uiLayout *layout, bool redalert);
805 void uiLayoutSetAlignment(uiLayout *layout, char alignment);
806 void uiLayoutSetKeepAspect(uiLayout *layout, bool keepaspect);
807 void uiLayoutSetScaleX(uiLayout *layout, float scale);
808 void uiLayoutSetScaleY(uiLayout *layout, float scale);
809
810 int uiLayoutGetOperatorContext(uiLayout *layout);
811 bool uiLayoutGetActive(uiLayout *layout);
812 bool uiLayoutGetEnabled(uiLayout *layout);
813 bool uiLayoutGetRedAlert(uiLayout *layout);
814 int uiLayoutGetAlignment(uiLayout *layout);
815 bool uiLayoutGetKeepAspect(uiLayout *layout);
816 int uiLayoutGetWidth(uiLayout *layout);
817 float uiLayoutGetScaleX(uiLayout *layout);
818 float uiLayoutGetScaleY(uiLayout *layout);
819
820 /* layout specifiers */
821 uiLayout *uiLayoutRow(uiLayout *layout, int align);
822 uiLayout *uiLayoutColumn(uiLayout *layout, int align);
823 uiLayout *uiLayoutColumnFlow(uiLayout *layout, int number, int align);
824 uiLayout *uiLayoutBox(uiLayout *layout);
825 uiLayout *uiLayoutListBox(uiLayout *layout, struct uiList *ui_list, struct PointerRNA *ptr, struct PropertyRNA *prop,
826                           struct PointerRNA *actptr, struct PropertyRNA *actprop);
827 uiLayout *uiLayoutAbsolute(uiLayout *layout, int align);
828 uiLayout *uiLayoutSplit(uiLayout *layout, float percentage, int align);
829 uiLayout *uiLayoutOverlap(uiLayout *layout);
830
831 uiBlock *uiLayoutAbsoluteBlock(uiLayout *layout);
832
833 /* templates */
834 void uiTemplateHeader(uiLayout *layout, struct bContext *C);
835 void uiTemplateID(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname,
836                   const char *newop, const char *openop, const char *unlinkop);
837 void uiTemplateIDBrowse(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname,
838                         const char *newop, const char *openop, const char *unlinkop);
839 void uiTemplateIDPreview(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname,
840                          const char *newop, const char *openop, const char *unlinkop, int rows, int cols);
841 void uiTemplateAnyID(uiLayout *layout, struct PointerRNA *ptr, const char *propname, 
842                      const char *proptypename, const char *text);
843 void uiTemplatePathBuilder(uiLayout *layout, struct PointerRNA *ptr, const char *propname, 
844                            struct PointerRNA *root_ptr, const char *text);
845 uiLayout *uiTemplateModifier(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr);
846 uiLayout *uiTemplateConstraint(uiLayout *layout, struct PointerRNA *ptr);
847 void uiTemplatePreview(uiLayout *layout, struct bContext *C, struct ID *id, int show_buttons, struct ID *parent,
848                        struct MTex *slot, const char *preview_id);
849 void uiTemplateColorRamp(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int expand);
850 void uiTemplateIconView(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
851 void uiTemplateHistogram(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
852 void uiTemplateWaveform(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
853 void uiTemplateVectorscope(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
854 void uiTemplateCurveMapping(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int type,
855                             int levels, int brush, int neg_slope);
856 void uiTemplateColorPicker(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int value_slider, int lock, int lock_luminosity, int cubic);
857 void uiTemplatePalette(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int color);
858 void uiTemplateLayers(uiLayout *layout, struct PointerRNA *ptr, const char *propname,
859                       PointerRNA *used_ptr, const char *used_propname, int active_layer);
860 void uiTemplateGameStates(uiLayout *layout, struct PointerRNA *ptr, const char *propname,
861                       PointerRNA *used_ptr, const char *used_propname, int active_state);
862 void uiTemplateImage(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname, struct PointerRNA *userptr, int compact);
863 void uiTemplateImageSettings(uiLayout *layout, struct PointerRNA *imfptr, int color_management);
864 void uiTemplateImageLayers(uiLayout *layout, struct bContext *C, struct Image *ima, struct ImageUser *iuser);
865 void uiTemplateRunningJobs(uiLayout *layout, struct bContext *C);
866 void uiOperatorSearch_But(uiBut *but);
867 void uiTemplateOperatorSearch(uiLayout *layout);
868 void uiTemplateHeader3D(uiLayout *layout, struct bContext *C);
869 void uiTemplateEditModeSelection(uiLayout *layout, struct bContext *C);
870 void uiTemplateReportsBanner(uiLayout *layout, struct bContext *C);
871 void uiTemplateKeymapItemProperties(uiLayout *layout, struct PointerRNA *ptr);
872 void uiTemplateComponentMenu(uiLayout *layout, struct PointerRNA *ptr, const char *propname, const char *name);
873 void uiTemplateNodeSocket(uiLayout *layout, struct bContext *C, float *color);
874
875 /* Default UIList class name, keep in sync with its declaration in bl_ui/__init__.py */
876 #define UI_UL_DEFAULT_CLASS_NAME "UI_UL_list"
877 void uiTemplateList(uiLayout *layout, struct bContext *C, const char *listtype_name, const char *list_id,
878                     struct PointerRNA *dataptr, const char *propname, struct PointerRNA *active_dataptr,
879                     const char *active_propname, int rows, int maxrows, int layout_type, int columns);
880 void uiTemplateNodeLink(uiLayout *layout, struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *input);
881 void uiTemplateNodeView(uiLayout *layout, struct bContext *C, struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *input);
882 void uiTemplateTextureUser(uiLayout *layout, struct bContext *C);
883 void uiTemplateTextureShow(uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop);
884
885 void uiTemplateMovieClip(struct uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname, int compact);
886 void uiTemplateTrack(struct uiLayout *layout, struct PointerRNA *ptr, const char *propname);
887 void uiTemplateMarker(struct uiLayout *layout, struct PointerRNA *ptr, const char *propname, PointerRNA *userptr, PointerRNA *trackptr, int cmpact);
888 void uiTemplateMovieclipInformation(struct uiLayout *layout, struct PointerRNA *ptr, const char *propname, struct PointerRNA *userptr);
889
890 void uiTemplateColorspaceSettings(struct uiLayout *layout, struct PointerRNA *ptr, const char *propname);
891 void uiTemplateColormanagedViewSettings(struct uiLayout *layout, struct bContext *C, struct PointerRNA *ptr, const char *propname);
892
893 /* items */
894 void uiItemO(uiLayout *layout, const char *name, int icon, const char *opname);
895 void uiItemEnumO_ptr(uiLayout *layout, struct wmOperatorType *ot, const char *name, int icon, const char *propname, int value);
896 void uiItemEnumO(uiLayout *layout, const char *opname, const char *name, int icon, const char *propname, int value);
897 void uiItemEnumO_value(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, int value);
898 void uiItemEnumO_string(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, const char *value);
899 void uiItemsEnumO(uiLayout *layout, const char *opname, const char *propname);
900 void uiItemBooleanO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, int value);
901 void uiItemIntO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, int value);
902 void uiItemFloatO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, float value);
903 void uiItemStringO(uiLayout *layout, const char *name, int icon, const char *opname, const char *propname, const char *value);
904
905 PointerRNA uiItemFullO_ptr(uiLayout *layout, struct wmOperatorType *ot, const char *name, int icon, IDProperty *properties, int context, int flag);
906 PointerRNA uiItemFullO(uiLayout *layout, const char *idname, const char *name, int icon, struct IDProperty *properties, int context, int flag);
907
908 void uiItemR(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int flag, const char *name, int icon);
909 void uiItemFullR(uiLayout *layout, struct PointerRNA *ptr, struct PropertyRNA *prop, int index, int value, int flag, const char *name, int icon);
910 void uiItemEnumR(uiLayout *layout, const char *name, int icon, struct PointerRNA *ptr, const char *propname, int value);
911 void uiItemEnumR_string(uiLayout *layout, struct PointerRNA *ptr, const char *propname, const char *value, const char *name, int icon);
912 void uiItemsEnumR(uiLayout *layout, struct PointerRNA *ptr, const char *propname);
913 void uiItemPointerR(uiLayout *layout, struct PointerRNA *ptr, const char *propname, struct PointerRNA *searchptr, const char *searchpropname, const char *name, int icon);
914 void uiItemsFullEnumO(uiLayout *layout, const char *opname, const char *propname, struct IDProperty *properties, int context, int flag);
915
916 void uiItemL(uiLayout *layout, const char *name, int icon); /* label */
917 void uiItemLDrag(uiLayout *layout, struct PointerRNA *ptr, const char *name, int icon); /* label icon for dragging */
918 void uiItemM(uiLayout *layout, struct bContext *C, const char *menuname, const char *name, int icon); /* menu */
919 void uiItemV(uiLayout *layout, const char *name, int icon, int argval); /* value */
920 void uiItemS(uiLayout *layout); /* separator */
921
922 void uiItemMenuF(uiLayout *layout, const char *name, int icon, uiMenuCreateFunc func, void *arg);
923 void uiItemMenuEnumO(uiLayout *layout, struct bContext *C, const char *opname, const char *propname, const char *name, int icon);
924 void uiItemMenuEnumR(uiLayout *layout, struct PointerRNA *ptr, const char *propname, const char *name, int icon);
925
926 /* UI Operators */
927 typedef struct uiDragColorHandle {
928         float color[3];
929         bool gamma_corrected;
930 } uiDragColorHandle;
931
932 void UI_buttons_operatortypes(void);
933 void UI_drop_color_copy(struct wmDrag *drag, struct wmDropBox *drop);
934 int UI_drop_color_poll(struct bContext *C, struct wmDrag *drag, const struct wmEvent *event);
935
936 /* Helpers for Operators */
937 uiBut *uiContextActiveButton(const struct bContext *C);
938 void uiContextActiveProperty(const struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA **prop, int *index);
939 void uiContextActivePropertyHandle(struct bContext *C);
940 struct wmOperator *uiContextActiveOperator(const struct bContext *C);
941 void uiContextAnimUpdate(const struct bContext *C);
942 void uiFileBrowseContextProperty(const struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA **prop);
943 void uiIDContextProperty(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA **prop);
944
945 /* Styled text draw */
946 void uiStyleFontSet(struct uiFontStyle *fs);
947 void uiStyleFontDrawExt(struct uiFontStyle *fs, const struct rcti *rect, const char *str,
948                         size_t len, float *r_xofs, float *r_yofs);
949 void uiStyleFontDraw(struct uiFontStyle *fs, const struct rcti *rect, const char *str);
950 void uiStyleFontDrawRotated(struct uiFontStyle *fs, const struct rcti *rect, const char *str);
951
952 int UI_GetStringWidth(const char *str); // XXX temp
953 void UI_DrawString(float x, float y, const char *str); // XXX temp
954 void UI_DrawTriIcon(float x, float y, char dir);
955
956 uiStyle *UI_GetStyle(void);             /* use for fonts etc */
957 uiStyle *UI_GetStyleDraw(void); /* DPI scaled settings for drawing */
958
959 /* linker workaround ack! */
960 void UI_template_fix_linking(void);
961
962 /* UI_OT_editsource helpers */
963 bool UI_editsource_enable_check(void);
964 void UI_editsource_active_but_test(uiBut *but);
965
966 /* UI_butstore_ helpers */
967 typedef struct uiButStore uiButStore;
968 typedef struct uiButStoreElem uiButStoreElem;
969
970 uiButStore *UI_butstore_create(uiBlock *block);
971 void UI_butstore_clear(uiBlock *block);
972 void UI_butstore_update(uiBlock *block);
973 void UI_butstore_free(uiBlock *block, uiButStore *bs);
974 bool UI_butstore_is_valid(uiButStore *bs);
975 bool UI_butstore_is_registered(uiBlock *block, uiBut *but);
976 void UI_butstore_register(uiButStore *bs_handle, uiBut **but_p);
977 void UI_butstore_unregister(uiButStore *bs_handle, uiBut **but_p);
978
979
980 /* Float precision helpers */
981 #define UI_PRECISION_FLOAT_MAX 7
982
983 int uiFloatPrecisionCalc(int prec, double value);
984
985 #endif  /* __UI_INTERFACE_H__ */