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