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