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