Fix [#20754] Histogram Not Updating, Showing Incorrect Levels, Colour Management...
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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         
92 } uiWidgetTypeEnum;
93
94
95
96 #define UI_MAX_DRAW_STR 400
97 #define UI_MAX_NAME_STR 64
98 #define UI_ARRAY        29
99
100 /* panel limits */
101 #define UI_PANEL_MINX   100
102 #define UI_PANEL_MINY   70
103
104 /* uiBut->flag */
105 #define UI_SELECT               1
106 #define UI_MOUSE_OVER   2
107 #define UI_ACTIVE               4
108 #define UI_HAS_ICON             8
109 #define UI_TEXTINPUT    16
110 #define UI_HIDDEN               32
111 /* warn: rest of uiBut->flag in UI_interface.h */
112
113 /* internal panel drawing defines */
114 #define PNL_GRID        4
115 #define PNL_HEADER  20
116
117 /* panel->flag */
118 #define PNL_SELECT      1
119 #define PNL_CLOSEDX     2
120 #define PNL_CLOSEDY     4
121 #define PNL_CLOSED      6
122 #define PNL_TABBED      8
123 #define PNL_OVERLAP     16
124
125 /* Button text selection:
126  * extension direction, selextend, inside ui_do_but_TEX */
127 #define EXTEND_LEFT             1
128 #define EXTEND_RIGHT    2
129
130 typedef struct {
131         short xim, yim;
132         unsigned int *rect;
133         short xofs, yofs;
134 } uiIconImage;
135
136
137 typedef struct uiLinkLine {                             /* only for draw/edit */
138         struct uiLinkLine *next, *prev;
139
140         short flag, pad;
141         
142         struct uiBut *from, *to;        
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         short type, pointype, bit, bitnr, retval, strwidth, ofs, pos, selsta, selend;
159         short alignnr;
160         int flag;
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, hsv[3];   // hsv is temp memory for hsv buttons
171         float aspect;
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         void (*embossfunc)(int , int , float, float, float, float, float, int);
184         void (*sliderfunc)(int , float, float, float, float, float, float, int);
185
186         uiButCompleteFunc autocomplete_func;
187         void *autofunc_arg;
188         
189         uiButSearchFunc search_func;
190         void *search_arg;
191
192         uiButHandleRenameFunc rename_func;
193         void *rename_arg1;
194         void *rename_orig;
195
196         uiLink *link;
197         short linkto[2];
198         
199         char *tip, *lockstr;
200
201         BIFIconID icon;
202         short but_align;        /* aligning buttons, horiz/vertical */
203         short lock;
204         short modifier_key;
205         short iconadd, dt;
206
207         /* IDPOIN data */
208         uiIDPoinFuncFP idpoin_func;
209         ID **idpoin_idpp;
210
211         /* BLOCK data */
212         uiBlockCreateFunc block_create_func;
213
214         /* PULLDOWN/MENU data */
215         uiMenuCreateFunc menu_create_func;
216
217         /* RNA data */
218         struct PointerRNA rnapoin;
219         struct PropertyRNA *rnaprop;
220         int rnaindex;
221
222         struct PointerRNA rnasearchpoin;
223         struct PropertyRNA *rnasearchprop;
224
225         /* Operator data */
226         struct wmOperatorType *optype;
227         int opcontext;
228         struct IDProperty *opproperties;
229         struct PointerRNA *opptr;
230         
231         /* Draggable data, type is WM_DRAG_... */
232         int dragtype;
233         void *dragpoin;
234         struct ImBuf *imb;
235         float imb_scale;
236
237         /* active button data */
238         struct uiHandleButtonData *active;
239
240         char *editstr;
241         double *editval;
242         float *editvec;
243         void *editcoba;
244         void *editcumap;
245         
246                 /* pointer back */
247         uiBlock *block;
248 };
249
250 struct uiBlock {
251         uiBlock *next, *prev;
252
253         ListBase buttons;
254         Panel *panel;
255         uiBlock *oldblock;
256
257         ListBase layouts;
258         struct uiLayout *curlayout;
259
260         ListBase contexts;
261         
262         char name[UI_MAX_NAME_STR];
263         
264         float winmat[4][4];
265         
266         float minx, miny, maxx, maxy;
267         float aspect;
268
269         short alignnr;
270
271         uiButHandleFunc func;
272         void *func_arg1;
273         void *func_arg2;
274
275         uiButHandleNFunc funcN;
276         void *func_argN;
277
278         uiMenuHandleFunc butm_func;
279         void *butm_func_arg;
280
281         uiBlockHandleFunc handle_func;
282         void *handle_func_arg;
283         
284         /* custom extra handling */
285         int (*block_event_func)(const struct bContext *C, struct uiBlock *, struct wmEvent *);
286         
287         /* extra draw function for custom blocks */
288         void (*drawextra)(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect);
289         void *drawextra_arg1;
290         void *drawextra_arg2;
291
292         int afterval, flag;
293         
294         short direction, dt;
295         short auto_open, in_use;
296         double auto_open_last;
297
298         int lock;
299         char *lockstr;
300         
301         float xofs, yofs;                               // offset to parent button
302         int dobounds, mx, my;                   // for doing delayed
303         int bounds, minbounds;                  // for doing delayed
304         int endblock;                                   // uiEndBlock done?
305
306         rctf safety;                            // pulldowns, to detect outside, can differ per case how it is created
307         ListBase saferct;                       // uiSafetyRct list
308
309         uiPopupBlockHandle *handle;     // handle
310         int tooltipdisabled;            // to avoid tooltip after click
311
312         int active;                                     // to keep blocks while drawing and free them afterwards
313         int puphash;                            // popup menu hash for memory
314         
315         int color_profile;                              // color profile for correcting linear colors for display
316
317         void *evil_C;                           // XXX hack for dynamic operator enums
318 };
319
320 typedef struct uiSafetyRct {
321         struct uiSafetyRct *next, *prev;
322         rctf parent;
323         rctf safety;
324 } uiSafetyRct;
325
326 /* interface.c */
327
328 extern void ui_delete_linkline(uiLinkLine *line, uiBut *but);
329
330 extern int ui_translate_buttons(void);
331 extern int ui_translate_menus(void);
332 extern int ui_translate_tooltips(void);
333
334 void ui_fontscale(short *points, float aspect);
335
336 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
337 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
338 extern void ui_block_to_window_rct(const struct ARegion *ar, uiBlock *block, rctf *graph, rcti *winr);
339 extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
340 extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
341 extern void ui_window_to_region(const ARegion *ar, int *x, int *y);
342
343 extern double ui_get_but_val(uiBut *but);
344 extern void ui_set_but_val(uiBut *but, double value);
345 extern void ui_set_but_hsv(uiBut *but);
346 extern void ui_get_but_vectorf(uiBut *but, float *vec);
347 extern void ui_set_but_vectorf(uiBut *but, float *vec);
348
349 extern void ui_hsvcircle_vals_from_pos(float *valrad, float *valdist, rcti *rect, float mx, float my);
350
351 extern void ui_get_but_string(uiBut *but, char *str, int maxlen);
352 extern int ui_set_but_string(struct bContext *C, uiBut *but, const char *str);
353 extern int ui_get_but_string_max_length(uiBut *but);
354
355 extern void ui_set_but_default(struct bContext *C, uiBut *but);
356
357 extern void ui_set_but_soft_range(uiBut *but, double value);
358
359 extern void ui_check_but(uiBut *but);
360 extern int  ui_is_but_float(uiBut *but);
361 extern int  ui_is_but_unit(uiBut *but);
362
363 extern void ui_bounds_block(uiBlock *block);
364 extern void ui_block_translate(uiBlock *block, int x, int y);
365 extern void ui_block_do_align(uiBlock *block);
366
367 /* interface_regions.c */
368
369 struct uiPopupBlockHandle {
370         /* internal */
371         struct ARegion *region;
372         int towardsx, towardsy;
373         double towardstime;
374         int dotowards;
375
376         int popup;
377         void (*popup_func)(struct bContext *C, void *arg, int event);
378         void (*cancel_func)(void *arg);
379         void *popup_arg;
380
381         /* for operator popups */
382         struct wmOperatorType *optype;
383         int opcontext;
384         ScrArea *ctx_area;
385         ARegion *ctx_region;
386         
387         /* return values */
388         int butretval;
389         int menuretval;
390         float retvalue;
391         float retvec[4];
392 };
393
394 uiBlock *ui_block_func_COL(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
395 void ui_block_func_ICONROW(struct bContext *C, uiLayout *layout, void *arg_but);
396 void ui_block_func_ICONTEXTROW(struct bContext *C, uiLayout *layout, void *arg_but);
397
398 struct ARegion *ui_tooltip_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
399 void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
400
401 uiBut *ui_popup_menu_memory(uiBlock *block, uiBut *but);
402
403 /* searchbox for string button */
404 ARegion *ui_searchbox_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
405 int ui_searchbox_inside(struct ARegion *ar, int x, int y);
406 void ui_searchbox_update(struct bContext *C, struct ARegion *ar, uiBut *but, int reset);
407 void ui_searchbox_autocomplete(struct bContext *C, struct ARegion *ar, uiBut *but, char *str);
408 void ui_searchbox_event(struct bContext *C, struct ARegion *ar, uiBut *but, struct wmEvent *event);
409 void ui_searchbox_apply(uiBut *but, struct ARegion *ar);
410 void ui_searchbox_free(struct bContext *C, struct ARegion *ar);
411
412 typedef uiBlock* (*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1);
413
414 uiPopupBlockHandle *ui_popup_block_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
415         uiBlockCreateFunc create_func, uiBlockHandleCreateFunc handle_create_func, void *arg);
416 uiPopupBlockHandle *ui_popup_menu_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
417         uiMenuCreateFunc create_func, void *arg, char *str);
418
419 void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
420
421 void ui_set_name_menu(uiBut *but, int value);
422 int ui_step_name_menu(uiBut *but, int step);
423
424 struct AutoComplete;
425 struct AutoComplete *autocomplete_begin(char *startname, int maxlen);
426 void autocomplete_do_name(struct AutoComplete *autocpl, const char *name);
427 void autocomplete_end(struct AutoComplete *autocpl, char *autoname);
428
429 /* interface_panel.c */
430 extern int ui_handler_panel_region(struct bContext *C, struct wmEvent *event);
431 extern void ui_draw_aligned_panel(struct ARegion *ar, struct uiStyle *style, uiBlock *block, rcti *rect);
432
433 /* interface_draw.c */
434 extern void ui_dropshadow(rctf *rct, float radius, float aspect, int select);
435
436 extern void gl_round_box(int mode, float minx, float miny, float maxx, float maxy, float rad);
437 extern void gl_round_box_shade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadetop, float shadedown);
438 extern void gl_round_box_vertical_shade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadeLeft, float shadeRight);
439
440 void ui_draw_gradient(rcti *rect, float *rgb, int type, float alpha);
441
442 void ui_draw_but_HISTOGRAM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
443 void ui_draw_but_COLORBAND(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
444 void ui_draw_but_NORMAL(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
445 void ui_draw_but_CURVE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
446 void ui_draw_but_IMAGE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
447
448 /* interface_handlers.c */
449 extern void ui_button_activate_do(struct bContext *C, struct ARegion *ar, uiBut *but);
450 extern void ui_button_active_cancel(const struct bContext *C, uiBut *but);
451 extern int ui_button_is_active(struct ARegion *ar);
452
453 /* interface_widgets.c */
454 void ui_draw_anti_tria(float x1, float y1, float x2, float y2, float x3, float y3);
455 void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect);
456 void ui_draw_search_back(struct uiStyle *style, uiBlock *block, rcti *rect);
457 int ui_link_bezier_points(rcti *rect, float coord_array[][2], int resol);
458 void ui_draw_link_bezier(rcti *rect);
459
460 extern void ui_draw_but(const struct bContext *C, ARegion *ar, struct uiStyle *style, uiBut *but, rcti *rect);
461                 /* theme color init */
462 struct ThemeUI;
463 void ui_widget_color_init(struct ThemeUI *tui);
464
465 void ui_draw_menu_item(struct uiFontStyle *fstyle, rcti *rect, char *name, int iconid, int state);
466 void ui_draw_preview_item(struct uiFontStyle *fstyle, rcti *rect, char *name, int iconid, int state);
467
468 /* interface_style.c */
469 void uiStyleInit(void);
470
471 /* interface_icons.c */
472 void ui_id_icon_render(struct bContext *C, struct ID *id, int preview);
473 int ui_id_icon_get(struct bContext *C, struct ID *id, int preview);
474
475 /* resources.c */
476 void init_userdef_do_versions(void);
477 void ui_theme_init_userdef(void);
478 void ui_resources_init(void);
479 void ui_resources_free(void);
480
481 /* interface_layout.c */
482 void ui_layout_add_but(uiLayout *layout, uiBut *but);
483 int ui_but_can_align(uiBut *but);
484 void ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop);
485
486 /* interface_anim.c */
487 void ui_but_anim_flag(uiBut *but, float cfra);
488 void ui_but_anim_insert_keyframe(struct bContext *C);
489 void ui_but_anim_delete_keyframe(struct bContext *C);
490 void ui_but_anim_add_driver(struct bContext *C);
491 void ui_but_anim_remove_driver(struct bContext *C);
492 void ui_but_anim_copy_driver(struct bContext *C);
493 void ui_but_anim_paste_driver(struct bContext *C);
494 void ui_but_anim_add_keyingset(struct bContext *C);
495 void ui_but_anim_remove_keyingset(struct bContext *C);
496 int ui_but_anim_expression_get(uiBut *but, char *str, int maxlen);
497 int ui_but_anim_expression_set(uiBut *but, const char *str);
498 void ui_but_anim_autokey(struct bContext *C, uiBut *but, struct Scene *scene, float cfra);
499
500 #endif
501