Splash screen, implemented by Matt.
[blender.git] / source / blender / windowmanager / WM_api.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) 2007 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28 #ifndef WM_API_H
29 #define WM_API_H
30
31 /* dna-savable wmStructs here */
32 #include "DNA_windowmanager_types.h"
33
34 struct bContext;
35 struct IDProperty;
36 struct wmEvent;
37 struct wmEventHandler;
38 struct wmGesture;
39 struct wmJob;
40 struct wmNotifier;
41 struct rcti;
42 struct PointerRNA;
43 struct EnumPropertyItem;
44 struct MenuType;
45
46 typedef struct wmJob wmJob;
47
48 /* general API */
49 void            WM_setprefsize          (int stax, int stay, int sizx, int sizy);
50
51 void            WM_init                         (struct bContext *C);
52 void            WM_exit                         (struct bContext *C);
53 void            WM_main                         (struct bContext *C);
54
55 void            WM_init_splash          (struct bContext *C);
56
57
58 void            WM_check                        (struct bContext *C);
59
60 struct wmWindow *WM_window_open (struct bContext *C, struct rcti *rect);
61
62                         /* defines for 'type' WM_window_open_temp */
63 #define WM_WINDOW_RENDER                0
64 #define WM_WINDOW_USERPREFS             1
65 #define WM_WINDOW_FILESEL               2
66
67 void            WM_window_open_temp     (struct bContext *C, struct rcti *position, int type);
68
69
70
71                         /* files */
72 int                     WM_read_homefile        (struct bContext *C, struct wmOperator *op);
73 int                     WM_write_homefile       (struct bContext *C, struct wmOperator *op);
74 void            WM_read_file            (struct bContext *C, char *name, struct ReportList *reports);
75 void            WM_write_file           (struct bContext *C, char *target, int fileflags, struct ReportList *reports);
76 void            WM_read_autosavefile(struct bContext *C);
77 void            WM_autosave_init        (struct bContext *C);
78
79                         /* mouse cursors */
80 void            WM_cursor_set           (struct wmWindow *win, int curs);
81 void            WM_cursor_modal         (struct wmWindow *win, int curs);
82 void            WM_cursor_restore       (struct wmWindow *win);
83 void            WM_cursor_wait          (int val);
84 void            WM_cursor_grab(struct wmWindow *win, int wrap, int hide, int *bounds);
85 void            WM_cursor_ungrab(struct wmWindow *win);
86 void            WM_timecursor           (struct wmWindow *win, int nr);
87
88 void            *WM_paint_cursor_activate(struct wmWindowManager *wm, int (*poll)(struct bContext *C), void (*draw)(struct bContext *C, int, int, void *customdata), void *customdata);
89 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
90
91 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
92
93                         /* keyconfig and keymap */
94 wmKeyConfig *WM_keyconfig_add   (struct wmWindowManager *wm, char *idname);
95 void            WM_keyconfig_free       (struct wmKeyConfig *keyconf);
96 void            WM_keyconfig_userdef(struct wmWindowManager *wm);
97
98 void            WM_keymap_init          (struct bContext *C);
99 void            WM_keymap_free          (struct wmKeyMap *keymap);
100
101 wmKeyMapItem *WM_keymap_verify_item(struct wmKeyMap *keymap, char *idname, int type, 
102                                                                  int val, int modifier, int keymodifier);
103 wmKeyMapItem *WM_keymap_add_item(struct wmKeyMap *keymap, char *idname, int type, 
104                                                                  int val, int modifier, int keymodifier);
105 wmKeyMapItem *WM_keymap_add_menu(struct wmKeyMap *keymap, char *idname, int type,
106                                                                  int val, int modifier, int keymodifier);
107 void         WM_keymap_remove_item(struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
108 char             *WM_keymap_item_to_string(wmKeyMapItem *kmi, char *str, int len);
109
110 wmKeyMap        *WM_keymap_find(struct wmKeyConfig *keyconf, char *idname, int spaceid, int regionid);
111 wmKeyMap        *WM_keymap_active(struct wmWindowManager *wm, struct wmKeyMap *keymap);
112 int                      WM_keymap_user_init(struct wmWindowManager *wm, struct wmKeyMap *keymap);
113 wmKeyMap        *WM_keymap_copy_to_user(struct wmKeyMap *keymap);
114 void            WM_keymap_restore_to_default(struct wmKeyMap *keymap);
115
116 wmKeyMap        *WM_modalkeymap_add(struct wmKeyConfig *keyconf, char *idname, struct EnumPropertyItem *items);
117 wmKeyMap        *WM_modalkeymap_get(struct wmKeyConfig *keyconf, char *idname);
118 wmKeyMapItem *WM_modalkeymap_add_item(struct wmKeyMap *km, int type, int val, int modifier, int keymodifier, int value);
119 void            WM_modalkeymap_assign(struct wmKeyMap *km, char *opname);
120
121 const char      *WM_key_event_string(short type);
122 char            *WM_key_event_operator_string(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, char *str, int len);
123 void            WM_key_event_operator_change(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, short key, short modifier);
124
125                         /* handlers */
126
127 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
128                                                 /* boundbox, optional subwindow boundbox for offset */
129 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, rcti *bb, rcti *swinbb);
130                                                 /* priority not implemented, it adds in begin */
131 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
132
133 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
134
135 struct wmEventHandler *WM_event_add_ui_handler(const struct bContext *C, ListBase *handlers,
136                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
137                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
138 void            WM_event_remove_ui_handler(ListBase *handlers,
139                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
140                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
141
142 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
143 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
144
145 void            WM_event_add_mousemove(struct bContext *C);
146 int                     WM_modal_tweak_exit(struct wmEvent *evt, int tweak_event);
147
148 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
149 void            WM_main_add_notifier(unsigned int type, void *reference);
150
151 void            wm_event_add            (struct wmWindow *win, struct wmEvent *event_to_add); /* XXX only for warning */
152
153                         /* at maximum, every timestep seconds it triggers event_type events */
154 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
155 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
156 void            WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, int dosleep);
157
158                 /* operator api, default callbacks */
159                         /* invoke callback, uses enum property named "type" */
160 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
161                         /* invoke callback, confirm menu + exec */
162 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
163                 /* invoke callback, file selector "path" unset + exec */
164 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
165                         /* poll callback, context checks */
166 int                     WM_operator_winactive   (struct bContext *C);
167                         /* invoke callback, exec + redo popup */
168 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
169 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
170
171 int                     WM_operator_confirm_message(struct bContext *C, struct wmOperator *op, char *message);
172
173                 /* operator api */
174 void            WM_operator_free                (struct wmOperator *op);
175 void            WM_operator_stack_clear(struct bContext *C);
176
177 wmOperatorType *WM_operatortype_find(const char *idnamem, int quiet);
178 wmOperatorType *WM_operatortype_exists(const char *idname);
179 wmOperatorType *WM_operatortype_first(void);
180 void            WM_operatortype_append  (void (*opfunc)(wmOperatorType*));
181 void            WM_operatortype_append_ptr      (void (*opfunc)(wmOperatorType*, void *), void *userdata);
182 int                     WM_operatortype_remove(const char *idname);
183
184 wmOperatorType *WM_operatortype_append_macro(char *idname, char *name, int flag);
185 wmOperatorTypeMacro *WM_operatortype_macro_define(wmOperatorType *ot, const char *idname);
186
187
188 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
189 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
190 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
191 int         WM_operator_name_call       (struct bContext *C, const char *opstring, int context, struct PointerRNA *properties);
192 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, int context, struct PointerRNA *properties, struct ReportList *reports);
193
194 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
195 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
196 void            WM_operator_properties_free(struct PointerRNA *ptr);
197 void            WM_operator_properties_filesel(struct wmOperatorType *ot, int filter, short type);
198 void            WM_operator_properties_gesture_border(wmOperatorType *ot, int extend);
199
200                 /* operator as a python command (resultuing string must be free'd) */
201 char            *WM_operator_pystring(struct bContext *C, struct wmOperatorType *ot, struct PointerRNA *opptr, int all_args);
202 void            WM_operator_bl_idname(char *to, const char *from);
203 void            WM_operator_py_idname(char *to, const char *from);
204
205 /* *************** menu types ******************** */
206 struct MenuType         *WM_menutype_find(const char *idname, int quiet);
207 int                                     WM_menutype_add(struct MenuType* mt);
208 void                            WM_menutype_freelink(struct MenuType* mt);
209 void                            WM_menutype_free(void);
210
211                         /* default operator callbacks for border/circle/lasso */
212 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
213 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
214 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
215 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
216 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
217 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
218 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
219 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
220
221                         /* default operator for arearegions, generates event */
222 void            WM_OT_tweak_gesture(struct wmOperatorType *ot);
223
224                         /* Gesture manager API */
225 struct wmGesture *WM_gesture_new(struct bContext *C, struct wmEvent *event, int type);
226 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
227
228                         /* radial control operator */
229 int                     WM_radial_control_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
230 int                     WM_radial_control_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
231 void            WM_OT_radial_control_partial(struct wmOperatorType *ot);
232 void            WM_radial_control_string(struct wmOperator *op, char str[], int maxlen);
233
234                         /* fileselecting support */
235 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
236 void            WM_event_fileselect_event(struct bContext *C, void *ophandle, int eventval);
237
238                         /* OpenGL wrappers, mimicking opengl syntax */
239 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
240 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, struct rcti *srct);
241
242 void            wmLoadMatrix            (float mat[][4]);
243 void            wmGetMatrix                     (float mat[][4]);
244 void            wmMultMatrix            (float mat[][4]);
245 void            wmGetSingleMatrix       (float mat[][4]);
246 void            wmScale                         (float x, float y, float z);
247 void            wmLoadIdentity          (void);         /* note: old name clear_view_mat */
248 void            wmPushMatrix            (void);         /* one level only */
249 void            wmPopMatrix                     (void);         /* one level only */
250
251 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
252 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
253 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
254
255                         /* utilities */
256 void            WM_set_framebuffer_index_color(int index);
257 int                     WM_framebuffer_to_index(unsigned int col);
258
259                         /* threaded Jobs Manager */
260 #define WM_JOB_PRIORITY         1
261 #define WM_JOB_EXCL_RENDER      2
262
263 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, int flag);
264
265 int                     WM_jobs_test(struct wmWindowManager *wm, void *owner);
266
267 void            WM_jobs_customdata(struct wmJob *, void *customdata, void (*free)(void *));
268 void            WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
269 void            WM_jobs_callbacks(struct wmJob *, 
270                                                           void (*startjob)(void *, short *, short *),
271                                                           void (*initjob)(void *),
272                                                           void (*update)(void *));
273
274 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
275 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner);
276 void            WM_jobs_stop_all(struct wmWindowManager *wm);
277
278                         /* clipboard */
279 char            *WM_clipboard_text_get(int selection);
280 void            WM_clipboard_text_set(char *buf, int selection);
281
282 #endif /* WM_API_H */
283