d9558af5f71a5ba24c805fe7bd95f6f684be05ce
[blender.git] / source / blender / editors / interface / interface_intern.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/editors/interface/interface_intern.h
29  *  \ingroup edinterface
30  */
31
32
33 #ifndef __INTERFACE_INTERN_H__
34 #define __INTERFACE_INTERN_H__
35
36 #include "BLI_compiler_attrs.h"
37 #include "UI_resources.h"
38 #include "RNA_types.h"
39 #include "DNA_listBase.h"
40
41 struct ARegion;
42 struct bContext;
43 struct uiHandleButtonData;
44 struct wmEvent;
45 struct wmOperatorType;
46 struct wmTimer;
47 struct uiStyle;
48 struct uiWidgetColors;
49 struct uiLayout;
50 struct bContextStore;
51 struct Scene;
52 struct ID;
53 struct ImBuf;
54
55 /* ****************** general defines ************** */
56
57 #define RNA_NO_INDEX    -1
58 #define RNA_ENUM_VALUE  -2
59
60 /* visual types for drawing */
61 /* for time being separated from functional types */
62 typedef enum {
63         /* default */
64         UI_WTYPE_REGULAR,
65
66         /* standard set */
67         UI_WTYPE_LABEL,
68         UI_WTYPE_TOGGLE,
69         UI_WTYPE_CHECKBOX,
70         UI_WTYPE_RADIO,
71         UI_WTYPE_NUMBER,
72         UI_WTYPE_SLIDER,
73         UI_WTYPE_EXEC,
74         UI_WTYPE_TOOLTIP,
75         
76         /* strings */
77         UI_WTYPE_NAME,
78         UI_WTYPE_NAME_LINK,
79         UI_WTYPE_POINTER_LINK,
80         UI_WTYPE_FILENAME,
81         
82         /* menus */
83         UI_WTYPE_MENU_RADIO,
84         UI_WTYPE_MENU_ICON_RADIO,
85         UI_WTYPE_MENU_POINTER_LINK,
86         UI_WTYPE_MENU_NODE_LINK,
87         
88         UI_WTYPE_PULLDOWN,
89         UI_WTYPE_MENU_ITEM,
90         UI_WTYPE_MENU_ITEM_RADIAL,
91         UI_WTYPE_MENU_BACK,
92
93         /* specials */
94         UI_WTYPE_ICON,
95         UI_WTYPE_SWATCH,
96         UI_WTYPE_RGB_PICKER,
97         UI_WTYPE_UNITVEC,
98         UI_WTYPE_BOX,
99         UI_WTYPE_SCROLL,
100         UI_WTYPE_LISTITEM,
101         UI_WTYPE_PROGRESSBAR,
102 } uiWidgetTypeEnum;
103
104 /* menu scrolling */
105 #define UI_MENU_SCROLL_ARROW    12
106 #define UI_MENU_SCROLL_MOUSE    (UI_MENU_SCROLL_ARROW + 2)
107 #define UI_MENU_SCROLL_PAD              4
108
109 /* panel limits */
110 #define UI_PANEL_MINX   100
111 #define UI_PANEL_MINY   70
112
113 /* uiBut->flag */
114 enum {
115         UI_SELECT       = (1 << 0),  /* use when the button is pressed */
116         UI_SCROLLED     = (1 << 1),  /* temp hidden, scrolled away */
117         UI_ACTIVE       = (1 << 2),
118         UI_HAS_ICON     = (1 << 3),
119         UI_TEXTINPUT    = (1 << 4),
120         UI_HIDDEN       = (1 << 5),
121         /* warn: rest of uiBut->flag in UI_interface.h */
122 };
123
124 /* some buttons display icons only under special conditions
125  * (e.g. 'x' icon in search menu) - used with ui_but_icon_extra_get */
126 typedef enum uiButExtraIconType {
127         UI_BUT_ICONEXTRA_NONE = 1,
128         UI_BUT_ICONEXTRA_UNLINK,
129         UI_BUT_ICONEXTRA_EYEDROPPER,
130 } uiButExtraIconType;
131
132 /* but->pie_dir */
133 typedef enum RadialDirection {
134         UI_RADIAL_NONE  = -1,
135         UI_RADIAL_N     =  0,
136         UI_RADIAL_NE    =  1,
137         UI_RADIAL_E     =  2,
138         UI_RADIAL_SE    =  3,
139         UI_RADIAL_S     =  4,
140         UI_RADIAL_SW    =  5,
141         UI_RADIAL_W     =  6,
142         UI_RADIAL_NW    =  7,
143 } RadialDirection;
144
145 extern const char  ui_radial_dir_order[8];
146 extern const char  ui_radial_dir_to_numpad[8];
147 extern const short ui_radial_dir_to_angle[8];
148
149 /* internal panel drawing defines */
150 #define PNL_GRID    (UI_UNIT_Y / 5) /* 4 default */
151 #define PNL_HEADER  (UI_UNIT_Y + 4) /* 24 default */
152
153 /* Button text selection:
154  * extension direction, selextend, inside ui_do_but_TEX */
155 #define EXTEND_LEFT     1
156 #define EXTEND_RIGHT    2
157
158 /* for scope resize zone */
159 #define SCOPE_RESIZE_PAD    9
160
161 /* bit button defines */
162 /* Bit operations */
163 #define UI_BITBUT_TEST(a, b)    ( ( (a) & 1 << (b) ) != 0)
164 #define UI_BITBUT_SET(a, b)     ( (a) | 1 << (b) )
165 #define UI_BITBUT_CLR(a, b)     ( (a) & ~(1 << (b)) )
166 /* bit-row */
167 #define UI_BITBUT_ROW(min, max)  (((max) >= 31 ? 0xFFFFFFFF : (1 << (max + 1)) - 1) - ((min) ? ((1 << (min)) - 1) : 0) )
168
169 /* split numbuts by ':' and align l/r */
170 #define USE_NUMBUTS_LR_ALIGN
171
172 /* PieMenuData->flags */
173 enum {
174         UI_PIE_DEGREES_RANGE_LARGE  = (1 << 0),  /* pie menu item collision is detected at 90 degrees */
175         UI_PIE_INITIAL_DIRECTION    = (1 << 1),  /* use initial center of pie menu to calculate direction */
176         UI_PIE_DRAG_STYLE           = (1 << 2),  /* pie menu is drag style */
177         UI_PIE_INVALID_DIR          = (1 << 3),  /* mouse not far enough from center position  */
178         UI_PIE_CLICK_STYLE          = (1 << 4),  /* pie menu changed to click style, click to confirm  */
179         UI_PIE_ANIMATION_FINISHED   = (1 << 5),  /* pie animation finished, do not calculate any more motion  */
180         UI_PIE_GESTURE_END_WAIT     = (1 << 6),  /* pie gesture selection has been done, now wait for mouse motion to end */
181 };
182
183 #define PIE_CLICK_THRESHOLD_SQ 50.0f
184
185 typedef struct uiLinkLine {  /* only for draw/edit */
186         struct uiLinkLine *next, *prev;
187         struct uiBut *from, *to;
188         short flag, deactive;
189 } uiLinkLine;
190
191 typedef struct {
192         void **poin;        /* pointer to original pointer */
193         void ***ppoin;      /* pointer to original pointer-array */
194         short *totlink;     /* if pointer-array, here is the total */
195         
196         short maxlink, pad;
197         short fromcode, tocode;
198         
199         ListBase lines;
200 } uiLink;
201
202 struct uiBut {
203         struct uiBut *next, *prev;
204         int flag, drawflag;
205         eButType         type;
206         eButPointerType  pointype;
207         short bit, bitnr, retval, strwidth, alignnr;
208         short ofs, pos, selsta, selend;
209
210         char *str;
211         char strdata[UI_MAX_NAME_STR];
212         char drawstr[UI_MAX_DRAW_STR];
213
214         rctf rect;  /* block relative coords */
215
216         char *poin;
217         float hardmin, hardmax, softmin, softmax;
218
219         /* both these values use depends on the button type
220          * (polymorphic struct or union would be nicer for this stuff) */
221
222         /* (type == UI_BTYPE_HSVCUBE),    Use UI_GRAD_* values.
223          * (type == UI_BTYPE_NUM),        Use to store RNA 'step' value, for dragging and click-step.
224          * (type == UI_BTYPE_LABEL),      Use (a1 == 1.0f) to use a2 as a blending factor (wow, this is imaginative!).
225          * (type == UI_BTYPE_SCROLL)      Use as scroll size.
226          * (type == UI_BTYPE_SEARCH_MENU) Use as number or rows.
227          * (type == UI_BTYPE_COLOR)       Use as indication of color palette
228          */
229         float a1;
230
231         /* (type == UI_BTYPE_HSVCIRCLE ), Use to store the luminosity.
232          * (type == UI_BTYPE_NUM),        Use to store RNA 'precision' value, for dragging and click-step.
233          * (type == UI_BTYPE_LABEL),      If (a1 == 1.0f) use a2 as a blending factor.
234          * (type == UI_BTYPE_SEARCH_MENU) Use as number or columns.
235          * (type == UI_BTYPE_COLOR)       Use as index in palette (not so good, needs refactor)
236          */
237         float a2;
238
239         unsigned char col[4];
240
241         uiButHandleFunc func;
242         void *func_arg1;
243         void *func_arg2;
244
245         uiButHandleNFunc funcN;
246         void *func_argN;
247
248         struct bContextStore *context;
249
250         uiButCompleteFunc autocomplete_func;
251         void *autofunc_arg;
252         
253         uiButSearchFunc search_func;
254         void *search_arg;
255
256         uiButHandleRenameFunc rename_func;
257         void *rename_arg1;
258         void *rename_orig;
259
260         uiLink *link;
261         short linkto[2];  /* region relative coords */
262         
263         const char *tip;
264         uiButToolTipFunc tip_func;
265         void *tip_argN;
266
267         const char *lockstr;
268
269         BIFIconID icon;
270         bool lock;
271         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSS_NONE ... etc, copied from the block */
272         signed char pie_dir; /* direction in a pie menu, used for collision detection (RadialDirection) */
273         char changed; /* could be made into a single flag */
274         unsigned char unit_type; /* so buttons can support unit systems which are not RNA */
275         short modifier_key;
276         short iconadd;
277
278         /* UI_BTYPE_BLOCK data */
279         uiBlockCreateFunc block_create_func;
280
281         /* UI_BTYPE_PULLDOWN/UI_BTYPE_MENU data */
282         uiMenuCreateFunc menu_create_func;
283
284         /* RNA data */
285         struct PointerRNA rnapoin;
286         struct PropertyRNA *rnaprop;
287         int rnaindex;
288
289         struct PointerRNA rnasearchpoin;
290         struct PropertyRNA *rnasearchprop;
291
292         /* Operator data */
293         struct wmOperatorType *optype;
294         struct PointerRNA *opptr;
295         short opcontext;
296         unsigned char menu_key; /* 'a'-'z', always lower case */
297
298         /* Draggable data, type is WM_DRAG_... */
299         char dragtype;
300         void *dragpoin;
301         struct ImBuf *imb;
302         float imb_scale;
303         
304         /* active button data */
305         struct uiHandleButtonData *active;
306
307         /* Custom button data. */
308         void *custom_data;
309
310         char *editstr;
311         double *editval;
312         float *editvec;
313         void *editcoba;
314         void *editcumap;
315         
316         /* pointer back */
317         uiBlock *block;
318 };
319
320 typedef struct ColorPicker {
321         struct ColorPicker *next, *prev;
322         float color_data[3]; /* colr data may be HSV or HSL for now */
323         int representation; /* store hsv/hsl value */
324 } ColorPicker;
325
326 typedef struct ColorPickerData {
327         ListBase list;
328 } ColorPickerData;
329
330 struct PieMenuData {
331         float pie_dir[2];
332         float pie_center_init[2];
333         float pie_center_spawned[2];
334         float last_pos[2];
335         double duration_gesture;
336         int flags;
337         int event; /* initial event used to fire the pie menu, store here so we can query for release */
338         float alphafac;
339 };
340
341 struct uiBlock {
342         uiBlock *next, *prev;
343
344         ListBase buttons;
345         Panel *panel;
346         uiBlock *oldblock;
347
348         ListBase butstore;  /* UI_butstore_* runtime function */
349
350         ListBase layouts;
351         struct uiLayout *curlayout;
352
353         ListBase contexts;
354         
355         char name[UI_MAX_NAME_STR];
356         
357         float winmat[4][4];
358
359         rctf rect;
360         float aspect;
361
362         unsigned int puphash;  /* popup menu hash for memory */
363
364         uiButHandleFunc func;
365         void *func_arg1;
366         void *func_arg2;
367
368         uiButHandleNFunc funcN;
369         void *func_argN;
370
371         uiMenuHandleFunc butm_func;
372         void *butm_func_arg;
373
374         uiBlockHandleFunc handle_func;
375         void *handle_func_arg;
376         
377         /* custom extra handling */
378         int (*block_event_func)(const struct bContext *C, struct uiBlock *, const struct wmEvent *);
379         
380         /* extra draw function for custom blocks */
381         void (*drawextra)(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect);
382         void *drawextra_arg1;
383         void *drawextra_arg2;
384
385         int flag;
386         short alignnr;
387
388         char direction;
389         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSS_NONE ... etc, copied to buttons */
390         bool auto_open;
391         char _pad[7];
392         double auto_open_last;
393
394         const char *lockstr;
395
396         char lock;
397         char active;                /* to keep blocks while drawing and free them afterwards */
398         char tooltipdisabled;       /* to avoid tooltip after click */
399         char endblock;              /* UI_block_end done? */
400
401         eBlockBoundsCalc bounds_type;  /* for doing delayed */
402         int mx, my;
403         int bounds, minbounds;      /* for doing delayed */
404
405         rctf safety;                /* pulldowns, to detect outside, can differ per case how it is created */
406         ListBase saferct;           /* uiSafetyRct list */
407
408         uiPopupBlockHandle *handle; /* handle */
409
410         struct wmOperator *ui_operator; /* use so presets can find the operator, */
411                                         /* across menus and from nested popups which fail for operator context. */
412
413         void *evil_C;               /* XXX hack for dynamic operator enums */
414
415         struct UnitSettings *unit;  /* unit system, used a lot for numeric buttons so include here rather then fetching through the scene every time. */
416         ColorPickerData color_pickers; /* XXX, only accessed by color picker templates */
417
418         bool color_profile;         /* color profile for correcting linear colors for display */
419
420         char display_device[64]; /* display device name used to display this block,
421                                   * used by color widgets to transform colors from/to scene linear
422                                   */
423         struct PieMenuData pie_data;
424 };
425
426 typedef struct uiSafetyRct {
427         struct uiSafetyRct *next, *prev;
428         rctf parent;
429         rctf safety;
430 } uiSafetyRct;
431
432 /* interface.c */
433
434 extern void ui_linkline_remove(uiLinkLine *line, uiBut *but);
435
436 void ui_fontscale(short *points, float aspect);
437
438 extern bool ui_block_is_menu(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
439 extern bool ui_block_is_pie_menu(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
440 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
441 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
442 extern void ui_block_to_window_rctf(const struct ARegion *ar, uiBlock *block, rctf *rct_dst, const rctf *rct_src);
443 extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
444 extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
445 extern void ui_window_to_region(const ARegion *ar, int *x, int *y);
446 extern void ui_region_to_window(const struct ARegion *ar, int *x, int *y);
447
448 extern double ui_but_value_get(uiBut *but);
449 extern void ui_but_value_set(uiBut *but, double value);
450 extern void ui_but_hsv_set(uiBut *but);
451 extern void ui_but_v3_get(uiBut *but, float vec[3]);
452 extern void ui_but_v3_set(uiBut *but, const float vec[3]);
453
454 extern void ui_hsvcircle_vals_from_pos(float *val_rad, float *val_dist, const rcti *rect,
455                                        const float mx, const float my);
456 extern void ui_hsvcircle_pos_from_vals(struct uiBut *but, const rcti *rect, float *hsv, float *xpos, float *ypos);
457 extern void ui_hsvcube_pos_from_vals(struct uiBut *but, const rcti *rect, float *hsv, float *xp, float *yp);
458 bool ui_but_is_colorpicker_display_space(struct uiBut *but);
459
460 extern void ui_but_string_get_ex(uiBut *but, char *str, const size_t maxlen, const int float_precision) ATTR_NONNULL();
461 extern void ui_but_string_get(uiBut *but, char *str, const size_t maxlen) ATTR_NONNULL();
462 extern void ui_but_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen) ATTR_NONNULL();
463 extern bool ui_but_string_set(struct bContext *C, uiBut *but, const char *str) ATTR_NONNULL();
464 extern bool ui_but_string_set_eval_num(struct bContext *C, uiBut *but, const char *str, double *value) ATTR_NONNULL();
465 extern int  ui_but_string_get_max_length(uiBut *but);
466 extern uiBut *ui_but_drag_multi_edit_get(uiBut *but);
467 extern uiButExtraIconType ui_but_icon_extra_get(uiBut *but);
468
469 extern void ui_but_default_set(struct bContext *C, const bool all, const bool use_afterfunc);
470
471 extern void ui_but_update(uiBut *but);
472 extern bool ui_but_is_float(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
473 extern bool ui_but_is_bool(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
474 extern bool ui_but_is_unit(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
475 extern bool ui_but_is_compatible(const uiBut *but_a, const uiBut *but_b) ATTR_WARN_UNUSED_RESULT;
476 extern bool ui_but_is_rna_valid(uiBut *but) ATTR_WARN_UNUSED_RESULT;
477 extern bool ui_but_is_utf8(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
478
479 extern int  ui_but_is_pushed_ex(uiBut *but, double *value) ATTR_WARN_UNUSED_RESULT;
480 extern int  ui_but_is_pushed(uiBut *but) ATTR_WARN_UNUSED_RESULT;
481
482
483 extern void ui_block_bounds_calc(uiBlock *block);
484 extern void ui_block_translate(uiBlock *block, int x, int y);
485 extern void ui_block_align_calc(uiBlock *block);
486
487 extern struct ColorManagedDisplay *ui_block_cm_display_get(uiBlock *block);
488 void ui_block_cm_to_display_space_v3(uiBlock *block, float pixel[3]);
489 void ui_block_cm_to_scene_linear_v3(uiBlock *block, float pixel[3]);
490
491 /* interface_regions.c */
492
493 struct uiKeyNavLock {
494         /* set when we're using keyinput */
495         bool is_keynav;
496         /* only used to check if we've moved the cursor */
497         int event_xy[2];
498 };
499
500 typedef uiBlock * (*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1);
501
502 struct uiPopupBlockCreate {
503         uiBlockCreateFunc              create_func;
504         uiBlockHandleCreateFunc handle_create_func;
505         void *arg;
506
507         int event_xy[2];
508
509         /* when popup is initialized from a button */
510         ARegion *butregion;
511 };
512
513 struct uiPopupBlockHandle {
514         /* internal */
515         struct ARegion *region;
516
517         /* use only for 'UI_BLOCK_MOVEMOUSE_QUIT' popups */
518         float towards_xy[2];
519         double towardstime;
520         bool dotowards;
521
522         bool popup;
523         void (*popup_func)(struct bContext *C, void *arg, int event);
524         void (*cancel_func)(struct bContext *C, void *arg);
525         void *popup_arg;
526         
527         /* store data for refreshing popups */
528         struct uiPopupBlockCreate popup_create_vars;
529
530         struct wmTimer *scrolltimer;
531
532         struct uiKeyNavLock keynav_state;
533
534         /* for operator popups */
535         struct wmOperatorType *optype;
536         ScrArea *ctx_area;
537         ARegion *ctx_region;
538         int opcontext;
539         
540         /* return values */
541         int butretval;
542         int menuretval;
543         int   retvalue;
544         float retvec[4];
545
546         /* menu direction */
547         int direction;
548
549 /* #ifdef USE_DRAG_POPUP */
550         bool is_grab;
551         int     grab_xy_prev[2];
552 /* #endif */
553 };
554
555 uiBlock *ui_block_func_COLOR(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
556
557 struct ARegion *ui_tooltip_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
558 void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
559
560 uiBut *ui_popup_menu_memory_get(struct uiBlock *block);
561 void   ui_popup_menu_memory_set(uiBlock *block, struct uiBut *but);
562
563 void   ui_popup_translate(struct bContext *C, struct ARegion *ar, const int mdiff[2]);
564
565 ColorPicker *ui_block_colorpicker_create(struct uiBlock *block);
566 void ui_popup_block_scrolltest(struct uiBlock *block);
567
568 void ui_rgb_to_color_picker_compat_v(const float rgb[3], float r_cp[3]);
569 void ui_rgb_to_color_picker_v(const float rgb[3], float r_cp[3]);
570 void ui_color_picker_to_rgb_v(const float r_cp[3], float rgb[3]);
571 void ui_color_picker_to_rgb(float r_cp0, float r_cp1, float r_cp2, float *r, float *g, float *b);
572
573 /* searchbox for string button */
574 ARegion *ui_searchbox_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
575 bool ui_searchbox_inside(struct ARegion *ar, int x, int y);
576 int  ui_searchbox_find_index(struct ARegion *ar, const char *name);
577 void ui_searchbox_update(struct bContext *C, struct ARegion *ar, uiBut *but, const bool reset);
578 int ui_searchbox_autocomplete(struct bContext *C, struct ARegion *ar, uiBut *but, char *str);
579 void ui_searchbox_event(struct bContext *C, struct ARegion *ar, uiBut *but, const struct wmEvent *event);
580 bool ui_searchbox_apply(uiBut *but, struct ARegion *ar);
581 void ui_searchbox_free(struct bContext *C, struct ARegion *ar);
582 void ui_but_search_refresh(uiBut *but);
583
584 uiBlock *ui_popup_block_refresh(struct bContext *C, uiPopupBlockHandle *handle,
585                                 ARegion *butregion, uiBut *but);
586
587 uiPopupBlockHandle *ui_popup_block_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
588                                           uiBlockCreateFunc create_func, uiBlockHandleCreateFunc handle_create_func,
589                                           void *arg);
590 uiPopupBlockHandle *ui_popup_menu_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
591                                          uiMenuCreateFunc create_func, void *arg);
592
593 void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
594
595 int ui_but_menu_step(uiBut *but, int step);
596
597
598 /* interface_panel.c */
599 extern int ui_handler_panel_region(struct bContext *C, const struct wmEvent *event, struct ARegion *ar);
600 extern void ui_draw_aligned_panel(struct uiStyle *style, uiBlock *block, const rcti *rect, const bool show_pin);
601
602 /* interface_draw.c */
603 extern void ui_draw_dropshadow(const rctf *rct, float radius, float aspect, float alpha, int select);
604
605 void ui_draw_gradient(const rcti *rect, const float hsv[3], const int type, const float alpha);
606
607 void ui_draw_but_HISTOGRAM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
608 void ui_draw_but_WAVEFORM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
609 void ui_draw_but_VECTORSCOPE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
610 void ui_draw_but_COLORBAND(uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
611 void ui_draw_but_UNITVEC(uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
612 void ui_draw_but_CURVE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
613 void ui_draw_but_IMAGE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
614 void ui_draw_but_TRACKPREVIEW(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
615 void ui_draw_but_NODESOCKET(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
616
617 /* interface_handlers.c */
618 PointerRNA *ui_handle_afterfunc_add_operator(struct wmOperatorType *ot, int opcontext, bool create_props);
619 extern void ui_pan_to_scroll(const struct wmEvent *event, int *type, int *val);
620 extern void ui_but_activate_event(struct bContext *C, struct ARegion *ar, uiBut *but);
621 extern void ui_but_activate_over(struct bContext *C, struct ARegion *ar, uiBut *but);
622 extern void ui_but_execute_begin(struct bContext *C, struct ARegion *ar, uiBut *but, void **active_back);
623 extern void ui_but_execute_end(struct bContext *C, struct ARegion *ar, uiBut *but, void *active_back);
624 extern void ui_but_active_free(const struct bContext *C, uiBut *but);
625 extern bool ui_but_is_active(struct ARegion *ar) ATTR_WARN_UNUSED_RESULT;
626 extern int ui_but_menu_direction(uiBut *but);
627 extern void ui_but_text_password_hide(char password_str[UI_MAX_DRAW_STR], uiBut *but, const bool restore);
628 extern uiBut *ui_but_find_select_in_enum(uiBut *but, int direction);
629 extern uiBut *ui_but_find_active_in_region(struct ARegion *ar);
630 bool ui_but_is_editable(const uiBut *but);
631 bool ui_but_is_editable_as_text(const uiBut *but);
632 void ui_but_pie_dir_visual(RadialDirection dir, float vec[2]);
633 void ui_but_pie_dir(RadialDirection dir, float vec[2]);
634 float ui_block_calc_pie_segment(struct uiBlock *block, const float event_xy[2]);
635
636 void ui_but_clipboard_free(void);
637 void ui_panel_menu(struct bContext *C, ARegion *ar, Panel *pa);
638 uiBut *ui_but_find_old(uiBlock *block_old, const uiBut *but_new);
639 uiBut *ui_but_find_new(uiBlock *block_old, const uiBut *but_new);
640
641 #ifdef WITH_INPUT_IME
642 void ui_but_ime_reposition(uiBut *but, int x, int y, bool complete);
643 struct wmIMEData *ui_but_ime_data_get(uiBut *but);
644 #endif
645
646 /* interface_widgets.c */
647 void ui_draw_anti_tria(float x1, float y1, float x2, float y2, float x3, float y3);
648 void ui_draw_anti_roundbox(int mode, float minx, float miny, float maxx, float maxy, float rad, bool use_alpha);
649 void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect);
650 void ui_draw_pie_center(uiBlock *block);
651 uiWidgetColors *ui_tooltip_get_theme(void);
652 void ui_draw_tooltip_background(uiStyle *UNUSED(style), uiBlock *block, rcti *rect);
653 void ui_draw_search_back(struct uiStyle *style, uiBlock *block, rcti *rect);
654 bool ui_link_bezier_points(const rcti *rect, float coord_array[][2], int resol);
655 void ui_draw_link_bezier(const rcti *rect);
656
657 extern void ui_draw_but(const struct bContext *C, ARegion *ar, struct uiStyle *style, uiBut *but, rcti *rect);
658 /* theme color init */
659 struct ThemeUI;
660 void ui_widget_color_init(struct ThemeUI *tui);
661
662 void ui_draw_menu_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state, bool use_sep);
663 void ui_draw_preview_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
664
665 #define UI_TEXT_MARGIN_X 0.4f
666 #define UI_POPUP_MARGIN (UI_DPI_FAC * 12)
667
668 /* interface_style.c */
669 void uiStyleInit(void);
670
671 /* interface_icons.c */
672 int ui_id_icon_get(const struct bContext *C, struct ID *id, const bool big);
673
674 /* resources.c */
675 void init_userdef_do_versions(void);
676 void ui_theme_init_default(void);
677 void ui_style_init_default(void);
678 void ui_resources_init(void);
679 void ui_resources_free(void);
680
681 /* interface_layout.c */
682 void ui_layout_add_but(uiLayout *layout, uiBut *but);
683 bool ui_but_can_align(uiBut *but) ATTR_WARN_UNUSED_RESULT;
684 void ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop);
685 void ui_but_add_shortcut(uiBut *but, const char *key_str, const bool do_strip);
686 void ui_layout_list_set_labels_active(uiLayout *layout);
687
688 /* interface_anim.c */
689 void ui_but_anim_flag(uiBut *but, float cfra);
690 void ui_but_anim_insert_keyframe(struct bContext *C);
691 void ui_but_anim_delete_keyframe(struct bContext *C);
692 void ui_but_anim_clear_keyframe(struct bContext *C);
693 void ui_but_anim_add_driver(struct bContext *C);
694 void ui_but_anim_remove_driver(struct bContext *C);
695 void ui_but_anim_copy_driver(struct bContext *C);
696 void ui_but_anim_paste_driver(struct bContext *C);
697 void ui_but_anim_add_keyingset(struct bContext *C);
698 void ui_but_anim_remove_keyingset(struct bContext *C);
699 bool ui_but_anim_expression_get(uiBut *but, char *str, size_t maxlen);
700 bool ui_but_anim_expression_set(uiBut *but, const char *str);
701 bool ui_but_anim_expression_create(uiBut *but, const char *str);
702 void ui_but_anim_autokey(struct bContext *C, uiBut *but, struct Scene *scene, float cfra);
703
704 /* interface_eyedropper.c */
705 void UI_OT_eyedropper_color(struct wmOperatorType *ot);
706 void UI_OT_eyedropper_id(struct wmOperatorType *ot);
707 void UI_OT_eyedropper_depth(struct wmOperatorType *ot);
708
709 #endif  /* __INTERFACE_INTERN_H__ */