3f89140888be2192b60fcc64238ec1ddf6bfeb60
[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 wmOperatorType;
57 struct wmOperator;
58 struct rcti;
59 struct PointerRNA;
60 struct PropertyRNA;
61 struct MenuType;
62 struct wmDropBox;
63 struct wmDrag;
64 struct ImBuf;
65 struct ImageFormatData;
66 struct ARegion;
67 struct wmNDOFMotionData;
68
69 typedef struct wmJob wmJob;
70
71 /* general API */
72 void            WM_init_state_size_set          (int stax, int stay, int sizx, int sizy);
73 void            WM_init_state_fullscreen_set(void);
74 void            WM_init_state_normal_set(void);
75 void            WM_init_native_pixels(bool do_it);
76
77 void            WM_init                         (struct bContext *C, int argc, const char **argv);
78 void            WM_exit_ext                     (struct bContext *C, const bool do_python);
79
80 void            WM_exit                         (struct bContext *C) ATTR_NORETURN;
81
82 void            WM_main                         (struct bContext *C) ATTR_NORETURN;
83
84 bool            WM_init_game            (struct bContext *C);
85 void            WM_init_splash          (struct bContext *C);
86
87
88 void            WM_check                        (struct bContext *C);
89
90 int                     WM_window_pixels_x              (struct wmWindow *win);
91 int                     WM_window_pixels_y              (struct wmWindow *win);
92 bool            WM_window_is_fullscreen (struct wmWindow *win);
93
94 /* defines for 'type' WM_window_open_temp */
95 enum {
96         WM_WINDOW_RENDER = 1,
97         WM_WINDOW_USERPREFS,
98         // WM_WINDOW_FILESEL // UNUSED
99 };
100
101 struct wmWindow *WM_window_open(struct bContext *C, const struct rcti *rect);
102 struct wmWindow *WM_window_open_temp(struct bContext *C, const struct rcti *rect_init, int type);
103                         
104                         /* returns true if draw method is triple buffer */
105 bool            WM_is_draw_triple(struct wmWindow *win);
106
107 bool            WM_stereo3d_enabled(struct wmWindow *win, bool only_fullscreen_test);
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 void            WM_file_tag_modified(const struct bContext *C);
116
117                         /* mouse cursors */
118 void            WM_cursor_set(struct wmWindow *win, int curs);
119 void            WM_cursor_modal_set(struct wmWindow *win, int curs);
120 void            WM_cursor_modal_restore(struct wmWindow *win);
121 void            WM_cursor_wait          (bool val);
122 void            WM_cursor_grab_enable(struct wmWindow *win, bool wrap, bool hide, int bounds[4]);
123 void            WM_cursor_grab_disable(struct wmWindow *win, const int mouse_ungrab_xy[2]);
124 void            WM_cursor_time          (struct wmWindow *win, int nr);
125
126 void            *WM_paint_cursor_activate(struct wmWindowManager *wm,
127                                       int (*poll)(struct bContext *C),
128                                       void (*draw)(struct bContext *C, int, int, void *customdata),
129                                       void *customdata);
130
131 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
132 void            WM_paint_cursor_tag_redraw(struct wmWindow *win, struct ARegion *ar);
133
134 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
135 void            WM_cursor_compatible_xy(wmWindow *win, int *x, int *y);
136 float           WM_cursor_pressure      (const struct wmWindow *win);
137
138                         /* event map */
139 int                     WM_userdef_event_map(int kmitype);
140
141                         /* handlers */
142
143 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
144                                                 /* boundbox, optional subwindow boundbox for offset */
145 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, const rcti *bb, const rcti *swinbb);
146                                                 /* priority not implemented, it adds in begin */
147 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
148
149 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
150
151 typedef int (*wmUIHandlerFunc)(struct bContext *C, const struct wmEvent *event, void *userdata);
152 typedef void (*wmUIHandlerRemoveFunc)(struct bContext *C, void *userdata);
153
154 struct wmEventHandler *WM_event_add_ui_handler(
155         const struct bContext *C, ListBase *handlers,
156         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove,
157         void *userdata, const char flag);
158 void WM_event_remove_ui_handler(
159         ListBase *handlers,
160         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove,
161         void *userdata, const bool postpone);
162 void WM_event_remove_area_handler(
163         struct ListBase *handlers, void *area);
164 void WM_event_free_ui_handler_all(
165         struct bContext *C, ListBase *handlers,
166         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove);
167
168 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
169 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
170
171 /* handler flag */
172 enum {
173         WM_HANDLER_BLOCKING             = (1 << 0),  /* after this handler all others are ignored */
174         WM_HANDLER_ACCEPT_DBL_CLICK     = (1 << 1),  /* handler accepts double key press events */
175
176         /* internal */
177         WM_HANDLER_DO_FREE              = (1 << 7),  /* handler tagged to be freed in wm_handlers_do() */
178 };
179
180 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
181
182                         /* mouse */
183 void            WM_event_add_mousemove(struct bContext *C);
184 bool        WM_modal_tweak_exit(const struct wmEvent *event, int tweak_event);
185 bool            WM_event_is_absolute(const struct wmEvent *event);
186
187                         /* 3D mouse */
188 void            WM_ndof_deadzone_set(float deadzone);
189
190                         /* notifiers */
191 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
192 void            WM_main_add_notifier(unsigned int type, void *reference);
193 void            WM_main_remove_notifier_reference(const void *reference);
194 void            WM_main_remove_editor_id_reference(const struct ID *id);
195
196                         /* reports */
197 void        WM_report_banner_show(const struct bContext *C);
198 void        WM_report(const struct bContext *C, ReportType type, const char *message);
199 void        WM_reportf(const struct bContext *C, ReportType type, const char *format, ...) ATTR_PRINTF_FORMAT(3, 4);
200
201 void wm_event_add_ex(
202         struct wmWindow *win, const struct wmEvent *event_to_add,
203         const struct wmEvent *event_to_add_after)
204         ATTR_NONNULL(1, 2);
205 void wm_event_add(
206         struct wmWindow *win, const struct wmEvent *event_to_add)
207         ATTR_NONNULL(1, 2);
208
209 void wm_event_init_from_window(struct wmWindow *win, struct wmEvent *event);
210
211
212                         /* at maximum, every timestep seconds it triggers event_type events */
213 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
214 struct wmTimer *WM_event_add_timer_notifier(struct wmWindowManager *wm, struct wmWindow *win, unsigned int type, double timestep);
215 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
216 void            WM_event_remove_timer_notifier(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
217 void        WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, bool do_sleep);
218
219                 /* operator api, default callbacks */
220                         /* invoke callback, uses enum property named "type" */
221 void            WM_operator_view3d_unit_defaults(struct bContext *C, struct wmOperator *op);
222 int                     WM_operator_smooth_viewtx_get(const struct wmOperator *op);
223 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
224 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
225                         /* invoke callback, confirm menu + exec */
226 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
227                 /* invoke callback, file selector "filepath" unset + exec */
228 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
229 bool        WM_operator_filesel_ensure_ext_imtype(wmOperator *op, const struct ImageFormatData *im_format);
230                         /* poll callback, context checks */
231 int                     WM_operator_winactive   (struct bContext *C);
232                         /* invoke callback, exec + redo popup */
233 int                     WM_operator_props_popup_confirm(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
234 int                     WM_operator_props_popup_call(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
235 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
236 int             WM_operator_props_dialog_popup(struct bContext *C, struct wmOperator *op, int width, int height);
237 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
238 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
239
240 int         WM_operator_confirm_message_ex(struct bContext *C, struct wmOperator *op,
241                                            const char *title, const int icon,
242                                            const char *message);
243 int         WM_operator_confirm_message(struct bContext *C, struct wmOperator *op,
244                                         const char *message);
245
246                 /* operator api */
247 void            WM_operator_free                (struct wmOperator *op);
248 void            WM_operator_type_set(struct wmOperator *op, struct wmOperatorType *ot);
249 void            WM_operator_stack_clear(struct wmWindowManager *wm);
250 void            WM_operator_handlers_clear(wmWindowManager *wm, struct wmOperatorType *ot);
251
252 struct wmOperatorType *WM_operatortype_find(const char *idname, bool quiet);
253 void        WM_operatortype_iter(struct GHashIterator *ghi);
254 void            WM_operatortype_append(void (*opfunc)(struct wmOperatorType *));
255 void            WM_operatortype_append_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
256 void            WM_operatortype_append_macro_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
257 void        WM_operatortype_remove_ptr(struct wmOperatorType *ot);
258 bool        WM_operatortype_remove(const char *idname);
259 void        WM_operatortype_last_properties_clear_all(void);
260
261 struct wmOperatorType *WM_operatortype_append_macro(const char *idname, const char *name, const char *description, int flag);
262 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
263
264
265 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
266 int                     WM_operator_poll_context(struct bContext *C, struct wmOperatorType *ot, short context);
267 int         WM_operator_call_ex(struct bContext *C, struct wmOperator *op, const bool store);
268 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
269 int                     WM_operator_call_notest(struct bContext *C, struct wmOperator *op);
270 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
271 bool        WM_operator_repeat_check(const struct bContext *C, struct wmOperator *op);
272 int         WM_operator_name_call_ptr(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties);
273 int                     WM_operator_name_call(struct bContext *C, const char *opstring, short context, struct PointerRNA *properties);
274 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties, struct ReportList *reports, const bool is_undo);
275
276 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
277 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, const bool no_context); /* make props context sensitive or not */
278 bool        WM_operator_properties_default(struct PointerRNA *ptr, const bool do_update);
279 void        WM_operator_properties_reset(struct wmOperator *op);
280 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
281 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
282 void        WM_operator_properties_clear(struct PointerRNA *ptr);
283 void            WM_operator_properties_free(struct PointerRNA *ptr);
284
285 bool        WM_operator_check_ui_enabled(const struct bContext *C, const char *idname);
286 wmOperator *WM_operator_last_redo(const struct bContext *C);
287 ID         *WM_operator_drop_load_path(struct bContext *C, struct wmOperator *op, const short idcode);
288
289 bool        WM_operator_last_properties_init(struct wmOperator *op);
290 bool        WM_operator_last_properties_store(struct wmOperator *op);
291
292
293 /* wm_operator_props.c */
294 void        WM_operator_properties_filesel(struct wmOperatorType *ot, int filter, short type, short action, short flag, short display, short sort);
295 void        WM_operator_properties_border(struct wmOperatorType *ot);
296 void        WM_operator_properties_border_to_rcti(struct wmOperator *op, struct rcti *rect);
297 void        WM_operator_properties_border_to_rctf(struct wmOperator *op, rctf *rect);
298 void        WM_operator_properties_gesture_border(struct wmOperatorType *ot, bool extend);
299 void        WM_operator_properties_mouse_select(struct wmOperatorType *ot);
300 void        WM_operator_properties_gesture_straightline(struct wmOperatorType *ot, int cursor);
301 void        WM_operator_properties_select_all(struct wmOperatorType *ot);
302 void        WM_operator_properties_select_action(struct wmOperatorType *ot, int default_action);
303 void        WM_operator_properties_select_action_simple(struct wmOperatorType *ot, int default_action);
304 void        WM_operator_properties_select_random(struct wmOperatorType *ot);
305 struct CheckerIntervalParams {
306         int nth;  /* bypass when set to zero */
307         int skip;
308         int offset;
309 };
310 void        WM_operator_properties_checker_interval(struct wmOperatorType *ot, bool nth_can_disable);
311 void        WM_operator_properties_checker_interval_from_op(
312         struct wmOperator *op, struct CheckerIntervalParams *op_params);
313 bool        WM_operator_properties_checker_interval_test(
314         const struct CheckerIntervalParams *op_params, int depth);
315
316
317 /* MOVE THIS SOMEWHERE ELSE */
318 #define SEL_TOGGLE              0
319 #define SEL_SELECT              1
320 #define SEL_DESELECT    2
321 #define SEL_INVERT              3
322
323
324 /* flags for WM_operator_properties_filesel */
325 #define WM_FILESEL_RELPATH              (1 << 0)
326
327 #define WM_FILESEL_DIRECTORY    (1 << 1)
328 #define WM_FILESEL_FILENAME             (1 << 2)
329 #define WM_FILESEL_FILEPATH             (1 << 3)
330 #define WM_FILESEL_FILES                (1 << 4)
331
332
333                 /* operator as a python command (resultuing string must be freed) */
334 char            *WM_operator_pystring_ex(struct bContext *C, struct wmOperator *op,
335                                      const bool all_args, const bool macro_args,
336                                      struct wmOperatorType *ot, struct PointerRNA *opptr);
337 char            *WM_operator_pystring(struct bContext *C, struct wmOperator *op,
338                                   const bool all_args, const bool macro_args);
339 bool         WM_operator_pystring_abbreviate(char *str, int str_len_max);
340 char            *WM_prop_pystring_assign(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
341 void            WM_operator_bl_idname(char *to, const char *from);
342 void            WM_operator_py_idname(char *to, const char *from);
343
344 /* *************** uilist types ******************** */
345 void                WM_uilisttype_init(void);
346 struct uiListType  *WM_uilisttype_find(const char *idname, bool quiet);
347 bool                WM_uilisttype_add(struct uiListType *ult);
348 void                WM_uilisttype_freelink(struct uiListType *ult);
349 void                WM_uilisttype_free(void);
350
351 /* *************** menu types ******************** */
352 void                WM_menutype_init(void);
353 struct MenuType    *WM_menutype_find(const char *idname, bool quiet);
354 bool                WM_menutype_add(struct MenuType *mt);
355 void                WM_menutype_freelink(struct MenuType *mt);
356 void                WM_menutype_free(void);
357
358                         /* default operator callbacks for border/circle/lasso */
359 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
360 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
361 void            WM_border_select_cancel(struct bContext *C, struct wmOperator *op);
362 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
363 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
364 void            WM_gesture_circle_cancel(struct bContext *C, struct wmOperator *op);
365 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
366 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
367 void            WM_gesture_lines_cancel(struct bContext *C, struct wmOperator *op);
368 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
369 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
370 void            WM_gesture_lasso_cancel(struct bContext *C, struct wmOperator *op);
371 const int (*WM_gesture_lasso_path_to_array(struct bContext *C, struct wmOperator *op, int *mcords_tot))[2];
372 int                     WM_gesture_straightline_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
373 int                     WM_gesture_straightline_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
374 void            WM_gesture_straightline_cancel(struct bContext *C, struct wmOperator *op);
375
376                         /* Gesture manager API */
377 struct wmGesture *WM_gesture_new(struct bContext *C, const struct wmEvent *event, int type);
378 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
379 void            WM_gestures_remove(struct bContext *C);
380
381                         /* fileselecting support */
382 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
383 void            WM_event_fileselect_event(struct wmWindowManager *wm, void *ophandle, int eventval);
384 #ifndef NDEBUG
385 void            WM_event_print(const struct wmEvent *event);
386 #endif
387
388 void            WM_operator_region_active_win_set(struct bContext *C);
389
390                         /* drag and drop */
391 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value, unsigned int flags);
392 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
393 void                WM_drag_free(struct wmDrag *drag);
394 void                WM_drag_free_list(struct ListBase *lb);
395
396 struct wmDropBox        *WM_dropbox_add(ListBase *lb, const char *idname, int (*poll)(struct bContext *, struct wmDrag *, const struct wmEvent *event),
397                                     void (*copy)(struct wmDrag *, struct wmDropBox *));
398 ListBase        *WM_dropboxmap_find(const char *idname, int spaceid, int regionid);
399
400                         /* Set a subwindow active in pixelspace view, with optional scissor subset */
401 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
402 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, const struct rcti *srct, bool srct_pad);
403
404                         /* OpenGL utilities with safety check + working in modelview matrix mode */
405 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
406 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
407 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
408                         /* use for conventions (avoid hard-coded offsets all over) */
409 void            wmOrtho2_region_pixelspace(const struct ARegion *ar);
410 void            wmOrtho2_region_ui(const struct ARegion *ar);
411 void            wmOrtho2_pixelspace(const float x, const float y);
412
413                         /* utilities */
414 void            WM_framebuffer_index_set(int index);
415 void            WM_framebuffer_index_get(int index, int *r_col);
416 int                     WM_framebuffer_to_index(unsigned int col);
417 void            WM_framebuffer_to_index_array(unsigned int *col, const unsigned int size);
418
419                         /* threaded Jobs Manager */
420 enum {
421         WM_JOB_PRIORITY     = (1 << 0),
422         WM_JOB_EXCL_RENDER  = (1 << 1),
423         WM_JOB_PROGRESS     = (1 << 2),
424         WM_JOB_SUSPEND      = (1 << 3)
425 };
426
427 /* identifying jobs by owner alone is unreliable, this isnt saved, order can change (keep 0 for 'any') */
428 enum {
429         WM_JOB_TYPE_ANY = 0,
430         WM_JOB_TYPE_COMPOSITE,
431         WM_JOB_TYPE_RENDER,
432         WM_JOB_TYPE_RENDER_PREVIEW,  /* UI preview */
433         WM_JOB_TYPE_SCREENCAST,
434         WM_JOB_TYPE_OBJECT_SIM_OCEAN,
435         WM_JOB_TYPE_OBJECT_SIM_FLUID,
436         WM_JOB_TYPE_OBJECT_BAKE_TEXTURE,
437         WM_JOB_TYPE_OBJECT_BAKE,
438         WM_JOB_TYPE_FILESEL_READDIR,
439         WM_JOB_TYPE_CLIP_BUILD_PROXY,
440         WM_JOB_TYPE_CLIP_TRACK_MARKERS,
441         WM_JOB_TYPE_CLIP_SOLVE_CAMERA,
442         WM_JOB_TYPE_CLIP_PREFETCH,
443         WM_JOB_TYPE_SEQ_BUILD_PROXY,
444         WM_JOB_TYPE_SEQ_BUILD_PREVIEW,
445         /* add as needed, screencast, seq proxy build
446          * if having hard coded values is a problem */
447 };
448
449 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, const char *name, int flag, int job_type);
450
451 bool        WM_jobs_test(struct wmWindowManager *wm, void *owner, int job_type);
452 float           WM_jobs_progress(struct wmWindowManager *wm, void *owner);
453 char       *WM_jobs_name(struct wmWindowManager *wm, void *owner);
454 void       *WM_jobs_customdata(struct wmWindowManager *wm, void *owner);
455 void       *WM_jobs_customdata_from_type(struct wmWindowManager *wm, int job_type);
456
457 bool        WM_jobs_is_running(struct wmJob *);
458 void       *WM_jobs_customdata_get(struct wmJob *);
459 void        WM_jobs_customdata_set(struct wmJob *, void *customdata, void (*free)(void *));
460 void        WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
461 void        WM_jobs_callbacks(struct wmJob *,
462                               void (*startjob)(void *, short *, short *, float *),
463                               void (*initjob)(void *),
464                               void (*update)(void *),
465                               void (*endjob)(void *));
466
467 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
468 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner, void *startjob);
469 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner, void (*)(void *, short int *, short int *, float *));
470 void            WM_jobs_kill_all(struct wmWindowManager *wm);
471 void            WM_jobs_kill_all_except(struct wmWindowManager *wm, void *owner);
472 void            WM_jobs_kill_type(struct wmWindowManager *wm, void *owner, int job_type);
473
474 bool        WM_jobs_has_running(struct wmWindowManager *wm);
475
476 void            WM_job_main_thread_lock_acquire(struct wmJob *job);
477 void            WM_job_main_thread_lock_release(struct wmJob *job);
478
479                         /* clipboard */
480 char       *WM_clipboard_text_get(bool selection, int *r_len);
481 char       *WM_clipboard_text_get_firstline(bool selection, int *r_len);
482 void        WM_clipboard_text_set(const char *buf, bool selection);
483
484                         /* progress */
485 void            WM_progress_set(struct wmWindow *win, float progress);
486 void            WM_progress_clear(struct wmWindow *win);
487
488                         /* Draw (for screenshot) */
489 void            WM_redraw_windows(struct bContext *C);
490
491 void        WM_main_playanim(int argc, const char **argv);
492
493 /* debugging only, convenience function to write on crash */
494 bool write_crash_blend(void);
495
496                         /* Lock the interface for any communication */
497 void        WM_set_locked_interface(struct wmWindowManager *wm, bool lock);
498
499 void        WM_event_ndof_pan_get(const struct wmNDOFMotionData *ndof, float r_pan[3], const bool use_zoom);
500 void        WM_event_ndof_rotate_get(const struct wmNDOFMotionData *ndof, float r_rot[3]);
501
502 float       WM_event_ndof_to_axis_angle(const struct wmNDOFMotionData *ndof, float axis[3]);
503 void        WM_event_ndof_to_quat(const struct wmNDOFMotionData *ndof, float q[4]);
504
505 float       WM_event_tablet_data(const struct wmEvent *event, int *pen_flip, float tilt[2]);
506 bool        WM_event_is_tablet(const struct wmEvent *event);
507
508 #ifdef WITH_INPUT_IME
509 bool        WM_event_is_ime_switch(const struct wmEvent *event);
510 #endif
511
512 #ifdef __cplusplus
513 }
514 #endif
515
516 #endif /* __WM_API_H__ */
517