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