f0b8391657257d49e888798cc0cbad08d7f78eac
[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 /* uiBut->dragflag */
133 enum {
134         UI_BUT_DRAGPOIN_FREE = (1 << 0),
135 };
136
137 /* but->pie_dir */
138 typedef enum RadialDirection {
139         UI_RADIAL_NONE  = -1,
140         UI_RADIAL_N     =  0,
141         UI_RADIAL_NE    =  1,
142         UI_RADIAL_E     =  2,
143         UI_RADIAL_SE    =  3,
144         UI_RADIAL_S     =  4,
145         UI_RADIAL_SW    =  5,
146         UI_RADIAL_W     =  6,
147         UI_RADIAL_NW    =  7,
148 } RadialDirection;
149
150 extern const char  ui_radial_dir_order[8];
151 extern const char  ui_radial_dir_to_numpad[8];
152 extern const short ui_radial_dir_to_angle[8];
153
154 /* internal panel drawing defines */
155 #define PNL_GRID    (UI_UNIT_Y / 5) /* 4 default */
156 #define PNL_HEADER  (UI_UNIT_Y + 4) /* 24 default */
157
158 /* bit button defines */
159 /* Bit operations */
160 #define UI_BITBUT_TEST(a, b)    ( ( (a) & 1 << (b) ) != 0)
161 #define UI_BITBUT_SET(a, b)     ( (a) | 1 << (b) )
162 #define UI_BITBUT_CLR(a, b)     ( (a) & ~(1 << (b)) )
163 /* bit-row */
164 #define UI_BITBUT_ROW(min, max)  (((max) >= 31 ? 0xFFFFFFFF : (1 << ((max) + 1)) - 1) - ((min) ? ((1 << (min)) - 1) : 0) )
165
166 /* split numbuts by ':' and align l/r */
167 #define USE_NUMBUTS_LR_ALIGN
168
169 /* Use new 'align' computation code. */
170 #define USE_UIBUT_SPATIAL_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 /* max amount of items a radial menu (pie menu) can contain */
186 #define PIE_MAX_ITEMS 8
187
188 typedef struct uiLinkLine {  /* only for draw/edit */
189         struct uiLinkLine *next, *prev;
190         struct uiBut *from, *to;
191         short flag, deactive;
192 } uiLinkLine;
193
194 typedef struct {
195         void **poin;        /* pointer to original pointer */
196         void ***ppoin;      /* pointer to original pointer-array */
197         short *totlink;     /* if pointer-array, here is the total */
198         
199         short maxlink, pad;
200         short fromcode, tocode;
201         
202         ListBase lines;
203 } uiLink;
204
205 struct uiBut {
206         struct uiBut *next, *prev;
207         int flag, drawflag;
208         eButType         type;
209         eButPointerType  pointype;
210         short bit, bitnr, retval, strwidth, alignnr;
211         short ofs, pos, selsta, selend;
212
213         char *str;
214         char strdata[UI_MAX_NAME_STR];
215         char drawstr[UI_MAX_DRAW_STR];
216
217         rctf rect;  /* block relative coords */
218
219         char *poin;
220         float hardmin, hardmax, softmin, softmax;
221
222         /* both these values use depends on the button type
223          * (polymorphic struct or union would be nicer for this stuff) */
224
225         /* (type == UI_BTYPE_HSVCUBE),    Use UI_GRAD_* values.
226          * (type == UI_BTYPE_NUM),        Use to store RNA 'step' value, for dragging and click-step.
227          * (type == UI_BTYPE_LABEL),      Use (a1 == 1.0f) to use a2 as a blending factor (wow, this is imaginative!).
228          * (type == UI_BTYPE_SCROLL)      Use as scroll size.
229          * (type == UI_BTYPE_SEARCH_MENU) Use as number or rows.
230          * (type == UI_BTYPE_COLOR)       Use as indication of color palette
231          * (type == UI_BTYPE_PROGRESS_BAR) Use to store progress (0..1).
232          */
233         float a1;
234
235         /* (type == UI_BTYPE_HSVCIRCLE ), Use to store the luminosity.
236          * (type == UI_BTYPE_NUM),        Use to store RNA 'precision' value, for dragging and click-step.
237          * (type == UI_BTYPE_LABEL),      If (a1 == 1.0f) use a2 as a blending factor.
238          * (type == UI_BTYPE_SEARCH_MENU) Use as number or columns.
239          * (type == UI_BTYPE_COLOR)       Use as index in palette (not so good, needs refactor)
240          */
241         float a2;
242
243         unsigned char col[4];
244
245         uiButHandleFunc func;
246         void *func_arg1;
247         void *func_arg2;
248
249         uiButHandleNFunc funcN;
250         void *func_argN;
251
252         struct bContextStore *context;
253
254         uiButCompleteFunc autocomplete_func;
255         void *autofunc_arg;
256         
257         uiButSearchFunc search_func;
258         void *search_arg;
259
260         uiButHandleRenameFunc rename_func;
261         void *rename_arg1;
262         void *rename_orig;
263
264         uiLink *link;
265         short linkto[2];  /* region relative coords */
266         
267         const char *tip;
268         uiButToolTipFunc tip_func;
269         void *tip_argN;
270
271         const char *lockstr;
272
273         BIFIconID icon;
274         bool lock;
275         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSS_NONE ... etc, copied from the block */
276         signed char pie_dir; /* direction in a pie menu, used for collision detection (RadialDirection) */
277         char changed; /* could be made into a single flag */
278         unsigned char unit_type; /* so buttons can support unit systems which are not RNA */
279         short modifier_key;
280         short iconadd;
281
282         /* UI_BTYPE_BLOCK data */
283         uiBlockCreateFunc block_create_func;
284
285         /* UI_BTYPE_PULLDOWN/UI_BTYPE_MENU data */
286         uiMenuCreateFunc menu_create_func;
287
288         uiMenuStepFunc menu_step_func;
289
290         /* RNA data */
291         struct PointerRNA rnapoin;
292         struct PropertyRNA *rnaprop;
293         int rnaindex;
294
295         struct PointerRNA rnasearchpoin;
296         struct PropertyRNA *rnasearchprop;
297
298         /* Operator data */
299         struct wmOperatorType *optype;
300         struct PointerRNA *opptr;
301         short opcontext;
302         unsigned char menu_key; /* 'a'-'z', always lower case */
303
304         /* Draggable data, type is WM_DRAG_... */
305         char dragtype;
306         short dragflag;
307         void *dragpoin;
308         struct ImBuf *imb;
309         float imb_scale;
310         
311         /* active button data */
312         struct uiHandleButtonData *active;
313
314         /* Custom button data. */
315         void *custom_data;
316
317         char *editstr;
318         double *editval;
319         float *editvec;
320         void *editcoba;
321         void *editcumap;
322         
323         /* pointer back */
324         uiBlock *block;
325 };
326
327 typedef struct ColorPicker {
328         struct ColorPicker *next, *prev;
329         float color_data[3]; /* colr data may be HSV or HSL for now */
330         int representation; /* store hsv/hsl value */
331 } ColorPicker;
332
333 typedef struct ColorPickerData {
334         ListBase list;
335 } ColorPickerData;
336
337 struct PieMenuData {
338         /* store title and icon to allow access when pie levels are created */
339         const char *title;
340         int icon;
341
342         float pie_dir[2];
343         float pie_center_init[2];
344         float pie_center_spawned[2];
345         float last_pos[2];
346         double duration_gesture;
347         int flags;
348         int event; /* initial event used to fire the pie menu, store here so we can query for release */
349         float alphafac;
350 };
351
352 struct uiBlock {
353         uiBlock *next, *prev;
354
355         ListBase buttons;
356         Panel *panel;
357         uiBlock *oldblock;
358
359         ListBase butstore;  /* UI_butstore_* runtime function */
360
361         ListBase layouts;
362         struct uiLayout *curlayout;
363
364         ListBase contexts;
365         
366         char name[UI_MAX_NAME_STR];
367         
368         float winmat[4][4];
369
370         rctf rect;
371         float aspect;
372
373         unsigned int puphash;  /* popup menu hash for memory */
374
375         uiButHandleFunc func;
376         void *func_arg1;
377         void *func_arg2;
378
379         uiButHandleNFunc funcN;
380         void *func_argN;
381
382         uiMenuHandleFunc butm_func;
383         void *butm_func_arg;
384
385         uiBlockHandleFunc handle_func;
386         void *handle_func_arg;
387         
388         /* custom extra handling */
389         int (*block_event_func)(const struct bContext *C, struct uiBlock *, const struct wmEvent *);
390         
391         /* extra draw function for custom blocks */
392         void (*drawextra)(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect);
393         void *drawextra_arg1;
394         void *drawextra_arg2;
395
396         int flag;
397         short alignnr;
398
399         char direction;
400         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSS_NONE ... etc, copied to buttons */
401         bool auto_open;
402         char _pad[7];
403         double auto_open_last;
404
405         const char *lockstr;
406
407         char lock;
408         char active;                /* to keep blocks while drawing and free them afterwards */
409         char tooltipdisabled;       /* to avoid tooltip after click */
410         char endblock;              /* UI_block_end done? */
411
412         eBlockBoundsCalc bounds_type;  /* for doing delayed */
413         int mx, my;
414         int bounds, minbounds;      /* for doing delayed */
415
416         rctf safety;                /* pulldowns, to detect outside, can differ per case how it is created */
417         ListBase saferct;           /* uiSafetyRct list */
418
419         uiPopupBlockHandle *handle; /* handle */
420
421         struct wmOperator *ui_operator; /* use so presets can find the operator, */
422                                         /* across menus and from nested popups which fail for operator context. */
423
424         void *evil_C;               /* XXX hack for dynamic operator enums */
425
426         struct UnitSettings *unit;  /* unit system, used a lot for numeric buttons so include here rather then fetching through the scene every time. */
427         ColorPickerData color_pickers; /* XXX, only accessed by color picker templates */
428
429         bool color_profile;         /* color profile for correcting linear colors for display */
430
431         char display_device[64]; /* display device name used to display this block,
432                                   * used by color widgets to transform colors from/to scene linear
433                                   */
434         struct PieMenuData pie_data;
435 };
436
437 typedef struct uiSafetyRct {
438         struct uiSafetyRct *next, *prev;
439         rctf parent;
440         rctf safety;
441 } uiSafetyRct;
442
443 /* interface.c */
444
445 extern void ui_linkline_remove(uiLinkLine *line, uiBut *but);
446
447 void ui_fontscale(short *points, float aspect);
448
449 extern bool ui_block_is_menu(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
450 extern bool ui_block_is_pie_menu(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
451 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
452 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
453 extern void ui_block_to_window_rctf(const struct ARegion *ar, uiBlock *block, rctf *rct_dst, const rctf *rct_src);
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         float *val_rad, float *val_dist, const rcti *rect,
468         const float mx, const float my);
469 extern void ui_hsvcircle_pos_from_vals(struct uiBut *but, const rcti *rect, float *hsv, float *xpos, float *ypos);
470 extern void ui_hsvcube_pos_from_vals(struct uiBut *but, const rcti *rect, float *hsv, float *xp, float *yp);
471 bool ui_but_is_colorpicker_display_space(struct uiBut *but);
472
473 extern void ui_but_string_get_ex(uiBut *but, char *str, const size_t maxlen, const int float_precision) ATTR_NONNULL();
474 extern void ui_but_string_get(uiBut *but, char *str, const size_t maxlen) ATTR_NONNULL();
475 extern char *ui_but_string_get_dynamic(uiBut *but, int *r_str_size);
476 extern void ui_but_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen) ATTR_NONNULL();
477 extern bool ui_but_string_set(struct bContext *C, uiBut *but, const char *str) ATTR_NONNULL();
478 extern bool ui_but_string_set_eval_num(struct bContext *C, uiBut *but, const char *str, double *value) ATTR_NONNULL();
479 extern int  ui_but_string_get_max_length(uiBut *but);
480 extern uiBut *ui_but_drag_multi_edit_get(uiBut *but);
481
482 void ui_def_but_icon(uiBut *but, const int icon, const int flag);
483 extern uiButExtraIconType ui_but_icon_extra_get(uiBut *but);
484
485 extern void ui_but_default_set(struct bContext *C, const bool all, const bool use_afterfunc);
486
487 extern void ui_but_update_ex(uiBut *but, const bool validate);
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_is_utf8(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
496 extern bool ui_but_supports_cycling(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
497
498 extern int  ui_but_is_pushed_ex(uiBut *but, double *value) ATTR_WARN_UNUSED_RESULT;
499 extern int  ui_but_is_pushed(uiBut *but) ATTR_WARN_UNUSED_RESULT;
500
501
502 extern void ui_block_bounds_calc(uiBlock *block);
503 extern void ui_block_translate(uiBlock *block, int x, int y);
504
505 extern struct ColorManagedDisplay *ui_block_cm_display_get(uiBlock *block);
506 void ui_block_cm_to_display_space_v3(uiBlock *block, float pixel[3]);
507 void ui_block_cm_to_scene_linear_v3(uiBlock *block, float pixel[3]);
508 void ui_block_cm_to_display_space_range(uiBlock *block, float *min, float *max);
509
510 /* interface_regions.c */
511
512 struct uiKeyNavLock {
513         /* set when we're using keyinput */
514         bool is_keynav;
515         /* only used to check if we've moved the cursor */
516         int event_xy[2];
517 };
518
519 typedef uiBlock * (*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1);
520
521 struct uiPopupBlockCreate {
522         uiBlockCreateFunc              create_func;
523         uiBlockHandleCreateFunc handle_create_func;
524         void *arg;
525
526         int event_xy[2];
527
528         /* when popup is initialized from a button */
529         ARegion *butregion;
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
549         struct wmTimer *scrolltimer;
550
551         struct uiKeyNavLock keynav_state;
552
553         /* for operator popups */
554         struct wmOperatorType *optype;
555         ScrArea *ctx_area;
556         ARegion *ctx_region;
557         int opcontext;
558         
559         /* return values */
560         int butretval;
561         int menuretval;
562         int   retvalue;
563         float retvec[4];
564
565         /* menu direction */
566         int direction;
567
568 /* #ifdef USE_DRAG_POPUP */
569         bool is_grab;
570         int     grab_xy_prev[2];
571 /* #endif */
572 };
573
574 uiBlock *ui_block_func_COLOR(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
575
576 struct ARegion *ui_tooltip_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
577 void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
578
579 uiBut *ui_popup_menu_memory_get(struct uiBlock *block);
580 void   ui_popup_menu_memory_set(uiBlock *block, struct uiBut *but);
581
582 void   ui_popup_translate(struct bContext *C, struct ARegion *ar, const int mdiff[2]);
583
584 ColorPicker *ui_block_colorpicker_create(struct uiBlock *block);
585 void ui_popup_block_scrolltest(struct uiBlock *block);
586
587 void ui_rgb_to_color_picker_compat_v(const float rgb[3], float r_cp[3]);
588 void ui_rgb_to_color_picker_v(const float rgb[3], float r_cp[3]);
589 void ui_color_picker_to_rgb_v(const float r_cp[3], float rgb[3]);
590 void ui_color_picker_to_rgb(float r_cp0, float r_cp1, float r_cp2, float *r, float *g, float *b);
591
592 /* searchbox for string button */
593 ARegion *ui_searchbox_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
594 bool ui_searchbox_inside(struct ARegion *ar, int x, int y);
595 int  ui_searchbox_find_index(struct ARegion *ar, const char *name);
596 void ui_searchbox_update(struct bContext *C, struct ARegion *ar, uiBut *but, const bool reset);
597 int ui_searchbox_autocomplete(struct bContext *C, struct ARegion *ar, uiBut *but, char *str);
598 void ui_searchbox_event(struct bContext *C, struct ARegion *ar, uiBut *but, const struct wmEvent *event);
599 bool ui_searchbox_apply(uiBut *but, struct ARegion *ar);
600 void ui_searchbox_free(struct bContext *C, struct ARegion *ar);
601 void ui_but_search_refresh(uiBut *but);
602
603 uiBlock *ui_popup_block_refresh(
604         struct bContext *C, uiPopupBlockHandle *handle,
605         ARegion *butregion, uiBut *but);
606
607 uiPopupBlockHandle *ui_popup_block_create(
608         struct bContext *C, struct ARegion *butregion, uiBut *but,
609         uiBlockCreateFunc create_func, uiBlockHandleCreateFunc handle_create_func,
610         void *arg);
611 uiPopupBlockHandle *ui_popup_menu_create(
612         struct bContext *C, struct ARegion *butregion, uiBut *but,
613         uiMenuCreateFunc create_func, void *arg);
614
615 void ui_pie_menu_level_create(
616         uiBlock *block, struct wmOperatorType *ot, const char *propname, IDProperty *properties,
617         const EnumPropertyItem *items, int totitem, int context, int flag);
618
619 void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
620
621 int  ui_but_menu_step(uiBut *but, int step);
622 bool ui_but_menu_step_poll(const uiBut *but);
623
624
625 /* interface_panel.c */
626 extern int ui_handler_panel_region(
627         struct bContext *C, const struct wmEvent *event,
628         struct ARegion *ar, const uiBut *active_but);
629 extern void ui_draw_aligned_panel(struct uiStyle *style, uiBlock *block, const rcti *rect, const bool show_pin);
630
631 /* interface_draw.c */
632 extern void ui_draw_dropshadow(const rctf *rct, float radius, float aspect, float alpha, int select);
633
634 void ui_draw_gradient(const rcti *rect, const float hsv[3], const int type, const float alpha);
635
636 void ui_draw_but_HISTOGRAM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
637 void ui_draw_but_WAVEFORM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
638 void ui_draw_but_VECTORSCOPE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
639 void ui_draw_but_COLORBAND(uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
640 void ui_draw_but_UNITVEC(uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
641 void ui_draw_but_CURVE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
642 void ui_draw_but_IMAGE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
643 void ui_draw_but_TRACKPREVIEW(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
644 void ui_draw_but_NODESOCKET(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
645
646 /* interface_handlers.c */
647 PointerRNA *ui_handle_afterfunc_add_operator(struct wmOperatorType *ot, int opcontext, bool create_props);
648 extern void ui_pan_to_scroll(const struct wmEvent *event, int *type, int *val);
649 extern void ui_but_activate_event(struct bContext *C, struct ARegion *ar, uiBut *but);
650 extern void ui_but_activate_over(struct bContext *C, struct ARegion *ar, uiBut *but);
651 extern void ui_but_execute_begin(struct bContext *C, struct ARegion *ar, uiBut *but, void **active_back);
652 extern void ui_but_execute_end(struct bContext *C, struct ARegion *ar, uiBut *but, void *active_back);
653 extern void ui_but_active_free(const struct bContext *C, uiBut *but);
654 extern bool ui_but_is_active(struct ARegion *ar) ATTR_WARN_UNUSED_RESULT;
655 extern int ui_but_menu_direction(uiBut *but);
656 extern void ui_but_text_password_hide(char password_str[UI_MAX_DRAW_STR], uiBut *but, const bool restore);
657 extern uiBut *ui_but_find_select_in_enum(uiBut *but, int direction);
658 extern uiBut *ui_but_find_active_in_region(struct ARegion *ar);
659 bool ui_but_is_editable(const uiBut *but);
660 bool ui_but_is_editable_as_text(const uiBut *but);
661 void ui_but_pie_dir_visual(RadialDirection dir, float vec[2]);
662 void ui_but_pie_dir(RadialDirection dir, float vec[2]);
663 float ui_block_calc_pie_segment(struct uiBlock *block, const float event_xy[2]);
664
665 void ui_but_add_shortcut(uiBut *but, const char *key_str, const bool do_strip);
666 void ui_but_clipboard_free(void);
667 void ui_panel_menu(struct bContext *C, ARegion *ar, Panel *pa);
668 uiBut *ui_but_find_old(uiBlock *block_old, const uiBut *but_new);
669 uiBut *ui_but_find_new(uiBlock *block_old, const uiBut *but_new);
670
671 #ifdef WITH_INPUT_IME
672 void ui_but_ime_reposition(uiBut *but, int x, int y, bool complete);
673 struct wmIMEData *ui_but_ime_data_get(uiBut *but);
674 #endif
675
676 /* interface_widgets.c */
677 void ui_draw_anti_tria(float x1, float y1, float x2, float y2, float x3, float y3);
678 void ui_draw_anti_roundbox(int mode, float minx, float miny, float maxx, float maxy, float rad, bool use_alpha);
679 void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect);
680 void ui_draw_pie_center(uiBlock *block);
681 uiWidgetColors *ui_tooltip_get_theme(void);
682 void ui_draw_tooltip_background(uiStyle *UNUSED(style), uiBlock *block, rcti *rect);
683 void ui_draw_search_back(struct uiStyle *style, uiBlock *block, rcti *rect);
684 bool ui_link_bezier_points(const rcti *rect, float coord_array[][2], int resol);
685 void ui_draw_link_bezier(const rcti *rect);
686
687 extern void ui_draw_but(const struct bContext *C, ARegion *ar, struct uiStyle *style, uiBut *but, rcti *rect);
688 /* theme color init */
689 struct ThemeUI;
690 void ui_widget_color_init(struct ThemeUI *tui);
691
692 void ui_draw_menu_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state, bool use_sep);
693 void ui_draw_preview_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
694
695 #define UI_TEXT_MARGIN_X 0.4f
696 #define UI_POPUP_MARGIN (UI_DPI_FAC * 12)
697 /* margin at top of screen for popups */
698 #define UI_POPUP_MENU_TOP (int)(8 * UI_DPI_FAC)
699
700 /* interface_style.c */
701 void uiStyleInit(void);
702
703 /* interface_icons.c */
704 void ui_icon_ensure_deferred(const struct bContext *C, const int icon_id, const bool big);
705 int ui_id_icon_get(const struct bContext *C, struct ID *id, const bool big);
706
707 /* resources.c */
708 void init_userdef_do_versions(void);
709 void ui_theme_init_default(void);
710 void ui_style_init_default(void);
711 void ui_resources_init(void);
712 void ui_resources_free(void);
713
714 /* interface_layout.c */
715 void ui_layout_add_but(uiLayout *layout, uiBut *but);
716 void ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop);
717 void ui_layout_list_set_labels_active(uiLayout *layout);
718
719 /* interface_align.c */
720 bool ui_but_can_align(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
721 void ui_block_align_calc(uiBlock *block);
722
723 /* interface_anim.c */
724 void ui_but_anim_flag(uiBut *but, float cfra);
725 void ui_but_anim_insert_keyframe(struct bContext *C);
726 void ui_but_anim_delete_keyframe(struct bContext *C);
727 void ui_but_anim_clear_keyframe(struct bContext *C);
728 void ui_but_anim_add_driver(struct bContext *C);
729 void ui_but_anim_remove_driver(struct bContext *C);
730 void ui_but_anim_copy_driver(struct bContext *C);
731 void ui_but_anim_paste_driver(struct bContext *C);
732 void ui_but_anim_add_keyingset(struct bContext *C);
733 void ui_but_anim_remove_keyingset(struct bContext *C);
734 bool ui_but_anim_expression_get(uiBut *but, char *str, size_t maxlen);
735 bool ui_but_anim_expression_set(uiBut *but, const char *str);
736 bool ui_but_anim_expression_create(uiBut *but, const char *str);
737 void ui_but_anim_autokey(struct bContext *C, uiBut *but, struct Scene *scene, float cfra);
738
739 /* interface_eyedropper.c */
740 void UI_OT_eyedropper_color(struct wmOperatorType *ot);
741 void UI_OT_eyedropper_id(struct wmOperatorType *ot);
742 void UI_OT_eyedropper_depth(struct wmOperatorType *ot);
743
744 #endif  /* __INTERFACE_INTERN_H__ */