9af3ff3bdd832b9d0425d7f200402604762a1229
[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         
99 } uiWidgetTypeEnum;
100
101 /* panel limits */
102 #define UI_PANEL_MINX   100
103 #define UI_PANEL_MINY   70
104
105 /* uiBut->flag */
106 #define UI_SELECT       1   /* use when the button is pressed */
107 #define UI_SCROLLED     2   /* temp hidden, scrolled away */
108 #define UI_ACTIVE       4
109 #define UI_HAS_ICON     8
110 #define UI_TEXTINPUT    16
111 #define UI_HIDDEN       32
112 /* warn: rest of uiBut->flag in UI_interface.h */
113
114 /* internal panel drawing defines */
115 #define PNL_GRID    (UI_UNIT_Y / 5) /* 4 default */
116 #define PNL_HEADER  (UI_UNIT_Y + 4) /* 24 default */
117
118 /* panel->flag */
119 #define PNL_SELECT  1
120 #define PNL_CLOSEDX 2
121 #define PNL_CLOSEDY 4
122 #define PNL_CLOSED  6
123 /*#define PNL_TABBED    8*/ /*UNUSED*/
124 #define PNL_OVERLAP 16
125
126 /* Button text selection:
127  * extension direction, selextend, inside ui_do_but_TEX */
128 #define EXTEND_LEFT     1
129 #define EXTEND_RIGHT    2
130
131 /* for scope resize zone */
132 #define SCOPE_RESIZE_PAD    9
133
134 typedef struct uiLinkLine {  /* only for draw/edit */
135         struct uiLinkLine *next, *prev;
136         struct uiBut *from, *to;
137         short flag, pad;
138 } uiLinkLine;
139
140 typedef struct {
141         void **poin;        /* pointer to original pointer */
142         void ***ppoin;      /* pointer to original pointer-array */
143         short *totlink;     /* if pointer-array, here is the total */
144         
145         short maxlink, pad;
146         short fromcode, tocode;
147         
148         ListBase lines;
149 } uiLink;
150
151 struct uiBut {
152         struct uiBut *next, *prev;
153         int flag, drawflag;
154         short type, pointype, bit, bitnr, retval, strwidth, ofs, pos, selsta, selend, alignnr;
155         short pad1;
156
157         char *str;
158         char strdata[UI_MAX_NAME_STR];
159         char drawstr[UI_MAX_DRAW_STR];
160         
161         float x1, y1, x2, y2;
162
163         char *poin;
164         float hardmin, hardmax, softmin, softmax;
165         float a1, a2;
166         float aspect;
167         unsigned char col[4];
168
169         uiButHandleFunc func;
170         void *func_arg1;
171         void *func_arg2;
172         void *func_arg3;
173
174         uiButHandleNFunc funcN;
175         void *func_argN;
176
177         struct bContextStore *context;
178
179         /* not ysed yet, was used in 2.4x for ui_draw_pulldown_round & friends */
180 #if 0
181         void (*embossfunc)(int, int, float, float, float, float, float, int);
182         void (*sliderfunc)(int, float, float, float, float, float, float, int);
183 #endif
184
185         uiButCompleteFunc autocomplete_func;
186         void *autofunc_arg;
187         
188         uiButSearchFunc search_func;
189         void *search_arg;
190
191         uiButHandleRenameFunc rename_func;
192         void *rename_arg1;
193         void *rename_orig;
194
195         uiLink *link;
196         short linkto[2];
197         
198         const char *tip, *lockstr;
199
200         BIFIconID icon;
201         char lock;
202         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSSN ... etc, copied from the block */
203         char changed; /* could be made into a single flag */
204         unsigned char unit_type; /* so buttons can support unit systems which are not RNA */
205         short modifier_key;
206         short iconadd;
207
208         /* IDPOIN data */
209         uiIDPoinFuncFP idpoin_func;
210         ID **idpoin_idpp;
211
212         /* BLOCK data */
213         uiBlockCreateFunc block_create_func;
214
215         /* PULLDOWN/MENU data */
216         uiMenuCreateFunc menu_create_func;
217
218         /* RNA data */
219         struct PointerRNA rnapoin;
220         struct PropertyRNA *rnaprop;
221         int rnaindex;
222
223         struct PointerRNA rnasearchpoin;
224         struct PropertyRNA *rnasearchprop;
225
226         /* Operator data */
227         struct wmOperatorType *optype;
228         struct IDProperty *opproperties;
229         struct PointerRNA *opptr;
230         short opcontext;
231         unsigned char menu_key; /* 'a'-'z', always lower case */
232
233         /* Draggable data, type is WM_DRAG_... */
234         char dragtype;
235         void *dragpoin;
236         struct ImBuf *imb;
237         float imb_scale;
238
239         /* active button data */
240         struct uiHandleButtonData *active;
241
242         char *editstr;
243         double *editval;
244         float *editvec;
245         void *editcoba;
246         void *editcumap;
247         
248         /* pointer back */
249         uiBlock *block;
250 };
251
252 struct uiBlock {
253         uiBlock *next, *prev;
254
255         ListBase buttons;
256         Panel *panel;
257         uiBlock *oldblock;
258
259         ListBase layouts;
260         struct uiLayout *curlayout;
261
262         ListBase contexts;
263         
264         char name[UI_MAX_NAME_STR];
265         
266         float winmat[4][4];
267         
268         float minx, miny, maxx, maxy;
269         float aspect;
270
271         int puphash;  /* popup menu hash for memory */
272
273         uiButHandleFunc func;
274         void *func_arg1;
275         void *func_arg2;
276
277         uiButHandleNFunc funcN;
278         void *func_argN;
279
280         uiMenuHandleFunc butm_func;
281         void *butm_func_arg;
282
283         uiBlockHandleFunc handle_func;
284         void *handle_func_arg;
285         
286         /* custom extra handling */
287         int (*block_event_func)(const struct bContext *C, struct uiBlock *, struct wmEvent *);
288         
289         /* extra draw function for custom blocks */
290         void (*drawextra)(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect);
291         void *drawextra_arg1;
292         void *drawextra_arg2;
293
294         int flag;
295         short alignnr;
296
297         char direction;
298         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSSN ... etc, copied to buttons */
299         char auto_open;
300         char _pad[7];
301         double auto_open_last;
302
303         const char *lockstr;
304
305         char lock;
306         char active;                // to keep blocks while drawing and free them afterwards
307         char tooltipdisabled;       // to avoid tooltip after click
308         char endblock;              // uiEndBlock done?
309         
310         float xofs, yofs;           // offset to parent button
311         int dobounds, mx, my;       // for doing delayed
312         int bounds, minbounds;      // for doing delayed
313
314         rctf safety;                // pulldowns, to detect outside, can differ per case how it is created
315         ListBase saferct;           // uiSafetyRct list
316
317         uiPopupBlockHandle *handle; // handle
318
319         struct wmOperator *ui_operator; // use so presets can find the operator,
320                                        // across menus and from nested popups which fail for operator context.
321
322         void *evil_C;               // XXX hack for dynamic operator enums
323
324         struct UnitSettings *unit;  // unit system, used a lot for numeric buttons so include here rather then fetching through the scene every time.
325         float _hsv[3];              // XXX, only access via ui_block_hsv_get()
326         char color_profile;         // color profile for correcting linear colors for display
327 };
328
329 typedef struct uiSafetyRct {
330         struct uiSafetyRct *next, *prev;
331         rctf parent;
332         rctf safety;
333 } uiSafetyRct;
334
335 /* interface.c */
336
337 extern void ui_delete_linkline(uiLinkLine *line, uiBut *but);
338
339 void ui_fontscale(short *points, float aspect);
340
341 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
342 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
343 extern void ui_block_to_window_rct(const struct ARegion *ar, uiBlock *block, rctf *graph, rcti *winr);
344 extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
345 extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
346 extern void ui_window_to_region(const ARegion *ar, int *x, int *y);
347
348 extern double ui_get_but_val(uiBut *but);
349 extern void ui_set_but_val(uiBut *but, double value);
350 extern void ui_set_but_hsv(uiBut *but);
351 extern void ui_get_but_vectorf(uiBut *but, float vec[3]);
352 extern void ui_set_but_vectorf(uiBut *but, const float vec[3]);
353
354 extern void ui_hsvcircle_vals_from_pos(float *valrad, float *valdist, rcti *rect, float mx, float my);
355
356 extern void ui_get_but_string(uiBut *but, char *str, size_t maxlen);
357 extern void ui_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen);
358 extern int ui_set_but_string(struct bContext *C, uiBut *but, const char *str);
359 extern int ui_get_but_string_max_length(uiBut *but);
360 extern int ui_set_but_string_eval_num(struct bContext *C, uiBut *but, const char *str, double *value);
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,
432                                           void *arg);
433 uiPopupBlockHandle *ui_popup_menu_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
434                                          uiMenuCreateFunc create_func, void *arg, char *str);
435
436 void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
437
438 void ui_set_name_menu(uiBut *but, int value);
439 int ui_step_name_menu(uiBut *but, int step);
440
441 struct AutoComplete;
442
443 /* interface_panel.c */
444 extern int ui_handler_panel_region(struct bContext *C, struct wmEvent *event);
445 extern void ui_draw_aligned_panel(struct uiStyle *style, uiBlock *block, rcti *rect);
446
447 /* interface_draw.c */
448 extern void ui_dropshadow(rctf *rct, float radius, float aspect, float alpha, int select);
449
450 void ui_draw_gradient(rcti *rect, const float hsv[3], int type, float alpha);
451
452 void ui_draw_but_HISTOGRAM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
453 void ui_draw_but_WAVEFORM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
454 void ui_draw_but_VECTORSCOPE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
455 void ui_draw_but_COLORBAND(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
456 void ui_draw_but_NORMAL(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
457 void ui_draw_but_CURVE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
458 void ui_draw_but_IMAGE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
459 void ui_draw_but_TRACKPREVIEW(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
460
461 /* interface_handlers.c */
462 extern void ui_button_activate_do(struct bContext *C, struct ARegion *ar, uiBut *but);
463 extern void ui_button_active_free(const struct bContext *C, uiBut *but);
464 extern int ui_button_is_active(struct ARegion *ar);
465
466 /* interface_widgets.c */
467 void ui_draw_anti_tria(float x1, float y1, float x2, float y2, float x3, float y3);
468 void ui_draw_anti_roundbox(int mode, float minx, float miny, float maxx, float maxy, float rad);
469 void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect);
470 uiWidgetColors *ui_tooltip_get_theme(void);
471 void ui_draw_tooltip_background(uiStyle *UNUSED(style), uiBlock * block, rcti * rect);
472 void ui_draw_search_back(struct uiStyle *style, uiBlock *block, rcti *rect);
473 int ui_link_bezier_points(rcti * rect, float coord_array[][2], int resol);
474 void ui_draw_link_bezier(rcti *rect);
475
476 extern void ui_draw_but(const struct bContext *C, ARegion *ar, struct uiStyle *style, uiBut *but, rcti *rect);
477 /* theme color init */
478 struct ThemeUI;
479 void ui_widget_color_init(struct ThemeUI *tui);
480
481 void ui_draw_menu_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
482 void ui_draw_preview_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
483
484 extern unsigned char checker_stipple_sml[];
485 /* used for transp checkers */
486 #define UI_TRANSP_DARK 100
487 #define UI_TRANSP_LIGHT 160
488
489 /* interface_style.c */
490 void uiStyleInit(void);
491
492 /* interface_icons.c */
493 int ui_id_icon_get(struct bContext *C, struct ID *id, int preview);
494
495 /* resources.c */
496 void init_userdef_do_versions(void);
497 void ui_theme_init_default(void);
498 void ui_resources_init(void);
499 void ui_resources_free(void);
500
501 /* interface_layout.c */
502 void ui_layout_add_but(uiLayout *layout, uiBut *but);
503 int ui_but_can_align(uiBut *but);
504 void ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop);
505 void ui_but_add_shortcut(uiBut *but, const char *key_str, const short do_strip);
506
507 /* interface_anim.c */
508 void ui_but_anim_flag(uiBut *but, float cfra);
509 void ui_but_anim_insert_keyframe(struct bContext *C);
510 void ui_but_anim_delete_keyframe(struct bContext *C);
511 void ui_but_anim_add_driver(struct bContext *C);
512 void ui_but_anim_remove_driver(struct bContext *C);
513 void ui_but_anim_copy_driver(struct bContext *C);
514 void ui_but_anim_paste_driver(struct bContext *C);
515 void ui_but_anim_add_keyingset(struct bContext *C);
516 void ui_but_anim_remove_keyingset(struct bContext *C);
517 int ui_but_anim_expression_get(uiBut *but, char *str, size_t maxlen);
518 int ui_but_anim_expression_set(uiBut *but, const char *str);
519 int ui_but_anim_expression_create(uiBut *but, const char *str);
520 void ui_but_anim_autokey(struct bContext *C, uiBut *but, struct Scene *scene, float cfra);
521
522 #endif
523