Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / interface / interface_intern.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 blender/editors/interface/interface_intern.h
29  *  \ingroup edinterface
30  */
31
32
33 #ifndef __INTERFACE_INTERN_H__
34 #define __INTERFACE_INTERN_H__
35
36 #include "BLI_compiler_attrs.h"
37 #include "UI_resources.h"
38 #include "RNA_types.h"
39 #include "DNA_listBase.h"
40
41 struct ARegion;
42 struct bContext;
43 struct uiHandleButtonData;
44 struct wmEvent;
45 struct wmKeyConfig;
46 struct wmOperatorType;
47 struct wmTimer;
48 struct uiStyle;
49 struct uiWidgetColors;
50 struct uiLayout;
51 struct bContextStore;
52 struct Scene;
53 struct ID;
54 struct ImBuf;
55
56 /* ****************** general defines ************** */
57
58 #define RNA_NO_INDEX    -1
59 #define RNA_ENUM_VALUE  -2
60
61 /* visual types for drawing */
62 /* for time being separated from functional types */
63 typedef enum {
64         /* default */
65         UI_WTYPE_REGULAR,
66
67         /* standard set */
68         UI_WTYPE_LABEL,
69         UI_WTYPE_TOGGLE,
70         UI_WTYPE_CHECKBOX,
71         UI_WTYPE_RADIO,
72         UI_WTYPE_NUMBER,
73         UI_WTYPE_SLIDER,
74         UI_WTYPE_EXEC,
75         UI_WTYPE_TOOLTIP,
76         
77         /* strings */
78         UI_WTYPE_NAME,
79         UI_WTYPE_NAME_LINK,
80         UI_WTYPE_POINTER_LINK,
81         UI_WTYPE_FILENAME,
82         
83         /* menus */
84         UI_WTYPE_MENU_RADIO,
85         UI_WTYPE_MENU_ICON_RADIO,
86         UI_WTYPE_MENU_POINTER_LINK,
87         UI_WTYPE_MENU_NODE_LINK,
88         
89         UI_WTYPE_PULLDOWN,
90         UI_WTYPE_MENU_ITEM,
91         UI_WTYPE_MENU_ITEM_RADIAL,
92         UI_WTYPE_MENU_BACK,
93
94         /* specials */
95         UI_WTYPE_ICON,
96         UI_WTYPE_ICON_LABEL,
97         UI_WTYPE_SWATCH,
98         UI_WTYPE_RGB_PICKER,
99         UI_WTYPE_UNITVEC,
100         UI_WTYPE_BOX,
101         UI_WTYPE_SCROLL,
102         UI_WTYPE_LISTITEM,
103         UI_WTYPE_PROGRESSBAR,
104 } uiWidgetTypeEnum;
105
106 /* menu scrolling */
107 #define UI_MENU_SCROLL_ARROW    12
108 #define UI_MENU_SCROLL_MOUSE    (UI_MENU_SCROLL_ARROW + 2)
109 #define UI_MENU_SCROLL_PAD              4
110
111 /* panel limits */
112 #define UI_PANEL_MINX   100
113 #define UI_PANEL_MINY   70
114
115 /* uiBut->flag */
116 enum {
117         UI_SELECT       = (1 << 0),  /* use when the button is pressed */
118         UI_SCROLLED     = (1 << 1),  /* temp hidden, scrolled away */
119         UI_ACTIVE       = (1 << 2),
120         UI_HAS_ICON     = (1 << 3),
121         UI_TEXTINPUT    = (1 << 4),
122         UI_HIDDEN       = (1 << 5),
123         /* warn: rest of uiBut->flag in UI_interface.h */
124 };
125
126 /* some buttons display icons only under special conditions
127  * (e.g. 'x' icon in search menu) - used with ui_but_icon_extra_get */
128 typedef enum uiButExtraIconType {
129         UI_BUT_ICONEXTRA_NONE = 1,
130         UI_BUT_ICONEXTRA_CLEAR,
131         UI_BUT_ICONEXTRA_EYEDROPPER,
132 } uiButExtraIconType;
133
134 /* uiBut->dragflag */
135 enum {
136         UI_BUT_DRAGPOIN_FREE = (1 << 0),
137 };
138
139 /* but->pie_dir */
140 typedef enum RadialDirection {
141         UI_RADIAL_NONE  = -1,
142         UI_RADIAL_N     =  0,
143         UI_RADIAL_NE    =  1,
144         UI_RADIAL_E     =  2,
145         UI_RADIAL_SE    =  3,
146         UI_RADIAL_S     =  4,
147         UI_RADIAL_SW    =  5,
148         UI_RADIAL_W     =  6,
149         UI_RADIAL_NW    =  7,
150 } RadialDirection;
151
152 extern const char  ui_radial_dir_order[8];
153 extern const char  ui_radial_dir_to_numpad[8];
154 extern const short ui_radial_dir_to_angle[8];
155
156 /* internal panel drawing defines */
157 #define PNL_GRID    (UI_UNIT_Y / 5) /* 4 default */
158 #define PNL_HEADER  (UI_UNIT_Y + 4) /* 24 default */
159
160 /* bit button defines */
161 /* Bit operations */
162 #define UI_BITBUT_TEST(a, b)    ( ( (a) & 1 << (b) ) != 0)
163 #define UI_BITBUT_SET(a, b)     ( (a) | 1 << (b) )
164 #define UI_BITBUT_CLR(a, b)     ( (a) & ~(1 << (b)) )
165 /* bit-row */
166 #define UI_BITBUT_ROW(min, max)  (((max) >= 31 ? 0xFFFFFFFF : (1 << ((max) + 1)) - 1) - ((min) ? ((1 << (min)) - 1) : 0) )
167
168 /* split numbuts by ':' and align l/r */
169 #define USE_NUMBUTS_LR_ALIGN
170
171 /* Use new 'align' computation code. */
172 #define USE_UIBUT_SPATIAL_ALIGN
173
174 /* PieMenuData->flags */
175 enum {
176         UI_PIE_DEGREES_RANGE_LARGE  = (1 << 0),  /* pie menu item collision is detected at 90 degrees */
177         UI_PIE_INITIAL_DIRECTION    = (1 << 1),  /* use initial center of pie menu to calculate direction */
178         UI_PIE_DRAG_STYLE           = (1 << 2),  /* pie menu is drag style */
179         UI_PIE_INVALID_DIR          = (1 << 3),  /* mouse not far enough from center position  */
180         UI_PIE_CLICK_STYLE          = (1 << 4),  /* pie menu changed to click style, click to confirm  */
181         UI_PIE_ANIMATION_FINISHED   = (1 << 5),  /* pie animation finished, do not calculate any more motion  */
182         UI_PIE_GESTURE_END_WAIT     = (1 << 6),  /* pie gesture selection has been done, now wait for mouse motion to end */
183 };
184
185 #define PIE_CLICK_THRESHOLD_SQ 50.0f
186
187 /* max amount of items a radial menu (pie menu) can contain */
188 #define PIE_MAX_ITEMS 8
189
190 typedef struct uiLinkLine {  /* only for draw/edit */
191         struct uiLinkLine *next, *prev;
192         struct uiBut *from, *to;
193         short flag, deactive;
194 } uiLinkLine;
195
196 typedef struct {
197         void **poin;        /* pointer to original pointer */
198         void ***ppoin;      /* pointer to original pointer-array */
199         short *totlink;     /* if pointer-array, here is the total */
200         
201         short maxlink, pad;
202         short fromcode, tocode;
203         
204         ListBase lines;
205 } uiLink;
206
207 struct uiBut {
208         struct uiBut *next, *prev;
209         int flag, drawflag;
210         eButType         type;
211         eButPointerType  pointype;
212         short bit, bitnr, retval, strwidth, alignnr;
213         short ofs, pos, selsta, selend;
214
215         char *str;
216         char strdata[UI_MAX_NAME_STR];
217         char drawstr[UI_MAX_DRAW_STR];
218
219         rctf rect;  /* block relative coords */
220
221         char *poin;
222         float hardmin, hardmax, softmin, softmax;
223
224         /* both these values use depends on the button type
225          * (polymorphic struct or union would be nicer for this stuff) */
226
227         /* (type == UI_BTYPE_HSVCUBE),    Use UI_GRAD_* values.
228          * (type == UI_BTYPE_NUM),        Use to store RNA 'step' value, for dragging and click-step.
229          * (type == UI_BTYPE_LABEL),      Use (a1 == 1.0f) to use a2 as a blending factor (wow, this is imaginative!).
230          * (type == UI_BTYPE_SCROLL)      Use as scroll size.
231          * (type == UI_BTYPE_SEARCH_MENU) Use as number or rows.
232          * (type == UI_BTYPE_COLOR)       Use as indication of color palette
233          * (type == UI_BTYPE_PROGRESS_BAR) Use to store progress (0..1).
234          */
235         float a1;
236
237         /* (type == UI_BTYPE_HSVCIRCLE ), Use to store the luminosity.
238          * (type == UI_BTYPE_NUM),        Use to store RNA 'precision' value, for dragging and click-step.
239          * (type == UI_BTYPE_LABEL),      If (a1 == 1.0f) use a2 as a blending factor.
240          * (type == UI_BTYPE_SEARCH_MENU) Use as number or columns.
241          * (type == UI_BTYPE_COLOR)       Use as index in palette (not so good, needs refactor)
242          */
243         float a2;
244
245         unsigned char col[4];
246
247         uiButHandleFunc func;
248         void *func_arg1;
249         void *func_arg2;
250
251         uiButHandleNFunc funcN;
252         void *func_argN;
253
254         struct bContextStore *context;
255
256         uiButCompleteFunc autocomplete_func;
257         void *autofunc_arg;
258         
259         uiButSearchCreateFunc search_create_func;
260         uiButSearchFunc search_func;
261         void *search_arg;
262
263         uiButHandleRenameFunc rename_func;
264         void *rename_arg1;
265         void *rename_orig;
266
267         uiLink *link;
268         short linkto[2];  /* region relative coords */
269         
270         const char *tip;
271         uiButToolTipFunc tip_func;
272         void *tip_argN;
273
274         /* info on why button is disabled, displayed in tooltip */
275         const char *disabled_info;
276
277         BIFIconID icon;
278         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSS_NONE ... etc, copied from the block */
279         signed char pie_dir; /* direction in a pie menu, used for collision detection (RadialDirection) */
280         char changed; /* could be made into a single flag */
281         unsigned char unit_type; /* so buttons can support unit systems which are not RNA */
282         short modifier_key;
283         short iconadd;
284
285         /* UI_BTYPE_BLOCK data */
286         uiBlockCreateFunc block_create_func;
287
288         /* UI_BTYPE_PULLDOWN/UI_BTYPE_MENU data */
289         uiMenuCreateFunc menu_create_func;
290
291         uiMenuStepFunc menu_step_func;
292
293         /* RNA data */
294         struct PointerRNA rnapoin;
295         struct PropertyRNA *rnaprop;
296         int rnaindex;
297
298         struct PointerRNA rnasearchpoin;
299         struct PropertyRNA *rnasearchprop;
300
301         /* Operator data */
302         struct wmOperatorType *optype;
303         struct PointerRNA *opptr;
304         short opcontext;
305         unsigned char menu_key; /* 'a'-'z', always lower case */
306
307         /* Draggable data, type is WM_DRAG_... */
308         char dragtype;
309         short dragflag;
310         void *dragpoin;
311         struct ImBuf *imb;
312         float imb_scale;
313         
314         /* active button data */
315         struct uiHandleButtonData *active;
316
317         /* Custom button data. */
318         void *custom_data;
319
320         char *editstr;
321         double *editval;
322         float *editvec;
323         void *editcoba;
324         void *editcumap;
325         
326         /* pointer back */
327         uiBlock *block;
328 };
329
330 typedef struct ColorPicker {
331         struct ColorPicker *next, *prev;
332         float color_data[3]; /* colr data may be HSV or HSL for now */
333         int representation; /* store hsv/hsl value */
334 } ColorPicker;
335
336 typedef struct ColorPickerData {
337         ListBase list;
338 } ColorPickerData;
339
340 struct PieMenuData {
341         /* store title and icon to allow access when pie levels are created */
342         const char *title;
343         int icon;
344
345         float pie_dir[2];
346         float pie_center_init[2];
347         float pie_center_spawned[2];
348         float last_pos[2];
349         double duration_gesture;
350         int flags;
351         int event; /* initial event used to fire the pie menu, store here so we can query for release */
352         float alphafac;
353 };
354
355 struct uiBlock {
356         uiBlock *next, *prev;
357
358         ListBase buttons;
359         Panel *panel;
360         uiBlock *oldblock;
361
362         ListBase butstore;  /* UI_butstore_* runtime function */
363
364         ListBase layouts;
365         struct uiLayout *curlayout;
366
367         ListBase contexts;
368         
369         char name[UI_MAX_NAME_STR];
370         
371         float winmat[4][4];
372
373         rctf rect;
374         float aspect;
375
376         unsigned int puphash;  /* popup menu hash for memory */
377
378         uiButHandleFunc func;
379         void *func_arg1;
380         void *func_arg2;
381
382         uiButHandleNFunc funcN;
383         void *func_argN;
384
385         uiMenuHandleFunc butm_func;
386         void *butm_func_arg;
387
388         uiBlockHandleFunc handle_func;
389         void *handle_func_arg;
390         
391         /* custom extra handling */
392         int (*block_event_func)(const struct bContext *C, struct uiBlock *, const struct wmEvent *);
393         
394         /* extra draw function for custom blocks */
395         void (*drawextra)(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect);
396         void *drawextra_arg1;
397         void *drawextra_arg2;
398
399         int flag;
400         short alignnr;
401
402         char direction;
403         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSS_NONE ... etc, copied to buttons */
404         bool auto_open;
405         char _pad[7];
406         double auto_open_last;
407
408         const char *lockstr;
409
410         char lock;
411         char active;                /* to keep blocks while drawing and free them afterwards */
412         char tooltipdisabled;       /* to avoid tooltip after click */
413         char endblock;              /* UI_block_end done? */
414
415         eBlockBoundsCalc bounds_type;  /* for doing delayed */
416         int mx, my;
417         int bounds, minbounds;      /* for doing delayed */
418
419         rctf safety;                /* pulldowns, to detect outside, can differ per case how it is created */
420         ListBase saferct;           /* uiSafetyRct list */
421
422         uiPopupBlockHandle *handle; /* handle */
423
424         struct wmOperator *ui_operator; /* use so presets can find the operator, */
425                                         /* across menus and from nested popups which fail for operator context. */
426
427         void *evil_C;               /* XXX hack for dynamic operator enums */
428
429         struct UnitSettings *unit;  /* unit system, used a lot for numeric buttons so include here rather then fetching through the scene every time. */
430         ColorPickerData color_pickers; /* XXX, only accessed by color picker templates */
431
432         bool color_profile;         /* color profile for correcting linear colors for display */
433
434         char display_device[64]; /* display device name used to display this block,
435                                   * used by color widgets to transform colors from/to scene linear
436                                   */
437         struct PieMenuData pie_data;
438 };
439
440 typedef struct uiSafetyRct {
441         struct uiSafetyRct *next, *prev;
442         rctf parent;
443         rctf safety;
444 } uiSafetyRct;
445
446 /* interface.c */
447
448 extern void ui_linkline_remove(uiLinkLine *line, uiBut *but);
449
450 void ui_fontscale(short *points, float aspect);
451
452 extern bool ui_block_is_menu(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
453 extern bool ui_block_is_pie_menu(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
454 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
455 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
456 extern void ui_block_to_window_rctf(const struct ARegion *ar, uiBlock *block, rctf *rct_dst, const rctf *rct_src);
457 extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
458 extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
459 extern void ui_window_to_region(const ARegion *ar, int *x, int *y);
460 extern void ui_region_to_window(const struct ARegion *ar, int *x, int *y);
461 extern void ui_region_winrct_get_no_margin(const struct ARegion *ar, struct rcti *r_rect);
462
463 extern double ui_but_value_get(uiBut *but);
464 extern void ui_but_value_set(uiBut *but, double value);
465 extern void ui_but_hsv_set(uiBut *but);
466 extern void ui_but_v3_get(uiBut *but, float vec[3]);
467 extern void ui_but_v3_set(uiBut *but, const float vec[3]);
468
469 extern void ui_hsvcircle_vals_from_pos(
470         float *val_rad, float *val_dist, const rcti *rect,
471         const float mx, const float my);
472 extern void ui_hsvcircle_pos_from_vals(struct uiBut *but, const rcti *rect, float *hsv, float *xpos, float *ypos);
473 extern void ui_hsvcube_pos_from_vals(struct uiBut *but, const rcti *rect, float *hsv, float *xp, float *yp);
474 bool ui_but_is_colorpicker_display_space(struct uiBut *but);
475
476 extern void ui_but_string_get_ex(uiBut *but, char *str, const size_t maxlen, const int float_precision) ATTR_NONNULL();
477 extern void ui_but_string_get(uiBut *but, char *str, const size_t maxlen) ATTR_NONNULL();
478 extern char *ui_but_string_get_dynamic(uiBut *but, int *r_str_size);
479 extern void ui_but_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen) ATTR_NONNULL();
480 extern bool ui_but_string_set(struct bContext *C, uiBut *but, const char *str) ATTR_NONNULL();
481 extern bool ui_but_string_set_eval_num(struct bContext *C, uiBut *but, const char *str, double *value) ATTR_NONNULL();
482 extern int  ui_but_string_get_max_length(uiBut *but);
483 extern uiBut *ui_but_drag_multi_edit_get(uiBut *but);
484
485 void ui_def_but_icon(uiBut *but, const int icon, const int flag);
486 extern uiButExtraIconType ui_but_icon_extra_get(uiBut *but);
487
488 extern void ui_but_default_set(struct bContext *C, const bool all, const bool use_afterfunc);
489
490 extern void ui_but_update_ex(uiBut *but, const bool validate);
491 extern void ui_but_update(uiBut *but);
492 extern void ui_but_update_edited(uiBut *but);
493 extern bool ui_but_is_float(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
494 extern bool ui_but_is_bool(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
495 extern bool ui_but_is_unit(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
496 extern bool ui_but_is_compatible(const uiBut *but_a, const uiBut *but_b) ATTR_WARN_UNUSED_RESULT;
497 extern bool ui_but_is_rna_valid(uiBut *but) ATTR_WARN_UNUSED_RESULT;
498 extern bool ui_but_is_utf8(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
499 extern bool ui_but_supports_cycling(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
500
501 extern int  ui_but_is_pushed_ex(uiBut *but, double *value) ATTR_WARN_UNUSED_RESULT;
502 extern int  ui_but_is_pushed(uiBut *but) ATTR_WARN_UNUSED_RESULT;
503
504
505 extern void ui_block_bounds_calc(uiBlock *block);
506 extern void ui_block_translate(uiBlock *block, int x, int y);
507
508 extern struct ColorManagedDisplay *ui_block_cm_display_get(uiBlock *block);
509 void ui_block_cm_to_display_space_v3(uiBlock *block, float pixel[3]);
510 void ui_block_cm_to_scene_linear_v3(uiBlock *block, float pixel[3]);
511 void ui_block_cm_to_display_space_range(uiBlock *block, float *min, float *max);
512
513 /* interface_regions.c */
514
515 struct uiKeyNavLock {
516         /* set when we're using keyinput */
517         bool is_keynav;
518         /* only used to check if we've moved the cursor */
519         int event_xy[2];
520 };
521
522 typedef uiBlock * (*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1);
523
524 struct uiPopupBlockCreate {
525         uiBlockCreateFunc              create_func;
526         uiBlockHandleCreateFunc handle_create_func;
527         void *arg;
528
529         int event_xy[2];
530
531         /* when popup is initialized from a button */
532         ARegion *butregion;
533 };
534
535 struct uiPopupBlockHandle {
536         /* internal */
537         struct ARegion *region;
538
539         /* use only for 'UI_BLOCK_MOVEMOUSE_QUIT' popups */
540         float towards_xy[2];
541         double towardstime;
542         bool dotowards;
543
544         bool popup;
545         void (*popup_func)(struct bContext *C, void *arg, int event);
546         void (*cancel_func)(struct bContext *C, void *arg);
547         void *popup_arg;
548         
549         /* store data for refreshing popups */
550         struct uiPopupBlockCreate popup_create_vars;
551         /* true if we can re-create the popup using 'popup_create_vars' */
552         bool can_refresh;
553
554         struct wmTimer *scrolltimer;
555
556         struct uiKeyNavLock keynav_state;
557
558         /* for operator popups */
559         struct wmOperatorType *optype;
560         ScrArea *ctx_area;
561         ARegion *ctx_region;
562         int opcontext;
563         
564         /* return values */
565         int butretval;
566         int menuretval;
567         int   retvalue;
568         float retvec[4];
569
570         /* menu direction */
571         int direction;
572
573 /* #ifdef USE_DRAG_POPUP */
574         bool is_grab;
575         int     grab_xy_prev[2];
576 /* #endif */
577 };
578
579 uiBlock *ui_block_func_COLOR(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
580
581 struct ARegion *ui_tooltip_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
582 void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
583
584 uiBut *ui_popup_menu_memory_get(struct uiBlock *block);
585 void   ui_popup_menu_memory_set(uiBlock *block, struct uiBut *but);
586
587 void   ui_popup_translate(struct bContext *C, struct ARegion *ar, const int mdiff[2]);
588
589 ColorPicker *ui_block_colorpicker_create(struct uiBlock *block);
590 void ui_popup_block_scrolltest(struct uiBlock *block);
591
592 void ui_rgb_to_color_picker_compat_v(const float rgb[3], float r_cp[3]);
593 void ui_rgb_to_color_picker_v(const float rgb[3], float r_cp[3]);
594 void ui_color_picker_to_rgb_v(const float r_cp[3], float rgb[3]);
595 void ui_color_picker_to_rgb(float r_cp0, float r_cp1, float r_cp2, float *r, float *g, float *b);
596
597 /* searchbox for string button */
598 ARegion *ui_searchbox_create_generic(struct bContext *C, struct ARegion *butregion, uiBut *but);
599 ARegion *ui_searchbox_create_operator(struct bContext *C, struct ARegion *butregion, uiBut *but);
600 bool ui_searchbox_inside(struct ARegion *ar, int x, int y);
601 int  ui_searchbox_find_index(struct ARegion *ar, const char *name);
602 void ui_searchbox_update(struct bContext *C, struct ARegion *ar, uiBut *but, const bool reset);
603 int ui_searchbox_autocomplete(struct bContext *C, struct ARegion *ar, uiBut *but, char *str);
604 void ui_searchbox_event(struct bContext *C, struct ARegion *ar, uiBut *but, const struct wmEvent *event);
605 bool ui_searchbox_apply(uiBut *but, struct ARegion *ar);
606 void ui_searchbox_free(struct bContext *C, struct ARegion *ar);
607 void ui_but_search_refresh(uiBut *but);
608
609 uiBlock *ui_popup_block_refresh(
610         struct bContext *C, uiPopupBlockHandle *handle,
611         ARegion *butregion, uiBut *but);
612
613 uiPopupBlockHandle *ui_popup_block_create(
614         struct bContext *C, struct ARegion *butregion, uiBut *but,
615         uiBlockCreateFunc create_func, uiBlockHandleCreateFunc handle_create_func,
616         void *arg);
617 uiPopupBlockHandle *ui_popup_menu_create(
618         struct bContext *C, struct ARegion *butregion, uiBut *but,
619         uiMenuCreateFunc create_func, void *arg);
620
621 void ui_pie_menu_level_create(
622         uiBlock *block, struct wmOperatorType *ot, const char *propname, IDProperty *properties,
623         const EnumPropertyItem *items, int totitem, int context, int flag);
624
625 void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
626
627 int  ui_but_menu_step(uiBut *but, int step);
628 bool ui_but_menu_step_poll(const uiBut *but);
629
630
631 /* interface_panel.c */
632 extern int ui_handler_panel_region(
633         struct bContext *C, const struct wmEvent *event,
634         struct ARegion *ar, const uiBut *active_but);
635 extern void ui_draw_aligned_panel(struct uiStyle *style, uiBlock *block, const rcti *rect, const bool show_pin);
636
637 /* interface_draw.c */
638 extern void ui_draw_dropshadow(const rctf *rct, float radius, float aspect, float alpha, int select);
639
640 void ui_draw_gradient(const rcti *rect, const float hsv[3], const int type, const float alpha);
641
642 void ui_draw_but_HISTOGRAM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
643 void ui_draw_but_WAVEFORM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
644 void ui_draw_but_VECTORSCOPE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
645 void ui_draw_but_COLORBAND(uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
646 void ui_draw_but_UNITVEC(uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
647 void ui_draw_but_CURVE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
648 void ui_draw_but_IMAGE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
649 void ui_draw_but_TRACKPREVIEW(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
650 void ui_draw_but_NODESOCKET(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
651
652 /* interface_handlers.c */
653 PointerRNA *ui_handle_afterfunc_add_operator(struct wmOperatorType *ot, int opcontext, bool create_props);
654 extern void ui_pan_to_scroll(const struct wmEvent *event, int *type, int *val);
655 extern void ui_but_activate_event(struct bContext *C, struct ARegion *ar, uiBut *but);
656 extern void ui_but_activate_over(struct bContext *C, struct ARegion *ar, uiBut *but);
657 extern void ui_but_execute_begin(struct bContext *C, struct ARegion *ar, uiBut *but, void **active_back);
658 extern void ui_but_execute_end(struct bContext *C, struct ARegion *ar, uiBut *but, void *active_back);
659 extern void ui_but_active_free(const struct bContext *C, uiBut *but);
660 extern bool ui_but_is_active(struct ARegion *ar) ATTR_WARN_UNUSED_RESULT;
661 extern int ui_but_menu_direction(uiBut *but);
662 extern void ui_but_text_password_hide(char password_str[UI_MAX_DRAW_STR], uiBut *but, const bool restore);
663 extern uiBut *ui_but_find_select_in_enum(uiBut *but, int direction);
664 extern uiBut *ui_but_find_active_in_region(struct ARegion *ar);
665 extern uiBut *ui_but_find_mouse_over(struct ARegion *ar, const struct wmEvent *event);
666 bool ui_but_is_editable(const uiBut *but);
667 bool ui_but_is_editable_as_text(const uiBut *but);
668 void ui_but_pie_dir_visual(RadialDirection dir, float vec[2]);
669 void ui_but_pie_dir(RadialDirection dir, float vec[2]);
670 float ui_block_calc_pie_segment(struct uiBlock *block, const float event_xy[2]);
671
672 void ui_but_add_shortcut(uiBut *but, const char *key_str, const bool do_strip);
673 void ui_but_clipboard_free(void);
674 void ui_panel_menu(struct bContext *C, ARegion *ar, Panel *pa);
675 uiBut *ui_but_find_old(uiBlock *block_old, const uiBut *but_new);
676 uiBut *ui_but_find_new(uiBlock *block_old, const uiBut *but_new);
677
678 #ifdef WITH_INPUT_IME
679 void ui_but_ime_reposition(uiBut *but, int x, int y, bool complete);
680 struct wmIMEData *ui_but_ime_data_get(uiBut *but);
681 #endif
682
683 /* interface_widgets.c */
684 void ui_draw_anti_tria(float x1, float y1, float x2, float y2, float x3, float y3);
685 void ui_draw_anti_roundbox(int mode, float minx, float miny, float maxx, float maxy,
686                            float rad, bool use_alpha, const float color[4]);
687 void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect);
688 void ui_draw_pie_center(uiBlock *block);
689 uiWidgetColors *ui_tooltip_get_theme(void);
690 void ui_draw_tooltip_background(uiStyle *UNUSED(style), uiBlock *block, rcti *rect);
691 void ui_draw_search_back(struct uiStyle *style, uiBlock *block, rcti *rect);
692 bool ui_link_bezier_points(const rcti *rect, float coord_array[][2], int resol);
693 void ui_draw_link_bezier(const rcti *rect);
694
695 extern void ui_draw_but(const struct bContext *C, ARegion *ar, struct uiStyle *style, uiBut *but, rcti *rect);
696 /* theme color init */
697 struct ThemeUI;
698 void ui_widget_color_init(struct ThemeUI *tui);
699
700 void ui_draw_menu_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state, bool use_sep);
701 void ui_draw_preview_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
702
703 #define UI_TEXT_MARGIN_X 0.4f
704 #define UI_POPUP_MARGIN (UI_DPI_FAC * 12)
705 /* margin at top of screen for popups */
706 #define UI_POPUP_MENU_TOP (int)(8 * UI_DPI_FAC)
707
708 /* interface_style.c */
709 void uiStyleInit(void);
710
711 /* interface_icons.c */
712 void ui_icon_ensure_deferred(const struct bContext *C, const int icon_id, const bool big);
713 int ui_id_icon_get(const struct bContext *C, struct ID *id, const bool big);
714
715 /* resources.c */
716 void init_userdef_do_versions(void);
717 void ui_theme_init_default(void);
718 void ui_style_init_default(void);
719 void ui_resources_init(void);
720 void ui_resources_free(void);
721
722 /* interface_layout.c */
723 void ui_layout_add_but(uiLayout *layout, uiBut *but);
724 void ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop);
725 void ui_layout_list_set_labels_active(uiLayout *layout);
726
727 /* interface_align.c */
728 bool ui_but_can_align(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
729 void ui_block_align_calc(uiBlock *block);
730
731 /* interface_anim.c */
732 void ui_but_anim_flag(uiBut *but, float cfra);
733 void ui_but_anim_copy_driver(struct bContext *C);
734 void ui_but_anim_paste_driver(struct bContext *C);
735 bool ui_but_anim_expression_get(uiBut *but, char *str, size_t maxlen);
736 bool ui_but_anim_expression_set(uiBut *but, const char *str);
737 bool ui_but_anim_expression_create(uiBut *but, const char *str);
738 void ui_but_anim_autokey(struct bContext *C, uiBut *but, struct Scene *scene, float cfra);
739
740 /* interface_eyedropper.c */
741 struct wmKeyMap *eyedropper_modal_keymap(struct wmKeyConfig *keyconf);
742 void UI_OT_eyedropper_color(struct wmOperatorType *ot);
743 void UI_OT_eyedropper_id(struct wmOperatorType *ot);
744 void UI_OT_eyedropper_depth(struct wmOperatorType *ot);
745 void UI_OT_eyedropper_driver(struct wmOperatorType *ot);
746
747 #endif  /* __INTERFACE_INTERN_H__ */