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