eb28df54b13dcd856d5a223441a8d461503622eb
[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 #ifndef INTERFACE_H
31 #define INTERFACE_H
32
33 #include "UI_resources.h"
34 #include "RNA_types.h"
35
36 struct ARegion;
37 struct bContext;
38 struct IDProperty;
39 struct uiHandleButtonData;
40 struct wmEvent;
41 struct wmOperatorType;
42 struct wmWindow;
43 struct uiStyle;
44 struct uiWidgetColors;
45 struct uiLayout;
46 struct bContextStore;
47 struct Scene;
48 struct ID;
49 struct ImBuf;
50
51 /* ****************** general defines ************** */
52
53 /* visual types for drawing */
54 /* for time being separated from functional types */
55 typedef enum {
56         /* default */
57         UI_WTYPE_REGULAR,
58
59         /* standard set */
60         UI_WTYPE_LABEL,
61         UI_WTYPE_TOGGLE,
62         UI_WTYPE_OPTION,
63         UI_WTYPE_RADIO,
64         UI_WTYPE_NUMBER,
65         UI_WTYPE_SLIDER,
66         UI_WTYPE_EXEC,
67         
68         /* strings */
69         UI_WTYPE_NAME,
70         UI_WTYPE_NAME_LINK,
71         UI_WTYPE_POINTER_LINK,
72         UI_WTYPE_FILENAME,
73         
74         /* menus */
75         UI_WTYPE_MENU_RADIO,
76         UI_WTYPE_MENU_ICON_RADIO,
77         UI_WTYPE_MENU_POINTER_LINK,
78         
79         UI_WTYPE_PULLDOWN,
80         UI_WTYPE_MENU_ITEM,
81         UI_WTYPE_MENU_BACK,
82         
83         /* specials */
84         UI_WTYPE_ICON,
85         UI_WTYPE_SWATCH,
86         UI_WTYPE_RGB_PICKER,
87         UI_WTYPE_NORMAL,
88         UI_WTYPE_BOX,
89         UI_WTYPE_SCROLL,
90         UI_WTYPE_LISTITEM,
91         UI_WTYPE_PROGRESSBAR,
92         
93 } uiWidgetTypeEnum;
94
95
96
97 #define UI_MAX_DRAW_STR 400
98 #define UI_MAX_NAME_STR 128
99 #define UI_ARRAY        29
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_MOUSE_OVER   2
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        4
116 #define PNL_HEADER  20
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
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 {
135         short xim, yim;
136         unsigned int *rect;
137         short xofs, yofs;
138 } uiIconImage;
139
140
141 typedef struct uiLinkLine {                             /* only for draw/edit */
142         struct uiLinkLine *next, *prev;
143
144         short flag, pad;
145         
146         struct uiBut *from, *to;        
147 } uiLinkLine;
148
149 typedef struct {
150         void **poin;            /* pointer to original pointer */
151         void ***ppoin;          /* pointer to original pointer-array */
152         short *totlink;         /* if pointer-array, here is the total */
153         
154         short maxlink, pad;
155         short fromcode, tocode;
156         
157         ListBase lines;
158 } uiLink;
159
160 struct uiBut {
161         struct uiBut *next, *prev;
162         short type, pointype, bit, bitnr, retval, strwidth, ofs, pos, selsta, selend;
163         short alignnr;
164         int flag;
165         
166         char *str;
167         char strdata[UI_MAX_NAME_STR];
168         char drawstr[UI_MAX_DRAW_STR];
169         
170         float x1, y1, x2, y2;
171
172         char *poin;
173         float hardmin, hardmax, softmin, softmax;
174         float a1, a2, hsv[3];   // hsv is temp memory for hsv buttons
175         float aspect;
176
177         uiButHandleFunc func;
178         void *func_arg1;
179         void *func_arg2;
180         void *func_arg3;
181
182         uiButHandleNFunc funcN;
183         void *func_argN;
184
185         struct bContextStore *context;
186
187         /* not ysed yet, was used in 2.4x for ui_draw_pulldown_round & friends */
188         /*
189         void (*embossfunc)(int , int , float, float, float, float, float, int);
190         void (*sliderfunc)(int , float, float, float, float, float, float, int);
191         */
192
193         uiButCompleteFunc autocomplete_func;
194         void *autofunc_arg;
195         
196         uiButSearchFunc search_func;
197         void *search_arg;
198
199         uiButHandleRenameFunc rename_func;
200         void *rename_arg1;
201         void *rename_orig;
202
203         uiLink *link;
204         short linkto[2];
205         
206         char *tip, *lockstr;
207
208         BIFIconID icon;
209         char lock;
210         char dt;
211         short changed; /* could be made into a single flag */
212         short modifier_key;
213         short iconadd;
214
215         /* IDPOIN data */
216         uiIDPoinFuncFP idpoin_func;
217         ID **idpoin_idpp;
218
219         /* BLOCK data */
220         uiBlockCreateFunc block_create_func;
221
222         /* PULLDOWN/MENU data */
223         uiMenuCreateFunc menu_create_func;
224
225         /* RNA data */
226         struct PointerRNA rnapoin;
227         struct PropertyRNA *rnaprop;
228         int rnaindex;
229
230         struct PointerRNA rnasearchpoin;
231         struct PropertyRNA *rnasearchprop;
232
233         /* Operator data */
234         struct wmOperatorType *optype;
235         struct IDProperty *opproperties;
236         struct PointerRNA *opptr;
237         short opcontext;
238         
239         /* Draggable data, type is WM_DRAG_... */
240         short dragtype;
241         void *dragpoin;
242         struct ImBuf *imb;
243         float imb_scale;
244
245         /* active button data */
246         struct uiHandleButtonData *active;
247
248         char *editstr;
249         double *editval;
250         float *editvec;
251         void *editcoba;
252         void *editcumap;
253         
254                 /* pointer back */
255         uiBlock *block;
256 };
257
258 struct uiBlock {
259         uiBlock *next, *prev;
260
261         ListBase buttons;
262         Panel *panel;
263         uiBlock *oldblock;
264
265         ListBase layouts;
266         struct uiLayout *curlayout;
267
268         ListBase contexts;
269         
270         char name[UI_MAX_NAME_STR];
271         
272         float winmat[4][4];
273         
274         float minx, miny, maxx, maxy;
275         float aspect;
276
277         short alignnr;
278
279         uiButHandleFunc func;
280         void *func_arg1;
281         void *func_arg2;
282
283         uiButHandleNFunc funcN;
284         void *func_argN;
285
286         uiMenuHandleFunc butm_func;
287         void *butm_func_arg;
288
289         uiBlockHandleFunc handle_func;
290         void *handle_func_arg;
291         
292         /* custom extra handling */
293         int (*block_event_func)(const struct bContext *C, struct uiBlock *, struct wmEvent *);
294         
295         /* extra draw function for custom blocks */
296         void (*drawextra)(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect);
297         void *drawextra_arg1;
298         void *drawextra_arg2;
299
300         int flag;
301         char direction, dt;
302         short auto_open;
303         double auto_open_last;
304
305         char active;                                    // to keep blocks while drawing and free them afterwards
306         char tooltipdisabled;           // to avoid tooltip after click
307         short lock;
308         char *lockstr;
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         int endblock;                                   // uiEndBlock done?
314
315         rctf safety;                            // pulldowns, to detect outside, can differ per case how it is created
316         ListBase saferct;                       // uiSafetyRct list
317
318         uiPopupBlockHandle *handle;     // handle
319
320         int puphash;                            // popup menu hash for memory
321         
322         int color_profile;                              // color profile for correcting linear colors for display
323
324         void *evil_C;                           // XXX hack for dynamic operator enums
325 };
326
327 typedef struct uiSafetyRct {
328         struct uiSafetyRct *next, *prev;
329         rctf parent;
330         rctf safety;
331 } uiSafetyRct;
332
333 /* interface.c */
334
335 extern void ui_delete_linkline(uiLinkLine *line, uiBut *but);
336
337 extern int ui_translate_buttons(void);
338 extern int ui_translate_menus(void);
339 extern int ui_translate_tooltips(void);
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);
354 extern void ui_set_but_vectorf(uiBut *but, float *vec);
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, int maxlen);
359 extern void ui_convert_to_unit_alt_name(uiBut *but, char *str, int 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, uiBut *but);
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
371 extern void ui_bounds_block(uiBlock *block);
372 extern void ui_block_translate(uiBlock *block, int x, int y);
373 extern void ui_block_do_align(uiBlock *block);
374
375 /* interface_regions.c */
376
377 struct uiPopupBlockHandle {
378         /* internal */
379         struct ARegion *region;
380         int towardsx, towardsy;
381         double towardstime;
382         int dotowards;
383
384         int popup;
385         void (*popup_func)(struct bContext *C, void *arg, int event);
386         void (*cancel_func)(void *arg);
387         void *popup_arg;
388
389         /* for operator popups */
390         struct wmOperatorType *optype;
391         int opcontext;
392         ScrArea *ctx_area;
393         ARegion *ctx_region;
394         
395         /* return values */
396         int butretval;
397         int menuretval;
398         float retvalue;
399         float retvec[4];
400 };
401
402 uiBlock *ui_block_func_COL(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
403 void ui_block_func_ICONROW(struct bContext *C, uiLayout *layout, void *arg_but);
404 void ui_block_func_ICONTEXTROW(struct bContext *C, uiLayout *layout, void *arg_but);
405
406 struct ARegion *ui_tooltip_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
407 void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
408
409 uiBut *ui_popup_menu_memory(uiBlock *block, uiBut *but);
410
411 /* searchbox for string button */
412 ARegion *ui_searchbox_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
413 int ui_searchbox_inside(struct ARegion *ar, int x, int y);
414 void ui_searchbox_update(struct bContext *C, struct ARegion *ar, uiBut *but, int reset);
415 void ui_searchbox_autocomplete(struct bContext *C, struct ARegion *ar, uiBut *but, char *str);
416 void ui_searchbox_event(struct bContext *C, struct ARegion *ar, uiBut *but, struct wmEvent *event);
417 void ui_searchbox_apply(uiBut *but, struct ARegion *ar);
418 void ui_searchbox_free(struct bContext *C, struct ARegion *ar);
419
420 typedef uiBlock* (*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1);
421
422 uiPopupBlockHandle *ui_popup_block_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
423         uiBlockCreateFunc create_func, uiBlockHandleCreateFunc handle_create_func, void *arg);
424 uiPopupBlockHandle *ui_popup_menu_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
425         uiMenuCreateFunc create_func, void *arg, char *str);
426
427 void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
428
429 void ui_set_name_menu(uiBut *but, int value);
430 int ui_step_name_menu(uiBut *but, int step);
431
432 struct AutoComplete;
433 struct AutoComplete *autocomplete_begin(char *startname, int maxlen);
434 void autocomplete_do_name(struct AutoComplete *autocpl, const char *name);
435 void autocomplete_end(struct AutoComplete *autocpl, char *autoname);
436
437 /* interface_panel.c */
438 extern int ui_handler_panel_region(struct bContext *C, struct wmEvent *event);
439 extern void ui_draw_aligned_panel(struct ARegion *ar, struct uiStyle *style, uiBlock *block, rcti *rect);
440
441 /* interface_draw.c */
442 extern void ui_dropshadow(rctf *rct, float radius, float aspect, int select);
443
444 void ui_draw_gradient(rcti *rect, float *rgb, int type, float alpha);
445
446 void ui_draw_but_HISTOGRAM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
447 void ui_draw_but_WAVEFORM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
448 void ui_draw_but_VECTORSCOPE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
449 void ui_draw_but_COLORBAND(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
450 void ui_draw_but_NORMAL(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
451 void ui_draw_but_CURVE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
452 void ui_draw_but_IMAGE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
453
454 /* interface_handlers.c */
455 extern void ui_button_activate_do(struct bContext *C, struct ARegion *ar, uiBut *but);
456 extern void ui_button_active_free(const struct bContext *C, uiBut *but);
457 extern int ui_button_is_active(struct ARegion *ar);
458
459 /* interface_widgets.c */
460 void ui_draw_anti_tria(float x1, float y1, float x2, float y2, float x3, float y3);
461 void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect);
462 void ui_draw_search_back(struct uiStyle *style, uiBlock *block, rcti *rect);
463 int ui_link_bezier_points(rcti *rect, float coord_array[][2], int resol);
464 void ui_draw_link_bezier(rcti *rect);
465
466 extern void ui_draw_but(const struct bContext *C, ARegion *ar, struct uiStyle *style, uiBut *but, rcti *rect);
467                 /* theme color init */
468 struct ThemeUI;
469 void ui_widget_color_init(struct ThemeUI *tui);
470
471 void ui_draw_menu_item(struct uiFontStyle *fstyle, rcti *rect, char *name, int iconid, int state);
472 void ui_draw_preview_item(struct uiFontStyle *fstyle, rcti *rect, char *name, int iconid, int state);
473
474 /* interface_style.c */
475 void uiStyleInit(void);
476
477 /* interface_icons.c */
478 void ui_id_icon_render(struct bContext *C, struct ID *id, int preview);
479 int ui_id_icon_get(struct bContext *C, struct ID *id, int preview);
480
481 /* resources.c */
482 void init_userdef_do_versions(void);
483 void ui_theme_init_default(void);
484 void ui_resources_init(void);
485 void ui_resources_free(void);
486
487 /* interface_layout.c */
488 void ui_layout_add_but(uiLayout *layout, uiBut *but);
489 int ui_but_can_align(uiBut *but);
490 void ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop);
491
492 /* interface_anim.c */
493 void ui_but_anim_flag(uiBut *but, float cfra);
494 void ui_but_anim_insert_keyframe(struct bContext *C);
495 void ui_but_anim_delete_keyframe(struct bContext *C);
496 void ui_but_anim_add_driver(struct bContext *C);
497 void ui_but_anim_remove_driver(struct bContext *C);
498 void ui_but_anim_copy_driver(struct bContext *C);
499 void ui_but_anim_paste_driver(struct bContext *C);
500 void ui_but_anim_add_keyingset(struct bContext *C);
501 void ui_but_anim_remove_keyingset(struct bContext *C);
502 int ui_but_anim_expression_get(uiBut *but, char *str, int maxlen);
503 int ui_but_anim_expression_set(uiBut *but, const char *str);
504 void ui_but_anim_autokey(struct bContext *C, uiBut *but, struct Scene *scene, float cfra);
505
506 #endif
507