12e9d39e89697f280c073dda1ad475e08e6d728a
[blender.git] / source / blender / editors / interface / interface_intern.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /** \file blender/editors/interface/interface_intern.h
31  *  \ingroup edinterface
32  */
33
34
35 #ifndef INTERFACE_H
36 #define INTERFACE_H
37
38 #include "UI_resources.h"
39 #include "RNA_types.h"
40
41 struct ARegion;
42 struct bContext;
43 struct IDProperty;
44 struct uiHandleButtonData;
45 struct wmEvent;
46 struct wmOperatorType;
47 struct wmWindow;
48 struct wmTimer;
49 struct uiStyle;
50 struct uiWidgetColors;
51 struct uiLayout;
52 struct bContextStore;
53 struct Scene;
54 struct ID;
55 struct ImBuf;
56
57 /* ****************** general defines ************** */
58
59 /* visual types for drawing */
60 /* for time being separated from functional types */
61 typedef enum {
62         /* default */
63         UI_WTYPE_REGULAR,
64
65         /* standard set */
66         UI_WTYPE_LABEL,
67         UI_WTYPE_TOGGLE,
68         UI_WTYPE_OPTION,
69         UI_WTYPE_RADIO,
70         UI_WTYPE_NUMBER,
71         UI_WTYPE_SLIDER,
72         UI_WTYPE_EXEC,
73         
74         /* strings */
75         UI_WTYPE_NAME,
76         UI_WTYPE_NAME_LINK,
77         UI_WTYPE_POINTER_LINK,
78         UI_WTYPE_FILENAME,
79         
80         /* menus */
81         UI_WTYPE_MENU_RADIO,
82         UI_WTYPE_MENU_ICON_RADIO,
83         UI_WTYPE_MENU_POINTER_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
102
103 #define UI_MAX_DRAW_STR 400
104 #define UI_MAX_NAME_STR 128
105
106 /* panel limits */
107 #define UI_PANEL_MINX   100
108 #define UI_PANEL_MINY   70
109
110 /* uiBut->flag */
111 #define UI_SELECT               1       /* use when the button is pressed */
112 #define UI_SCROLLED             2       /* temp hidden, scrolled away */
113 #define UI_ACTIVE               4
114 #define UI_HAS_ICON             8
115 #define UI_TEXTINPUT    16
116 #define UI_HIDDEN               32
117 /* warn: rest of uiBut->flag in UI_interface.h */
118
119 /* internal panel drawing defines */
120 #define PNL_GRID        (UI_UNIT_Y / 5) /* 4 default */
121 #define PNL_HEADER  UI_UNIT_Y           /* 20 default */
122
123 /* panel->flag */
124 #define PNL_SELECT      1
125 #define PNL_CLOSEDX     2
126 #define PNL_CLOSEDY     4
127 #define PNL_CLOSED      6
128 /*#define PNL_TABBED    8*/ /*UNUSED*/
129 #define PNL_OVERLAP     16
130
131 /* Button text selection:
132  * extension direction, selextend, inside ui_do_but_TEX */
133 #define EXTEND_LEFT             1
134 #define EXTEND_RIGHT    2
135
136 /* for scope resize zone */
137 #define SCOPE_RESIZE_PAD        9
138
139 typedef struct uiLinkLine {                             /* only for draw/edit */
140         struct uiLinkLine *next, *prev;
141         struct uiBut *from, *to;
142         short flag, pad;
143 } uiLinkLine;
144
145 typedef struct {
146         void **poin;            /* pointer to original pointer */
147         void ***ppoin;          /* pointer to original pointer-array */
148         short *totlink;         /* if pointer-array, here is the total */
149         
150         short maxlink, pad;
151         short fromcode, tocode;
152         
153         ListBase lines;
154 } uiLink;
155
156 struct uiBut {
157         struct uiBut *next, *prev;
158         int flag;
159         short type, pointype, bit, bitnr, retval, strwidth, ofs, pos, selsta, selend, alignnr;
160         short pad1;
161
162         char *str;
163         char strdata[UI_MAX_NAME_STR];
164         char drawstr[UI_MAX_DRAW_STR];
165         
166         float x1, y1, x2, y2;
167
168         char *poin;
169         float hardmin, hardmax, softmin, softmax;
170         float a1, a2;
171         float aspect;
172         char col[4];
173
174         uiButHandleFunc func;
175         void *func_arg1;
176         void *func_arg2;
177         void *func_arg3;
178
179         uiButHandleNFunc funcN;
180         void *func_argN;
181
182         struct bContextStore *context;
183
184         /* not ysed yet, was used in 2.4x for ui_draw_pulldown_round & friends */
185         /*
186         void (*embossfunc)(int , int , float, float, float, float, float, int);
187         void (*sliderfunc)(int , float, float, float, float, float, float, int);
188         */
189
190         uiButCompleteFunc autocomplete_func;
191         void *autofunc_arg;
192         
193         uiButSearchFunc search_func;
194         void *search_arg;
195
196         uiButHandleRenameFunc rename_func;
197         void *rename_arg1;
198         void *rename_orig;
199
200         uiLink *link;
201         short linkto[2];
202         
203         const char *tip, *lockstr;
204
205         BIFIconID icon;
206         char lock;
207         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSSN ... etc, copied from the block */
208         char changed; /* could be made into a single flag */
209         unsigned char unit_type; /* so buttons can support unit systems which are not RNA */
210         short modifier_key;
211         short iconadd;
212
213         /* IDPOIN data */
214         uiIDPoinFuncFP idpoin_func;
215         ID **idpoin_idpp;
216
217         /* BLOCK data */
218         uiBlockCreateFunc block_create_func;
219
220         /* PULLDOWN/MENU data */
221         uiMenuCreateFunc menu_create_func;
222
223         /* RNA data */
224         struct PointerRNA rnapoin;
225         struct PropertyRNA *rnaprop;
226         int rnaindex;
227
228         struct PointerRNA rnasearchpoin;
229         struct PropertyRNA *rnasearchprop;
230
231         /* Operator data */
232         struct wmOperatorType *optype;
233         struct IDProperty *opproperties;
234         struct PointerRNA *opptr;
235         short opcontext;
236         unsigned char menu_key; /* 'a'-'z', always lower case */
237
238         /* Draggable data, type is WM_DRAG_... */
239         char dragtype;
240         void *dragpoin;
241         struct ImBuf *imb;
242         float imb_scale;
243
244         /* active button data */
245         struct uiHandleButtonData *active;
246
247         char *editstr;
248         double *editval;
249         float *editvec;
250         void *editcoba;
251         void *editcumap;
252         
253                 /* pointer back */
254         uiBlock *block;
255 };
256
257 struct uiBlock {
258         uiBlock *next, *prev;
259
260         ListBase buttons;
261         Panel *panel;
262         uiBlock *oldblock;
263
264         ListBase layouts;
265         struct uiLayout *curlayout;
266
267         ListBase contexts;
268         
269         char name[UI_MAX_NAME_STR];
270         
271         float winmat[4][4];
272         
273         float minx, miny, maxx, maxy;
274         float aspect;
275
276         int puphash;                            // popup menu hash for memory
277
278         uiButHandleFunc func;
279         void *func_arg1;
280         void *func_arg2;
281
282         uiButHandleNFunc funcN;
283         void *func_argN;
284
285         uiMenuHandleFunc butm_func;
286         void *butm_func_arg;
287
288         uiBlockHandleFunc handle_func;
289         void *handle_func_arg;
290         
291         /* custom extra handling */
292         int (*block_event_func)(const struct bContext *C, struct uiBlock *, struct wmEvent *);
293         
294         /* extra draw function for custom blocks */
295         void (*drawextra)(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect);
296         void *drawextra_arg1;
297         void *drawextra_arg2;
298
299         int flag;
300         short alignnr;
301
302         char direction;
303         char dt; /* drawtype: UI_EMBOSS, UI_EMBOSSN ... etc, copied to buttons */
304         char auto_open;
305         char _pad[7];
306         double auto_open_last;
307
308         const char *lockstr;
309
310         char lock;
311         char active;                                    // to keep blocks while drawing and free them afterwards
312         char tooltipdisabled;                   // to avoid tooltip after click
313         char endblock;                                  // uiEndBlock done?
314         
315         float xofs, yofs;                               // offset to parent button
316         int dobounds, mx, my;                   // for doing delayed
317         int bounds, minbounds;                  // for doing delayed
318
319         rctf safety;                            // pulldowns, to detect outside, can differ per case how it is created
320         ListBase saferct;                       // uiSafetyRct list
321
322         uiPopupBlockHandle *handle;     // handle
323         
324         void *evil_C;                           // XXX hack for dynamic operator enums
325
326         struct UnitSettings *unit;      // unit system, used a lot for numeric buttons so include here rather then fetching through the scene every time.
327         float _hsv[3];                          // XXX, only access via ui_block_hsv_get()
328         char color_profile;                     // color profile for correcting linear colors for display
329 };
330
331 typedef struct uiSafetyRct {
332         struct uiSafetyRct *next, *prev;
333         rctf parent;
334         rctf safety;
335 } uiSafetyRct;
336
337 /* interface.c */
338
339 extern void ui_delete_linkline(uiLinkLine *line, uiBut *but);
340
341 void ui_fontscale(short *points, float aspect);
342
343 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
344 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
345 extern void ui_block_to_window_rct(const struct ARegion *ar, uiBlock *block, rctf *graph, rcti *winr);
346 extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
347 extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
348 extern void ui_window_to_region(const ARegion *ar, int *x, int *y);
349
350 extern double ui_get_but_val(uiBut *but);
351 extern void ui_set_but_val(uiBut *but, double value);
352 extern void ui_set_but_hsv(uiBut *but);
353 extern void ui_get_but_vectorf(uiBut *but, float vec[3]);
354 extern void ui_set_but_vectorf(uiBut *but, const float vec[3]);
355
356 extern void ui_hsvcircle_vals_from_pos(float *valrad, float *valdist, rcti *rect, float mx, float my);
357
358 extern void ui_get_but_string(uiBut *but, char *str, size_t maxlen);
359 extern void ui_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen);
360 extern int ui_set_but_string(struct bContext *C, uiBut *but, const char *str);
361 extern int ui_get_but_string_max_length(uiBut *but);
362
363 extern void ui_set_but_default(struct bContext *C, short all);
364
365 extern void ui_set_but_soft_range(uiBut *but, double value);
366
367 extern void ui_check_but(uiBut *but);
368 extern int  ui_is_but_float(uiBut *but);
369 extern int  ui_is_but_unit(uiBut *but);
370 extern int  ui_is_but_rna_valid(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
459 /* interface_handlers.c */
460 extern void ui_button_activate_do(struct bContext *C, struct ARegion *ar, uiBut *but);
461 extern void ui_button_active_free(const struct bContext *C, uiBut *but);
462 extern int ui_button_is_active(struct ARegion *ar);
463
464 /* interface_widgets.c */
465 void ui_draw_anti_tria(float x1, float y1, float x2, float y2, float x3, float y3);
466 void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect);
467 void ui_draw_search_back(struct uiStyle *style, uiBlock *block, rcti *rect);
468 int ui_link_bezier_points(rcti *rect, float coord_array[][2], int resol);
469 void ui_draw_link_bezier(rcti *rect);
470
471 extern void ui_draw_but(const struct bContext *C, ARegion *ar, struct uiStyle *style, uiBut *but, rcti *rect);
472                 /* theme color init */
473 struct ThemeUI;
474 void ui_widget_color_init(struct ThemeUI *tui);
475
476 void ui_draw_menu_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
477 void ui_draw_preview_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
478
479 extern unsigned char checker_stipple_sml[];
480 /* used for transp checkers */
481 #define UI_TRANSP_DARK 100
482 #define UI_TRANSP_LIGHT 160
483
484 /* interface_style.c */
485 void uiStyleInit(void);
486
487 /* interface_icons.c */
488 int ui_id_icon_get(struct bContext *C, struct ID *id, int preview);
489
490 /* resources.c */
491 void init_userdef_do_versions(void);
492 void ui_theme_init_default(void);
493 void ui_resources_init(void);
494 void ui_resources_free(void);
495
496 /* interface_layout.c */
497 void ui_layout_add_but(uiLayout *layout, uiBut *but);
498 int ui_but_can_align(uiBut *but);
499 void ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop);
500
501 /* interface_anim.c */
502 void ui_but_anim_flag(uiBut *but, float cfra);
503 void ui_but_anim_insert_keyframe(struct bContext *C);
504 void ui_but_anim_delete_keyframe(struct bContext *C);
505 void ui_but_anim_add_driver(struct bContext *C);
506 void ui_but_anim_remove_driver(struct bContext *C);
507 void ui_but_anim_copy_driver(struct bContext *C);
508 void ui_but_anim_paste_driver(struct bContext *C);
509 void ui_but_anim_add_keyingset(struct bContext *C);
510 void ui_but_anim_remove_keyingset(struct bContext *C);
511 int ui_but_anim_expression_get(uiBut *but, char *str, size_t maxlen);
512 int ui_but_anim_expression_set(uiBut *but, const char *str);
513 int ui_but_anim_expression_create(uiBut *but, const char *str);
514 void ui_but_anim_autokey(struct bContext *C, uiBut *but, struct Scene *scene, float cfra);
515
516 #endif
517