Cleanup: minor UI code changes
[blender.git] / source / blender / editors / interface / interface_intern.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup edinterface
22  */
23
24
25 #ifndef __INTERFACE_INTERN_H__
26 #define __INTERFACE_INTERN_H__
27
28 #include "BLI_compiler_attrs.h"
29 #include "UI_resources.h"
30 #include "RNA_types.h"
31 #include "DNA_listBase.h"
32
33 struct ARegion;
34 struct ID;
35 struct ImBuf;
36 struct Scene;
37 struct bContext;
38 struct bContextStore;
39 struct uiHandleButtonData;
40 struct uiLayout;
41 struct uiStyle;
42 struct uiWidgetColors;
43 struct wmEvent;
44 struct wmKeyConfig;
45 struct wmOperatorType;
46 struct wmTimer;
47
48 /* ****************** general defines ************** */
49
50 #define RNA_NO_INDEX    -1
51 #define RNA_ENUM_VALUE  -2
52
53 #define UI_MENU_PADDING (int)(0.2f * UI_UNIT_Y)
54
55 #define UI_MENU_WIDTH_MIN       (UI_UNIT_Y * 9)
56 /* some extra padding added to menus containing submenu icons */
57 #define UI_MENU_SUBMENU_PADDING (6 * UI_DPI_FAC)
58
59 /* menu scrolling */
60 #define UI_MENU_SCROLL_ARROW    12
61 #define UI_MENU_SCROLL_MOUSE    (UI_MENU_SCROLL_ARROW + 2)
62 #define UI_MENU_SCROLL_PAD              4
63
64 /* panel limits */
65 #define UI_PANEL_MINX   100
66 #define UI_PANEL_MINY   70
67
68 /* popover width (multiplied by 'U.widget_unit') */
69 #define UI_POPOVER_WIDTH_UNITS 10
70
71 /* uiBut->flag */
72 enum {
73         UI_SELECT       = (1 << 0),  /* use when the button is pressed */
74         UI_SCROLLED     = (1 << 1),  /* temp hidden, scrolled away */
75         UI_ACTIVE       = (1 << 2),
76         UI_HAS_ICON     = (1 << 3),
77         UI_HIDDEN       = (1 << 4),
78         UI_SELECT_DRAW  = (1 << 5),  /* Display selected, doesn't impact interaction. */
79         /* warn: rest of uiBut->flag in UI_interface.h */
80 };
81
82 /* some buttons display icons only under special conditions
83  * (e.g. 'x' icon in search menu) - used with ui_but_icon_extra_get */
84 typedef enum uiButExtraIconType {
85         UI_BUT_ICONEXTRA_NONE = 1,
86         UI_BUT_ICONEXTRA_CLEAR,
87         UI_BUT_ICONEXTRA_EYEDROPPER,
88 } uiButExtraIconType;
89
90 /* uiBut->dragflag */
91 enum {
92         UI_BUT_DRAGPOIN_FREE = (1 << 0),
93 };
94
95 /* but->pie_dir */
96 typedef enum RadialDirection {
97         UI_RADIAL_NONE  = -1,
98         UI_RADIAL_N     =  0,
99         UI_RADIAL_NE    =  1,
100         UI_RADIAL_E     =  2,
101         UI_RADIAL_SE    =  3,
102         UI_RADIAL_S     =  4,
103         UI_RADIAL_SW    =  5,
104         UI_RADIAL_W     =  6,
105         UI_RADIAL_NW    =  7,
106 } RadialDirection;
107
108 extern const char  ui_radial_dir_order[8];
109 extern const char  ui_radial_dir_to_numpad[8];
110 extern const short ui_radial_dir_to_angle[8];
111
112 /* internal panel drawing defines */
113 #define PNL_GRID    (UI_UNIT_Y / 5) /* 4 default */
114 #define PNL_HEADER  (UI_UNIT_Y * 1.2)  /* 24 default */
115
116 /* bit button defines */
117 /* Bit operations */
118 #define UI_BITBUT_TEST(a, b)    ( ( (a) & 1 << (b) ) != 0)
119 #define UI_BITBUT_SET(a, b)     ( (a) | 1 << (b) )
120 #define UI_BITBUT_CLR(a, b)     ( (a) & ~(1 << (b)) )
121 /* bit-row */
122 #define UI_BITBUT_ROW(min, max)  (((max) >= 31 ? 0xFFFFFFFF : (1 << ((max) + 1)) - 1) - ((min) ? ((1 << (min)) - 1) : 0) )
123
124 /* split numbuts by ':' and align l/r */
125 #define USE_NUMBUTS_LR_ALIGN
126
127 /* Use new 'align' computation code. */
128 #define USE_UIBUT_SPATIAL_ALIGN
129
130 /* PieMenuData->flags */
131 enum {
132         /** pie menu item collision is detected at 90 degrees */
133         UI_PIE_DEGREES_RANGE_LARGE  = (1 << 0),
134         /** use initial center of pie menu to calculate direction */
135         UI_PIE_INITIAL_DIRECTION    = (1 << 1),
136         /** pie menu is drag style */
137         UI_PIE_DRAG_STYLE           = (1 << 2),
138         /** mouse not far enough from center position  */
139         UI_PIE_INVALID_DIR          = (1 << 3),
140         /** pie menu changed to click style, click to confirm  */
141         UI_PIE_CLICK_STYLE          = (1 << 4),
142         /** pie animation finished, do not calculate any more motion  */
143         UI_PIE_ANIMATION_FINISHED   = (1 << 5),
144         /** pie gesture selection has been done, now wait for mouse motion to end */
145         UI_PIE_GESTURE_END_WAIT     = (1 << 6),
146 };
147
148 #define PIE_CLICK_THRESHOLD_SQ 50.0f
149
150 /* max amount of items a radial menu (pie menu) can contain */
151 #define PIE_MAX_ITEMS 8
152
153 struct uiBut {
154         struct uiBut *next, *prev;
155         int flag, drawflag;
156         eButType         type;
157         eButPointerType  pointype;
158         short bit, bitnr, retval, strwidth, alignnr;
159         short ofs, pos, selsta, selend;
160
161         char *str;
162         char strdata[UI_MAX_NAME_STR];
163         char drawstr[UI_MAX_DRAW_STR];
164
165         rctf rect;  /* block relative coords */
166
167         char *poin;
168         float hardmin, hardmax, softmin, softmax;
169
170         /* both these values use depends on the button type
171          * (polymorphic struct or union would be nicer for this stuff) */
172
173         /* (type == UI_BTYPE_HSVCUBE),    Use UI_GRAD_* values.
174          * (type == UI_BTYPE_NUM),        Use to store RNA 'step' value, for dragging and click-step.
175          * (type == UI_BTYPE_LABEL),      Use (a1 == 1.0f) to use a2 as a blending factor (wow, this is imaginative!).
176          * (type == UI_BTYPE_SCROLL)      Use as scroll size.
177          * (type == UI_BTYPE_SEARCH_MENU) Use as number or rows.
178          * (type == UI_BTYPE_COLOR)       Use as indication of color palette
179          * (type == UI_BTYPE_PROGRESS_BAR) Use to store progress (0..1).
180          */
181         float a1;
182
183         /* (type == UI_BTYPE_HSVCIRCLE ), Use to store the luminosity.
184          * (type == UI_BTYPE_NUM),        Use to store RNA 'precision' value, for dragging and click-step.
185          * (type == UI_BTYPE_LABEL),      If (a1 == 1.0f) use a2 as a blending factor.
186          * (type == UI_BTYPE_SEARCH_MENU) Use as number or columns.
187          * (type == UI_BTYPE_COLOR)       Use as index in palette (not so good, needs refactor)
188          */
189         float a2;
190
191         uchar col[4];
192
193         uiButHandleFunc func;
194         void *func_arg1;
195         void *func_arg2;
196
197         uiButHandleNFunc funcN;
198         void *func_argN;
199
200         struct bContextStore *context;
201
202         uiButCompleteFunc autocomplete_func;
203         void *autofunc_arg;
204
205         uiButSearchCreateFunc search_create_func;
206         uiButSearchFunc search_func;
207         bool free_search_arg;
208         void *search_arg;
209
210         uiButHandleRenameFunc rename_func;
211         void *rename_arg1;
212         void *rename_orig;
213
214         /** Run an action when holding the button down. */
215         uiButHandleHoldFunc hold_func;
216         void *hold_argN;
217
218         const char *tip;
219         uiButToolTipFunc tip_func;
220         void *tip_argN;
221
222         /** info on why button is disabled, displayed in tooltip */
223         const char *disabled_info;
224
225         BIFIconID icon;
226         /** drawtype: UI_EMBOSS, UI_EMBOSS_NONE ... etc, copied from the block */
227         char dt;
228         /** direction in a pie menu, used for collision detection (RadialDirection) */
229         signed char pie_dir;
230         /** could be made into a single flag */
231         bool changed;
232         /** so buttons can support unit systems which are not RNA */
233         uchar unit_type;
234         short modifier_key;
235         short iconadd;
236
237         /* UI_BTYPE_BLOCK data */
238         uiBlockCreateFunc block_create_func;
239
240         /* UI_BTYPE_PULLDOWN/UI_BTYPE_MENU data */
241         uiMenuCreateFunc menu_create_func;
242
243         uiMenuStepFunc menu_step_func;
244
245         /* RNA data */
246         struct PointerRNA rnapoin;
247         struct PropertyRNA *rnaprop;
248         int rnaindex;
249
250         struct PointerRNA rnasearchpoin;
251         struct PropertyRNA *rnasearchprop;
252
253         /* Operator data */
254         struct wmOperatorType *optype;
255         struct PointerRNA *opptr;
256         short opcontext;
257         uchar menu_key; /* 'a'-'z', always lower case */
258
259         /* Draggable data, type is WM_DRAG_... */
260         char dragtype;
261         short dragflag;
262         void *dragpoin;
263         struct ImBuf *imb;
264         float imb_scale;
265
266         /* active button data */
267         struct uiHandleButtonData *active;
268
269         /* Custom button data. */
270         void *custom_data;
271
272         char *editstr;
273         double *editval;
274         float *editvec;
275         void *editcoba;
276         void *editcumap;
277
278         uiButPushedStateFunc pushed_state_func;
279         void *pushed_state_arg;
280
281         /* pointer back */
282         uiBlock *block;
283 };
284
285 typedef struct uiButTab {
286         uiBut but;
287         struct MenuType *menu;
288 } uiButTab;
289
290 typedef struct ColorPicker {
291         struct ColorPicker *next, *prev;
292         /** Color data, may be HSV or HSL. */
293         float color_data[3];
294         /** Initial color data (detect changes). */
295         float color_data_init[3];
296         bool is_init;
297         /** Cubic saturation for the color wheel. */
298         bool use_color_cubic;
299         bool use_color_lock;
300         bool use_luminosity_lock;
301         float luminosity_lock_value;
302 } ColorPicker;
303
304 typedef struct ColorPickerData {
305         ListBase list;
306 } ColorPickerData;
307
308 struct PieMenuData {
309         /** store title and icon to allow access when pie levels are created */
310         const char *title;
311         int icon;
312
313         float pie_dir[2];
314         float pie_center_init[2];
315         float pie_center_spawned[2];
316         float last_pos[2];
317         double duration_gesture;
318         int flags;
319         /** initial event used to fire the pie menu, store here so we can query for release */
320         int event;
321         float alphafac;
322 };
323
324 /* uiBlock.content_hints */
325 enum eBlockContentHints {
326         /** In a menu block, if there is a single sub-menu button, we add some
327          * padding to the right to put nicely aligned triangle icons there. */
328         UI_BLOCK_CONTAINS_SUBMENU_BUT = (1 << 0),
329 };
330
331 struct uiBlock {
332         uiBlock *next, *prev;
333
334         ListBase buttons;
335         Panel *panel;
336         uiBlock *oldblock;
337
338         ListBase butstore;  /* UI_butstore_* runtime function */
339
340         ListBase layouts;
341         struct uiLayout *curlayout;
342
343         ListBase contexts;
344
345         char name[UI_MAX_NAME_STR];
346
347         float winmat[4][4];
348
349         rctf rect;
350         float aspect;
351
352         uint puphash;  /* popup menu hash for memory */
353
354         uiButHandleFunc func;
355         void *func_arg1;
356         void *func_arg2;
357
358         uiButHandleNFunc funcN;
359         void *func_argN;
360
361         uiMenuHandleFunc butm_func;
362         void *butm_func_arg;
363
364         uiBlockHandleFunc handle_func;
365         void *handle_func_arg;
366
367         /* custom extra handling */
368         int (*block_event_func)(const struct bContext *C, struct uiBlock *, const struct wmEvent *);
369
370         /* extra draw function for custom blocks */
371         void (*drawextra)(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect);
372         void *drawextra_arg1;
373         void *drawextra_arg2;
374
375         int flag;
376         short alignnr;
377         /** Hints about the buttons of this block. Used to avoid iterating over
378          * buttons to find out if some criteria is met by any. Instead, check this
379          * criteria when adding the button and set a flag here if it's met. */
380         short content_hints; /* eBlockContentHints */
381
382         char direction;
383         /** UI_BLOCK_THEME_STYLE_* */
384         char theme_style;
385         /** drawtype: UI_EMBOSS, UI_EMBOSS_NONE ... etc, copied to buttons */
386         char dt;
387         bool auto_open;
388         char _pad[5];
389         double auto_open_last;
390
391         const char *lockstr;
392
393         char lock;
394         /** to keep blocks while drawing and free them afterwards */
395         char active;
396         /** to avoid tooltip after click */
397         char tooltipdisabled;
398         /** UI_block_end done? */
399         char endblock;
400
401         /** for doing delayed */
402         eBlockBoundsCalc bounds_type;
403         /** Offset to use when calculating bounds (in pixels). */
404         int bounds_offset[2];
405         /** for doing delayed */
406         int bounds, minbounds;
407
408         /** pulldowns, to detect outside, can differ per case how it is created */
409         rctf safety;
410         /** uiSafetyRct list */
411         ListBase saferct;
412
413         uiPopupBlockHandle *handle; /* handle */
414
415         /** use so presets can find the operator,
416          * across menus and from nested popups which fail for operator context. */
417         struct wmOperator *ui_operator;
418
419         /** XXX hack for dynamic operator enums */
420         void *evil_C;
421
422         /** unit system, used a lot for numeric buttons so include here
423          * rather then fetching through the scene every time. */
424         struct UnitSettings *unit;
425         /** \note only accessed by color picker templates. */
426         ColorPickerData color_pickers;
427
428         bool is_color_gamma_picker; /* Block for color picker with gamma baked in. */
429
430         /** display device name used to display this block,
431          * used by color widgets to transform colors from/to scene linear
432          */
433         char display_device[64];
434
435         struct PieMenuData pie_data;
436 };
437
438 typedef struct uiSafetyRct {
439         struct uiSafetyRct *next, *prev;
440         rctf parent;
441         rctf safety;
442 } uiSafetyRct;
443
444 /* interface.c */
445
446 void ui_fontscale(short *points, float aspect);
447
448 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
449 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
450 extern void ui_block_to_window_rctf(const struct ARegion *ar, uiBlock *block, rctf *rct_dst, const rctf *rct_src);
451 extern float ui_block_to_window_scale(const struct ARegion *ar, uiBlock *block);
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(const ColorPicker *cpicker, const rcti *rect, const float *hsv, float *xpos, float *ypos);
468 extern void ui_hsvcube_pos_from_vals(const struct uiBut *but, const rcti *rect, const float *hsv, float *xp, float *yp);
469
470 extern void ui_but_string_get_ex(
471         uiBut *but, char *str, const size_t maxlen,
472         const int float_precision, const bool use_exp_float, bool *r_use_exp_float) ATTR_NONNULL(1, 2);
473 extern void ui_but_string_get(uiBut *but, char *str, const size_t maxlen) ATTR_NONNULL();
474 extern char *ui_but_string_get_dynamic(uiBut *but, int *r_str_size);
475 extern void ui_but_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen) ATTR_NONNULL();
476 extern bool ui_but_string_set(struct bContext *C, uiBut *but, const char *str) ATTR_NONNULL();
477 extern bool ui_but_string_set_eval_num(struct bContext *C, uiBut *but, const char *str, double *value) ATTR_NONNULL();
478 extern int  ui_but_string_get_max_length(uiBut *but);
479 extern uiBut *ui_but_drag_multi_edit_get(uiBut *but);
480
481 void ui_def_but_icon(uiBut *but, const int icon, const int flag);
482 extern uiButExtraIconType ui_but_icon_extra_get(uiBut *but);
483
484 extern void ui_but_default_set(struct bContext *C, const bool all, const bool use_afterfunc);
485
486 extern void ui_but_update(uiBut *but);
487 extern void ui_but_update_edited(uiBut *but);
488 extern bool ui_but_is_float(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
489 extern bool ui_but_is_bool(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
490 extern bool ui_but_is_unit(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
491 extern bool ui_but_is_compatible(const uiBut *but_a, const uiBut *but_b) ATTR_WARN_UNUSED_RESULT;
492 extern bool ui_but_is_rna_valid(uiBut *but) ATTR_WARN_UNUSED_RESULT;
493 extern bool ui_but_supports_cycling(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
494
495 extern int  ui_but_is_pushed_ex(uiBut *but, double *value) ATTR_WARN_UNUSED_RESULT;
496 extern int  ui_but_is_pushed(uiBut *but) ATTR_WARN_UNUSED_RESULT;
497
498 void ui_but_override_flag(uiBut *but);
499
500 extern void ui_block_bounds_calc(uiBlock *block);
501
502 extern struct ColorManagedDisplay *ui_block_cm_display_get(uiBlock *block);
503 void ui_block_cm_to_display_space_v3(uiBlock *block, float pixel[3]);
504
505 /* interface_regions.c */
506
507 struct uiKeyNavLock {
508         /* set when we're using keyinput */
509         bool is_keynav;
510         /* only used to check if we've moved the cursor */
511         int event_xy[2];
512 };
513
514 typedef uiBlock * (*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1);
515 typedef void (*uiBlockHandleFreeFunc)(struct uiPopupBlockHandle *handle, void *arg1);
516
517 struct uiPopupBlockCreate {
518         uiBlockCreateFunc       create_func;
519         uiBlockHandleCreateFunc handle_create_func;
520         uiBlockHandleFreeFunc   free_func;
521         void *arg;
522
523         int event_xy[2];
524
525         /* when popup is initialized from a button */
526         ARegion *butregion;
527         uiBut *but;
528 };
529
530 struct uiPopupBlockHandle {
531         /* internal */
532         struct ARegion *region;
533
534         /* use only for 'UI_BLOCK_MOVEMOUSE_QUIT' popups */
535         float towards_xy[2];
536         double towardstime;
537         bool dotowards;
538
539         bool popup;
540         void (*popup_func)(struct bContext *C, void *arg, int event);
541         void (*cancel_func)(struct bContext *C, void *arg);
542         void *popup_arg;
543
544         /* store data for refreshing popups */
545         struct uiPopupBlockCreate popup_create_vars;
546         /* true if we can re-create the popup using 'popup_create_vars' */
547         bool can_refresh;
548         bool refresh;
549
550         struct wmTimer *scrolltimer;
551         float scrolloffset;
552
553         struct uiKeyNavLock keynav_state;
554
555         /* for operator popups */
556         struct wmOperator *popup_op;
557         struct wmOperatorType *optype;
558         ScrArea *ctx_area;
559         ARegion *ctx_region;
560         int opcontext;
561
562         /* return values */
563         int butretval;
564         int menuretval;
565         int   retvalue;
566         float retvec[4];
567
568         /* menu direction */
569         int direction;
570
571         /* Previous values so we don't resize or reposition on refresh. */
572         rctf prev_block_rect;
573         rctf prev_butrct;
574         short prev_dir1, prev_dir2;
575         int prev_bounds_offset[2];
576
577         /* Maximum estimated size to avoid having to reposition on refresh. */
578         float max_size_x, max_size_y;
579
580 /* #ifdef USE_DRAG_POPUP */
581         bool is_grab;
582         int     grab_xy_prev[2];
583 /* #endif */
584 };
585
586 /* -------------------------------------------------------------------- */
587 /* interface_region_*.c */
588
589 /* interface_region_tooltip.c */
590 /* exposed as public API in UI_interface.h */
591
592 /* interface_region_color_picker.c */
593 void ui_rgb_to_color_picker_compat_v(const float rgb[3], float r_cp[3]);
594 void ui_rgb_to_color_picker_v(const float rgb[3], float r_cp[3]);
595 void ui_color_picker_to_rgb_v(const float r_cp[3], float rgb[3]);
596 void ui_color_picker_to_rgb(float r_cp0, float r_cp1, float r_cp2, float *r, float *g, float *b);
597
598 bool ui_but_is_color_gamma(uiBut *but);
599
600 void ui_scene_linear_to_color_picker_space(uiBut *but, float rgb[3]);
601 void ui_color_picker_to_scene_linear_space(uiBut *but, float rgb[3]);
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 uiPopupBlockHandle *ui_popover_panel_create(
639         struct bContext *C, struct ARegion *butregion, uiBut *but,
640         uiMenuCreateFunc create_func, void *arg);
641
642 /* interface_region_menu_pie.c */
643 void ui_pie_menu_level_create(
644         uiBlock *block, struct wmOperatorType *ot, const char *propname, IDProperty *properties,
645         const EnumPropertyItem *items, int totitem, int context, int flag);
646
647 /* interface_region_popup.c */
648 void ui_popup_translate(struct ARegion *ar, const int mdiff[2]);
649 void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
650 void ui_popup_block_scrolltest(struct uiBlock *block);
651
652 /* end interface_region_*.c */
653
654
655 /* interface_panel.c */
656 extern int ui_handler_panel_region(
657         struct bContext *C, const struct wmEvent *event,
658         struct ARegion *ar, const uiBut *active_but);
659 extern void ui_draw_aligned_panel(
660         struct uiStyle *style, uiBlock *block, const rcti *rect,
661         const bool show_pin, const bool show_background);
662
663 /* interface_draw.c */
664 extern void ui_draw_dropshadow(const rctf *rct, float radius, float aspect, float alpha, int select);
665
666 void ui_draw_gradient(const rcti *rect, const float hsv[3], const int type, const float alpha);
667
668
669 void ui_draw_but_TAB_outline(const rcti *rect, float rad, uchar highlight[3], uchar highlight_fade[3]);
670 void ui_draw_but_HISTOGRAM(ARegion *ar, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
671 void ui_draw_but_WAVEFORM(ARegion *ar, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
672 void ui_draw_but_VECTORSCOPE(ARegion *ar, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
673 void ui_draw_but_COLORBAND(uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
674 void ui_draw_but_UNITVEC(uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
675 void ui_draw_but_CURVE(ARegion *ar, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
676 void ui_draw_but_IMAGE(ARegion *ar, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
677 void ui_draw_but_TRACKPREVIEW(ARegion *ar, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
678 void ui_draw_but_NODESOCKET(ARegion *ar, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
679
680 /* interface_handlers.c */
681 PointerRNA *ui_handle_afterfunc_add_operator(struct wmOperatorType *ot, int opcontext, bool create_props);
682 extern void ui_pan_to_scroll(const struct wmEvent *event, int *type, int *val);
683 extern void ui_but_activate_event(struct bContext *C, struct ARegion *ar, uiBut *but);
684 extern void ui_but_activate_over(struct bContext *C, struct ARegion *ar, uiBut *but);
685 extern void ui_but_execute_begin(struct bContext *C, struct ARegion *ar, uiBut *but, void **active_back);
686 extern void ui_but_execute_end(struct bContext *C, struct ARegion *ar, uiBut *but, void *active_back);
687 extern void ui_but_active_free(const struct bContext *C, uiBut *but);
688 extern int ui_but_menu_direction(uiBut *but);
689 extern void ui_but_text_password_hide(char password_str[UI_MAX_DRAW_STR], uiBut *but, const bool restore);
690 extern uiBut *ui_but_find_select_in_enum(uiBut *but, int direction);
691 bool ui_but_is_editing(const uiBut *but);
692 float ui_block_calc_pie_segment(struct uiBlock *block, const float event_xy[2]);
693
694 void ui_but_add_shortcut(uiBut *but, const char *key_str, const bool do_strip);
695 void ui_but_clipboard_free(void);
696 uiBut *ui_but_find_old(uiBlock *block_old, const uiBut *but_new);
697 uiBut *ui_but_find_new(uiBlock *block_old, const uiBut *but_new);
698
699 #ifdef WITH_INPUT_IME
700 void ui_but_ime_reposition(uiBut *but, int x, int y, bool complete);
701 struct wmIMEData *ui_but_ime_data_get(uiBut *but);
702 #endif
703
704 /* interface_widgets.c */
705
706 /* Widget shader parameters, must match the shader layout. */
707 typedef struct uiWidgetBaseParameters {
708         rctf recti, rect;
709         float radi, rad;
710         float facxi, facyi;
711         float round_corners[4];
712         float color_inner1[4], color_inner2[4];
713         float color_outline[4], color_emboss[4];
714         float color_tria[4];
715         float tria1_center[2], tria2_center[2];
716         float tria1_size, tria2_size;
717         float shade_dir;
718         /* We pack alpha check and discard factor in alpha_discard.
719          * If the value is negative then we do alpha check.
720          * The absolute value itself is the discard factor.
721          * Initialize value to 1.0.f if you don't want discard */
722         float alpha_discard;
723 } uiWidgetBaseParameters;
724
725 enum {
726         ROUNDBOX_TRIA_NONE = 0,
727         ROUNDBOX_TRIA_ARROWS,
728         ROUNDBOX_TRIA_SCROLL,
729         ROUNDBOX_TRIA_MENU,
730         ROUNDBOX_TRIA_CHECK,
731         ROUNDBOX_TRIA_HOLD_ACTION_ARROW,
732
733         ROUNDBOX_TRIA_MAX, /* don't use */
734 };
735
736 struct GPUBatch *ui_batch_roundbox_get(bool filled, bool antialiased);
737 struct GPUBatch *ui_batch_roundbox_widget_get(int tria);
738 struct GPUBatch *ui_batch_roundbox_shadow_get(void);
739
740 void ui_draw_anti_tria_rect(const rctf *rect, char dir, const float color[4]);
741 void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect);
742 void ui_draw_popover_back(ARegion *ar, struct uiStyle *style, uiBlock *block, rcti *rect);
743 void ui_draw_pie_center(uiBlock *block);
744 const struct uiWidgetColors *ui_tooltip_get_theme(void);
745
746 void ui_draw_widget_menu_back_color(const rcti *rect, bool use_shadow, const float color[4]);
747 void ui_draw_widget_menu_back(const rcti *rect, bool use_shadow);
748 void ui_draw_tooltip_background(struct uiStyle *UNUSED(style), uiBlock *block, rcti *rect);
749
750 extern void ui_draw_but(const struct bContext *C, ARegion *ar, struct uiStyle *style, uiBut *but, rcti *rect);
751
752 void ui_draw_menu_item(const struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state, bool use_sep);
753 void ui_draw_preview_item(const struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
754
755 #define UI_TEXT_MARGIN_X 0.4f
756 #define UI_POPUP_MARGIN (UI_DPI_FAC * 12)
757 /* margin at top of screen for popups */
758 #define UI_POPUP_MENU_TOP (int)(8 * UI_DPI_FAC)
759
760 #define UI_PIXEL_AA_JITTER 8
761 extern const float ui_pixel_jitter[UI_PIXEL_AA_JITTER][2];
762
763 /* interface_style.c */
764 void uiStyleInit(void);
765
766 /* interface_icons.c */
767 void ui_icon_ensure_deferred(const struct bContext *C, const int icon_id, const bool big);
768 int ui_id_icon_get(const struct bContext *C, struct ID *id, const bool big);
769
770 /* interface_icons_event.c */
771 void icon_draw_rect_input(
772         float x, float y, int w, int h, float alpha,
773         short event_type, short event_value);
774
775 /* resources.c */
776 void init_userdef_do_versions(struct Main *bmain);
777 void ui_resources_init(void);
778 void ui_resources_free(void);
779
780 /* interface_layout.c */
781 void ui_layout_add_but(uiLayout *layout, uiBut *but);
782 void ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop);
783 void ui_layout_list_set_labels_active(uiLayout *layout);
784 /* menu callback */
785 void ui_item_paneltype_func(struct bContext *C, struct uiLayout *layout, void *arg_pt);
786
787 /* interface_align.c */
788 bool ui_but_can_align(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
789 int  ui_but_align_opposite_to_area_align_get(const ARegion *ar) ATTR_WARN_UNUSED_RESULT;
790 void ui_block_align_calc(uiBlock *block, const ARegion *region);
791
792 /* interface_anim.c */
793 void ui_but_anim_flag(uiBut *but, float cfra);
794 void ui_but_anim_copy_driver(struct bContext *C);
795 void ui_but_anim_paste_driver(struct bContext *C);
796 bool ui_but_anim_expression_get(uiBut *but, char *str, size_t maxlen);
797 bool ui_but_anim_expression_set(uiBut *but, const char *str);
798 bool ui_but_anim_expression_create(uiBut *but, const char *str);
799 void ui_but_anim_autokey(struct bContext *C, uiBut *but, struct Scene *scene, float cfra);
800
801 void ui_but_anim_decorate_cb(struct bContext *C, void *arg_but, void *arg_dummy);
802 void ui_but_anim_decorate_update_from_flag(uiBut *but);
803
804 /* interface_query.c */
805 bool ui_but_is_editable(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
806 bool ui_but_is_editable_as_text(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
807 bool ui_but_is_toggle(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
808 bool ui_but_is_interactive(const uiBut *but, const bool labeledit) ATTR_WARN_UNUSED_RESULT;
809 bool ui_but_is_utf8(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
810 bool ui_but_is_popover_once_compat(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
811 bool ui_but_has_array_value(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
812 void ui_but_pie_dir(RadialDirection dir, float vec[2]);
813
814 bool ui_but_is_cursor_warp(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
815
816 bool ui_but_contains_pt(
817         const uiBut *but, float mx, float my) ATTR_WARN_UNUSED_RESULT;
818 bool ui_but_contains_point_px_icon(
819         const uiBut *but, struct  ARegion *ar, const struct wmEvent *event) ATTR_WARN_UNUSED_RESULT;
820 bool ui_but_contains_point_px(
821         const uiBut *but, const struct ARegion *ar, int x, int y) ATTR_WARN_UNUSED_RESULT;
822
823 uiBut *ui_list_find_mouse_over(struct ARegion *ar, const struct wmEvent *event) ATTR_WARN_UNUSED_RESULT;
824
825 uiBut *ui_but_find_mouse_over_ex(struct ARegion *ar, const int x, const int y, const bool labeledit) ATTR_WARN_UNUSED_RESULT;
826 uiBut *ui_but_find_mouse_over(struct ARegion *ar, const struct wmEvent *event) ATTR_WARN_UNUSED_RESULT;
827
828 uiBut *ui_list_find_mouse_over_ex(struct ARegion *ar, int x, int y) ATTR_WARN_UNUSED_RESULT;
829
830 bool ui_but_contains_password(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
831
832 uiBut *ui_but_prev(uiBut *but) ATTR_WARN_UNUSED_RESULT;
833 uiBut *ui_but_next(uiBut *but) ATTR_WARN_UNUSED_RESULT;
834 uiBut *ui_but_first(uiBlock *block) ATTR_WARN_UNUSED_RESULT;
835 uiBut *ui_but_last(uiBlock *block) ATTR_WARN_UNUSED_RESULT;
836
837 bool ui_block_is_menu(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
838 bool ui_block_is_popover(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
839 bool ui_block_is_pie_menu(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
840 bool ui_block_is_popup_any(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
841
842 uiBut *ui_region_find_active_but(struct ARegion *ar) ATTR_WARN_UNUSED_RESULT;
843 bool ui_region_contains_point_px(
844         const struct ARegion *ar, int x, int y) ATTR_WARN_UNUSED_RESULT;
845
846 /* interface_context_menu.c */
847 bool ui_popup_context_menu_for_button(struct bContext *C, uiBut *but);
848 void ui_popup_context_menu_for_panel(struct bContext *C, struct ARegion *ar, struct Panel *pa);
849
850 /* interface_eyedropper.c */
851 struct wmKeyMap *eyedropper_modal_keymap(struct wmKeyConfig *keyconf);
852 struct wmKeyMap *eyedropper_colorband_modal_keymap(struct wmKeyConfig *keyconf);
853
854 /* interface_eyedropper_color.c */
855 void UI_OT_eyedropper_color(struct wmOperatorType *ot);
856
857 /* interface_eyedropper_colorband.c */
858 void UI_OT_eyedropper_colorramp(struct wmOperatorType *ot);
859 void UI_OT_eyedropper_colorramp_point(struct wmOperatorType *ot);
860
861 /* interface_eyedropper_datablock.c */
862 void UI_OT_eyedropper_id(struct wmOperatorType *ot);
863
864 /* interface_eyedropper_depth.c */
865 void UI_OT_eyedropper_depth(struct wmOperatorType *ot);
866
867 /* interface_eyedropper_driver.c */
868 void UI_OT_eyedropper_driver(struct wmOperatorType *ot);
869
870 /* interface_util.c */
871
872 /**
873  * For use with #ui_rna_collection_search_cb.
874  */
875 typedef struct uiRNACollectionSearch {
876         PointerRNA target_ptr;
877         PropertyRNA *target_prop;
878
879         PointerRNA search_ptr;
880         PropertyRNA *search_prop;
881
882         bool *but_changed; /* pointer to uiBut.changed */
883 } uiRNACollectionSearch;
884 void ui_rna_collection_search_cb(const struct bContext *C, void *arg, const char *str, uiSearchItems *items);
885
886 /* interface_ops.c */
887 bool ui_jump_to_target_button_poll(struct bContext *C);
888
889
890 #endif  /* __INTERFACE_INTERN_H__ */