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