Port of part of the Interface code to 2.50.
[blender.git] / source / blender / editors / interface / interface.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 uiActivateBut;
37 struct wmWindow;
38 struct ARegion;
39
40 /* general defines */
41
42 #define UI_MAX_DRAW_STR 400
43 #define UI_MAX_NAME_STR 64
44 #define UI_ARRAY        29
45
46 /* panel limits */
47 #define UI_PANEL_MINX   100
48 #define UI_PANEL_MINY   70
49
50 /* uiBut->flag */
51 #define UI_SELECT               1
52 #define UI_MOUSE_OVER   2
53 #define UI_ACTIVE               4
54 #define UI_HAS_ICON             8
55 /* warn: rest of uiBut->flag in BIF_interface.c */
56
57 /* uiBut->activateflag */
58 #define UI_ACTIVATE                                     1
59 #define UI_ACTIVATE_APPLY                       2
60 #define UI_ACTIVATE_TEXT_EDITING        4
61 #define UI_ACTIVATE_OPEN                        8
62
63 /* internal panel drawing defines */
64 #define PNL_GRID        4
65 #define PNL_DIST        8
66 #define PNL_SAFETY      8
67 #define PNL_HEADER  20
68
69 /* panel->flag */
70 #define PNL_SELECT      1
71 #define PNL_CLOSEDX     2
72 #define PNL_CLOSEDY     4
73 #define PNL_CLOSED      6
74 #define PNL_TABBED      8
75 #define PNL_OVERLAP     16
76
77 /* Button text selection:
78  * extension direction, selextend, inside ui_do_but_TEX */
79 #define EXTEND_LEFT             1
80 #define EXTEND_RIGHT    2
81
82 typedef struct {
83         short xim, yim;
84         unsigned int *rect;
85         short xofs, yofs;
86 } uiIconImage;
87
88 typedef struct {
89         short mval[2];
90         short qual, val;
91         int event;
92 } uiEvent;
93
94 typedef struct {
95         void *xl, *large, *medium, *small;
96 } uiFont;
97
98 typedef struct uiLinkLine {                             /* only for draw/edit */
99         struct uiLinkLine *next, *prev;
100
101         short flag, pad;
102         
103         struct uiBut *from, *to;        
104 } uiLinkLine;
105
106 typedef struct {
107         void **poin;            /* pointer to original pointer */
108         void ***ppoin;          /* pointer to original pointer-array */
109         short *totlink;         /* if pointer-array, here is the total */
110         
111         short maxlink, pad;
112         short fromcode, tocode;
113         
114         ListBase lines;
115 } uiLink;
116
117 struct uiBut {
118         struct uiBut *next, *prev;
119         short type, pointype, bit, bitnr, retval, strwidth, ofs, pos, selsta, selend;
120         int flag;
121         
122         char *str;
123         char strdata[UI_MAX_NAME_STR];
124         char drawstr[UI_MAX_DRAW_STR];
125         
126         float x1, y1, x2, y2;
127
128         char *poin;
129         float min, max;
130         float a1, a2, hsv[3];   // hsv is temp memory for hsv buttons
131         float aspect;
132
133         void (*func)(void *, void *);
134         void (*func3)(void *, void *, void *); /* XXX remove */
135         void *func_arg1;
136         void *func_arg2;
137         void *func_arg3; /* XXX remove */
138
139         void (*embossfunc)(int , int , float, float, float, float, float, int);
140         void (*sliderfunc)(int , float, float, float, float, float, float, int);
141
142         void (*autocomplete_func)(char *, void *);
143         void *autofunc_arg;
144         
145         uiLink *link;
146         
147         char *tip, *lockstr;
148
149         int themecol;   /* themecolor id */
150         void *font;
151
152         BIFIconID icon;
153         short but_align;        /* aligning buttons, horiz/vertical */
154         short lock, win;
155         short iconadd, dt;
156
157                 /* IDPOIN data */
158         uiIDPoinFuncFP idpoin_func;
159         ID **idpoin_idpp;
160
161                 /* BLOCK data */
162         uiBlockFuncFP block_func;
163
164                 /* BUTM data */
165         void (*butm_func)(void *arg, int event);
166         void *butm_func_arg;
167
168                 /* RNA */
169         struct PointerRNA rnapoin;
170         struct PropertyRNA *rnaprop;
171         int rnaindex;
172
173                 /* Activation data */
174         struct uiActivateBut *activate;
175         int activateflag;
176
177         char *editstr;
178         double *editval;
179         float *editvec;
180         void *editcoba;
181         void *editcumap;
182         
183                 /* pointer back */
184         uiBlock *block;
185 };
186
187 struct uiBlock {
188         uiBlock *next, *prev;
189         
190         ListBase buttons;
191         Panel *panel;
192         uiBlock *oldblock;
193         
194         char name[UI_MAX_NAME_STR];
195         
196         float winmat[4][4];
197         
198         float minx, miny, maxx, maxy;
199         float aspect;
200
201         void (*butm_func)(void *arg, int event);
202         void *butm_func_arg;
203
204         void (*func)(void *arg1, void *arg2);
205         void *func_arg1;
206         void *func_arg2;
207         
208         /* extra draw function for custom blocks */
209         void (*drawextra)();
210
211         int themecol;   /* themecolor id */
212         
213         short font;     /* indices */
214         int afterval, flag;
215         void *curfont;
216         
217         short autofill, win, winq, direction, dt;
218         short auto_open, in_use, pad;
219         double auto_open_last;
220
221         int lock;
222         char *lockstr;
223         
224         float xofs, yofs;                       // offset to parent button
225         rctf safety;                            // pulldowns, to detect outside, can differ per case how it is created
226         ListBase saferct;                       // uiSafetyRct list
227         uiMenuBlockHandle *handle;      // handle
228 };
229
230 typedef struct uiSafetyRct {
231         struct uiSafetyRct *next, *prev;
232         rctf parent;
233         rctf safety;
234 } uiSafetyRct;
235
236 /* interface.c */
237
238 extern int ui_translate_buttons(void);
239 extern int ui_translate_menus(void);
240 extern int ui_translate_tooltips(void);
241
242 extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
243 extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
244 extern void ui_block_to_window_rct(const struct ARegion *ar, uiBlock *block, rctf *graph, rcti *winr);
245 extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
246 extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
247
248 extern double ui_get_but_val(uiBut *but);
249 extern void ui_set_but_val(uiBut *but, double value);
250 extern void ui_set_but_hsv(uiBut *but);
251 extern void ui_get_but_vectorf(uiBut *but, float *vec);
252 extern void ui_set_but_vectorf(uiBut *but, float *vec);
253 extern void ui_get_but_string(uiBut *but, char *str, int maxlen);
254 extern void ui_set_but_string(uiBut *but, const char *str);
255
256 extern void ui_check_but(uiBut *but);
257 extern void ui_autofill(uiBlock *block);
258 extern int  ui_is_but_float(uiBut *but);
259 extern void ui_update_block_buts_hsv(uiBlock *block, float *hsv);
260
261 /* interface_regions.c */
262 uiBlock *ui_block_func_MENU(struct wmWindow *window, uiMenuBlockHandle *handle, void *arg_but);
263 uiBlock *ui_block_func_ICONROW(struct wmWindow *window, uiMenuBlockHandle *handle, void *arg_but);
264 uiBlock *ui_block_func_ICONTEXTROW(struct wmWindow *window, uiMenuBlockHandle *handle, void *arg_but);
265 uiBlock *ui_block_func_COL(struct wmWindow *window, uiMenuBlockHandle *handle, void *arg_but);
266
267 struct ARegion *ui_tooltip_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
268 void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
269
270 uiMenuBlockHandle *ui_menu_block_create(struct bContext *C, struct ARegion *butregion, uiBut *but,
271         uiBlockFuncFP block_func, void *arg);
272 void ui_menu_block_free(struct bContext *C, uiMenuBlockHandle *handle);
273
274 void ui_set_name_menu(uiBut *but, int value);
275
276 /* interface_panel.c */
277 extern void ui_draw_panel(uiBlock *block);
278 extern void ui_do_panel(uiBlock *block, uiEvent *uevent);
279 extern void ui_scale_panel(uiBlock *block);
280 extern void gl_round_box(int mode, float minx, float miny, float maxx, float maxy, float rad);
281 extern void gl_round_box_shade(int mode, float minx, float miny, float maxx, float maxy, float rad, float shadetop, float shadedown);
282
283 /* interface_draw.c */
284 extern void ui_set_embossfunc(uiBut *but, int drawtype);
285 extern void ui_draw_but(uiBut *but);
286 extern void ui_rasterpos_safe(float x, float y, float aspect);
287 extern void ui_draw_tria_icon(float x, float y, float aspect, char dir);
288 extern void ui_draw_anti_x(float x1, float y1, float x2, float y2);
289 extern void ui_dropshadow(rctf *rct, float radius, float aspect, int select);
290
291 #endif
292