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