Fix T43427: Particle system children sometimes not generated on reload
[blender.git] / source / blender / windowmanager / WM_api.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2007 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26 #ifndef __WM_API_H__
27 #define __WM_API_H__
28
29 /** \file WM_api.h
30  *  \ingroup wm
31  *
32  *  \page wmpage windowmanager
33  *  \section wmabout About windowmanager
34  *  \ref wm handles events received from \ref GHOST and manages
35  *  the screens, areas and input for Blender
36  *  \section wmnote NOTE
37  *  \todo document
38  */
39
40 /* dna-savable wmStructs here */
41 #include "DNA_windowmanager_types.h"
42 #include "WM_keymap.h"
43 #include "BLI_compiler_attrs.h"
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 struct bContext;
50 struct GHashIterator;
51 struct IDProperty;
52 struct wmEvent;
53 struct wmEventHandler;
54 struct wmGesture;
55 struct wmJob;
56 struct wmNotifier;
57 struct wmOperatorType;
58 struct wmOperator;
59 struct rcti;
60 struct PointerRNA;
61 struct PropertyRNA;
62 struct EnumPropertyItem;
63 struct MenuType;
64 struct wmDropBox;
65 struct wmDrag;
66 struct ImBuf;
67 struct ImageFormatData;
68 struct ARegion;
69 struct wmNDOFMotionData;
70
71 typedef struct wmJob wmJob;
72
73 /* general API */
74 void            WM_init_state_size_set          (int stax, int stay, int sizx, int sizy);
75 void            WM_init_state_fullscreen_set(void);
76 void            WM_init_state_normal_set(void);
77 void            WM_init_native_pixels(bool do_it);
78
79 void            WM_init                         (struct bContext *C, int argc, const char **argv);
80 void            WM_exit_ext                     (struct bContext *C, const bool do_python);
81
82 void            WM_exit                         (struct bContext *C) ATTR_NORETURN;
83
84 void            WM_main                         (struct bContext *C) ATTR_NORETURN;
85
86 bool            WM_init_game            (struct bContext *C);
87 void            WM_init_splash          (struct bContext *C);
88
89
90 void            WM_check                        (struct bContext *C);
91
92 struct wmWindow *WM_window_open (struct bContext *C, const struct rcti *rect);
93
94 int                     WM_window_pixels_x              (struct wmWindow *win);
95 int                     WM_window_pixels_y              (struct wmWindow *win);
96 bool            WM_window_is_fullscreen (struct wmWindow *win);
97
98 /* defines for 'type' WM_window_open_temp */
99 #define WM_WINDOW_RENDER                0
100 #define WM_WINDOW_USERPREFS             1
101 // #define WM_WINDOW_FILESEL            2  // UNUSED
102
103 void            WM_window_open_temp     (struct bContext *C, struct rcti *position, int type);
104                         
105                         /* returns true if draw method is triple buffer */
106 bool            WM_is_draw_triple(struct wmWindow *win);
107
108
109
110                         /* files */
111 void            WM_file_autoexec_init(const char *filepath);
112 bool            WM_file_read(struct bContext *C, const char *filepath, struct ReportList *reports);
113 void            WM_autosave_init(struct wmWindowManager *wm);
114 void            WM_recover_last_session(struct bContext *C, struct ReportList *reports);
115
116                         /* mouse cursors */
117 void            WM_cursor_set(struct wmWindow *win, int curs);
118 void            WM_cursor_modal_set(struct wmWindow *win, int curs);
119 void            WM_cursor_modal_restore(struct wmWindow *win);
120 void            WM_cursor_wait          (bool val);
121 void            WM_cursor_grab_enable(struct wmWindow *win, bool wrap, bool hide, int bounds[4]);
122 void            WM_cursor_grab_disable(struct wmWindow *win, const int mouse_ungrab_xy[2]);
123 void            WM_cursor_time          (struct wmWindow *win, int nr);
124
125 void            *WM_paint_cursor_activate(struct wmWindowManager *wm,
126                                       int (*poll)(struct bContext *C),
127                                       void (*draw)(struct bContext *C, int, int, void *customdata),
128                                       void *customdata);
129
130 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
131 void            WM_paint_cursor_tag_redraw(struct wmWindow *win, struct ARegion *ar);
132
133 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
134 float           WM_cursor_pressure      (const struct wmWindow *win);
135
136                         /* event map */
137 int                     WM_userdef_event_map(int kmitype);
138
139                         /* handlers */
140
141 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
142                                                 /* boundbox, optional subwindow boundbox for offset */
143 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, const rcti *bb, const rcti *swinbb);
144                                                 /* priority not implemented, it adds in begin */
145 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
146
147 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
148
149 typedef int (*wmUIHandlerFunc)(struct bContext *C, const struct wmEvent *event, void *userdata);
150 typedef void (*wmUIHandlerRemoveFunc)(struct bContext *C, void *userdata);
151
152 struct wmEventHandler *WM_event_add_ui_handler(
153         const struct bContext *C, ListBase *handlers,
154         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove,
155         void *userdata,  const bool accept_dbl_click);
156 void WM_event_remove_ui_handler(
157         ListBase *handlers,
158         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove,
159         void *userdata, const bool postpone);
160 void WM_event_remove_area_handler(
161         struct ListBase *handlers, void *area);
162 void WM_event_free_ui_handler_all(
163         struct bContext *C, ListBase *handlers,
164         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove);
165
166 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
167 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
168
169 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
170
171                         /* mouse */
172 void            WM_event_add_mousemove(struct bContext *C);
173 bool        WM_modal_tweak_exit(const struct wmEvent *event, int tweak_event);
174
175                         /* notifiers */
176 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
177 void            WM_main_add_notifier(unsigned int type, void *reference);
178 void            WM_main_remove_notifier_reference(const void *reference);
179
180                         /* reports */
181 void        WM_report(const struct bContext *C, ReportType type, const char *message);
182 void        WM_reportf(const struct bContext *C, ReportType type, const char *format, ...) ATTR_PRINTF_FORMAT(3, 4);
183
184 void            wm_event_add(struct wmWindow *win, const struct wmEvent *event_to_add);
185 void            wm_event_init_from_window(struct wmWindow *win, struct wmEvent *event);
186
187
188                         /* at maximum, every timestep seconds it triggers event_type events */
189 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
190 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
191 void        WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, bool do_sleep);
192
193                 /* operator api, default callbacks */
194                         /* invoke callback, uses enum property named "type" */
195 void            WM_operator_view3d_unit_defaults(struct bContext *C, struct wmOperator *op);
196 int                     WM_operator_smooth_viewtx_get(const struct wmOperator *op);
197 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
198 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
199                         /* invoke callback, confirm menu + exec */
200 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
201                 /* invoke callback, file selector "filepath" unset + exec */
202 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
203 bool        WM_operator_filesel_ensure_ext_imtype(wmOperator *op, const struct ImageFormatData *im_format);
204                         /* poll callback, context checks */
205 int                     WM_operator_winactive   (struct bContext *C);
206                         /* invoke callback, exec + redo popup */
207 int                     WM_operator_props_popup_confirm(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
208 int                     WM_operator_props_popup_call(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
209 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
210 int             WM_operator_props_dialog_popup(struct bContext *C, struct wmOperator *op, int width, int height);
211 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
212 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
213
214 int         WM_operator_confirm_message_ex(struct bContext *C, struct wmOperator *op,
215                                            const char *title, const int icon,
216                                            const char *message);
217 int         WM_operator_confirm_message(struct bContext *C, struct wmOperator *op,
218                                         const char *message);
219
220                 /* operator api */
221 void            WM_operator_free                (struct wmOperator *op);
222 void            WM_operator_type_set(struct wmOperator *op, struct wmOperatorType *ot);
223 void            WM_operator_stack_clear(struct wmWindowManager *wm);
224 void            WM_operator_handlers_clear(wmWindowManager *wm, struct wmOperatorType *ot);
225
226 struct wmOperatorType *WM_operatortype_find(const char *idname, bool quiet);
227 void        WM_operatortype_iter(struct GHashIterator *ghi);
228 void            WM_operatortype_append(void (*opfunc)(struct wmOperatorType *));
229 void            WM_operatortype_append_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
230 void            WM_operatortype_append_macro_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
231 void        WM_operatortype_remove_ptr(struct wmOperatorType *ot);
232 bool        WM_operatortype_remove(const char *idname);
233 void        WM_operatortype_last_properties_clear_all(void);
234
235 struct wmOperatorType *WM_operatortype_append_macro(const char *idname, const char *name, const char *description, int flag);
236 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
237
238
239 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
240 int                     WM_operator_poll_context(struct bContext *C, struct wmOperatorType *ot, short context);
241 int         WM_operator_call_ex(struct bContext *C, struct wmOperator *op, const bool store);
242 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
243 int                     WM_operator_call_notest(struct bContext *C, struct wmOperator *op);
244 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
245 bool        WM_operator_repeat_check(const struct bContext *C, struct wmOperator *op);
246 int         WM_operator_name_call_ptr(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties);
247 int                     WM_operator_name_call(struct bContext *C, const char *opstring, short context, struct PointerRNA *properties);
248 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties, struct ReportList *reports, const bool is_undo);
249
250 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
251 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, const bool no_context); /* make props context sensitive or not */
252 bool        WM_operator_properties_default(struct PointerRNA *ptr, const bool do_update);
253 void        WM_operator_properties_reset(struct wmOperator *op);
254 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
255 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
256 void        WM_operator_properties_clear(struct PointerRNA *ptr);
257 void            WM_operator_properties_free(struct PointerRNA *ptr);
258 void            WM_operator_properties_filesel(struct wmOperatorType *ot, int filter, short type, short action, short flag, short display);
259 void        WM_operator_properties_border(struct wmOperatorType *ot);
260 void        WM_operator_properties_border_to_rcti(struct wmOperator *op, struct rcti *rect);
261 void        WM_operator_properties_border_to_rctf(struct wmOperator *op, rctf *rect);
262 void            WM_operator_properties_gesture_border(struct wmOperatorType *ot, bool extend);
263 void        WM_operator_properties_mouse_select(struct wmOperatorType *ot);
264 void            WM_operator_properties_gesture_straightline(struct wmOperatorType *ot, int cursor);
265 void            WM_operator_properties_select_all(struct wmOperatorType *ot);
266 void            WM_operator_properties_select_action(struct wmOperatorType *ot, int default_action);
267 void            WM_operator_properties_select_action_simple(struct wmOperatorType *ot, int default_action);
268
269 bool        WM_operator_check_ui_enabled(const struct bContext *C, const char *idname);
270 wmOperator *WM_operator_last_redo(const struct bContext *C);
271 ID         *WM_operator_drop_load_path(struct bContext *C, struct wmOperator *op, const short idcode);
272
273 bool        WM_operator_last_properties_init(struct wmOperator *op);
274 bool        WM_operator_last_properties_store(struct wmOperator *op);
275
276 /* MOVE THIS SOMEWHERE ELSE */
277 #define SEL_TOGGLE              0
278 #define SEL_SELECT              1
279 #define SEL_DESELECT    2
280 #define SEL_INVERT              3
281
282
283 /* flags for WM_operator_properties_filesel */
284 #define WM_FILESEL_RELPATH              (1 << 0)
285
286 #define WM_FILESEL_DIRECTORY    (1 << 1)
287 #define WM_FILESEL_FILENAME             (1 << 2)
288 #define WM_FILESEL_FILEPATH             (1 << 3)
289 #define WM_FILESEL_FILES                (1 << 4)
290
291
292                 /* operator as a python command (resultuing string must be freed) */
293 char            *WM_operator_pystring_ex(struct bContext *C, struct wmOperator *op,
294                                      const bool all_args, const bool macro_args,
295                                      struct wmOperatorType *ot, struct PointerRNA *opptr);
296 char            *WM_operator_pystring(struct bContext *C, struct wmOperator *op,
297                                   const bool all_args, const bool macro_args);
298 bool         WM_operator_pystring_abbreviate(char *str, int str_len_max);
299 char            *WM_prop_pystring_assign(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
300 void            WM_operator_bl_idname(char *to, const char *from);
301 void            WM_operator_py_idname(char *to, const char *from);
302
303 /* *************** uilist types ******************** */
304 void                WM_uilisttype_init(void);
305 struct uiListType  *WM_uilisttype_find(const char *idname, bool quiet);
306 bool                WM_uilisttype_add(struct uiListType *ult);
307 void                WM_uilisttype_freelink(struct uiListType *ult);
308 void                WM_uilisttype_free(void);
309
310 /* *************** menu types ******************** */
311 void                WM_menutype_init(void);
312 struct MenuType    *WM_menutype_find(const char *idname, bool quiet);
313 bool                WM_menutype_add(struct MenuType *mt);
314 void                WM_menutype_freelink(struct MenuType *mt);
315 void                WM_menutype_free(void);
316
317                         /* default operator callbacks for border/circle/lasso */
318 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
319 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
320 void            WM_border_select_cancel(struct bContext *C, struct wmOperator *op);
321 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
322 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
323 void            WM_gesture_circle_cancel(struct bContext *C, struct wmOperator *op);
324 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
325 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
326 void            WM_gesture_lines_cancel(struct bContext *C, struct wmOperator *op);
327 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
328 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
329 void            WM_gesture_lasso_cancel(struct bContext *C, struct wmOperator *op);
330 const int (*WM_gesture_lasso_path_to_array(struct bContext *C, struct wmOperator *op, int *mcords_tot))[2];
331 int                     WM_gesture_straightline_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
332 int                     WM_gesture_straightline_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
333 void            WM_gesture_straightline_cancel(struct bContext *C, struct wmOperator *op);
334
335                         /* Gesture manager API */
336 struct wmGesture *WM_gesture_new(struct bContext *C, const struct wmEvent *event, int type);
337 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
338 void            WM_gestures_remove(struct bContext *C);
339
340                         /* fileselecting support */
341 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
342 void            WM_event_fileselect_event(struct wmWindowManager *wm, void *ophandle, int eventval);
343 #ifndef NDEBUG
344 void            WM_event_print(const struct wmEvent *event);
345 #endif
346
347 void            WM_operator_region_active_win_set(struct bContext *C);
348
349                         /* drag and drop */
350 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value, unsigned int flags);
351 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
352 void                WM_drag_free(struct wmDrag *drag);
353 void                WM_drag_free_list(struct ListBase *lb);
354
355 struct wmDropBox        *WM_dropbox_add(ListBase *lb, const char *idname, int (*poll)(struct bContext *, struct wmDrag *, const struct wmEvent *event),
356                                     void (*copy)(struct wmDrag *, struct wmDropBox *));
357 ListBase        *WM_dropboxmap_find(const char *idname, int spaceid, int regionid);
358
359                         /* Set a subwindow active in pixelspace view, with optional scissor subset */
360 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
361 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, const struct rcti *srct, bool srct_pad);
362
363                         /* OpenGL utilities with safety check + working in modelview matrix mode */
364 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
365 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
366 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
367                         /* use for conventions (avoid hard-coded offsets all over) */
368 void            wmOrtho2_region_pixelspace(const struct ARegion *ar);
369 void            wmOrtho2_region_ui(const struct ARegion *ar);
370 void            wmOrtho2_pixelspace(const float x, const float y);
371
372                         /* utilities */
373 void            WM_framebuffer_index_set(int index);
374 int                     WM_framebuffer_to_index(unsigned int col);
375
376                         /* threaded Jobs Manager */
377 enum {
378         WM_JOB_PRIORITY     = (1 << 0),
379         WM_JOB_EXCL_RENDER  = (1 << 1),
380         WM_JOB_PROGRESS     = (1 << 2),
381         WM_JOB_SUSPEND      = (1 << 3)
382 };
383
384 /* identifying jobs by owner alone is unreliable, this isnt saved, order can change (keep 0 for 'any') */
385 enum {
386         WM_JOB_TYPE_ANY = 0,
387         WM_JOB_TYPE_COMPOSITE,
388         WM_JOB_TYPE_RENDER,
389         WM_JOB_TYPE_RENDER_PREVIEW,  /* UI preview */
390         WM_JOB_TYPE_SCREENCAST,
391         WM_JOB_TYPE_OBJECT_SIM_OCEAN,
392         WM_JOB_TYPE_OBJECT_SIM_FLUID,
393         WM_JOB_TYPE_OBJECT_BAKE_TEXTURE,
394         WM_JOB_TYPE_OBJECT_BAKE,
395         WM_JOB_TYPE_FILESEL_THUMBNAIL,
396         WM_JOB_TYPE_CLIP_BUILD_PROXY,
397         WM_JOB_TYPE_CLIP_TRACK_MARKERS,
398         WM_JOB_TYPE_CLIP_SOLVE_CAMERA,
399         WM_JOB_TYPE_CLIP_PREFETCH,
400         WM_JOB_TYPE_SEQ_BUILD_PROXY,
401         WM_JOB_TYPE_SEQ_BUILD_PREVIEW,
402         /* add as needed, screencast, seq proxy build
403          * if having hard coded values is a problem */
404 };
405
406 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, const char *name, int flag, int job_type);
407
408 bool        WM_jobs_test(struct wmWindowManager *wm, void *owner, int job_type);
409 float           WM_jobs_progress(struct wmWindowManager *wm, void *owner);
410 char       *WM_jobs_name(struct wmWindowManager *wm, void *owner);
411 void       *WM_jobs_customdata(struct wmWindowManager *wm, void *owner);
412 void       *WM_jobs_customdata_from_type(struct wmWindowManager *wm, int job_type);
413
414 bool        WM_jobs_is_running(struct wmJob *);
415 void       *WM_jobs_customdata_get(struct wmJob *);
416 void        WM_jobs_customdata_set(struct wmJob *, void *customdata, void (*free)(void *));
417 void        WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
418 void        WM_jobs_callbacks(struct wmJob *,
419                               void (*startjob)(void *, short *, short *, float *),
420                               void (*initjob)(void *),
421                               void (*update)(void *),
422                               void (*endjob)(void *));
423
424 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
425 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner, void *startjob);
426 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner, void (*)(void *, short int *, short int *, float *));
427 void            WM_jobs_kill_all(struct wmWindowManager *wm);
428 void            WM_jobs_kill_all_except(struct wmWindowManager *wm, void *owner);
429 void            WM_jobs_kill_type(struct wmWindowManager *wm, void *owner, int job_type);
430
431 bool        WM_jobs_has_running(struct wmWindowManager *wm);
432
433 void            WM_job_main_thread_lock_acquire(struct wmJob *job);
434 void            WM_job_main_thread_lock_release(struct wmJob *job);
435
436                         /* clipboard */
437 char       *WM_clipboard_text_get(bool selection, int *r_len);
438 char       *WM_clipboard_text_get_firstline(bool selection, int *r_len);
439 void        WM_clipboard_text_set(const char *buf, bool selection);
440
441                         /* progress */
442 void            WM_progress_set(struct wmWindow *win, float progress);
443 void            WM_progress_clear(struct wmWindow *win);
444
445                         /* Draw (for screenshot) */
446 void            WM_redraw_windows(struct bContext *C);
447
448 void        WM_main_playanim(int argc, const char **argv);
449
450 /* debugging only, convenience function to write on crash */
451 bool write_crash_blend(void);
452
453                         /* Lock the interface for any communication */
454 void        WM_set_locked_interface(struct wmWindowManager *wm, bool lock);
455
456 void        WM_event_ndof_pan_get(const struct wmNDOFMotionData *ndof, float r_pan[3], const bool use_zoom);
457 void        WM_event_ndof_rotate_get(const struct wmNDOFMotionData *ndof, float r_rot[3]);
458
459 float       WM_event_ndof_to_axis_angle(const struct wmNDOFMotionData *ndof, float axis[3]);
460 void        WM_event_ndof_to_quat(const struct wmNDOFMotionData *ndof, float q[4]);
461
462 float       WM_event_tablet_data(const struct wmEvent *event, int *pen_flip, float tilt[2]);
463 bool        WM_event_is_tablet(const struct wmEvent *event);
464
465 #ifdef WITH_INPUT_IME
466 bool        WM_event_is_ime_switch(const struct wmEvent *event);
467 #endif
468
469 #ifdef __cplusplus
470 }
471 #endif
472
473 #endif /* __WM_API_H__ */
474