Sculpt: svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r24095...
[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, win;
203         short iconadd, dt;
204
205         /* IDPOIN data */
206         uiIDPoinFuncFP idpoin_func;
207         ID **idpoin_idpp;
208
209         /* BLOCK data */
210         uiBlockCreateFunc block_create_func;
211
212         /* PULLDOWN/MENU data */
213         uiMenuCreateFunc menu_create_func;
214
215         /* RNA data */
216         struct PointerRNA rnapoin;
217         struct PropertyRNA *rnaprop;
218         int rnaindex;
219
220         struct PointerRNA rnasearchpoin;
221         struct PropertyRNA *rnasearchprop;
222
223         /* Operator data */
224         struct wmOperatorType *optype;
225         int opcontext;
226         struct IDProperty *opproperties;
227         struct PointerRNA *opptr;
228
229                 /* active button data */
230         struct uiHandleButtonData *active;
231
232         char *editstr;
233         double *editval;
234         float *editvec;
235         void *editcoba;
236         void *editcumap;
237         
238                 /* pointer back */
239         uiBlock *block;
240 };
241
242 struct uiBlock {
243         uiBlock *next, *prev;
244
245         ListBase buttons;
246         Panel *panel;
247         uiBlock *oldblock;
248
249         ListBase layouts;
250         struct uiLayout *curlayout;
251
252         ListBase contexts;
253         
254         char name[UI_MAX_NAME_STR];
255         
256         float winmat[4][4];
257         
258         float minx, miny, maxx, maxy;
259         float aspect;
260
261         short alignnr;
262
263         uiButHandleFunc func;
264         void *func_arg1;
265         void *func_arg2;
266
267         uiButHandleNFunc funcN;
268         void *func_argN;
269
270         uiMenuHandleFunc butm_func;
271         void *butm_func_arg;
272
273         uiBlockHandleFunc handle_func;
274         void *handle_func_arg;
275         
276         /* custom extra handling */
277         int (*block_event_func)(const struct bContext *C, struct uiBlock *, struct wmEvent *);
278         
279         /* extra draw function for custom blocks */
280         void (*drawextra)(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect);
281         void *drawextra_arg1;
282         void *drawextra_arg2;
283
284         int afterval, flag;
285         
286         short direction, dt;
287         short auto_open, in_use;
288         double auto_open_last;
289
290         int lock;
291         char *lockstr;
292         
293         float xofs, yofs;                               // offset to parent button
294         int dobounds, mx, my;                   // for doing delayed
295         int bounds, minbounds;                  // for doing delayed
296         int endblock;                                   // uiEndBlock done?
297
298         rctf safety;                            // pulldowns, to detect outside, can differ per case how it is created
299         ListBase saferct;                       // uiSafetyRct list
300
301         uiPopupBlockHandle *handle;     // handle
302         int tooltipdisabled;            // to avoid tooltip after click
303
304         int active;                                     // to keep blocks while drawing and free them afterwards
305         int puphash;                            // popup menu hash for memory
306
307         void *evil_C;                           // XXX hack for dynamic operator enums
308 };
309
310 typedef struct uiSafetyRct {
311         struct uiSafetyRct *next, *prev;
312         rctf parent;
313         rctf safety;
314 } uiSafetyRct;
315
316 /* interface.c */
317
318 extern int ui_translate_buttons(void);
319 extern int ui_translate_menus(void);
320 extern int ui_translate_tooltips(void);
321
322 void ui_fontscale(short *points, float aspect);
323
324 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
325 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
326 extern void ui_block_to_window_rct(const struct ARegion *ar, uiBlock *block, rctf *graph, rcti *winr);
327 extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
328 extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
329 extern void ui_window_to_region(const ARegion *ar, int *x, int *y);
330
331 extern double ui_get_but_val(uiBut *but);
332 extern void ui_set_but_val(uiBut *but, double value);
333 extern void ui_set_but_hsv(uiBut *but);
334 extern void ui_get_but_vectorf(uiBut *but, float *vec);
335 extern void ui_set_but_vectorf(uiBut *but, float *vec);
336
337 extern void ui_hsvcircle_vals_from_pos(float *valrad, float *valdist, rcti *rect, float mx, float my);
338
339 extern void ui_get_but_string(uiBut *but, char *str, int maxlen);
340 extern int ui_set_but_string(struct bContext *C, uiBut *but, const char *str);
341 extern int ui_get_but_string_max_length(uiBut *but);
342
343 extern void ui_set_but_soft_range(uiBut *but, double value);
344
345 extern void ui_check_but(uiBut *but);
346 extern int  ui_is_but_float(uiBut *but);
347 extern int  ui_is_but_unit(uiBut *but);
348 extern void ui_update_block_buts_hsv(uiBlock *block, float *hsv);
349
350 extern void ui_bounds_block(uiBlock *block);
351 extern void ui_block_translate(uiBlock *block, int x, int y);
352 extern void ui_block_do_align(uiBlock *block);
353
354 /* interface_regions.c */
355
356 struct uiPopupBlockHandle {
357         /* internal */
358         struct ARegion *region;
359         int towardsx, towardsy;
360         double towardstime;
361         int dotowards;
362
363         int popup;
364         void (*popup_func)(struct bContext *C, void *arg, int event);
365         void (*cancel_func)(void *arg);
366         void *popup_arg;
367
368         /* for operator popups */
369         struct wmOperatorType *optype;
370         int opcontext;
371         ScrArea *ctx_area;
372         ARegion *ctx_region;
373         
374         /* return values */
375         int butretval;
376         int menuretval;
377         float retvalue;
378         float retvec[3];
379 };
380
381 uiBlock *ui_block_func_COL(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
382 void ui_block_func_ICONROW(struct bContext *C, uiLayout *layout, void *arg_but);
383 void ui_block_func_ICONTEXTROW(struct bContext *C, uiLayout *layout, void *arg_but);
384
385 struct ARegion *ui_tooltip_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
386 void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
387
388 uiBut *ui_popup_menu_memory(uiBlock *block, uiBut *but);
389
390 /* searchbox for string button */
391 ARegion *ui_searchbox_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
392 int ui_searchbox_inside(struct ARegion *ar, int x, int y);
393 void ui_searchbox_update(struct bContext *C, struct ARegion *ar, uiBut *but, int reset);
394 void ui_searchbox_autocomplete(struct bContext *C, struct ARegion *ar, uiBut *but, char *str);
395 void ui_searchbox_event(struct bContext *C, struct ARegion *ar, uiBut *but, struct wmEvent *event);
396 void ui_searchbox_apply(uiBut *but, struct ARegion *ar);
397 void ui_searchbox_free(struct bContext *C, struct ARegion *ar);
398
399 typedef uiBlock* (*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1);
400
401 uiPopupBlockHandle *ui_popup_block_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
402         uiBlockCreateFunc create_func, uiBlockHandleCreateFunc handle_create_func, void *arg);
403 uiPopupBlockHandle *ui_popup_menu_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
404         uiMenuCreateFunc create_func, void *arg, char *str);
405
406 void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
407
408 void ui_set_name_menu(uiBut *but, int value);
409 int ui_step_name_menu(uiBut *but, int step);
410
411 struct AutoComplete;
412 struct AutoComplete *autocomplete_begin(char *startname, int maxlen);
413 void autocomplete_do_name(struct AutoComplete *autocpl, const char *name);
414 void autocomplete_end(struct AutoComplete *autocpl, char *autoname);
415
416 /* interface_panel.c */
417 extern int ui_handler_panel_region(struct bContext *C, struct wmEvent *event);
418 extern void ui_draw_aligned_panel(struct ARegion *ar, struct uiStyle *style, uiBlock *block, rcti *rect);
419
420 /* interface_draw.c */
421 extern void ui_dropshadow(rctf *rct, float radius, float aspect, int select);
422
423 extern void gl_round_box(int mode, float minx, float miny, float maxx, float maxy, float rad);
424 extern void gl_round_box_shade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadetop, float shadedown);
425 extern void gl_round_box_vertical_shade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadeLeft, float shadeRight);
426
427 void ui_draw_but_COLORBAND(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
428 void ui_draw_but_NORMAL(uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
429 void ui_draw_but_CURVE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, rcti *rect);
430
431
432 /* interface_handlers.c */
433 extern void ui_button_activate_do(struct bContext *C, struct ARegion *ar, uiBut *but);
434 extern void ui_button_active_cancel(const struct bContext *C, uiBut *but);
435 extern int ui_button_is_active(struct ARegion *ar);
436
437 /* interface_widgets.c */
438 void ui_draw_anti_tria(float x1, float y1, float x2, float y2, float x3, float y3);
439 void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect);
440 void ui_draw_search_back(struct uiStyle *style, uiBlock *block, rcti *rect);
441 void ui_draw_link_bezier(rcti *rect);
442
443 extern void ui_draw_but(const struct bContext *C, ARegion *ar, struct uiStyle *style, uiBut *but, rcti *rect);
444                 /* theme color init */
445 struct ThemeUI;
446 void ui_widget_color_init(struct ThemeUI *tui);
447
448 void ui_draw_menu_item(struct uiFontStyle *fstyle, rcti *rect, char *name, int iconid, int state);
449
450 /* interface_style.c */
451 void uiStyleInit(void);
452
453 /* interface_icons.c */
454 void ui_id_icon_render(struct bContext *C, struct ID *id);
455 int ui_id_icon_get(struct bContext *C, struct ID *id);
456
457 /* resources.c */
458 void init_userdef_do_versions(void);
459 void ui_theme_init_userdef(void);
460 void ui_resources_init(void);
461 void ui_resources_free(void);
462
463 /* interface_layout.c */
464 void ui_layout_add_but(uiLayout *layout, uiBut *but);
465 int ui_but_can_align(uiBut *but);
466 void ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop);
467
468 /* interface_anim.c */
469 void ui_but_anim_flag(uiBut *but, float cfra);
470 void ui_but_anim_insert_keyframe(struct bContext *C);
471 void ui_but_anim_delete_keyframe(struct bContext *C);
472 void ui_but_anim_add_driver(struct bContext *C);
473 void ui_but_anim_remove_driver(struct bContext *C);
474 void ui_but_anim_copy_driver(struct bContext *C);
475 void ui_but_anim_paste_driver(struct bContext *C);
476 void ui_but_anim_add_keyingset(struct bContext *C);
477 void ui_but_anim_remove_keyingset(struct bContext *C);
478 int ui_but_anim_expression_get(uiBut *but, char *str, int maxlen);
479 int ui_but_anim_expression_set(uiBut *but, const char *str);
480 void ui_but_anim_autokey(uiBut *but, struct Scene *scene, float cfra);
481
482 #endif
483