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
43 /* general defines */
44
45 #define UI_MAX_DRAW_STR 400
46 #define UI_MAX_NAME_STR 64
47 #define UI_ARRAY        29
48
49 /* panel limits */
50 #define UI_PANEL_MINX   100
51 #define UI_PANEL_MINY   70
52
53 /* uiBut->flag */
54 #define UI_SELECT               1
55 #define UI_MOUSE_OVER   2
56 #define UI_ACTIVE               4
57 #define UI_HAS_ICON             8
58 /* warn: rest of uiBut->flag in BIF_interface.c */
59
60 /* internal panel drawing defines */
61 #define PNL_GRID        4
62 #define PNL_DIST        8
63 #define PNL_SAFETY      8
64 #define PNL_HEADER  20
65
66 /* panel->flag */
67 #define PNL_SELECT      1
68 #define PNL_CLOSEDX     2
69 #define PNL_CLOSEDY     4
70 #define PNL_CLOSED      6
71 #define PNL_TABBED      8
72 #define PNL_OVERLAP     16
73
74 /* Button text selection:
75  * extension direction, selextend, inside ui_do_but_TEX */
76 #define EXTEND_LEFT             1
77 #define EXTEND_RIGHT    2
78
79 typedef struct {
80         short xim, yim;
81         unsigned int *rect;
82         short xofs, yofs;
83 } uiIconImage;
84
85 typedef struct {
86         void *xl, *large, *medium, *small;
87 } uiFont;
88
89 typedef struct uiLinkLine {                             /* only for draw/edit */
90         struct uiLinkLine *next, *prev;
91
92         short flag, pad;
93         
94         struct uiBut *from, *to;        
95 } uiLinkLine;
96
97 typedef struct {
98         void **poin;            /* pointer to original pointer */
99         void ***ppoin;          /* pointer to original pointer-array */
100         short *totlink;         /* if pointer-array, here is the total */
101         
102         short maxlink, pad;
103         short fromcode, tocode;
104         
105         ListBase lines;
106 } uiLink;
107
108 struct uiBut {
109         struct uiBut *next, *prev;
110         short type, pointype, bit, bitnr, retval, strwidth, ofs, pos, selsta, selend;
111         int flag;
112         
113         char *str;
114         char strdata[UI_MAX_NAME_STR];
115         char drawstr[UI_MAX_DRAW_STR];
116         
117         float x1, y1, x2, y2;
118
119         char *poin;
120         float min, max;
121         float a1, a2, hsv[3];   // hsv is temp memory for hsv buttons
122         float aspect;
123
124         uiButHandleFunc func;
125         void *func_arg1;
126         void *func_arg2;
127
128         uiButHandleNFunc funcN;
129         void *func_argN;
130
131         void (*embossfunc)(int , int , float, float, float, float, float, int);
132         void (*sliderfunc)(int , float, float, float, float, float, float, int);
133
134         uiButCompleteFunc autocomplete_func;
135         void *autofunc_arg;
136         
137         uiLink *link;
138         
139         char *tip, *lockstr;
140
141         int themecol;   /* themecolor id */
142         void *font;
143
144         BIFIconID icon;
145         short but_align;        /* aligning buttons, horiz/vertical */
146         short lock, win;
147         short iconadd, dt;
148
149         /* IDPOIN data */
150         uiIDPoinFuncFP idpoin_func;
151         ID **idpoin_idpp;
152
153         /* BLOCK data */
154         uiBlockCreateFunc block_create_func;
155
156         /* HMENU data */
157         uiMenuCreateFunc menu_create_func;
158
159         /* RNA data */
160         struct PointerRNA rnapoin;
161         struct PropertyRNA *rnaprop;
162         int rnaindex;
163
164         /* Operator data */
165         const char *opname;
166         int opcontext;
167         struct IDProperty *opproperties;
168         struct PointerRNA *opptr;
169
170                 /* active button data */
171         struct uiHandleButtonData *active;
172
173         char *editstr;
174         double *editval;
175         float *editvec;
176         void *editcoba;
177         void *editcumap;
178         
179                 /* pointer back */
180         uiBlock *block;
181 };
182
183 struct uiBlock {
184         uiBlock *next, *prev;
185         
186         ListBase buttons;
187         Panel *panel;
188         uiBlock *oldblock;
189         
190         char name[UI_MAX_NAME_STR];
191         
192         float winmat[4][4];
193         
194         float minx, miny, maxx, maxy;
195         float aspect;
196
197         uiButHandleFunc func;
198         void *func_arg1;
199         void *func_arg2;
200
201         uiMenuHandleFunc butm_func;
202         void *butm_func_arg;
203
204         uiBlockHandleFunc handle_func;
205         void *handle_func_arg;
206         
207         /* extra draw function for custom blocks */
208         void (*drawextra)();
209
210         int themecol;   /* themecolor id */
211         
212         short font;     /* indices */
213         int afterval, flag;
214         void *curfont;
215         
216         short autofill, win, winq, direction, dt;
217         short auto_open, in_use, pad;
218         double auto_open_last;
219
220         int lock;
221         char *lockstr;
222         
223         float xofs, yofs;                               // offset to parent button
224         int bounds, dobounds, mx, my;   // for doing delayed
225         int endblock;                                   // uiEndBlock done?
226
227         rctf safety;                            // pulldowns, to detect outside, can differ per case how it is created
228         ListBase saferct;                       // uiSafetyRct list
229
230         uiPopupBlockHandle *handle;     // handle
231         int tooltipdisabled;            // to avoid tooltip after click
232
233         int handler;                            // for panels in other windows than buttonswin... just event code
234         int active;                                     // to keep blocks while drawing and free them afterwards
235 };
236
237 typedef struct uiSafetyRct {
238         struct uiSafetyRct *next, *prev;
239         rctf parent;
240         rctf safety;
241 } uiSafetyRct;
242
243 /* interface.c */
244
245 extern int ui_translate_buttons(void);
246 extern int ui_translate_menus(void);
247 extern int ui_translate_tooltips(void);
248
249 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
250 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
251 extern void ui_block_to_window_rct(const struct ARegion *ar, uiBlock *block, rctf *graph, rcti *winr);
252 extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
253 extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
254 extern void ui_window_to_region(const ARegion *ar, int *x, int *y);
255
256 extern double ui_get_but_val(uiBut *but);
257 extern void ui_set_but_val(uiBut *but, double value);
258 extern void ui_set_but_hsv(uiBut *but);
259 extern void ui_get_but_vectorf(uiBut *but, float *vec);
260 extern void ui_set_but_vectorf(uiBut *but, float *vec);
261 extern void ui_get_but_string(uiBut *but, char *str, int maxlen);
262 extern void ui_set_but_string(uiBut *but, const char *str);
263
264 extern void ui_check_but(uiBut *but);
265 extern void ui_autofill(uiBlock *block);
266 extern int  ui_is_but_float(uiBut *but);
267 extern void ui_update_block_buts_hsv(uiBlock *block, float *hsv);
268
269 extern void ui_bounds_block(uiBlock *block);
270
271 /* interface_regions.c */
272
273 struct uiPopupBlockHandle {
274         /* internal */
275         struct ARegion *region;
276         int towardsx, towardsy;
277         double towardstime;
278         int dotowards;
279
280         int popup;
281         void (*popup_func)(struct bContext *C, void *arg, int event);
282         void (*cancel_func)(void *arg);
283         void *popup_arg;
284
285         /* for operator popups */
286         const char *opname;
287         int opcontext;
288         ScrArea *ctx_area;
289         ARegion *ctx_region;
290         
291         /* return values */
292         int butretval;
293         int menuretval;
294         float retvalue;
295         float retvec[3];
296 };
297
298 uiBlock *ui_block_func_MENU(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
299 uiBlock *ui_block_func_ICONROW(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
300 uiBlock *ui_block_func_ICONTEXTROW(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
301 uiBlock *ui_block_func_COL(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
302
303 struct ARegion *ui_tooltip_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
304 void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
305
306 typedef uiBlock* (*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1);
307
308 uiPopupBlockHandle *ui_popup_block_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
309         uiBlockCreateFunc create_func, uiBlockHandleCreateFunc handle_create_func, void *arg);
310 uiPopupBlockHandle *ui_popup_menu_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
311         uiMenuCreateFunc create_func, void *arg);
312 void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
313
314 void ui_set_name_menu(uiBut *but, int value);
315
316 /* interface_panel.c */
317 extern int ui_handler_panel_region(struct bContext *C, struct wmEvent *event);
318 extern void ui_draw_panel(struct ARegion *ar, uiBlock *block);
319
320 /* interface_draw.c */
321 extern void ui_set_embossfunc(uiBut *but, int drawtype);
322 extern void ui_draw_but(uiBut *but);
323 extern void ui_rasterpos_safe(float x, float y, float aspect);
324 extern void ui_draw_tria_icon(float x, float y, float aspect, char dir);
325 extern void ui_draw_anti_x(float x1, float y1, float x2, float y2);
326 extern void ui_dropshadow(rctf *rct, float radius, float aspect, int select);
327
328 extern void gl_round_box(int mode, float minx, float miny, float maxx, float maxy, float rad);
329 extern void gl_round_box_shade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadetop, float shadedown);
330 extern void gl_round_box_vertical_shade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadeLeft, float shadeRight);
331
332 /* interface_handlers.c */
333 extern void ui_button_active_cancel(const struct bContext *C, uiBut *but);
334
335 #endif
336