Holiday coding log :)
[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 "UI_resources.h"
37 #include "RNA_types.h"
38
39 struct ARegion;
40 struct bContext;
41 struct IDProperty;
42 struct uiHandleButtonData;
43 struct wmEvent;
44 struct wmOperatorType;
45 struct wmWindow;
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 /* visual types for drawing */
58 /* for time being separated from functional types */
59 typedef enum {
60         /* default */
61         UI_WTYPE_REGULAR,
62
63         /* standard set */
64         UI_WTYPE_LABEL,
65         UI_WTYPE_TOGGLE,
66         UI_WTYPE_OPTION,
67         UI_WTYPE_RADIO,
68         UI_WTYPE_NUMBER,
69         UI_WTYPE_SLIDER,
70         UI_WTYPE_EXEC,
71         UI_WTYPE_TOOLTIP,
72         
73         /* strings */
74         UI_WTYPE_NAME,
75         UI_WTYPE_NAME_LINK,
76         UI_WTYPE_POINTER_LINK,
77         UI_WTYPE_FILENAME,
78         
79         /* menus */
80         UI_WTYPE_MENU_RADIO,
81         UI_WTYPE_MENU_ICON_RADIO,
82         UI_WTYPE_MENU_POINTER_LINK,
83         UI_WTYPE_MENU_NODE_LINK,
84         
85         UI_WTYPE_PULLDOWN,
86         UI_WTYPE_MENU_ITEM,
87         UI_WTYPE_MENU_BACK,
88
89         /* specials */
90         UI_WTYPE_ICON,
91         UI_WTYPE_SWATCH,
92         UI_WTYPE_RGB_PICKER,
93         UI_WTYPE_NORMAL,
94         UI_WTYPE_BOX,
95         UI_WTYPE_SCROLL,
96         UI_WTYPE_LISTITEM,
97         UI_WTYPE_PROGRESSBAR
98 } uiWidgetTypeEnum;
99
100 /* menu scrolling */
101 #define UI_MENU_SCROLL_ARROW    12
102 #define UI_MENU_SCROLL_MOUSE    (UI_MENU_SCROLL_ARROW + 2)
103 #define UI_MENU_SCROLL_PAD              4
104
105 /* panel limits */
106 #define UI_PANEL_MINX   100
107 #define UI_PANEL_MINY   70
108
109 /* uiBut->flag */
110 #define UI_SELECT       1   /* use when the button is pressed */
111 #define UI_SCROLLED     2   /* temp hidden, scrolled away */
112 #define UI_ACTIVE       4
113 #define UI_HAS_ICON     8
114 #define UI_TEXTINPUT    16
115 #define UI_HIDDEN       32
116 /* warn: rest of uiBut->flag in UI_interface.h */
117
118 /* internal panel drawing defines */
119 #define PNL_GRID    (UI_UNIT_Y / 5) /* 4 default */
120 #define PNL_HEADER  (UI_UNIT_Y + 4) /* 24 default */
121
122 /* panel->flag */
123 #define PNL_SELECT  1
124 #define PNL_CLOSEDX 2
125 #define PNL_CLOSEDY 4
126 #define PNL_CLOSED  6
127 /*#define PNL_TABBED    8*/ /*UNUSED*/
128 #define PNL_OVERLAP 16
129
130 /* Button text selection:
131  * extension direction, selextend, inside ui_do_but_TEX */
132 #define EXTEND_LEFT     1
133 #define EXTEND_RIGHT    2
134
135 /* for scope resize zone */
136 #define SCOPE_RESIZE_PAD    9
137
138 /* bit button defines */
139 /* Bit operations */
140 #define UI_BITBUT_TEST(a, b)    ( ( (a) & 1 << (b) ) != 0)
141 #define UI_BITBUT_SET(a, b)     ( (a) | 1 << (b) )
142 #define UI_BITBUT_CLR(a, b)     ( (a) & ~(1 << (b)) )
143 /* bit-row */
144 #define UI_BITBUT_ROW(min, max)  (((max) >= 31 ? 0xFFFFFFFF : (1 << (max + 1)) - 1) - ((min) ? ((1 << (min)) - 1) : 0) )
145
146 typedef struct uiLinkLine {  /* only for draw/edit */
147         struct uiLinkLine *next, *prev;
148         struct uiBut *from, *to;
149         short flag, pad;
150 } uiLinkLine;
151
152 typedef struct {
153         void **poin;        /* pointer to original pointer */
154         void ***ppoin;      /* pointer to original pointer-array */
155         short *totlink;     /* if pointer-array, here is the total */
156         
157         short maxlink, pad;
158         short fromcode, tocode;
159         
160         ListBase lines;
161 } uiLink;
162
163 struct uiBut {
164         struct uiBut *next, *prev;
165         int flag, drawflag;
166         eButType         type;
167         eButPointerType  pointype;
168         short bit, bitnr, retval, strwidth, alignnr;
169         short ofs, pos, selsta, selend;
170
171         char *str;
172         char strdata[UI_MAX_NAME_STR];
173         char drawstr[UI_MAX_DRAW_STR];
174         
175         rctf rect;
176
177         char *poin;
178         float hardmin, hardmax, softmin, softmax;
179
180         /* both these values use depends on the button type
181          * (polymorphic struct or union would be nicer for this stuff) */
182
183         /* (type == COLOR),      Use UI_GRAD_* values.
184          * (type == NUM),        Use to store RNA 'step' value, for dragging and click-step.
185          * (type == LABEL),      Use (a1 == 1.0f) to use a2 as a blending factor (wow, this is imaginative!).
186          * (type == SCROLL)      Use as scroll size.
187          * (type == SEARCH_MENU) Use as number or rows.
188          */
189         float a1;
190
191         /* (type == HSVCIRCLE ), Use to store the luminosity.
192          * (type == NUM),        Use to store RNA 'precision' value, for dragging and click-step.
193          * (type == LABEL),      If (a1 == 1.0f) use a2 as a blending factor.
194          * (type == SEARCH_MENU) Use as number or columns.
195          */
196         float a2;
197
198         float aspect;
199         unsigned char col[4];
200
201         uiButHandleFunc func;
202         void *func_arg1;
203         void *func_arg2;
204         void *func_arg3;
205
206         uiButHandleNFunc funcN;
207         void *func_argN;
208
209         struct bContextStore *context;
210
211         /* not used yet, was used in 2.4x for ui_draw_pulldown_round & friends */
212 #if 0
213         void (*embossfunc)(int, int, float, float, float, float, float, int);
214         void (*sliderfunc)(int, float, float, float, float, float, float, int);
215 #endif
216
217         uiButCompleteFunc autocomplete_func;
218         void *autofunc_arg;
219         
220         uiButSearchFunc search_func;
221         void *search_arg;
222
223         uiButHandleRenameFunc rename_func;
224         void *rename_arg1;
225         void *rename_orig;
226
227         uiLink *link;
228         short linkto[2];
229         
230         const char *tip, *lockstr;
231
232         BIFIconID icon;
233         char lock;
234         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSSN ... etc, copied from the block */
235         char changed; /* could be made into a single flag */
236         unsigned char unit_type; /* so buttons can support unit systems which are not RNA */
237         short modifier_key;
238         short iconadd;
239
240         /* IDPOIN data */
241         uiIDPoinFuncFP idpoin_func;
242         ID **idpoin_idpp;
243
244         /* BLOCK data */
245         uiBlockCreateFunc block_create_func;
246
247         /* PULLDOWN/MENU data */
248         uiMenuCreateFunc menu_create_func;
249
250         /* RNA data */
251         struct PointerRNA rnapoin;
252         struct PropertyRNA *rnaprop;
253         int rnaindex;
254
255         struct PointerRNA rnasearchpoin;
256         struct PropertyRNA *rnasearchprop;
257
258         /* Operator data */
259         struct wmOperatorType *optype;
260         struct IDProperty *opproperties;
261         struct PointerRNA *opptr;
262         short opcontext;
263         unsigned char menu_key; /* 'a'-'z', always lower case */
264
265         /* Draggable data, type is WM_DRAG_... */
266         char dragtype;
267         void *dragpoin;
268         struct ImBuf *imb;
269         float imb_scale;
270         
271         /* active button data */
272         struct uiHandleButtonData *active;
273
274         char *editstr;
275         double *editval;
276         float *editvec;
277         void *editcoba;
278         void *editcumap;
279         
280         /* pointer back */
281         uiBlock *block;
282 };
283
284 struct uiBlock {
285         uiBlock *next, *prev;
286
287         ListBase buttons;
288         Panel *panel;
289         uiBlock *oldblock;
290
291         ListBase layouts;
292         struct uiLayout *curlayout;
293
294         ListBase contexts;
295         
296         char name[UI_MAX_NAME_STR];
297         
298         float winmat[4][4];
299
300         rctf rect;
301         float aspect;
302
303         int puphash;  /* popup menu hash for memory */
304
305         uiButHandleFunc func;
306         void *func_arg1;
307         void *func_arg2;
308
309         uiButHandleNFunc funcN;
310         void *func_argN;
311
312         uiMenuHandleFunc butm_func;
313         void *butm_func_arg;
314
315         uiBlockHandleFunc handle_func;
316         void *handle_func_arg;
317         
318         /* custom extra handling */
319         int (*block_event_func)(const struct bContext *C, struct uiBlock *, struct wmEvent *);
320         
321         /* extra draw function for custom blocks */
322         void (*drawextra)(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect);
323         void *drawextra_arg1;
324         void *drawextra_arg2;
325
326         int flag;
327         short alignnr;
328
329         char direction;
330         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSSN ... etc, copied to buttons */
331         char auto_open;
332         char _pad[7];
333         double auto_open_last;
334
335         const char *lockstr;
336
337         char lock;
338         char active;                /* to keep blocks while drawing and free them afterwards */
339         char tooltipdisabled;       /* to avoid tooltip after click */
340         char endblock;              /* uiEndBlock done? */
341
342         eBlockBoundsCalc bounds_type;  /* for doing delayed */
343         int mx, my;
344         int bounds, minbounds;      /* for doing delayed */
345
346         rctf safety;                /* pulldowns, to detect outside, can differ per case how it is created */
347         ListBase saferct;           /* uiSafetyRct list */
348
349         uiPopupBlockHandle *handle; /* handle */
350
351         struct wmOperator *ui_operator; /* use so presets can find the operator, */
352                                         /* across menus and from nested popups which fail for operator context. */
353
354         void *evil_C;               /* XXX hack for dynamic operator enums */
355
356         struct UnitSettings *unit;  /* unit system, used a lot for numeric buttons so include here rather then fetching through the scene every time. */
357         float _hsv[3];              /* XXX, only access via ui_block_hsv_get() */
358
359         char color_profile;         /* color profile for correcting linear colors for display */
360
361         const char *display_device; /* display device name used to display this block,
362                                      * used by color widgets to transform colors from/to scene linear
363                                      */
364 };
365
366 typedef struct uiSafetyRct {
367         struct uiSafetyRct *next, *prev;
368         rctf parent;
369         rctf safety;
370 } uiSafetyRct;
371
372 /* interface.c */
373
374 extern void ui_delete_linkline(uiLinkLine *line, uiBut *but);
375
376 void ui_fontscale(short *points, float aspect);
377
378 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
379 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
380 extern void ui_block_to_window_rct(const struct ARegion *ar, uiBlock *block, const rctf *graph, rcti *winr);
381 extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
382 extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
383 extern void ui_window_to_region(const ARegion *ar, int *x, int *y);
384
385 extern double ui_get_but_val(uiBut *but);
386 extern void ui_set_but_val(uiBut *but, double value);
387 extern void ui_set_but_hsv(uiBut *but);
388 extern void ui_get_but_vectorf(uiBut *but, float vec[3]);
389 extern void ui_set_but_vectorf(uiBut *but, const float vec[3]);
390
391 extern void ui_hsvcircle_vals_from_pos(float *val_rad, float *val_dist, const rcti *rect,
392                                        const float mx, const float my);
393
394 extern void ui_get_but_string(uiBut *but, char *str, size_t maxlen);
395 extern void ui_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen);
396 extern int ui_set_but_string(struct bContext *C, uiBut *but, const char *str);
397 extern int ui_get_but_string_max_length(uiBut *but);
398 extern int ui_set_but_string_eval_num(struct bContext *C, uiBut *but, const char *str, double *value);
399
400 extern void ui_set_but_default(struct bContext *C, short all);
401
402 extern void ui_set_but_soft_range(uiBut *but, double value);
403
404 extern void ui_check_but(uiBut *but);
405 extern int  ui_is_but_float(uiBut *but);
406 extern int  ui_is_but_unit(uiBut *but);
407 extern int  ui_is_but_rna_valid(uiBut *but);
408 extern int  ui_is_but_utf8(uiBut *but);
409
410 extern void ui_bounds_block(uiBlock *block);
411 extern void ui_block_translate(uiBlock *block, int x, int y);
412 extern void ui_block_do_align(uiBlock *block);
413
414 extern struct ColorManagedDisplay *ui_block_display_get(uiBlock *block);
415 void ui_block_to_display_space_v3(uiBlock *block, float pixel[3]);
416 void ui_block_to_scene_linear_v3(uiBlock *block, float pixel[3]);
417
418 /* interface_regions.c */
419
420 struct uiPopupBlockHandle {
421         /* internal */
422         struct ARegion *region;
423         int towardsx, towardsy;
424         double towardstime;
425         int dotowards;
426
427         int popup;
428         void (*popup_func)(struct bContext *C, void *arg, int event);
429         void (*cancel_func)(void *arg);
430         void *popup_arg;
431         
432         struct wmTimer *scrolltimer;
433
434         /* for operator popups */
435         struct wmOperatorType *optype;
436         ScrArea *ctx_area;
437         ARegion *ctx_region;
438         int opcontext;
439         
440         /* return values */
441         int butretval;
442         int menuretval;
443         float retvalue;
444         float retvec[4];
445
446         /* menu direction */
447         int direction;
448 };
449
450 uiBlock *ui_block_func_COLOR(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
451 void ui_block_func_ICONROW(struct bContext *C, uiLayout *layout, void *arg_but);
452 void ui_block_func_ICONTEXTROW(struct bContext *C, uiLayout *layout, void *arg_but);
453
454 struct ARegion *ui_tooltip_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
455 void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
456
457 uiBut *ui_popup_menu_memory(struct uiBlock *block, struct uiBut *but);
458
459 float *ui_block_hsv_get(struct uiBlock *block);
460 void ui_popup_block_scrolltest(struct uiBlock *block);
461
462
463 /* searchbox for string button */
464 ARegion *ui_searchbox_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
465 int ui_searchbox_inside(struct ARegion *ar, int x, int y);
466 void ui_searchbox_update(struct bContext *C, struct ARegion *ar, uiBut *but, int reset);
467 void ui_searchbox_autocomplete(struct bContext *C, struct ARegion *ar, uiBut *but, char *str);
468 void ui_searchbox_event(struct bContext *C, struct ARegion *ar, uiBut *but, struct wmEvent *event);
469 void ui_searchbox_apply(uiBut *but, struct ARegion *ar);
470 void ui_searchbox_free(struct bContext *C, struct ARegion *ar);
471 void ui_but_search_test(uiBut *but);
472
473 typedef uiBlock * (*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1);
474
475 uiPopupBlockHandle *ui_popup_block_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
476                                           uiBlockCreateFunc create_func, uiBlockHandleCreateFunc handle_create_func,
477                                           void *arg);
478 uiPopupBlockHandle *ui_popup_menu_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
479                                          uiMenuCreateFunc create_func, void *arg, char *str);
480
481 void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
482
483 void ui_set_name_menu(uiBut *but, int value);
484 int ui_step_name_menu(uiBut *but, int step);
485
486 struct AutoComplete;
487
488 /* interface_panel.c */
489 extern int ui_handler_panel_region(struct bContext *C, struct wmEvent *event);
490 extern void ui_draw_aligned_panel(struct uiStyle *style, uiBlock *block, rcti *rect);
491
492 /* interface_draw.c */
493 extern void ui_dropshadow(const rctf *rct, float radius, float aspect, float alpha, int select);
494
495 void ui_draw_gradient(rcti *rect, const float hsv[3], const int type, const float alpha);
496
497 void ui_draw_but_HISTOGRAM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
498 void ui_draw_but_WAVEFORM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
499 void ui_draw_but_VECTORSCOPE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
500 void ui_draw_but_COLORBAND(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
501 void ui_draw_but_NORMAL(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
502 void ui_draw_but_CURVE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
503 void ui_draw_but_IMAGE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
504 void ui_draw_but_TRACKPREVIEW(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
505
506 /* interface_handlers.c */
507 extern void ui_button_activate_do(struct bContext *C, struct ARegion *ar, uiBut *but);
508 extern void ui_button_active_free(const struct bContext *C, uiBut *but);
509 extern int ui_button_is_active(struct ARegion *ar);
510 extern int ui_button_open_menu_direction(uiBut *but);
511 extern void ui_button_text_password_hide(char password_str[UI_MAX_DRAW_STR], uiBut *but, int restore);
512
513 /* interface_widgets.c */
514 void ui_draw_anti_tria(float x1, float y1, float x2, float y2, float x3, float y3);
515 void ui_draw_anti_roundbox(int mode, float minx, float miny, float maxx, float maxy, float rad);
516 void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect);
517 uiWidgetColors *ui_tooltip_get_theme(void);
518 void ui_draw_tooltip_background(uiStyle *UNUSED(style), uiBlock * block, rcti * rect);
519 void ui_draw_search_back(struct uiStyle *style, uiBlock *block, rcti *rect);
520 int ui_link_bezier_points(rcti * rect, float coord_array[][2], int resol);
521 void ui_draw_link_bezier(rcti *rect);
522
523 extern void ui_draw_but(const struct bContext *C, ARegion *ar, struct uiStyle *style, uiBut *but, rcti *rect);
524 /* theme color init */
525 struct ThemeUI;
526 void ui_widget_color_init(struct ThemeUI *tui);
527
528 void ui_draw_menu_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
529 void ui_draw_preview_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
530
531 extern unsigned char checker_stipple_sml[32 * 32 / 8];
532 /* used for transp checkers */
533 #define UI_TRANSP_DARK 100
534 #define UI_TRANSP_LIGHT 160
535
536 /* interface_style.c */
537 void uiStyleInit(void);
538
539 /* interface_icons.c */
540 int ui_id_icon_get(struct bContext *C, struct ID *id, int preview);
541
542 /* resources.c */
543 void init_userdef_do_versions(void);
544 void ui_theme_init_default(void);
545 void ui_resources_init(void);
546 void ui_resources_free(void);
547
548 /* interface_layout.c */
549 void ui_layout_add_but(uiLayout *layout, uiBut *but);
550 int ui_but_can_align(uiBut *but);
551 void ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop);
552 void ui_but_add_shortcut(uiBut *but, const char *key_str, const short do_strip);
553
554 /* interface_anim.c */
555 void ui_but_anim_flag(uiBut *but, float cfra);
556 void ui_but_anim_insert_keyframe(struct bContext *C);
557 void ui_but_anim_delete_keyframe(struct bContext *C);
558 void ui_but_anim_clear_keyframe(struct bContext *C);
559 void ui_but_anim_add_driver(struct bContext *C);
560 void ui_but_anim_remove_driver(struct bContext *C);
561 void ui_but_anim_copy_driver(struct bContext *C);
562 void ui_but_anim_paste_driver(struct bContext *C);
563 void ui_but_anim_add_keyingset(struct bContext *C);
564 void ui_but_anim_remove_keyingset(struct bContext *C);
565 int ui_but_anim_expression_get(uiBut *but, char *str, size_t maxlen);
566 int ui_but_anim_expression_set(uiBut *but, const char *str);
567 int ui_but_anim_expression_create(uiBut *but, const char *str);
568 void ui_but_anim_autokey(struct bContext *C, uiBut *but, struct Scene *scene, float cfra);
569
570 #endif