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