c27eafd501cddc9af3d872b2e24bc70f9a74e6a2
[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_POINTER_LINK,
76         
77         UI_WTYPE_PULLDOWN,
78         UI_WTYPE_MENU_ITEM,
79         UI_WTYPE_MENU_BACK,
80         
81         /* specials */
82         UI_WTYPE_ICON,
83         UI_WTYPE_SWATCH,
84         UI_WTYPE_RGB_PICKER,
85         UI_WTYPE_NORMAL,
86         UI_WTYPE_BOX,
87         UI_WTYPE_SCROLL
88         
89 } uiWidgetTypeEnum;
90
91
92
93 #define UI_MAX_DRAW_STR 400
94 #define UI_MAX_NAME_STR 64
95 #define UI_ARRAY        29
96
97 /* panel limits */
98 #define UI_PANEL_MINX   100
99 #define UI_PANEL_MINY   70
100
101 /* uiBut->flag */
102 #define UI_SELECT               1
103 #define UI_MOUSE_OVER   2
104 #define UI_ACTIVE               4
105 #define UI_HAS_ICON             8
106 #define UI_TEXTINPUT    16
107 #define UI_HIDDEN               32
108 /* warn: rest of uiBut->flag in UI_interface.h */
109
110 /* internal panel drawing defines */
111 #define PNL_GRID        4
112 #define PNL_HEADER  20
113
114 /* panel->flag */
115 #define PNL_SELECT      1
116 #define PNL_CLOSEDX     2
117 #define PNL_CLOSEDY     4
118 #define PNL_CLOSED      6
119 #define PNL_TABBED      8
120 #define PNL_OVERLAP     16
121
122 /* Button text selection:
123  * extension direction, selextend, inside ui_do_but_TEX */
124 #define EXTEND_LEFT             1
125 #define EXTEND_RIGHT    2
126
127 typedef struct {
128         short xim, yim;
129         unsigned int *rect;
130         short xofs, yofs;
131 } uiIconImage;
132
133
134 typedef struct uiLinkLine {                             /* only for draw/edit */
135         struct uiLinkLine *next, *prev;
136
137         short flag, pad;
138         
139         struct uiBut *from, *to;        
140 } uiLinkLine;
141
142 typedef struct {
143         void **poin;            /* pointer to original pointer */
144         void ***ppoin;          /* pointer to original pointer-array */
145         short *totlink;         /* if pointer-array, here is the total */
146         
147         short maxlink, pad;
148         short fromcode, tocode;
149         
150         ListBase lines;
151 } uiLink;
152
153 struct uiBut {
154         struct uiBut *next, *prev;
155         short type, pointype, bit, bitnr, retval, strwidth, ofs, pos, selsta, selend;
156         short alignnr;
157         int flag;
158         
159         char *str;
160         char strdata[UI_MAX_NAME_STR];
161         char drawstr[UI_MAX_DRAW_STR];
162         
163         float x1, y1, x2, y2;
164
165         char *poin;
166         float hardmin, hardmax, softmin, softmax;
167         float a1, a2, hsv[3];   // hsv is temp memory for hsv buttons
168         float aspect;
169
170         uiButHandleFunc func;
171         void *func_arg1;
172         void *func_arg2;
173         void *func_arg3;
174
175         uiButHandleNFunc funcN;
176         void *func_argN;
177
178         struct bContextStore *context;
179
180         void (*embossfunc)(int , int , float, float, float, float, float, int);
181         void (*sliderfunc)(int , float, float, float, float, float, float, int);
182
183         uiButCompleteFunc autocomplete_func;
184         void *autofunc_arg;
185         
186         uiButSearchFunc search_func;
187         void *search_arg;
188         
189         uiLink *link;
190         short linkto[2];
191         
192         char *tip, *lockstr;
193
194         BIFIconID icon;
195         short but_align;        /* aligning buttons, horiz/vertical */
196         short lock, win;
197         short iconadd, dt;
198
199         /* IDPOIN data */
200         uiIDPoinFuncFP idpoin_func;
201         ID **idpoin_idpp;
202
203         /* BLOCK data */
204         uiBlockCreateFunc block_create_func;
205
206         /* PULLDOWN/MENU data */
207         uiMenuCreateFunc menu_create_func;
208
209         /* RNA data */
210         struct PointerRNA rnapoin;
211         struct PropertyRNA *rnaprop;
212         int rnaindex;
213
214         /* Operator data */
215         struct wmOperatorType *optype;
216         int opcontext;
217         struct IDProperty *opproperties;
218         struct PointerRNA *opptr;
219
220                 /* active button data */
221         struct uiHandleButtonData *active;
222
223         char *editstr;
224         double *editval;
225         float *editvec;
226         void *editcoba;
227         void *editcumap;
228         
229                 /* pointer back */
230         uiBlock *block;
231 };
232
233 struct uiBlock {
234         uiBlock *next, *prev;
235
236         ListBase buttons;
237         Panel *panel;
238         uiBlock *oldblock;
239
240         ListBase layouts;
241         struct uiLayout *curlayout;
242
243         ListBase contexts;
244         
245         char name[UI_MAX_NAME_STR];
246         
247         float winmat[4][4];
248         
249         float minx, miny, maxx, maxy;
250         float aspect;
251
252         short alignnr;
253
254         uiButHandleFunc func;
255         void *func_arg1;
256         void *func_arg2;
257
258         uiMenuHandleFunc butm_func;
259         void *butm_func_arg;
260
261         uiBlockHandleFunc handle_func;
262         void *handle_func_arg;
263         
264         /* custom extra handling */
265         int (*block_event_func)(const struct bContext *C, struct uiBlock *, struct wmEvent *);
266         
267         /* extra draw function for custom blocks */
268         void (*drawextra)(const struct bContext *C, void *idv, rcti *rect);
269
270         int afterval, flag;
271         
272         short direction, dt;
273         short auto_open, in_use;
274         double auto_open_last;
275
276         int lock;
277         char *lockstr;
278         
279         float xofs, yofs;                               // offset to parent button
280         int bounds, dobounds, mx, my;   // for doing delayed
281         int endblock;                                   // uiEndBlock done?
282
283         rctf safety;                            // pulldowns, to detect outside, can differ per case how it is created
284         ListBase saferct;                       // uiSafetyRct list
285
286         uiPopupBlockHandle *handle;     // handle
287         int tooltipdisabled;            // to avoid tooltip after click
288
289         int active;                                     // to keep blocks while drawing and free them afterwards
290 };
291
292 typedef struct uiSafetyRct {
293         struct uiSafetyRct *next, *prev;
294         rctf parent;
295         rctf safety;
296 } uiSafetyRct;
297
298 /* interface.c */
299
300 extern int ui_translate_buttons(void);
301 extern int ui_translate_menus(void);
302 extern int ui_translate_tooltips(void);
303
304 void ui_fontscale(short *points, float aspect);
305
306 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
307 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
308 extern void ui_block_to_window_rct(const struct ARegion *ar, uiBlock *block, rctf *graph, rcti *winr);
309 extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
310 extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
311 extern void ui_window_to_region(const ARegion *ar, int *x, int *y);
312
313 extern double ui_get_but_val(uiBut *but);
314 extern void ui_set_but_val(uiBut *but, double value);
315 extern void ui_set_but_hsv(uiBut *but);
316 extern void ui_get_but_vectorf(uiBut *but, float *vec);
317 extern void ui_set_but_vectorf(uiBut *but, float *vec);
318
319 extern void ui_hsvcircle_vals_from_pos(float *valrad, float *valdist, rcti *rect, float mx, float my);
320
321 extern void ui_get_but_string(uiBut *but, char *str, int maxlen);
322 extern int ui_set_but_string(struct bContext *C, uiBut *but, const char *str);
323 extern int ui_get_but_string_max_length(uiBut *but);
324
325 extern void ui_set_but_soft_range(uiBut *but, double value);
326
327 extern void ui_check_but(uiBut *but);
328 extern int  ui_is_but_float(uiBut *but);
329 extern void ui_update_block_buts_hsv(uiBlock *block, float *hsv);
330
331 extern void ui_bounds_block(uiBlock *block);
332 extern void ui_block_translate(uiBlock *block, int x, int y);
333 extern void ui_block_do_align(uiBlock *block);
334
335 /* interface_regions.c */
336
337 struct uiPopupBlockHandle {
338         /* internal */
339         struct ARegion *region;
340         int towardsx, towardsy;
341         double towardstime;
342         int dotowards;
343
344         int popup;
345         void (*popup_func)(struct bContext *C, void *arg, int event);
346         void (*cancel_func)(void *arg);
347         void *popup_arg;
348
349         /* for operator popups */
350         struct wmOperatorType *optype;
351         int opcontext;
352         ScrArea *ctx_area;
353         ARegion *ctx_region;
354         
355         /* return values */
356         int butretval;
357         int menuretval;
358         float retvalue;
359         float retvec[3];
360 };
361
362 uiBlock *ui_block_func_MENU(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
363 uiBlock *ui_block_func_ICONROW(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
364 uiBlock *ui_block_func_ICONTEXTROW(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
365 uiBlock *ui_block_func_COL(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
366
367 struct ARegion *ui_tooltip_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
368 void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
369
370 /* searchbox for string button */
371 ARegion *ui_searchbox_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
372 int ui_searchbox_inside(struct ARegion *ar, int x, int y);
373 void ui_searchbox_update(struct bContext *C, struct ARegion *ar, uiBut *but, int reset);
374 void ui_searchbox_event(struct bContext *C, struct ARegion *ar, uiBut *but, struct wmEvent *event);
375 void ui_searchbox_apply(uiBut *but, struct ARegion *ar);
376 void ui_searchbox_free(struct bContext *C, struct ARegion *ar);
377
378 typedef uiBlock* (*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1);
379
380 uiPopupBlockHandle *ui_popup_block_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
381         uiBlockCreateFunc create_func, uiBlockHandleCreateFunc handle_create_func, void *arg);
382 uiPopupBlockHandle *ui_popup_menu_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
383         uiMenuCreateFunc create_func, void *arg);
384 void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
385
386 void ui_set_name_menu(uiBut *but, int value);
387 int ui_step_name_menu(uiBut *but, int step);
388
389 struct AutoComplete;
390 struct AutoComplete *autocomplete_begin(char *startname, int maxlen);
391 void autocomplete_do_name(struct AutoComplete *autocpl, const char *name);
392 void autocomplete_end(struct AutoComplete *autocpl, char *autoname);
393
394 /* interface_panel.c */
395 extern int ui_handler_panel_region(struct bContext *C, struct wmEvent *event);
396 extern void ui_draw_aligned_panel(struct ARegion *ar, struct uiStyle *style, uiBlock *block, rcti *rect);
397
398 /* interface_draw.c */
399 extern void ui_dropshadow(rctf *rct, float radius, float aspect, int select);
400
401 extern void gl_round_box(int mode, float minx, float miny, float maxx, float maxy, float rad);
402 extern void gl_round_box_shade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadetop, float shadedown);
403 extern void gl_round_box_vertical_shade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadeLeft, float shadeRight);
404
405 void ui_draw_but_COLORBAND(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
406 void ui_draw_but_NORMAL(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
407 void ui_draw_but_CURVE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
408
409
410 /* interface_handlers.c */
411 extern void ui_button_active_cancel(const struct bContext *C, uiBut *but);
412 extern int ui_button_is_active(struct ARegion *ar);
413
414 /* interface_widgets.c */
415 void ui_draw_anti_tria(float x1, float y1, float x2, float y2, float x3, float y3);
416 void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect);
417 void ui_draw_search_back(struct uiStyle *style, uiBlock *block, rcti *rect);
418 void ui_draw_link_bezier(rcti *rect);
419
420 extern void ui_draw_but(const struct bContext *C, ARegion *ar, struct uiStyle *style, uiBut *but, rcti *rect);
421                 /* theme color init */
422 struct ThemeUI;
423 void ui_widget_color_init(struct ThemeUI *tui);
424
425 void ui_draw_menu_item(struct uiFontStyle *fstyle, rcti *rect, char *name, int iconid, int state);
426
427 /* interface_style.c */
428 void uiStyleInit(void);
429
430 /* interface_icons.c */
431 void ui_id_icon_render(struct Scene *scene, struct ID *id);
432
433 /* resources.c */
434 void init_userdef_do_versions(void);
435 void ui_theme_init_userdef(void);
436 void ui_resources_init(void);
437 void ui_resources_free(void);
438
439 /* interface_layout.c */
440 void ui_layout_add_but(struct uiLayout *layout, uiBut *but);
441 int ui_but_can_align(uiBut *but);
442
443 /* interface_anim.c */
444 void ui_but_anim_flag(uiBut *but, float cfra);
445 void ui_but_anim_insert_keyframe(struct bContext *C);
446 void ui_but_anim_delete_keyframe(struct bContext *C);
447 void ui_but_anim_add_driver(struct bContext *C);
448 void ui_but_anim_remove_driver(struct bContext *C);
449 void ui_but_anim_menu(struct bContext *C, uiBut *but);
450
451 #endif
452