Bugfix #27058
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 /** \file WM_api.h
32  *  \ingroup wm
33  *
34  *  \page wmpage windowmanager
35  *  \section wmabout About windowmanager
36  *  \ref wm handles events received from \ref GHOST and manages
37  *  the screens, areas and input for Blender
38  *  \section wmnote NOTE
39  *  \todo document
40  */
41
42 /* dna-savable wmStructs here */
43 #include "DNA_windowmanager_types.h"
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 struct bContext;
50 struct IDProperty;
51 struct wmEvent;
52 struct wmEventHandler;
53 struct wmGesture;
54 struct wmJob;
55 struct wmNotifier;
56 struct wmOperatorType;
57 struct wmOperator;
58 struct rcti;
59 struct PointerRNA;
60 struct EnumPropertyItem;
61 struct MenuType;
62 struct wmDropBox;
63 struct wmDrag;
64 struct ImBuf;
65
66 typedef struct wmJob wmJob;
67
68 /* general API */
69 void            WM_setprefsize          (int stax, int stay, int sizx, int sizy);
70 void            WM_setinitialstate_fullscreen(void);
71 void            WM_setinitialstate_normal(void);
72
73 void            WM_init                         (struct bContext *C, int argc, const char **argv);
74 void            WM_exit                         (struct bContext *C);
75 void            WM_main                         (struct bContext *C);
76
77 int             WM_init_game            (struct bContext *C);
78 void            WM_init_splash          (struct bContext *C);
79
80
81 void            WM_check                        (struct bContext *C);
82
83 struct wmWindow *WM_window_open (struct bContext *C, struct rcti *rect);
84
85                         /* defines for 'type' WM_window_open_temp */
86 #define WM_WINDOW_RENDER                0
87 #define WM_WINDOW_USERPREFS             1
88 #define WM_WINDOW_FILESEL               2
89
90 void            WM_window_open_temp     (struct bContext *C, struct rcti *position, int type);
91
92
93
94                         /* files */
95 int                     WM_read_homefile_exec(struct bContext *C, struct wmOperator *op);
96 int                     WM_read_homefile        (struct bContext *C, struct ReportList *reports, short from_memory);
97 int                     WM_write_homefile       (struct bContext *C, struct wmOperator *op);
98 void            WM_read_file            (struct bContext *C, const char *name, struct ReportList *reports);
99 int                     WM_write_file           (struct bContext *C, const char *target, int fileflags, struct ReportList *reports, int copy);
100 void            WM_read_autosavefile(struct bContext *C);
101 void            WM_autosave_init        (struct wmWindowManager *wm);
102
103                         /* mouse cursors */
104 void            WM_cursor_set           (struct wmWindow *win, int curs);
105 void            WM_cursor_modal         (struct wmWindow *win, int curs);
106 void            WM_cursor_restore       (struct wmWindow *win);
107 void            WM_cursor_wait          (int val);
108 void            WM_cursor_grab(struct wmWindow *win, int wrap, int hide, int *bounds);
109 void            WM_cursor_ungrab(struct wmWindow *win);
110 void            WM_timecursor           (struct wmWindow *win, int nr);
111
112 void            *WM_paint_cursor_activate(struct wmWindowManager *wm, int (*poll)(struct bContext *C), void (*draw)(struct bContext *C, int, int, void *customdata), void *customdata);
113 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
114
115 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
116
117                         /* keyconfig and keymap */
118 wmKeyConfig *WM_keyconfig_new   (struct wmWindowManager *wm, const char *idname);
119 wmKeyConfig *WM_keyconfig_new_user(struct wmWindowManager *wm, const char *idname);
120 void            WM_keyconfig_remove     (struct wmWindowManager *wm, struct wmKeyConfig *keyconf);
121 void            WM_keyconfig_free       (struct wmKeyConfig *keyconf);
122 void            WM_keyconfig_userdef(void);
123
124 void            WM_keymap_init          (struct bContext *C);
125 void            WM_keymap_free          (struct wmKeyMap *keymap);
126
127 wmKeyMapItem *WM_keymap_verify_item(struct wmKeyMap *keymap, const char *idname, int type, 
128                                                                  int val, int modifier, int keymodifier);
129 wmKeyMapItem *WM_keymap_add_item(struct wmKeyMap *keymap, const char *idname, int type, 
130                                                                  int val, int modifier, int keymodifier);
131 wmKeyMapItem *WM_keymap_add_menu(struct wmKeyMap *keymap, const char *idname, int type,
132                                                                  int val, int modifier, int keymodifier);
133
134 void            WM_keymap_remove_item(struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
135 char             *WM_keymap_item_to_string(wmKeyMapItem *kmi, char *str, int len);
136
137 wmKeyMap        *WM_keymap_list_find(ListBase *lb, const char *idname, int spaceid, int regionid);
138 wmKeyMap        *WM_keymap_find(struct wmKeyConfig *keyconf, const char *idname, int spaceid, int regionid);
139 wmKeyMap        *WM_keymap_find_all(const struct bContext *C, const char *idname, int spaceid, int regionid);
140 wmKeyMap        *WM_keymap_active(struct wmWindowManager *wm, struct wmKeyMap *keymap);
141 wmKeyMap        *WM_keymap_guess_opname(const struct bContext *C, const char *opname);
142 int                      WM_keymap_user_init(struct wmWindowManager *wm, struct wmKeyMap *keymap);
143 wmKeyMap        *WM_keymap_copy_to_user(struct wmKeyMap *keymap);
144 void            WM_keymap_restore_to_default(struct wmKeyMap *keymap);
145 void            WM_keymap_properties_reset(struct wmKeyMapItem *kmi, struct IDProperty *properties);
146 void            WM_keymap_restore_item_to_default(struct bContext *C, struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
147
148 wmKeyMapItem *WM_keymap_item_find_id(struct wmKeyMap *keymap, int id);
149 int                     WM_keymap_item_compare(struct wmKeyMapItem *k1, struct wmKeyMapItem *k2);
150 int                     WM_userdef_event_map(int kmitype);
151
152 wmKeyMap        *WM_modalkeymap_add(struct wmKeyConfig *keyconf, const char *idname, struct EnumPropertyItem *items);
153 wmKeyMap        *WM_modalkeymap_get(struct wmKeyConfig *keyconf, const char *idname);
154 wmKeyMapItem *WM_modalkeymap_add_item(struct wmKeyMap *km, int type, int val, int modifier, int keymodifier, int value);
155 void            WM_modalkeymap_assign(struct wmKeyMap *km, const char *opname);
156
157 const char      *WM_key_event_string(short type);
158 int                     WM_key_event_operator_id(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, int hotkey, struct wmKeyMap **keymap_r);
159 char            *WM_key_event_operator_string(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, char *str, int len);
160
161                         /* handlers */
162
163 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
164                                                 /* boundbox, optional subwindow boundbox for offset */
165 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, rcti *bb, rcti *swinbb);
166                                                 /* priority not implemented, it adds in begin */
167 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
168
169 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
170
171 struct wmEventHandler *WM_event_add_ui_handler(const struct bContext *C, ListBase *handlers,
172                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
173                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
174 void            WM_event_remove_ui_handler(ListBase *handlers,
175                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
176                         void (*remove)(struct bContext *C, void *userdata), void *userdata, int postpone);
177 void            WM_event_remove_area_handler(struct ListBase *handlers, void *area);
178
179 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
180 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
181
182 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
183
184                         /* mouse */
185 void            WM_event_add_mousemove(struct bContext *C);
186 int                     WM_modal_tweak_exit(struct wmEvent *evt, int tweak_event);
187
188                         /* notifiers */
189 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
190 void            WM_main_add_notifier(unsigned int type, void *reference);
191
192 void            wm_event_add            (struct wmWindow *win, struct wmEvent *event_to_add); /* XXX only for warning */
193
194                         /* at maximum, every timestep seconds it triggers event_type events */
195 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
196 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
197 void            WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, int dosleep);
198
199                 /* operator api, default callbacks */
200                         /* invoke callback, uses enum property named "type" */
201 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
202 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
203                         /* invoke callback, confirm menu + exec */
204 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
205                 /* invoke callback, file selector "filepath" unset + exec */
206 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
207                         /* poll callback, context checks */
208 int                     WM_operator_winactive   (struct bContext *C);
209                         /* invoke callback, exec + redo popup */
210 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
211 int             WM_operator_props_dialog_popup (struct bContext *C, struct wmOperator *op, int width, int height);
212 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
213 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
214
215 int                     WM_operator_confirm_message(struct bContext *C, struct wmOperator *op, const char *message);
216
217                 /* operator api */
218 void            WM_operator_free                (struct wmOperator *op);
219 void            WM_operator_stack_clear(struct bContext *C);
220
221 struct wmOperatorType *WM_operatortype_find(const char *idnamem, int quiet);
222 struct wmOperatorType *WM_operatortype_first(void);
223 void            WM_operatortype_append  (void (*opfunc)(struct wmOperatorType*));
224 void            WM_operatortype_append_ptr      (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
225 void            WM_operatortype_append_macro_ptr        (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
226 int                     WM_operatortype_remove(const char *idname);
227
228 struct wmOperatorType *WM_operatortype_append_macro(const char *idname, const char *name, int flag);
229 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
230
231
232 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
233 int                     WM_operator_poll_context(struct bContext *C, struct wmOperatorType *ot, int context);
234 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
235 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
236 int                     WM_operator_repeat_check(const struct bContext *C, struct wmOperator *op);
237 int                     WM_operator_name_call   (struct bContext *C, const char *opstring, int context, struct PointerRNA *properties);
238 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, int context, struct PointerRNA *properties, struct ReportList *reports);
239
240 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
241 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, const short no_context); /* make props context sensitive or not */
242 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
243 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
244 void            WM_operator_properties_free(struct PointerRNA *ptr);
245 void            WM_operator_properties_filesel(struct wmOperatorType *ot, int filter, short type, short action, short flag);
246 void            WM_operator_properties_gesture_border(struct wmOperatorType *ot, int extend);
247 void            WM_operator_properties_gesture_straightline(struct wmOperatorType *ot, int cursor);
248 void            WM_operator_properties_select_all(struct wmOperatorType *ot);
249
250 /* MOVE THIS SOMEWHERE ELSE */
251 #define SEL_TOGGLE              0
252 #define SEL_SELECT              1
253 #define SEL_DESELECT    2
254 #define SEL_INVERT              3
255
256
257 /* flags for WM_operator_properties_filesel */
258 #define WM_FILESEL_RELPATH              (1 << 0)
259
260 #define WM_FILESEL_DIRECTORY    (1 << 1)
261 #define WM_FILESEL_FILENAME             (1 << 2)
262 #define WM_FILESEL_FILEPATH             (1 << 3)
263
264
265                 /* operator as a python command (resultuing string must be free'd) */
266 char            *WM_operator_pystring(struct bContext *C, struct wmOperatorType *ot, struct PointerRNA *opptr, int all_args);
267 void            WM_operator_bl_idname(char *to, const char *from);
268 void            WM_operator_py_idname(char *to, const char *from);
269
270 /* *************** menu types ******************** */
271 struct MenuType         *WM_menutype_find(const char *idname, int quiet);
272 int                                     WM_menutype_add(struct MenuType* mt);
273 void                            WM_menutype_freelink(struct MenuType* mt);
274 void                            WM_menutype_free(void);
275
276                         /* default operator callbacks for border/circle/lasso */
277 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
278 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
279 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
280 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
281 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
282 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
283 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
284 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
285 int                     WM_gesture_straightline_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
286 int                     WM_gesture_straightline_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
287
288                         /* default operator for arearegions, generates event */
289 void            WM_OT_tweak_gesture(struct wmOperatorType *ot);
290
291                         /* Gesture manager API */
292 struct wmGesture *WM_gesture_new(struct bContext *C, struct wmEvent *event, int type);
293 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
294 void            WM_gestures_remove(struct bContext *C);
295
296                         /* radial control operator */
297 int                     WM_radial_control_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
298 int                     WM_radial_control_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
299 void            WM_OT_radial_control_partial(struct wmOperatorType *ot);
300 void            WM_radial_control_string(struct wmOperator *op, char str[], int maxlen);
301
302                         /* fileselecting support */
303 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
304 void            WM_event_fileselect_event(struct bContext *C, void *ophandle, int eventval);
305
306                         /* drag and drop */
307 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value);
308 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
309
310 struct wmDropBox        *WM_dropbox_add(ListBase *lb, const char *idname, int (*poll)(struct bContext *, struct wmDrag *, struct wmEvent *event),
311                                                   void (*copy)(struct wmDrag *, struct wmDropBox *));
312 ListBase        *WM_dropboxmap_find(const char *idname, int spaceid, int regionid);
313
314                         /* Set a subwindow active in pixelspace view, with optional scissor subset */
315 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
316 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, struct rcti *srct);
317
318                         /* OpenGL utilities with safety check + working in modelview matrix mode */
319 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
320 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
321 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
322
323                         /* utilities */
324 void            WM_set_framebuffer_index_color(int index);
325 int                     WM_framebuffer_to_index(unsigned int col);
326
327                         /* threaded Jobs Manager */
328 #define WM_JOB_PRIORITY         1
329 #define WM_JOB_EXCL_RENDER      2
330 #define WM_JOB_PROGRESS         4
331 #define WM_JOB_SUSPEND          8
332
333 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, const char *name, int flag);
334
335 int                     WM_jobs_test(struct wmWindowManager *wm, void *owner);
336 float           WM_jobs_progress(struct wmWindowManager *wm, void *owner);
337 char            *WM_jobs_name(struct wmWindowManager *wm, void *owner);
338
339 void            WM_jobs_customdata(struct wmJob *, void *customdata, void (*free)(void *));
340 void            WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
341 void            WM_jobs_callbacks(struct wmJob *, 
342                                                           void (*startjob)(void *, short *, short *, float *),
343                                                           void (*initjob)(void *),
344                                                           void (*update)(void *),
345                                                           void (*endjob)(void *));
346
347 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
348 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner, void *startjob);
349 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner, void (*)(void *, short int *, short int *, float *));
350 void            WM_jobs_stop_all(struct wmWindowManager *wm);
351
352                         /* clipboard */
353 char            *WM_clipboard_text_get(int selection);
354 void            WM_clipboard_text_set(char *buf, int selection);
355
356                         /* progress */
357 void            WM_progress_set(struct wmWindow *win, float progress);
358 void            WM_progress_clear(struct wmWindow *win);
359
360 #ifdef WIN32
361                         /* Windows System Console */
362 void            WM_console_toggle(struct bContext *C, short show);
363 #endif
364
365 /* debugging only, convenience function to write on crash */
366 int write_crash_blend(void);
367
368 #ifdef __cplusplus
369 }
370 #endif
371
372 #endif /* WM_API_H */
373