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