Cleanup: use typed unsigned ints
[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 #define UI_MENU_SUBMENU_PADDING (6 * UI_DPI_FAC) /* some extra padding added to menus containing submenu icons */
110
111 /* menu scrolling */
112 #define UI_MENU_SCROLL_ARROW    12
113 #define UI_MENU_SCROLL_MOUSE    (UI_MENU_SCROLL_ARROW + 2)
114 #define UI_MENU_SCROLL_PAD              4
115
116 /* panel limits */
117 #define UI_PANEL_MINX   100
118 #define UI_PANEL_MINY   70
119
120 /* popover width (multiplied by 'U.widget_unit') */
121 #define UI_POPOVER_WIDTH_UNITS 10
122
123 /* uiBut->flag */
124 enum {
125         UI_SELECT       = (1 << 0),  /* use when the button is pressed */
126         UI_SCROLLED     = (1 << 1),  /* temp hidden, scrolled away */
127         UI_ACTIVE       = (1 << 2),
128         UI_HAS_ICON     = (1 << 3),
129         UI_HIDDEN       = (1 << 4),
130         UI_SELECT_DRAW  = (1 << 5),  /* Display selected, doesn't impact interaction. */
131         /* warn: rest of uiBut->flag in UI_interface.h */
132 };
133
134 /* some buttons display icons only under special conditions
135  * (e.g. 'x' icon in search menu) - used with ui_but_icon_extra_get */
136 typedef enum uiButExtraIconType {
137         UI_BUT_ICONEXTRA_NONE = 1,
138         UI_BUT_ICONEXTRA_CLEAR,
139         UI_BUT_ICONEXTRA_EYEDROPPER,
140 } uiButExtraIconType;
141
142 /* uiBut->dragflag */
143 enum {
144         UI_BUT_DRAGPOIN_FREE = (1 << 0),
145 };
146
147 /* but->pie_dir */
148 typedef enum RadialDirection {
149         UI_RADIAL_NONE  = -1,
150         UI_RADIAL_N     =  0,
151         UI_RADIAL_NE    =  1,
152         UI_RADIAL_E     =  2,
153         UI_RADIAL_SE    =  3,
154         UI_RADIAL_S     =  4,
155         UI_RADIAL_SW    =  5,
156         UI_RADIAL_W     =  6,
157         UI_RADIAL_NW    =  7,
158 } RadialDirection;
159
160 extern const char  ui_radial_dir_order[8];
161 extern const char  ui_radial_dir_to_numpad[8];
162 extern const short ui_radial_dir_to_angle[8];
163
164 /* internal panel drawing defines */
165 #define PNL_GRID    (UI_UNIT_Y / 5) /* 4 default */
166 #define PNL_HEADER  (UI_UNIT_Y + 4) /* 24 default */
167
168 /* bit button defines */
169 /* Bit operations */
170 #define UI_BITBUT_TEST(a, b)    ( ( (a) & 1 << (b) ) != 0)
171 #define UI_BITBUT_SET(a, b)     ( (a) | 1 << (b) )
172 #define UI_BITBUT_CLR(a, b)     ( (a) & ~(1 << (b)) )
173 /* bit-row */
174 #define UI_BITBUT_ROW(min, max)  (((max) >= 31 ? 0xFFFFFFFF : (1 << ((max) + 1)) - 1) - ((min) ? ((1 << (min)) - 1) : 0) )
175
176 /* split numbuts by ':' and align l/r */
177 #define USE_NUMBUTS_LR_ALIGN
178
179 /* Use new 'align' computation code. */
180 #define USE_UIBUT_SPATIAL_ALIGN
181
182 /* PieMenuData->flags */
183 enum {
184         UI_PIE_DEGREES_RANGE_LARGE  = (1 << 0),  /* pie menu item collision is detected at 90 degrees */
185         UI_PIE_INITIAL_DIRECTION    = (1 << 1),  /* use initial center of pie menu to calculate direction */
186         UI_PIE_DRAG_STYLE           = (1 << 2),  /* pie menu is drag style */
187         UI_PIE_INVALID_DIR          = (1 << 3),  /* mouse not far enough from center position  */
188         UI_PIE_CLICK_STYLE          = (1 << 4),  /* pie menu changed to click style, click to confirm  */
189         UI_PIE_ANIMATION_FINISHED   = (1 << 5),  /* pie animation finished, do not calculate any more motion  */
190         UI_PIE_GESTURE_END_WAIT     = (1 << 6),  /* pie gesture selection has been done, now wait for mouse motion to end */
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         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSS_NONE ... etc, copied from the block */
272         signed char pie_dir; /* direction in a pie menu, used for collision detection (RadialDirection) */
273         bool changed; /* could be made into a single flag */
274         uchar unit_type; /* so buttons can support unit systems which are not RNA */
275         short modifier_key;
276         short iconadd;
277
278         /* UI_BTYPE_BLOCK data */
279         uiBlockCreateFunc block_create_func;
280
281         /* UI_BTYPE_PULLDOWN/UI_BTYPE_MENU data */
282         uiMenuCreateFunc menu_create_func;
283
284         uiMenuStepFunc menu_step_func;
285
286         /* RNA data */
287         struct PointerRNA rnapoin;
288         struct PropertyRNA *rnaprop;
289         int rnaindex;
290
291         struct PointerRNA rnasearchpoin;
292         struct PropertyRNA *rnasearchprop;
293
294         /* Operator data */
295         struct wmOperatorType *optype;
296         struct PointerRNA *opptr;
297         short opcontext;
298         uchar menu_key; /* 'a'-'z', always lower case */
299
300         /* Draggable data, type is WM_DRAG_... */
301         char dragtype;
302         short dragflag;
303         void *dragpoin;
304         struct ImBuf *imb;
305         float imb_scale;
306
307         /* active button data */
308         struct uiHandleButtonData *active;
309
310         /* Custom button data. */
311         void *custom_data;
312
313         char *editstr;
314         double *editval;
315         float *editvec;
316         void *editcoba;
317         void *editcumap;
318
319         /* pointer back */
320         uiBlock *block;
321 };
322
323 typedef struct uiButTab {
324         uiBut but;
325         struct MenuType *menu;
326 } uiButTab;
327
328 typedef struct ColorPicker {
329         struct ColorPicker *next, *prev;
330         float color_data[3]; /* colr data may be HSV or HSL for now */
331         int representation; /* store hsv/hsl value */
332 } ColorPicker;
333
334 typedef struct ColorPickerData {
335         ListBase list;
336 } ColorPickerData;
337
338 struct PieMenuData {
339         /* store title and icon to allow access when pie levels are created */
340         const char *title;
341         int icon;
342
343         float pie_dir[2];
344         float pie_center_init[2];
345         float pie_center_spawned[2];
346         float last_pos[2];
347         double duration_gesture;
348         int flags;
349         int event; /* initial event used to fire the pie menu, store here so we can query for release */
350         float alphafac;
351 };
352
353 /* uiBlock.content_hints */
354 enum eBlockContentHints {
355         /* In a menu block, if there is a single sub-menu button, we add some
356          * padding to the right to put nicely aligned triangle icons there. */
357         UI_BLOCK_CONTAINS_SUBMENU_BUT = (1 << 0),
358 };
359
360 struct uiBlock {
361         uiBlock *next, *prev;
362
363         ListBase buttons;
364         Panel *panel;
365         uiBlock *oldblock;
366
367         ListBase butstore;  /* UI_butstore_* runtime function */
368
369         ListBase layouts;
370         struct uiLayout *curlayout;
371
372         ListBase contexts;
373
374         char name[UI_MAX_NAME_STR];
375
376         float winmat[4][4];
377
378         rctf rect;
379         float aspect;
380
381         uint puphash;  /* popup menu hash for memory */
382
383         uiButHandleFunc func;
384         void *func_arg1;
385         void *func_arg2;
386
387         uiButHandleNFunc funcN;
388         void *func_argN;
389
390         uiMenuHandleFunc butm_func;
391         void *butm_func_arg;
392
393         uiBlockHandleFunc handle_func;
394         void *handle_func_arg;
395
396         /* custom extra handling */
397         int (*block_event_func)(const struct bContext *C, struct uiBlock *, const struct wmEvent *);
398
399         /* extra draw function for custom blocks */
400         void (*drawextra)(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect);
401         void *drawextra_arg1;
402         void *drawextra_arg2;
403
404         int flag;
405         short alignnr;
406         /* Hints about the buttons of this block. Used to avoid iterating over
407          * buttons to find out if some criteria is met by any. Instead, check this
408          * criteria when adding the button and set a flag here if it's met. */
409         short content_hints; /* eBlockContentHints */
410
411         char direction;
412         char theme_style; /* UI_BLOCK_THEME_STYLE_* */
413         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSS_NONE ... etc, copied to buttons */
414         bool auto_open;
415         char _pad[5];
416         double auto_open_last;
417
418         const char *lockstr;
419
420         char lock;
421         char active;                /* to keep blocks while drawing and free them afterwards */
422         char tooltipdisabled;       /* to avoid tooltip after click */
423         char endblock;              /* UI_block_end done? */
424
425         eBlockBoundsCalc bounds_type;  /* for doing delayed */
426         int mx, my;
427         int bounds, minbounds;      /* for doing delayed */
428
429         rctf safety;                /* pulldowns, to detect outside, can differ per case how it is created */
430         ListBase saferct;           /* uiSafetyRct list */
431
432         uiPopupBlockHandle *handle; /* handle */
433
434         struct wmOperator *ui_operator; /* use so presets can find the operator, */
435                                         /* across menus and from nested popups which fail for operator context. */
436
437         void *evil_C;               /* XXX hack for dynamic operator enums */
438
439         struct UnitSettings *unit;  /* unit system, used a lot for numeric buttons so include here rather then fetching through the scene every time. */
440         ColorPickerData color_pickers; /* XXX, only accessed by color picker templates */
441
442         bool is_color_gamma_picker; /* Block for color picker with gamma baked in. */
443
444         char display_device[64]; /* display device name used to display this block,
445                                   * used by color widgets to transform colors from/to scene linear
446                                   */
447         struct PieMenuData pie_data;
448 };
449
450 typedef struct uiSafetyRct {
451         struct uiSafetyRct *next, *prev;
452         rctf parent;
453         rctf safety;
454 } uiSafetyRct;
455
456 /* interface.c */
457
458 void ui_fontscale(short *points, float aspect);
459
460 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
461 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
462 extern void ui_block_to_window_rctf(const struct ARegion *ar, uiBlock *block, rctf *rct_dst, const rctf *rct_src);
463 extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
464 extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
465 extern void ui_window_to_region(const ARegion *ar, int *x, int *y);
466 extern void ui_region_to_window(const struct ARegion *ar, int *x, int *y);
467 extern void ui_region_winrct_get_no_margin(const struct ARegion *ar, struct rcti *r_rect);
468
469 extern double ui_but_value_get(uiBut *but);
470 extern void ui_but_value_set(uiBut *but, double value);
471 extern void ui_but_hsv_set(uiBut *but);
472 extern void ui_but_v3_get(uiBut *but, float vec[3]);
473 extern void ui_but_v3_set(uiBut *but, const float vec[3]);
474
475 extern void ui_hsvcircle_vals_from_pos(
476         float *val_rad, float *val_dist, const rcti *rect,
477         const float mx, const float my);
478 extern void ui_hsvcircle_pos_from_vals(struct uiBut *but, const rcti *rect, float *hsv, float *xpos, float *ypos);
479 extern void ui_hsvcube_pos_from_vals(struct uiBut *but, const rcti *rect, float *hsv, float *xp, float *yp);
480
481 extern void ui_but_string_get_ex(
482         uiBut *but, char *str, const size_t maxlen,
483         const int float_precision, const bool use_exp_float, bool *r_use_exp_float) ATTR_NONNULL(1, 2);
484 extern void ui_but_string_get(uiBut *but, char *str, const size_t maxlen) ATTR_NONNULL();
485 extern char *ui_but_string_get_dynamic(uiBut *but, int *r_str_size);
486 extern void ui_but_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen) ATTR_NONNULL();
487 extern bool ui_but_string_set(struct bContext *C, uiBut *but, const char *str) ATTR_NONNULL();
488 extern bool ui_but_string_set_eval_num(struct bContext *C, uiBut *but, const char *str, double *value) ATTR_NONNULL();
489 extern int  ui_but_string_get_max_length(uiBut *but);
490 extern uiBut *ui_but_drag_multi_edit_get(uiBut *but);
491
492 void ui_def_but_icon(uiBut *but, const int icon, const int flag);
493 extern uiButExtraIconType ui_but_icon_extra_get(uiBut *but);
494
495 extern void ui_but_default_set(struct bContext *C, const bool all, const bool use_afterfunc);
496
497 extern void ui_but_update_ex(uiBut *but, const bool validate);
498 extern void ui_but_update(uiBut *but);
499 extern void ui_but_update_edited(uiBut *but);
500 extern bool ui_but_is_float(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
501 extern bool ui_but_is_bool(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
502 extern bool ui_but_is_unit(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
503 extern bool ui_but_is_compatible(const uiBut *but_a, const uiBut *but_b) ATTR_WARN_UNUSED_RESULT;
504 extern bool ui_but_is_rna_valid(uiBut *but) ATTR_WARN_UNUSED_RESULT;
505 extern bool ui_but_is_utf8(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
506 extern bool ui_but_supports_cycling(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
507
508 extern int  ui_but_is_pushed_ex(uiBut *but, double *value) ATTR_WARN_UNUSED_RESULT;
509 extern int  ui_but_is_pushed(uiBut *but) ATTR_WARN_UNUSED_RESULT;
510
511 void ui_but_override_flag(uiBut *but);
512
513 extern void ui_block_bounds_calc(uiBlock *block);
514
515 extern struct ColorManagedDisplay *ui_block_cm_display_get(uiBlock *block);
516 void ui_block_cm_to_display_space_v3(uiBlock *block, float pixel[3]);
517
518 /* interface_regions.c */
519
520 struct uiKeyNavLock {
521         /* set when we're using keyinput */
522         bool is_keynav;
523         /* only used to check if we've moved the cursor */
524         int event_xy[2];
525 };
526
527 typedef uiBlock * (*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1);
528 typedef void (*uiBlockHandleFreeFunc)(struct uiPopupBlockHandle *handle, void *arg1);
529
530 struct uiPopupBlockCreate {
531         uiBlockCreateFunc       create_func;
532         uiBlockHandleCreateFunc handle_create_func;
533         uiBlockHandleFreeFunc   free_func;
534         void *arg;
535
536         int event_xy[2];
537
538         /* when popup is initialized from a button */
539         ARegion *butregion;
540         uiBut *but;
541 };
542
543 struct uiPopupBlockHandle {
544         /* internal */
545         struct ARegion *region;
546
547         /* use only for 'UI_BLOCK_MOVEMOUSE_QUIT' popups */
548         float towards_xy[2];
549         double towardstime;
550         bool dotowards;
551
552         bool popup;
553         void (*popup_func)(struct bContext *C, void *arg, int event);
554         void (*cancel_func)(struct bContext *C, void *arg);
555         void *popup_arg;
556
557         /* store data for refreshing popups */
558         struct uiPopupBlockCreate popup_create_vars;
559         /* true if we can re-create the popup using 'popup_create_vars' */
560         bool can_refresh;
561         bool refresh;
562
563         struct wmTimer *scrolltimer;
564         float scrolloffset;
565
566         struct uiKeyNavLock keynav_state;
567
568         /* for operator popups */
569         struct wmOperator *popup_op;
570         struct wmOperatorType *optype;
571         ScrArea *ctx_area;
572         ARegion *ctx_region;
573         int opcontext;
574
575         /* return values */
576         int butretval;
577         int menuretval;
578         int   retvalue;
579         float retvec[4];
580
581         /* menu direction */
582         int direction;
583
584         /* Previous values so we don't resize or reposition on refresh. */
585         rctf prev_block_rect;
586         rctf prev_butrct;
587         short prev_dir1, prev_dir2;
588         int prev_mx, prev_my;
589
590         /* Maximum estimated size to avoid having to reposition on refresh. */
591         float max_size_x, max_size_y;
592
593 /* #ifdef USE_DRAG_POPUP */
594         bool is_grab;
595         int     grab_xy_prev[2];
596 /* #endif */
597 };
598
599 /* -------------------------------------------------------------------- */
600 /* interface_region_*.c */
601
602 /* interface_region_tooltip.c */
603 /* exposed as public API in UI_interface.h */
604
605 /* interface_region_color_picker.c */
606 void ui_rgb_to_color_picker_compat_v(const float rgb[3], float r_cp[3]);
607 void ui_rgb_to_color_picker_v(const float rgb[3], float r_cp[3]);
608 void ui_color_picker_to_rgb_v(const float r_cp[3], float rgb[3]);
609 void ui_color_picker_to_rgb(float r_cp0, float r_cp1, float r_cp2, float *r, float *g, float *b);
610
611 bool ui_but_is_color_gamma(uiBut *but);
612
613 void ui_scene_linear_to_color_picker_space(uiBut *but, float rgb[3]);
614 void ui_color_picker_to_scene_linear_space(uiBut *but, float rgb[3]);
615
616 uiBlock *ui_block_func_COLOR(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
617 ColorPicker *ui_block_colorpicker_create(struct uiBlock *block);
618
619 /* interface_region_search.c */
620 /* Searchbox for string button */
621 ARegion *ui_searchbox_create_generic(struct bContext *C, struct ARegion *butregion, uiBut *but);
622 ARegion *ui_searchbox_create_operator(struct bContext *C, struct ARegion *butregion, uiBut *but);
623 bool ui_searchbox_inside(struct ARegion *ar, int x, int y);
624 int  ui_searchbox_find_index(struct ARegion *ar, const char *name);
625 void ui_searchbox_update(struct bContext *C, struct ARegion *ar, uiBut *but, const bool reset);
626 int ui_searchbox_autocomplete(struct bContext *C, struct ARegion *ar, uiBut *but, char *str);
627 void ui_searchbox_event(struct bContext *C, struct ARegion *ar, uiBut *but, const struct wmEvent *event);
628 bool ui_searchbox_apply(uiBut *but, struct ARegion *ar);
629 void ui_searchbox_free(struct bContext *C, struct ARegion *ar);
630 void ui_but_search_refresh(uiBut *but);
631
632 /* interface_region_menu_popup.c */
633 int    ui_but_menu_step(uiBut *but, int step);
634 bool   ui_but_menu_step_poll(const uiBut *but);
635 uiBut *ui_popup_menu_memory_get(struct uiBlock *block);
636 void   ui_popup_menu_memory_set(uiBlock *block, struct uiBut *but);
637
638 uiBlock *ui_popup_block_refresh(
639         struct bContext *C, uiPopupBlockHandle *handle,
640         ARegion *butregion, uiBut *but);
641
642 uiPopupBlockHandle *ui_popup_block_create(
643         struct bContext *C, struct ARegion *butregion, uiBut *but,
644         uiBlockCreateFunc create_func, uiBlockHandleCreateFunc handle_create_func,
645         void *arg);
646 uiPopupBlockHandle *ui_popup_menu_create(
647         struct bContext *C, struct ARegion *butregion, uiBut *but,
648         uiMenuCreateFunc create_func, void *arg);
649
650 /* interface_region_popover.c */
651 uiPopupBlockHandle *ui_popover_panel_create(
652         struct bContext *C, struct ARegion *butregion, uiBut *but,
653         uiMenuCreateFunc create_func, void *arg);
654
655 /* interface_region_menu_pie.c */
656 void ui_pie_menu_level_create(
657         uiBlock *block, struct wmOperatorType *ot, const char *propname, IDProperty *properties,
658         const EnumPropertyItem *items, int totitem, int context, int flag);
659
660 /* interface_region_popup.c */
661 void ui_popup_translate(struct ARegion *ar, const int mdiff[2]);
662 void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
663 void ui_popup_block_scrolltest(struct uiBlock *block);
664
665 /* end interface_region_*.c */
666
667
668 /* interface_panel.c */
669 extern int ui_handler_panel_region(
670         struct bContext *C, const struct wmEvent *event,
671         struct ARegion *ar, const uiBut *active_but);
672 extern void ui_draw_aligned_panel(
673         struct uiStyle *style, uiBlock *block, const rcti *rect,
674         const bool show_pin, const bool show_background);
675
676 /* interface_draw.c */
677 extern void ui_draw_dropshadow(const rctf *rct, float radius, float aspect, float alpha, int select);
678
679 void ui_draw_gradient(const rcti *rect, const float hsv[3], const int type, const float alpha);
680
681
682 void ui_draw_but_TAB_outline(const rcti *rect, float rad, uchar highlight[3], uchar highlight_fade[3]);
683 void ui_draw_but_HISTOGRAM(ARegion *ar, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
684 void ui_draw_but_WAVEFORM(ARegion *ar, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
685 void ui_draw_but_VECTORSCOPE(ARegion *ar, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
686 void ui_draw_but_COLORBAND(uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
687 void ui_draw_but_UNITVEC(uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
688 void ui_draw_but_CURVE(ARegion *ar, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
689 void ui_draw_but_IMAGE(ARegion *ar, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
690 void ui_draw_but_TRACKPREVIEW(ARegion *ar, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
691 void ui_draw_but_NODESOCKET(ARegion *ar, uiBut *but, const struct uiWidgetColors *wcol, const rcti *rect);
692
693 /* interface_handlers.c */
694 PointerRNA *ui_handle_afterfunc_add_operator(struct wmOperatorType *ot, int opcontext, bool create_props);
695 extern void ui_pan_to_scroll(const struct wmEvent *event, int *type, int *val);
696 extern void ui_but_activate_event(struct bContext *C, struct ARegion *ar, uiBut *but);
697 extern void ui_but_activate_over(struct bContext *C, struct ARegion *ar, uiBut *but);
698 extern void ui_but_execute_begin(struct bContext *C, struct ARegion *ar, uiBut *but, void **active_back);
699 extern void ui_but_execute_end(struct bContext *C, struct ARegion *ar, uiBut *but, void *active_back);
700 extern void ui_but_active_free(const struct bContext *C, uiBut *but);
701 extern bool ui_but_is_active(struct ARegion *ar) ATTR_WARN_UNUSED_RESULT;
702 extern int ui_but_menu_direction(uiBut *but);
703 extern void ui_but_text_password_hide(char password_str[UI_MAX_DRAW_STR], uiBut *but, const bool restore);
704 extern uiBut *ui_but_find_select_in_enum(uiBut *but, int direction);
705 extern uiBut *ui_but_find_active_in_region(struct ARegion *ar);
706 extern uiBut *ui_but_find_mouse_over(struct ARegion *ar, const struct wmEvent *event);
707 void ui_but_pie_dir(RadialDirection dir, float vec[2]);
708 float ui_block_calc_pie_segment(struct uiBlock *block, const float event_xy[2]);
709
710 void ui_but_add_shortcut(uiBut *but, const char *key_str, const bool do_strip);
711 void ui_but_clipboard_free(void);
712 uiBut *ui_but_find_old(uiBlock *block_old, const uiBut *but_new);
713 uiBut *ui_but_find_new(uiBlock *block_old, const uiBut *but_new);
714
715 #ifdef WITH_INPUT_IME
716 void ui_but_ime_reposition(uiBut *but, int x, int y, bool complete);
717 struct wmIMEData *ui_but_ime_data_get(uiBut *but);
718 #endif
719
720 /* interface_widgets.c */
721
722 /* Widget shader parameters, must match the shader layout. */
723 typedef struct uiWidgetBaseParameters {
724         rctf recti, rect;
725         float radi, rad;
726         float facxi, facyi;
727         float round_corners[4];
728         float color_inner1[4], color_inner2[4];
729         float color_outline[4], color_emboss[4];
730         float color_tria[4];
731         float tria1_center[2], tria2_center[2];
732         float tria1_size, tria2_size;
733         float shade_dir;
734         /* We pack alpha check and discard factor in alpha_discard.
735          * If the value is negative then we do alpha check.
736          * The absolute value itself is the discard factor.
737          * Initialize value to 1.0.f if you don't want discard */
738         float alpha_discard;
739 } uiWidgetBaseParameters;
740
741 enum {
742         ROUNDBOX_TRIA_NONE = 0,
743         ROUNDBOX_TRIA_ARROWS,
744         ROUNDBOX_TRIA_SCROLL,
745         ROUNDBOX_TRIA_MENU,
746         ROUNDBOX_TRIA_CHECK,
747         ROUNDBOX_TRIA_HOLD_ACTION_ARROW,
748
749         ROUNDBOX_TRIA_MAX, /* don't use */
750 };
751
752 struct GPUBatch *ui_batch_roundbox_get(bool filled, bool antialiased);
753 struct GPUBatch *ui_batch_roundbox_widget_get(int tria);
754 struct GPUBatch *ui_batch_roundbox_shadow_get(void);
755
756 void ui_draw_anti_tria_rect(const rctf *rect, char dir, const float color[4]);
757 void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect);
758 void ui_draw_popover_back(ARegion *ar, struct uiStyle *style, uiBlock *block, rcti *rect);
759 void ui_draw_pie_center(uiBlock *block);
760 const struct uiWidgetColors *ui_tooltip_get_theme(void);
761
762 void ui_draw_widget_back_color(
763         uiWidgetTypeEnum type, bool use_shadow, const rcti *rect,
764         const float color[4]);
765 void ui_draw_widget_back(
766         uiWidgetTypeEnum type, bool use_shadow, const rcti *rect);
767 void ui_draw_tooltip_background(struct uiStyle *UNUSED(style), uiBlock *block, rcti *rect);
768
769 extern void ui_draw_but(const struct bContext *C, ARegion *ar, struct uiStyle *style, uiBut *but, rcti *rect);
770
771 void ui_draw_menu_item(const struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state, bool use_sep);
772 void ui_draw_preview_item(const struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
773
774 #define UI_TEXT_MARGIN_X 0.4f
775 #define UI_POPUP_MARGIN (UI_DPI_FAC * 12)
776 /* margin at top of screen for popups */
777 #define UI_POPUP_MENU_TOP (int)(8 * UI_DPI_FAC)
778
779 #define UI_PIXEL_AA_JITTER 8
780 extern const float ui_pixel_jitter[UI_PIXEL_AA_JITTER][2];
781
782 /* interface_style.c */
783 void uiStyleInit(void);
784
785 /* interface_icons.c */
786 void ui_icon_ensure_deferred(const struct bContext *C, const int icon_id, const bool big);
787 int ui_id_icon_get(const struct bContext *C, struct ID *id, const bool big);
788
789 /* interface_icons_event.c */
790 void icon_draw_rect_input(
791         float x, float y, int w, int h, float alpha,
792         short event_type, short event_value);
793
794 /* resources.c */
795 void init_userdef_do_versions(struct Main *bmain);
796 void ui_theme_init_default(void);
797 void ui_style_init_default(void);
798 void ui_resources_init(void);
799 void ui_resources_free(void);
800
801 /* interface_layout.c */
802 void ui_layout_add_but(uiLayout *layout, uiBut *but);
803 void ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop);
804 void ui_layout_list_set_labels_active(uiLayout *layout);
805 /* menu callback */
806 void ui_item_paneltype_func(struct bContext *C, struct uiLayout *layout, void *arg_pt);
807
808 /* interface_align.c */
809 bool ui_but_can_align(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
810 int  ui_but_align_opposite_to_area_align_get(const ARegion *ar) ATTR_WARN_UNUSED_RESULT;
811 void ui_block_align_calc(uiBlock *block, const ARegion *region);
812
813 /* interface_anim.c */
814 void ui_but_anim_flag(uiBut *but, float cfra);
815 void ui_but_anim_copy_driver(struct bContext *C);
816 void ui_but_anim_paste_driver(struct bContext *C);
817 bool ui_but_anim_expression_get(uiBut *but, char *str, size_t maxlen);
818 bool ui_but_anim_expression_set(uiBut *but, const char *str);
819 bool ui_but_anim_expression_create(uiBut *but, const char *str);
820 void ui_but_anim_autokey(struct bContext *C, uiBut *but, struct Scene *scene, float cfra);
821
822 void ui_but_anim_decorate_cb(struct bContext *C, void *arg_but, void *arg_dummy);
823 void ui_but_anim_decorate_update_from_flag(uiBut *but);
824
825 /* interface_query.c */
826 bool ui_but_is_editable(const uiBut *but);
827 bool ui_but_is_editable_as_text(const uiBut *but);
828 bool ui_but_is_toggle(const uiBut *but);
829 bool ui_but_is_popover_once_compat(const uiBut *but);
830
831 extern bool ui_block_is_menu(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
832 extern bool ui_block_is_popover(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
833 extern bool ui_block_is_pie_menu(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
834 extern bool ui_block_is_popup_any(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
835
836 /* interface_context_menu.c */
837 bool ui_popup_context_menu_for_button(struct bContext *C, uiBut *but);
838 void ui_popup_context_menu_for_panel(struct bContext *C, struct ARegion *ar, struct Panel *pa);
839
840 /* interface_eyedropper.c */
841 struct wmKeyMap *eyedropper_modal_keymap(struct wmKeyConfig *keyconf);
842 struct wmKeyMap *eyedropper_colorband_modal_keymap(struct wmKeyConfig *keyconf);
843
844 /* interface_eyedropper_color.c */
845 void UI_OT_eyedropper_color(struct wmOperatorType *ot);
846 void UI_OT_eyedropper_color_crypto(struct wmOperatorType *ot);
847
848 /* interface_eyedropper_colorband.c */
849 void UI_OT_eyedropper_colorband(struct wmOperatorType *ot);
850 void UI_OT_eyedropper_colorband_point(struct wmOperatorType *ot);
851
852 /* interface_eyedropper_datablock.c */
853 void UI_OT_eyedropper_id(struct wmOperatorType *ot);
854
855 /* interface_eyedropper_depth.c */
856 void UI_OT_eyedropper_depth(struct wmOperatorType *ot);
857
858 /* interface_eyedropper_driver.c */
859 void UI_OT_eyedropper_driver(struct wmOperatorType *ot);
860
861 /* interface_util.c */
862
863 /**
864  * For use with #ui_rna_collection_search_cb.
865  */
866 typedef struct uiRNACollectionSearch {
867         PointerRNA target_ptr;
868         PropertyRNA *target_prop;
869
870         PointerRNA search_ptr;
871         PropertyRNA *search_prop;
872
873         bool *but_changed; /* pointer to uiBut.changed */
874 } uiRNACollectionSearch;
875 void ui_rna_collection_search_cb(const struct bContext *C, void *arg, const char *str, uiSearchItems *items);
876
877 #endif  /* __INTERFACE_INTERN_H__ */