Cycles: svn merge -r41531:41613 ^/trunk/blender
[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_H
34 #define INTERFACE_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         
72         /* strings */
73         UI_WTYPE_NAME,
74         UI_WTYPE_NAME_LINK,
75         UI_WTYPE_POINTER_LINK,
76         UI_WTYPE_FILENAME,
77         
78         /* menus */
79         UI_WTYPE_MENU_RADIO,
80         UI_WTYPE_MENU_ICON_RADIO,
81         UI_WTYPE_MENU_POINTER_LINK,
82         UI_WTYPE_MENU_NODE_LINK,
83         
84         UI_WTYPE_PULLDOWN,
85         UI_WTYPE_MENU_ITEM,
86         UI_WTYPE_MENU_BACK,
87         
88         /* specials */
89         UI_WTYPE_ICON,
90         UI_WTYPE_SWATCH,
91         UI_WTYPE_RGB_PICKER,
92         UI_WTYPE_NORMAL,
93         UI_WTYPE_BOX,
94         UI_WTYPE_SCROLL,
95         UI_WTYPE_LISTITEM,
96         UI_WTYPE_PROGRESSBAR,
97         
98 } uiWidgetTypeEnum;
99
100
101
102 #define UI_MAX_DRAW_STR 400
103 #define UI_MAX_NAME_STR 128
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+2)       /* 20 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 typedef struct uiLinkLine {                             /* only for draw/edit */
139         struct uiLinkLine *next, *prev;
140         struct uiBut *from, *to;
141         short flag, pad;
142 } uiLinkLine;
143
144 typedef struct {
145         void **poin;            /* pointer to original pointer */
146         void ***ppoin;          /* pointer to original pointer-array */
147         short *totlink;         /* if pointer-array, here is the total */
148         
149         short maxlink, pad;
150         short fromcode, tocode;
151         
152         ListBase lines;
153 } uiLink;
154
155 struct uiBut {
156         struct uiBut *next, *prev;
157         int flag;
158         short type, pointype, bit, bitnr, retval, strwidth, ofs, pos, selsta, selend, alignnr;
159         short pad1;
160
161         char *str;
162         char strdata[UI_MAX_NAME_STR];
163         char drawstr[UI_MAX_DRAW_STR];
164         
165         float x1, y1, x2, y2;
166
167         char *poin;
168         float hardmin, hardmax, softmin, softmax;
169         float a1, a2;
170         float aspect;
171         char col[4];
172
173         uiButHandleFunc func;
174         void *func_arg1;
175         void *func_arg2;
176         void *func_arg3;
177
178         uiButHandleNFunc funcN;
179         void *func_argN;
180
181         struct bContextStore *context;
182
183         /* not ysed yet, was used in 2.4x for ui_draw_pulldown_round & friends */
184         /*
185         void (*embossfunc)(int , int , float, float, float, float, float, int);
186         void (*sliderfunc)(int , float, float, float, float, float, float, int);
187         */
188
189         uiButCompleteFunc autocomplete_func;
190         void *autofunc_arg;
191         
192         uiButSearchFunc search_func;
193         void *search_arg;
194
195         uiButHandleRenameFunc rename_func;
196         void *rename_arg1;
197         void *rename_orig;
198
199         uiLink *link;
200         short linkto[2];
201         
202         const char *tip, *lockstr;
203
204         BIFIconID icon;
205         char lock;
206         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSSN ... etc, copied from the block */
207         char changed; /* could be made into a single flag */
208         unsigned char unit_type; /* so buttons can support unit systems which are not RNA */
209         short modifier_key;
210         short iconadd;
211
212         /* IDPOIN data */
213         uiIDPoinFuncFP idpoin_func;
214         ID **idpoin_idpp;
215
216         /* BLOCK data */
217         uiBlockCreateFunc block_create_func;
218
219         /* PULLDOWN/MENU data */
220         uiMenuCreateFunc menu_create_func;
221
222         /* RNA data */
223         struct PointerRNA rnapoin;
224         struct PropertyRNA *rnaprop;
225         int rnaindex;
226
227         struct PointerRNA rnasearchpoin;
228         struct PropertyRNA *rnasearchprop;
229
230         /* Operator data */
231         struct wmOperatorType *optype;
232         struct IDProperty *opproperties;
233         struct PointerRNA *opptr;
234         short opcontext;
235         unsigned char menu_key; /* 'a'-'z', always lower case */
236
237         /* Draggable data, type is WM_DRAG_... */
238         char dragtype;
239         void *dragpoin;
240         struct ImBuf *imb;
241         float imb_scale;
242
243         /* active button data */
244         struct uiHandleButtonData *active;
245
246         char *editstr;
247         double *editval;
248         float *editvec;
249         void *editcoba;
250         void *editcumap;
251         
252                 /* pointer back */
253         uiBlock *block;
254 };
255
256 struct uiBlock {
257         uiBlock *next, *prev;
258
259         ListBase buttons;
260         Panel *panel;
261         uiBlock *oldblock;
262
263         ListBase layouts;
264         struct uiLayout *curlayout;
265
266         ListBase contexts;
267         
268         char name[UI_MAX_NAME_STR];
269         
270         float winmat[4][4];
271         
272         float minx, miny, maxx, maxy;
273         float aspect;
274
275         int puphash;                            // popup menu hash for memory
276
277         uiButHandleFunc func;
278         void *func_arg1;
279         void *func_arg2;
280
281         uiButHandleNFunc funcN;
282         void *func_argN;
283
284         uiMenuHandleFunc butm_func;
285         void *butm_func_arg;
286
287         uiBlockHandleFunc handle_func;
288         void *handle_func_arg;
289         
290         /* custom extra handling */
291         int (*block_event_func)(const struct bContext *C, struct uiBlock *, struct wmEvent *);
292         
293         /* extra draw function for custom blocks */
294         void (*drawextra)(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect);
295         void *drawextra_arg1;
296         void *drawextra_arg2;
297
298         int flag;
299         short alignnr;
300
301         char direction;
302         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSSN ... etc, copied to buttons */
303         char auto_open;
304         char _pad[7];
305         double auto_open_last;
306
307         const char *lockstr;
308
309         char lock;
310         char active;                                    // to keep blocks while drawing and free them afterwards
311         char tooltipdisabled;                   // to avoid tooltip after click
312         char endblock;                                  // uiEndBlock done?
313         
314         float xofs, yofs;                               // offset to parent button
315         int dobounds, mx, my;                   // for doing delayed
316         int bounds, minbounds;                  // for doing delayed
317
318         rctf safety;                            // pulldowns, to detect outside, can differ per case how it is created
319         ListBase saferct;                       // uiSafetyRct list
320
321         uiPopupBlockHandle *handle;     // handle
322         
323         void *evil_C;                           // XXX hack for dynamic operator enums
324
325         struct UnitSettings *unit;      // unit system, used a lot for numeric buttons so include here rather then fetching through the scene every time.
326         float _hsv[3];                          // XXX, only access via ui_block_hsv_get()
327         char color_profile;                     // color profile for correcting linear colors for display
328 };
329
330 typedef struct uiSafetyRct {
331         struct uiSafetyRct *next, *prev;
332         rctf parent;
333         rctf safety;
334 } uiSafetyRct;
335
336 /* interface.c */
337
338 extern void ui_delete_linkline(uiLinkLine *line, uiBut *but);
339
340 void ui_fontscale(short *points, float aspect);
341
342 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
343 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
344 extern void ui_block_to_window_rct(const struct ARegion *ar, uiBlock *block, rctf *graph, rcti *winr);
345 extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
346 extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
347 extern void ui_window_to_region(const ARegion *ar, int *x, int *y);
348
349 extern double ui_get_but_val(uiBut *but);
350 extern void ui_set_but_val(uiBut *but, double value);
351 extern void ui_set_but_hsv(uiBut *but);
352 extern void ui_get_but_vectorf(uiBut *but, float vec[3]);
353 extern void ui_set_but_vectorf(uiBut *but, const float vec[3]);
354
355 extern void ui_hsvcircle_vals_from_pos(float *valrad, float *valdist, rcti *rect, float mx, float my);
356
357 extern void ui_get_but_string(uiBut *but, char *str, size_t maxlen);
358 extern void ui_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen);
359 extern int ui_set_but_string(struct bContext *C, uiBut *but, const char *str);
360 extern int ui_get_but_string_max_length(uiBut *but);
361
362 extern void ui_set_but_default(struct bContext *C, short all);
363
364 extern void ui_set_but_soft_range(uiBut *but, double value);
365
366 extern void ui_check_but(uiBut *but);
367 extern int  ui_is_but_float(uiBut *but);
368 extern int  ui_is_but_unit(uiBut *but);
369 extern int  ui_is_but_rna_valid(uiBut *but);
370 extern int  ui_is_but_utf8(uiBut *but);
371
372 extern void ui_bounds_block(uiBlock *block);
373 extern void ui_block_translate(uiBlock *block, int x, int y);
374 extern void ui_block_do_align(uiBlock *block);
375
376 /* interface_regions.c */
377
378 struct uiPopupBlockHandle {
379         /* internal */
380         struct ARegion *region;
381         int towardsx, towardsy;
382         double towardstime;
383         int dotowards;
384
385         int popup;
386         void (*popup_func)(struct bContext *C, void *arg, int event);
387         void (*cancel_func)(void *arg);
388         void *popup_arg;
389         
390         struct wmTimer *scrolltimer;
391
392         /* for operator popups */
393         struct wmOperatorType *optype;
394         ScrArea *ctx_area;
395         ARegion *ctx_region;
396         int opcontext;
397         
398         /* return values */
399         int butretval;
400         int menuretval;
401         float retvalue;
402         float retvec[4];
403 };
404
405 uiBlock *ui_block_func_COL(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
406 void ui_block_func_ICONROW(struct bContext *C, uiLayout *layout, void *arg_but);
407 void ui_block_func_ICONTEXTROW(struct bContext *C, uiLayout *layout, void *arg_but);
408
409 struct ARegion *ui_tooltip_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
410 void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
411
412 uiBut *ui_popup_menu_memory(struct uiBlock *block, struct uiBut *but);
413
414 float *ui_block_hsv_get(struct uiBlock *block);
415 void ui_popup_block_scrolltest(struct uiBlock *block);
416
417
418 /* searchbox for string button */
419 ARegion *ui_searchbox_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
420 int ui_searchbox_inside(struct ARegion *ar, int x, int y);
421 void ui_searchbox_update(struct bContext *C, struct ARegion *ar, uiBut *but, int reset);
422 void ui_searchbox_autocomplete(struct bContext *C, struct ARegion *ar, uiBut *but, char *str);
423 void ui_searchbox_event(struct bContext *C, struct ARegion *ar, uiBut *but, struct wmEvent *event);
424 void ui_searchbox_apply(uiBut *but, struct ARegion *ar);
425 void ui_searchbox_free(struct bContext *C, struct ARegion *ar);
426 void ui_but_search_test(uiBut *but);
427
428 typedef uiBlock* (*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1);
429
430 uiPopupBlockHandle *ui_popup_block_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
431         uiBlockCreateFunc create_func, uiBlockHandleCreateFunc handle_create_func, void *arg);
432 uiPopupBlockHandle *ui_popup_menu_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
433         uiMenuCreateFunc create_func, void *arg, char *str);
434
435 void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
436
437 void ui_set_name_menu(uiBut *but, int value);
438 int ui_step_name_menu(uiBut *but, int step);
439
440 struct AutoComplete;
441
442 /* interface_panel.c */
443 extern int ui_handler_panel_region(struct bContext *C, struct wmEvent *event);
444 extern void ui_draw_aligned_panel(struct uiStyle *style, uiBlock *block, rcti *rect);
445
446 /* interface_draw.c */
447 extern void ui_dropshadow(rctf *rct, float radius, float aspect, int select);
448
449 void ui_draw_gradient(rcti *rect, float *hsv, int type, float alpha);
450
451 void ui_draw_but_HISTOGRAM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
452 void ui_draw_but_WAVEFORM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
453 void ui_draw_but_VECTORSCOPE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
454 void ui_draw_but_COLORBAND(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
455 void ui_draw_but_NORMAL(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
456 void ui_draw_but_CURVE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
457 void ui_draw_but_IMAGE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
458 void ui_draw_but_TRACKPREVIEW(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
459
460 /* interface_handlers.c */
461 extern void ui_button_activate_do(struct bContext *C, struct ARegion *ar, uiBut *but);
462 extern void ui_button_active_free(const struct bContext *C, uiBut *but);
463 extern int ui_button_is_active(struct ARegion *ar);
464
465 /* interface_widgets.c */
466 void ui_draw_anti_tria(float x1, float y1, float x2, float y2, float x3, float y3);
467 void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect);
468 void ui_draw_search_back(struct uiStyle *style, uiBlock *block, rcti *rect);
469 int ui_link_bezier_points(rcti *rect, float coord_array[][2], int resol);
470 void ui_draw_link_bezier(rcti *rect);
471
472 extern void ui_draw_but(const struct bContext *C, ARegion *ar, struct uiStyle *style, uiBut *but, rcti *rect);
473                 /* theme color init */
474 struct ThemeUI;
475 void ui_widget_color_init(struct ThemeUI *tui);
476
477 void ui_draw_menu_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
478 void ui_draw_preview_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
479
480 extern unsigned char checker_stipple_sml[];
481 /* used for transp checkers */
482 #define UI_TRANSP_DARK 100
483 #define UI_TRANSP_LIGHT 160
484
485 /* interface_style.c */
486 void uiStyleInit(void);
487
488 /* interface_icons.c */
489 int ui_id_icon_get(struct bContext *C, struct ID *id, int preview);
490
491 /* resources.c */
492 void init_userdef_do_versions(void);
493 void ui_theme_init_default(void);
494 void ui_resources_init(void);
495 void ui_resources_free(void);
496
497 /* interface_layout.c */
498 void ui_layout_add_but(uiLayout *layout, uiBut *but);
499 int ui_but_can_align(uiBut *but);
500 void ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop);
501
502 /* interface_anim.c */
503 void ui_but_anim_flag(uiBut *but, float cfra);
504 void ui_but_anim_insert_keyframe(struct bContext *C);
505 void ui_but_anim_delete_keyframe(struct bContext *C);
506 void ui_but_anim_add_driver(struct bContext *C);
507 void ui_but_anim_remove_driver(struct bContext *C);
508 void ui_but_anim_copy_driver(struct bContext *C);
509 void ui_but_anim_paste_driver(struct bContext *C);
510 void ui_but_anim_add_keyingset(struct bContext *C);
511 void ui_but_anim_remove_keyingset(struct bContext *C);
512 int ui_but_anim_expression_get(uiBut *but, char *str, size_t maxlen);
513 int ui_but_anim_expression_set(uiBut *but, const char *str);
514 int ui_but_anim_expression_create(uiBut *but, const char *str);
515 void ui_but_anim_autokey(struct bContext *C, uiBut *but, struct Scene *scene, float cfra);
516
517 #endif
518