Port of part of the Interface code to 2.50.
[blender.git] / source / blender / editors / include / UI_interface.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 UI_INTERFACE_H
31 #define UI_INTERFACE_H
32
33 struct ID;
34 struct ListBase;
35 struct ARegion;
36 struct wmWindow;
37 struct wmWindowManager;
38 struct AutoComplete;
39 struct bContext;
40
41 /* uiBlock->dt */
42 #define UI_EMBOSS               0       /* use one of the themes for drawing */
43 #define UI_EMBOSSN              1       /* Nothing */
44 #define UI_EMBOSSM              2       /* Minimal builtin emboss, also for logic buttons */
45 #define UI_EMBOSSP              3       /* Pulldown */
46 #define UI_EMBOSSR              4       /* Rounded */
47 #define UI_EMBOSST              5       /* Table */
48
49 #define UI_EMBOSSX              0       /* for a python file, which i can't change.... duh! */
50
51 /* uiBlock->direction */
52 #define UI_TOP          1
53 #define UI_DOWN         2
54 #define UI_LEFT         4
55 #define UI_RIGHT        8
56 #define UI_DIRECTION    15
57 #define UI_CENTER               16
58 #define UI_SHIFT_FLIPPED        32
59
60 /* uiBlock->autofill */
61 #define UI_BLOCK_COLLUMNS       1
62 #define UI_BLOCK_ROWS           2
63
64 /* uiBlock->flag (controls) */
65 #define UI_BLOCK_LOOP                   1
66 #define UI_BLOCK_REDRAW                 2
67 #define UI_BLOCK_RET_1                  4               /* XXX 2.5 not implemented */
68 #define UI_BLOCK_NUMSELECT              8
69 #define UI_BLOCK_ENTER_OK               16
70 #define UI_BLOCK_NOSHADOW               32
71 #define UI_BLOCK_NO_HILITE              64              /* XXX 2.5 not implemented */
72 #define UI_BLOCK_MOVEMOUSE_QUIT 128
73 #define UI_BLOCK_KEEP_OPEN              256
74
75 /* uiMenuBlockHandle->blockretval */
76 #define UI_RETURN_CANCEL        1       /* cancel all menus cascading */
77 #define UI_RETURN_OK        2       /* choice made */
78 #define UI_RETURN_OUT       4       /* left the menu */
79
80         /* block->flag bits 12-15 are identical to but->flag bits */
81
82 /* block->font, for now: bold = medium+1 */
83 #define UI_HELV                 0
84 #define UI_HELVB                1
85
86 /* panel controls */
87 #define UI_PNL_TRANSP   1
88 #define UI_PNL_SOLID    2
89
90 #define UI_PNL_CLOSE    32
91 #define UI_PNL_STOW             64
92 #define UI_PNL_TO_MOUSE 128
93 #define UI_PNL_UNSTOW   256
94 #define UI_PNL_SCALE    512
95
96 /* warning the first 4 flags are internal */
97 /* but->flag */
98 #define UI_TEXT_LEFT    16
99 #define UI_ICON_LEFT    32
100 #define UI_ICON_RIGHT   64
101         /* control for button type block */
102 #define UI_MAKE_TOP             128
103 #define UI_MAKE_DOWN    256
104 #define UI_MAKE_LEFT    512
105 #define UI_MAKE_RIGHT   1024
106         /* dont draw hilite on mouse over */
107 #define UI_NO_HILITE    2048
108         /* button align flag, for drawing groups together */
109 #define UI_BUT_ALIGN            (15<<12)
110 #define UI_BUT_ALIGN_TOP        (1<<12)
111 #define UI_BUT_ALIGN_LEFT       (1<<13)
112 #define UI_BUT_ALIGN_RIGHT      (1<<14)
113 #define UI_BUT_ALIGN_DOWN       (1<<15)
114
115
116 /* Button types, bits stored in 1 value... and a short even!
117 - bits 0-4:  bitnr (0-31)
118 - bits 5-7:  pointer type
119 - bit  8:    for 'bit'
120 - bit  9-15: button type (now 6 bits, 64 types)
121 */
122
123 #define CHA     32
124 #define SHO     64
125 #define INT     96
126 #define FLO     128
127 #define FUN     192
128 #define BIT     256
129
130 #define BUTPOIN (128+64+32)
131
132 #define BUT     (1<<9)
133 #define ROW     (2<<9)
134 #define TOG     (3<<9)
135 #define SLI     (4<<9)
136 #define NUM     (5<<9)
137 #define TEX     (6<<9)
138 #define TOG3    (7<<9)
139 #define TOGR    (8<<9)
140 #define TOGN    (9<<9)
141 #define LABEL   (10<<9)
142 #define MENU    (11<<9)
143 #define ICONROW (12<<9)
144 #define ICONTOG (13<<9)
145 #define NUMSLI  (14<<9)
146 #define COL             (15<<9)
147 #define IDPOIN  (16<<9)
148 #define HSVSLI  (17<<9)
149 #define SCROLL  (18<<9)
150 #define BLOCK   (19<<9)
151 #define BUTM    (20<<9)
152 #define SEPR    (21<<9)
153 #define LINK    (22<<9)
154 #define INLINK  (23<<9)
155 #define KEYEVT  (24<<9)
156 #define ICONTEXTROW (25<<9)
157 #define HSVCUBE (26<<9)
158 #define PULLDOWN (27<<9)
159 #define ROUNDBOX (28<<9)
160 #define CHARTAB (29<<9)
161 #define BUT_COLORBAND (30<<9)
162 #define BUT_NORMAL (31<<9)
163 #define BUT_CURVE (32<<9)
164 #define BUT_TOGDUAL (33<<9)
165 #define ICONTOGN (34<<9)
166 #define FTPREVIEW (35<<9)
167 #define NUMABS  (36<<9)
168 #define BUTTYPE (63<<9)
169
170 /* Menu Block Handle */
171 typedef struct uiMenuBlockHandle {
172         struct ARegion *region;
173         int butretval;
174         int blockretval;
175
176         float retvalue;
177         float retvec[3];
178 } uiMenuBlockHandle;
179
180 typedef struct uiBut uiBut;
181 typedef struct uiBlock uiBlock;
182
183 void uiEmboss(float x1, float y1, float x2, float y2, int sel);
184 void uiRoundBoxEmboss(float minx, float miny, float maxx, float maxy, float rad, int active);
185 void uiRoundBox(float minx, float miny, float maxx, float maxy, float rad);
186 void uiSetRoundBox(int type);
187 void uiRoundRect(float minx, float miny, float maxx, float maxy, float rad);
188
189 void uiDrawMenuBox(float minx, float miny, float maxx, float maxy, short flag);
190 void uiTextBoundsBlock(uiBlock *block, int addval);
191 void uiBoundsBlock(struct uiBlock *block, int addval);
192 void uiDrawBlock(struct uiBlock *block);
193 void uiGetMouse(int win, short *adr);
194 void uiComposeLinks(uiBlock *block);
195 void uiSetButLock(int val, char *lockstr);
196 uiBut *uiFindInlink(uiBlock *block, void *poin);
197 void uiClearButLock(void);
198 int uiDoBlocks(struct ListBase *lb, int event, int movemouse_quit);
199 void uiSetCurFont(uiBlock *block, int index);
200 void uiDefFont(unsigned int index, void *xl, void *large, void *medium, void *small);
201 void uiFreeBlock(uiBlock *block);
202 void uiFreeBlocks(struct ListBase *lb);
203 uiBlock *uiBeginBlock(struct wmWindow *window, struct ARegion *region, char *name, short dt, short font);
204 void uiEndBlock(uiBlock *block);
205 uiBlock *uiGetBlock(char *name, struct ARegion *ar);
206
207 void uiBlockPickerButtons(struct uiBlock *block, float *col, float *hsv, float *old, char *hexcol, char mode, short retval);
208
209
210 /* automatic aligning, horiz or verical */
211 void uiBlockBeginAlign(uiBlock *block);
212 void uiBlockEndAlign(uiBlock *block);
213
214 uiBut *uiDefBut(uiBlock *block, 
215                                            int type, int retval, char *str, 
216                                            short x1, short y1, 
217                                            short x2, short y2, 
218                                            void *poin, 
219                                            float min, float max, 
220                                            float a1, float a2,  char *tip);
221 uiBut *uiDefButF(uiBlock *block, int type, int retval, char *str, short x1, short y1, short x2, short y2, float *poin, float min, float max, float a1, float a2,  char *tip);
222 uiBut *uiDefButBitF(uiBlock *block, int type, int bit, int retval, char *str, short x1, short y1, short x2, short y2, float *poin, float min, float max, float a1, float a2,  char *tip);
223 uiBut *uiDefButI(uiBlock *block, int type, int retval, char *str, short x1, short y1, short x2, short y2, int *poin, float min, float max, float a1, float a2,  char *tip);
224 uiBut *uiDefButBitI(uiBlock *block, int type, int bit, int retval, char *str, short x1, short y1, short x2, short y2, int *poin, float min, float max, float a1, float a2,  char *tip);
225 uiBut *uiDefButS(uiBlock *block, int type, int retval, char *str, short x1, short y1, short x2, short y2, short *poin, float min, float max, float a1, float a2,  char *tip);
226 uiBut *uiDefButBitS(uiBlock *block, int type, int bit, int retval, char *str, short x1, short y1, short x2, short y2, short *poin, float min, float max, float a1, float a2,  char *tip);
227 uiBut *uiDefButC(uiBlock *block, int type, int retval, char *str, short x1, short y1, short x2, short y2, char *poin, float min, float max, float a1, float a2,  char *tip);
228 uiBut *uiDefButBitC(uiBlock *block, int type, int bit, int retval, char *str, short x1, short y1, short x2, short y2, char *poin, float min, float max, float a1, float a2,  char *tip);
229
230 uiBut *uiDefIconBut(uiBlock *block, 
231                                            int type, int retval, int icon, 
232                                            short x1, short y1, 
233                                            short x2, short y2, 
234                                            void *poin, 
235                                            float min, float max, 
236                                            float a1, float a2,  char *tip);
237 uiBut *uiDefIconButF(uiBlock *block, int type, int retval, int icon, short x1, short y1, short x2, short y2, float *poin, float min, float max, float a1, float a2,  char *tip);
238 uiBut *uiDefIconButBitF(uiBlock *block, int type, int bit, int retval, int icon, short x1, short y1, short x2, short y2, float *poin, float min, float max, float a1, float a2,  char *tip);
239 uiBut *uiDefIconButI(uiBlock *block, int type, int retval, int icon, short x1, short y1, short x2, short y2, int *poin, float min, float max, float a1, float a2,  char *tip);
240 uiBut *uiDefIconButBitI(uiBlock *block, int type, int bit, int retval, int icon, short x1, short y1, short x2, short y2, int *poin, float min, float max, float a1, float a2,  char *tip);
241 uiBut *uiDefIconButS(uiBlock *block, int type, int retval, int icon, short x1, short y1, short x2, short y2, short *poin, float min, float max, float a1, float a2,  char *tip);
242 uiBut *uiDefIconButBitS(uiBlock *block, int type, int bit, int retval, int icon, short x1, short y1, short x2, short y2, short *poin, float min, float max, float a1, float a2,  char *tip);
243 uiBut *uiDefIconButC(uiBlock *block, int type, int retval, int icon, short x1, short y1, short x2, short y2, char *poin, float min, float max, float a1, float a2,  char *tip);
244 uiBut *uiDefIconButBitC(uiBlock *block, int type, int bit, int retval, int icon, short x1, short y1, short x2, short y2, char *poin, float min, float max, float a1, float a2,  char *tip);
245
246 uiBut *uiDefIconTextBut(uiBlock *block, int type, int retval, int icon, char *str, short x1, short y1, short x2, short y2, void *poin, float min, float max, float a1, float a2,  char *tip);
247
248 uiBut *uiDefIconTextButF(uiBlock *block, int type, int retval, int icon, char *str, short x1, short y1, short x2, short y2, float *poin, float min, float max, float a1, float a2,  char *tip);
249 uiBut *uiDefIconTextButBitF(uiBlock *block, int type, int bit, int retval, int icon, char *str, short x1, short y1, short x2, short y2, float *poin, float min, float max, float a1, float a2,  char *tip);
250 uiBut *uiDefIconTextButI(uiBlock *block, int type, int retval, int icon, char *str, short x1, short y1, short x2, short y2, int *poin, float min, float max, float a1, float a2,  char *tip);
251 uiBut *uiDefIconTextButBitI(uiBlock *block, int type, int bit, int retval, int icon, char *str, short x1, short y1, short x2, short y2, int *poin, float min, float max, float a1, float a2,  char *tip);
252 uiBut *uiDefIconTextButS(uiBlock *block, int type, int retval, int icon, char *str, short x1, short y1, short x2, short y2, short *poin, float min, float max, float a1, float a2,  char *tip);
253 uiBut *uiDefIconTextButBitS(uiBlock *block, int type, int bit, int retval, int icon, char *str, short x1, short y1, short x2, short y2, short *poin, float min, float max, float a1, float a2,  char *tip);
254 uiBut *uiDefIconTextButC(uiBlock *block, int type, int retval, int icon, char *str, short x1, short y1, short x2, short y2, char *poin, float min, float max, float a1, float a2,  char *tip);
255 uiBut *uiDefIconTextButBitC(uiBlock *block, int type, int bit, int retval, int icon, char *str, short x1, short y1, short x2, short y2, char *poin, float min, float max, float a1, float a2,  char *tip);
256
257 typedef void            (*uiIDPoinFuncFP)       (char *str, struct ID **idpp);
258 uiBut *uiDefIDPoinBut(struct uiBlock *block, uiIDPoinFuncFP func, short blocktype, int retval, char *str,
259                                                 short x1, short y1, short x2, short y2, void *idpp, char *tip);
260
261 typedef uiBlock* (*uiBlockFuncFP)       (struct wmWindow *window, struct uiMenuBlockHandle *handle, void *arg1);
262 uiBut *uiDefBlockBut(uiBlock *block, uiBlockFuncFP func, void *func_arg1, char *str, short x1, short y1, short x2, short y2, char *tip);
263 uiBut *uiDefPulldownBut(uiBlock *block, uiBlockFuncFP func, void *func_arg1, char *str, short x1, short y1, short x2, short y2, char *tip);
264
265 uiBut *uiDefIconTextBlockBut(uiBlock *block, uiBlockFuncFP func, void *arg, int icon, char *str, short x1, short y1, short x2, short y2, char *tip);
266 uiBut *uiDefIconBlockBut(uiBlock *block, uiBlockFuncFP func, void *arg, int retval, int icon, short x1, short y1, short x2, short y2, char *tip);
267
268 void uiDefKeyevtButS(uiBlock *block, int retval, char *str, short x1, short y1, short x2, short y2, short *spoin, char *tip);
269
270 struct PointerRNA;
271 struct PropertyRNA;
272 uiBut *uiDefRNABut(uiBlock *block, int retval, struct PointerRNA *ptr, struct PropertyRNA *prop, int index, short x1, short y1, short x2, short y2);
273 void uiButSetFunc3(uiBut *but, void (*func)(void *arg1, void *arg2, void *arg3), void *arg1, void *arg2, void *arg3);
274
275 void uiAutoBlock(struct uiBlock *block, 
276                                  float minx, float miny, 
277                                  float sizex, float sizey, int flag);
278 void uiSetButLink(struct uiBut *but, 
279                                   void **poin, 
280                                   void ***ppoin, 
281                                   short *tot, 
282                                   int from, int to);
283
284 int             uiBlocksGetYMin         (ListBase *lb);
285 int             uiBlockGetCol           (uiBlock *block);
286 void*   uiBlockGetCurFont       (uiBlock *block);
287
288 void    uiBlockSetCol           (uiBlock *block, int col);
289 void    uiBlockSetEmboss        (uiBlock *block, int emboss);
290 void    uiBlockSetDirection     (uiBlock *block, int direction);
291 void    uiBlockFlipOrder        (uiBlock *block);
292 void    uiBlockSetFlag          (uiBlock *block, int flag);
293 void    uiBlockSetXOfs          (uiBlock *block, int xofs);
294
295 int             uiButGetRetVal          (uiBut *but);
296
297 void    uiButSetFlag            (uiBut *but, int flag);
298 void    uiButClearFlag          (uiBut *but, int flag);
299
300 void    uiBlockSetButmFunc      (uiBlock *block,        void (*butmfunc)(void *arg, int but_a2), void *arg);
301
302 void    uiBlockSetFunc          (uiBlock *block,        void (*func)(void *arg1, void *arg2), void *arg1, void *arg2);
303 void    uiButSetFunc            (uiBut *but,            void (*func)(void *arg1, void *arg2), void *arg1, void *arg2);
304
305 void    uiButSetCompleteFunc(uiBut *but,                void (*func)(char *str, void *arg), void *arg);
306
307 void    uiBlockSetDrawExtraFunc(uiBlock *block, void (*func)(struct ScrArea *sa, uiBlock *block));
308
309
310 extern void pupmenu_set_active(int val);
311 extern uiMenuBlockHandle *pupmenu_col(struct bContext *C, char *instr, int mx, int my, int maxrow);
312 extern uiMenuBlockHandle *pupmenu(struct bContext *C, char *instr, int mx, int my);
313 extern void pupmenu_free(struct bContext *C, uiMenuBlockHandle *handle);
314
315 extern void uiFreePanels(struct ListBase *lb);
316 extern void uiNewPanelTabbed(char *, char *);
317 extern int uiNewPanel(struct ScrArea *sa, struct uiBlock *block, char *panelname, char *tabname, int ofsx, int ofsy, int sizex, int sizey);
318         
319 extern void uiSetPanel_view2d(struct ScrArea *sa);
320 extern void uiMatchPanel_view2d(struct ScrArea *sa);
321
322 extern void uiDrawBlocksPanels(struct ScrArea *sa, int re_align);
323 extern void uiNewPanelHeight(struct uiBlock *block, int sizey);
324 extern void uiNewPanelTitle(struct uiBlock *block, char *str);
325 extern void uiPanelPush(struct uiBlock *block);
326 extern void uiPanelPop(struct uiBlock *block);
327 extern uiBlock *uiFindOpenPanelBlockName(ListBase *lb, char *name);
328 extern int uiAlignPanelStep(struct ScrArea *sa, float fac);
329 extern void uiPanelControl(int);
330 extern void uiSetPanelHandler(int);
331
332 extern void uiDrawBoxShadow(unsigned char alpha, float minx, float miny, float maxx, float maxy);
333 extern void *uiSetCurFont_ext(float aspect);
334
335 typedef struct AutoComplete AutoComplete;
336
337 AutoComplete *autocomplete_begin(char *startname, int maxlen);
338 void autocomplete_do_name(AutoComplete *autocpl, const char *name);
339 void autocomplete_end(AutoComplete *autocpl, char *autoname);
340
341 void uiTestRegion(const struct bContext *C); /* XXX 2.50 temporary test */
342
343 void UI_keymap(struct wmWindowManager *wm);
344
345 void UI_init(void);
346 void UI_init_userdef(void);
347 void UI_exit(void);
348
349 #endif /*  UI_INTERFACE_H */
350