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