Merge branch 'blender2.7'
[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 blender/windowmanager/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 bToolRef_Runtime;
51 struct GHashIterator;
52 struct IDProperty;
53 struct wmEvent;
54 struct wmEventHandler;
55 struct wmGesture;
56 struct wmJob;
57 struct wmMsgSubscribeKey;
58 struct wmMsgSubscribeValue;
59 struct wmOperatorType;
60 struct wmOperator;
61 struct wmPaintCursor;
62 struct rcti;
63 struct PointerRNA;
64 struct PropertyRNA;
65 struct MenuType;
66 struct wmDropBox;
67 struct wmDrag;
68 struct ImBuf;
69 struct ImageFormatData;
70 struct ARegion;
71 struct ScrArea;
72 struct Main;
73 struct ViewLayer;
74 struct GPUViewport;
75
76 #ifdef WITH_INPUT_NDOF
77 struct wmNDOFMotionData;
78 #endif
79
80 typedef struct wmJob wmJob;
81 typedef struct wmGizmo wmGizmo;
82 typedef struct wmGizmoMap wmGizmoMap;
83 typedef struct wmGizmoMapType wmGizmoMapType;
84
85 /* general API */
86 void            WM_init_state_app_template_set(const char *app_template);
87 const char *WM_init_state_app_template_get(void);
88
89 void            WM_init_state_size_set          (int stax, int stay, int sizx, int sizy);
90 void            WM_init_state_fullscreen_set(void);
91 void            WM_init_state_normal_set(void);
92 void            WM_init_window_focus_set(bool do_it);
93 void            WM_init_native_pixels(bool do_it);
94 void            WM_init_tablet_api(void);
95
96 void            WM_init                         (struct bContext *C, int argc, const char **argv);
97 void            WM_exit_ext                     (struct bContext *C, const bool do_python);
98
99 void            WM_exit                         (struct bContext *C) ATTR_NORETURN;
100
101 void            WM_main                         (struct bContext *C) ATTR_NORETURN;
102
103 void            WM_init_splash          (struct bContext *C);
104
105 void            WM_init_opengl          (struct Main *bmain);
106
107 void            WM_check                        (struct bContext *C);
108
109 int WM_window_pixels_x(const struct wmWindow *win);
110 int WM_window_pixels_y(const struct wmWindow *win);
111 void WM_window_rect_calc(const struct wmWindow *win, struct rcti *r_rect);
112 void WM_window_screen_rect_calc(const struct wmWindow *win, struct rcti *r_rect);
113 bool WM_window_is_fullscreen(struct wmWindow *win);
114
115 void WM_windows_scene_data_sync(const ListBase *win_lb, struct Scene *scene) ATTR_NONNULL();
116 struct Scene *WM_windows_scene_get_from_screen(const struct wmWindowManager *wm, const struct bScreen *screen) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
117 struct WorkSpace *WM_windows_workspace_get_from_screen(const wmWindowManager *wm, const struct bScreen *screen) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
118
119 struct Scene *WM_window_get_active_scene(const struct wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
120 void          WM_window_set_active_scene(struct Main *bmain, struct bContext *C, struct wmWindow *win,
121                                          struct Scene *scene_new) ATTR_NONNULL();
122 struct WorkSpace *WM_window_get_active_workspace(const struct wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
123 void              WM_window_set_active_workspace(struct bContext *C, struct wmWindow *win, struct WorkSpace *workspace) ATTR_NONNULL(1);
124 struct WorkSpaceLayout *WM_window_get_active_layout(const struct wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
125 void                    WM_window_set_active_layout(
126         struct wmWindow *win, struct WorkSpace *workspace, struct WorkSpaceLayout *layout) ATTR_NONNULL(1);
127 struct bScreen *WM_window_get_active_screen(const struct wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
128 void            WM_window_set_active_screen(struct wmWindow *win, struct WorkSpace *workspace, struct bScreen *screen) ATTR_NONNULL(1);
129
130 struct ViewLayer *WM_window_get_active_view_layer(const struct wmWindow *win) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT;
131 void              WM_window_set_active_view_layer(struct wmWindow *win, struct ViewLayer *view_layer) ATTR_NONNULL(1);
132 void              WM_window_ensure_active_view_layer(struct wmWindow *win) ATTR_NONNULL(1);
133
134 bool WM_window_is_temp_screen(const struct wmWindow *win) ATTR_WARN_UNUSED_RESULT;
135
136 void *WM_opengl_context_create(void);
137 void WM_opengl_context_dispose(void *context);
138 void WM_opengl_context_activate(void *context);
139 void WM_opengl_context_release(void *context);
140
141 /* defines for 'type' WM_window_open_temp */
142 enum {
143         WM_WINDOW_RENDER = 1,
144         WM_WINDOW_USERPREFS,
145         WM_WINDOW_DRIVERS,
146         // WM_WINDOW_FILESEL // UNUSED
147 };
148
149 struct wmWindow *WM_window_open(struct bContext *C, const struct rcti *rect);
150 struct wmWindow *WM_window_open_temp(struct bContext *C, int x, int y, int sizex, int sizey, int type);
151 void             WM_window_set_dpi(wmWindow *win);
152
153 bool            WM_stereo3d_enabled(struct wmWindow *win, bool only_fullscreen_test);
154
155
156                         /* files */
157 void            WM_file_autoexec_init(const char *filepath);
158 bool            WM_file_read(struct bContext *C, const char *filepath, struct ReportList *reports);
159 void            WM_autosave_init(struct wmWindowManager *wm);
160 void            WM_recover_last_session(struct bContext *C, struct ReportList *reports);
161 void            WM_file_tag_modified(void);
162
163 void        WM_lib_reload(struct Library *lib, struct bContext *C, struct ReportList *reports);
164
165                         /* mouse cursors */
166 void            WM_cursor_set(struct wmWindow *win, int curs);
167 bool            WM_cursor_set_from_tool(struct wmWindow *win, const ScrArea *sa, const ARegion *ar);
168 void            WM_cursor_modal_set(struct wmWindow *win, int curs);
169 void            WM_cursor_modal_restore(struct wmWindow *win);
170 void            WM_cursor_wait          (bool val);
171 void            WM_cursor_grab_enable(struct wmWindow *win, bool wrap, bool hide, int bounds[4]);
172 void            WM_cursor_grab_disable(struct wmWindow *win, const int mouse_ungrab_xy[2]);
173 void            WM_cursor_time          (struct wmWindow *win, int nr);
174
175 struct wmPaintCursor *WM_paint_cursor_activate(
176         struct wmWindowManager *wm,
177         short space_type, short region_type,
178         bool (*poll)(struct bContext *C),
179         void (*draw)(struct bContext *C, int, int, void *customdata),
180         void *customdata);
181
182 bool            WM_paint_cursor_end(struct wmWindowManager *wm, struct wmPaintCursor *handle);
183 void            WM_paint_cursor_tag_redraw(struct wmWindow *win, struct ARegion *ar);
184
185
186 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
187 void            WM_cursor_compatible_xy(wmWindow *win, int *x, int *y);
188 float           WM_cursor_pressure      (const struct wmWindow *win);
189
190                         /* event map */
191 int                     WM_userdef_event_map(int kmitype);
192 int                     WM_userdef_event_type_from_keymap_type(int kmitype);
193
194                         /* handlers */
195
196 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
197                                                 /* boundbox, optional subwindow boundbox for offset */
198 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, const rcti *bb, const rcti *swinbb);
199                                                 /* priority not implemented, it adds in begin */
200 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
201
202 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
203
204 void WM_event_set_keymap_handler_callback(
205         struct wmEventHandler *handler,
206         void (keymap_tag)(wmKeyMap *keymap, wmKeyMapItem *kmi, void *user_data),
207         void *user_data);
208
209 typedef int (*wmUIHandlerFunc)(struct bContext *C, const struct wmEvent *event, void *userdata);
210 typedef void (*wmUIHandlerRemoveFunc)(struct bContext *C, void *userdata);
211
212 struct wmEventHandler *WM_event_add_ui_handler(
213         const struct bContext *C, ListBase *handlers,
214         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove,
215         void *userdata, const char flag);
216 void WM_event_remove_ui_handler(
217         ListBase *handlers,
218         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove,
219         void *userdata, const bool postpone);
220 void WM_event_remove_area_handler(
221         struct ListBase *handlers, void *area);
222 void WM_event_free_ui_handler_all(
223         struct bContext *C, ListBase *handlers,
224         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove);
225
226 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
227 void WM_event_modal_handler_area_replace(wmWindow *win, const struct ScrArea *old_area, struct ScrArea *new_area);
228 void WM_event_modal_handler_region_replace(wmWindow *win, const struct ARegion *old_region, struct ARegion *new_region);
229
230 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
231
232 /* handler flag */
233 enum {
234         WM_HANDLER_BLOCKING             = (1 << 0),  /* after this handler all others are ignored */
235         WM_HANDLER_ACCEPT_DBL_CLICK     = (1 << 1),  /* handler accepts double key press events */
236
237         /* internal */
238         WM_HANDLER_DO_FREE              = (1 << 7),  /* handler tagged to be freed in wm_handlers_do() */
239 };
240
241 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
242
243                         /* mouse */
244 void            WM_event_add_mousemove(const struct bContext *C);
245 bool            WM_event_is_modal_tweak_exit(const struct wmEvent *event, int tweak_event);
246 bool            WM_event_is_last_mousemove(const struct wmEvent *event);
247
248 #ifdef WITH_INPUT_NDOF
249                         /* 3D mouse */
250 void            WM_ndof_deadzone_set(float deadzone);
251 #endif
252                         /* notifiers */
253 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
254 void            WM_main_add_notifier(unsigned int type, void *reference);
255 void            WM_main_remove_notifier_reference(const void *reference);
256 void            WM_main_remap_editor_id_reference(struct ID *old_id, struct ID *new_id);
257
258                         /* reports */
259 void        WM_report_banner_show(void);
260 void        WM_report(ReportType type, const char *message);
261 void        WM_reportf(ReportType type, const char *format, ...) ATTR_PRINTF_FORMAT(2, 3);
262
263 struct wmEvent *wm_event_add_ex(
264         struct wmWindow *win, const struct wmEvent *event_to_add,
265         const struct wmEvent *event_to_add_after)
266         ATTR_NONNULL(1, 2);
267 struct wmEvent *wm_event_add(
268         struct wmWindow *win, const struct wmEvent *event_to_add)
269         ATTR_NONNULL(1, 2);
270
271 void wm_event_init_from_window(struct wmWindow *win, struct wmEvent *event);
272
273
274                         /* at maximum, every timestep seconds it triggers event_type events */
275 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
276 struct wmTimer *WM_event_add_timer_notifier(struct wmWindowManager *wm, struct wmWindow *win, unsigned int type, double timestep);
277 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
278 void            WM_event_remove_timer_notifier(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
279 void        WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, bool do_sleep);
280
281                 /* operator api, default callbacks */
282                         /* invoke callback, uses enum property named "type" */
283 void            WM_operator_view3d_unit_defaults(struct bContext *C, struct wmOperator *op);
284 int                     WM_operator_smooth_viewtx_get(const struct wmOperator *op);
285 int                     WM_menu_invoke_ex(struct bContext *C, struct wmOperator *op, int opcontext);
286 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
287 void            WM_menu_name_call(struct bContext *C, const char *menu_name, short context);
288 int         WM_enum_search_invoke_previews(struct bContext *C, struct wmOperator *op, short prv_cols, short prv_rows);
289 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
290                         /* invoke callback, confirm menu + exec */
291 int                     WM_operator_confirm(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
292 int                     WM_operator_confirm_or_exec(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
293                 /* invoke callback, file selector "filepath" unset + exec */
294 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
295 bool        WM_operator_filesel_ensure_ext_imtype(wmOperator *op, const struct ImageFormatData *im_format);
296                         /* poll callback, context checks */
297 bool                    WM_operator_winactive   (struct bContext *C);
298                         /* invoke callback, exec + redo popup */
299 int                     WM_operator_props_popup_confirm(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
300 int                     WM_operator_props_popup_call(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
301 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
302 int             WM_operator_props_dialog_popup(struct bContext *C, struct wmOperator *op, int width, int height);
303 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
304 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
305
306 int         WM_operator_confirm_message_ex(struct bContext *C, struct wmOperator *op,
307                                            const char *title, const int icon,
308                                            const char *message);
309 int         WM_operator_confirm_message(struct bContext *C, struct wmOperator *op,
310                                         const char *message);
311
312                 /* operator api */
313 void            WM_operator_free                (struct wmOperator *op);
314 void            WM_operator_free_all_after(wmWindowManager *wm, struct wmOperator *op);
315 void            WM_operator_type_set(struct wmOperator *op, struct wmOperatorType *ot);
316 void            WM_operator_stack_clear(struct wmWindowManager *wm);
317 void            WM_operator_handlers_clear(wmWindowManager *wm, struct wmOperatorType *ot);
318
319 bool        WM_operator_poll            (struct bContext *C, struct wmOperatorType *ot);
320 bool        WM_operator_poll_context(struct bContext *C, struct wmOperatorType *ot, short context);
321 int         WM_operator_call_ex(struct bContext *C, struct wmOperator *op, const bool store);
322 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
323 int                     WM_operator_call_notest(struct bContext *C, struct wmOperator *op);
324 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
325 bool        WM_operator_repeat_check(const struct bContext *C, struct wmOperator *op);
326 bool        WM_operator_is_repeat(const struct bContext *C, const struct wmOperator *op);
327 int         WM_operator_name_call_ptr(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties);
328 int                     WM_operator_name_call(struct bContext *C, const char *opstring, short context, struct PointerRNA *properties);
329 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties, struct ReportList *reports, const bool is_undo);
330
331 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
332 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, const bool no_context); /* make props context sensitive or not */
333 bool        WM_operator_properties_default(struct PointerRNA *ptr, const bool do_update);
334 void        WM_operator_properties_reset(struct wmOperator *op);
335 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
336 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
337 void        WM_operator_properties_clear(struct PointerRNA *ptr);
338 void            WM_operator_properties_free(struct PointerRNA *ptr);
339
340 bool        WM_operator_check_ui_empty(struct wmOperatorType *ot);
341 bool        WM_operator_check_ui_enabled(const struct bContext *C, const char *idname);
342
343 IDProperty *WM_operator_last_properties_ensure_idprops(struct wmOperatorType *ot);
344 void        WM_operator_last_properties_ensure(struct wmOperatorType *ot, struct PointerRNA *ptr);
345 wmOperator *WM_operator_last_redo(const struct bContext *C);
346 ID         *WM_operator_drop_load_path(struct bContext *C, struct wmOperator *op, const short idcode);
347
348 bool        WM_operator_last_properties_init(struct wmOperator *op);
349 bool        WM_operator_last_properties_store(struct wmOperator *op);
350
351
352 /* wm_operator_props.c */
353 void        WM_operator_properties_confirm_or_exec(struct wmOperatorType *ot);
354 void        WM_operator_properties_filesel(
355         struct wmOperatorType *ot, int filter, short type, short action,
356         short flag, short display, short sort);
357 void        WM_operator_properties_border(struct wmOperatorType *ot);
358 void        WM_operator_properties_border_to_rcti(struct wmOperator *op, struct rcti *rect);
359 void        WM_operator_properties_border_to_rctf(struct wmOperator *op, rctf *rect);
360 void        WM_operator_properties_gesture_box_ex(struct wmOperatorType *ot, bool deselect, bool extend);
361 void        WM_operator_properties_gesture_box(struct wmOperatorType *ot);
362 void        WM_operator_properties_gesture_box_select(struct wmOperatorType *ot);
363 void        WM_operator_properties_gesture_box_zoom(struct wmOperatorType *ot);
364 void        WM_operator_properties_gesture_lasso_ex(struct wmOperatorType *ot, bool deselect, bool extend);
365 void        WM_operator_properties_gesture_lasso(struct wmOperatorType *ot);
366 void        WM_operator_properties_gesture_lasso_select(struct wmOperatorType *ot);
367 void        WM_operator_properties_gesture_straightline(struct wmOperatorType *ot, int cursor);
368 void        WM_operator_properties_gesture_circle_ex(struct wmOperatorType *ot, bool deselect);
369 void        WM_operator_properties_gesture_circle(struct wmOperatorType *ot);
370 void        WM_operator_properties_gesture_circle_select(struct wmOperatorType *ot);
371 void        WM_operator_properties_mouse_select(struct wmOperatorType *ot);
372 void        WM_operator_properties_select_all(struct wmOperatorType *ot);
373 void        WM_operator_properties_select_action(struct wmOperatorType *ot, int default_action);
374 void        WM_operator_properties_select_action_simple(struct wmOperatorType *ot, int default_action);
375 void        WM_operator_properties_select_random(struct wmOperatorType *ot);
376 int         WM_operator_properties_select_random_seed_increment_get(wmOperator *op);
377 void        WM_operator_properties_select_operation(struct wmOperatorType *ot);
378 void        WM_operator_properties_select_operation_simple(struct wmOperatorType *ot);
379 struct CheckerIntervalParams {
380         int nth;  /* bypass when set to zero */
381         int skip;
382         int offset;
383 };
384 void        WM_operator_properties_checker_interval(struct wmOperatorType *ot, bool nth_can_disable);
385 void        WM_operator_properties_checker_interval_from_op(
386         struct wmOperator *op, struct CheckerIntervalParams *op_params);
387 bool        WM_operator_properties_checker_interval_test(
388         const struct CheckerIntervalParams *op_params, int depth);
389
390 /* flags for WM_operator_properties_filesel */
391 #define WM_FILESEL_RELPATH              (1 << 0)
392
393 #define WM_FILESEL_DIRECTORY    (1 << 1)
394 #define WM_FILESEL_FILENAME             (1 << 2)
395 #define WM_FILESEL_FILEPATH             (1 << 3)
396 #define WM_FILESEL_FILES                (1 << 4)
397
398                 /* operator as a python command (resultuing string must be freed) */
399 char            *WM_operator_pystring_ex(struct bContext *C, struct wmOperator *op,
400                                      const bool all_args, const bool macro_args,
401                                      struct wmOperatorType *ot, struct PointerRNA *opptr);
402 char            *WM_operator_pystring(struct bContext *C, struct wmOperator *op,
403                                   const bool all_args, const bool macro_args);
404 bool         WM_operator_pystring_abbreviate(char *str, int str_len_max);
405 char            *WM_prop_pystring_assign(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
406 void            WM_operator_bl_idname(char *to, const char *from);
407 void            WM_operator_py_idname(char *to, const char *from);
408 bool        WM_operator_py_idname_ok_or_report(struct ReportList *reports, const char *classname, const char *idname);
409 const char *WM_context_member_from_ptr(struct bContext *C, const struct PointerRNA *ptr);
410
411 /* wm_operator_type.c */
412 struct wmOperatorType *WM_operatortype_find(const char *idname, bool quiet);
413 void WM_operatortype_iter(struct GHashIterator *ghi);
414 void WM_operatortype_append(void (*opfunc)(struct wmOperatorType *));
415 void WM_operatortype_append_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
416 void WM_operatortype_append_macro_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
417 void WM_operatortype_remove_ptr(struct wmOperatorType *ot);
418 bool WM_operatortype_remove(const char *idname);
419 void WM_operatortype_last_properties_clear_all(void);
420 void WM_operatortype_props_advanced_begin(struct wmOperatorType *ot);
421 void WM_operatortype_props_advanced_end(struct wmOperatorType *ot);
422
423 #define WM_operatortype_prop_tag(property, tags) \
424         { \
425                 CHECK_TYPE(tags, eOperatorPropTags); \
426                 RNA_def_property_tags(prop, tags); \
427         } (void)0
428
429 struct wmOperatorType *WM_operatortype_append_macro(const char *idname, const char *name, const char *description, int flag);
430 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
431
432 /* wm_uilist_type.c */
433 void                WM_uilisttype_init(void);
434 struct uiListType  *WM_uilisttype_find(const char *idname, bool quiet);
435 bool                WM_uilisttype_add(struct uiListType *ult);
436 void                WM_uilisttype_freelink(struct uiListType *ult);
437 void                WM_uilisttype_free(void);
438
439 /* wm_menu_type.c */
440 void                WM_menutype_init(void);
441 struct MenuType    *WM_menutype_find(const char *idname, bool quiet);
442 bool                WM_menutype_add(struct MenuType *mt);
443 void                WM_menutype_freelink(struct MenuType *mt);
444 void                WM_menutype_free(void);
445 bool                WM_menutype_poll(struct bContext *C, struct MenuType *mt);
446
447 /* wm_panel_type.c */
448 void                WM_paneltype_init(void);
449 void                WM_paneltype_clear(void);
450 struct PanelType   *WM_paneltype_find(const char *idname, bool quiet);
451 bool                WM_paneltype_add(struct PanelType *mt);
452 void                WM_paneltype_remove(struct PanelType *mt);
453
454 /* wm_gesture_ops.c */
455 int                     WM_gesture_box_invoke   (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
456 int                     WM_gesture_box_modal    (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
457 void            WM_gesture_box_cancel(struct bContext *C, struct wmOperator *op);
458 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
459 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
460 void            WM_gesture_circle_cancel(struct bContext *C, struct wmOperator *op);
461 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
462 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
463 void            WM_gesture_lines_cancel(struct bContext *C, struct wmOperator *op);
464 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
465 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
466 void            WM_gesture_lasso_cancel(struct bContext *C, struct wmOperator *op);
467 const int (*WM_gesture_lasso_path_to_array(struct bContext *C, struct wmOperator *op, int *mcords_tot))[2];
468 int                     WM_gesture_straightline_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
469 int                     WM_gesture_straightline_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
470 void            WM_gesture_straightline_cancel(struct bContext *C, struct wmOperator *op);
471
472                         /* Gesture manager API */
473 struct wmGesture *WM_gesture_new(struct bContext *C, const struct wmEvent *event, int type);
474 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
475 void            WM_gestures_remove(struct bContext *C);
476
477                         /* fileselecting support */
478 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
479 void            WM_event_fileselect_event(struct wmWindowManager *wm, void *ophandle, int eventval);
480 void            WM_event_print(const struct wmEvent *event);
481
482 void            WM_operator_region_active_win_set(struct bContext *C);
483
484                         /* drag and drop */
485 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value, unsigned int flags);
486 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
487 void                WM_drag_free(struct wmDrag *drag);
488 void                WM_drag_free_list(struct ListBase *lb);
489
490 struct wmDropBox        *WM_dropbox_add(
491         ListBase *lb, const char *idname,
492         bool (*poll)(struct bContext *, struct wmDrag *, const struct wmEvent *event, const char **),
493         void (*copy)(struct wmDrag *, struct wmDropBox *));
494 ListBase        *WM_dropboxmap_find(const char *idname, int spaceid, int regionid);
495
496                         /* ID drag and drop */
497 void                WM_drag_add_ID(struct wmDrag *drag, struct ID *id, struct ID *from_parent);
498 struct ID          *WM_drag_ID(const struct wmDrag *drag, short idcode);
499 struct ID          *WM_drag_ID_from_event(const struct wmEvent *event, short idcode);
500
501                         /* Set OpenGL viewport and scissor */
502 void            wmViewport(const struct rcti *rect);
503 void            wmPartialViewport(rcti *drawrct, const rcti *winrct, const rcti *partialrct);
504 void            wmWindowViewport(struct wmWindow *win);
505
506                         /* OpenGL utilities with safety check */
507 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
508                         /* use for conventions (avoid hard-coded offsets all over) */
509 void            wmOrtho2_region_pixelspace(const struct ARegion *ar);
510 void            wmOrtho2_pixelspace(const float x, const float y);
511 void            wmGetProjectionMatrix(float mat[4][4], const struct rcti *winrct);
512
513                         /* threaded Jobs Manager */
514 enum {
515         WM_JOB_PRIORITY     = (1 << 0),
516         WM_JOB_EXCL_RENDER  = (1 << 1),
517         WM_JOB_PROGRESS     = (1 << 2),
518         WM_JOB_SUSPEND      = (1 << 3),
519 };
520
521 /* identifying jobs by owner alone is unreliable, this isnt saved, order can change (keep 0 for 'any') */
522 enum {
523         WM_JOB_TYPE_ANY = 0,
524         WM_JOB_TYPE_COMPOSITE,
525         WM_JOB_TYPE_RENDER,
526         WM_JOB_TYPE_RENDER_PREVIEW,  /* UI preview */
527         WM_JOB_TYPE_OBJECT_SIM_OCEAN,
528         WM_JOB_TYPE_OBJECT_SIM_FLUID,
529         WM_JOB_TYPE_OBJECT_BAKE_TEXTURE,
530         WM_JOB_TYPE_OBJECT_BAKE,
531         WM_JOB_TYPE_FILESEL_READDIR,
532         WM_JOB_TYPE_CLIP_BUILD_PROXY,
533         WM_JOB_TYPE_CLIP_TRACK_MARKERS,
534         WM_JOB_TYPE_CLIP_SOLVE_CAMERA,
535         WM_JOB_TYPE_CLIP_PREFETCH,
536         WM_JOB_TYPE_SEQ_BUILD_PROXY,
537         WM_JOB_TYPE_SEQ_BUILD_PREVIEW,
538         WM_JOB_TYPE_POINTCACHE,
539         WM_JOB_TYPE_DPAINT_BAKE,
540         WM_JOB_TYPE_ALEMBIC,
541         WM_JOB_TYPE_SHADER_COMPILATION,
542         WM_JOB_TYPE_STUDIOLIGHT,
543         WM_JOB_TYPE_LIGHT_BAKE,
544         /* add as needed, screencast, seq proxy build
545          * if having hard coded values is a problem */
546 };
547
548 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, const char *name, int flag, int job_type);
549
550 bool        WM_jobs_test(struct wmWindowManager *wm, void *owner, int job_type);
551 float           WM_jobs_progress(struct wmWindowManager *wm, void *owner);
552 char       *WM_jobs_name(struct wmWindowManager *wm, void *owner);
553 double      WM_jobs_starttime(struct wmWindowManager *wm, void *owner);
554 void       *WM_jobs_customdata(struct wmWindowManager *wm, void *owner);
555 void       *WM_jobs_customdata_from_type(struct wmWindowManager *wm, int job_type);
556
557 bool        WM_jobs_is_running(struct wmJob *);
558 bool            WM_jobs_is_stopped(wmWindowManager *wm, void *owner);
559 void       *WM_jobs_customdata_get(struct wmJob *);
560 void        WM_jobs_customdata_set(struct wmJob *, void *customdata, void (*free)(void *));
561 void        WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
562 void        WM_jobs_callbacks(struct wmJob *,
563                               void (*startjob)(void *, short *, short *, float *),
564                               void (*initjob)(void *),
565                               void (*update)(void *),
566                               void (*endjob)(void *));
567
568 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
569 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner, void *startjob);
570 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner, void (*)(void *, short int *, short int *, float *));
571 void            WM_jobs_kill_all(struct wmWindowManager *wm);
572 void            WM_jobs_kill_all_except(struct wmWindowManager *wm, void *owner);
573 void            WM_jobs_kill_type(struct wmWindowManager *wm, void *owner, int job_type);
574
575 bool        WM_jobs_has_running(struct wmWindowManager *wm);
576
577 void            WM_job_main_thread_lock_acquire(struct wmJob *job);
578 void            WM_job_main_thread_lock_release(struct wmJob *job);
579
580                         /* clipboard */
581 char       *WM_clipboard_text_get(bool selection, int *r_len);
582 char       *WM_clipboard_text_get_firstline(bool selection, int *r_len);
583 void        WM_clipboard_text_set(const char *buf, bool selection);
584
585                         /* progress */
586 void            WM_progress_set(struct wmWindow *win, float progress);
587 void            WM_progress_clear(struct wmWindow *win);
588
589                         /* Draw (for screenshot) */
590 void        *WM_draw_cb_activate(
591                     struct wmWindow *win,
592                     void (*draw)(const struct wmWindow *, void *),
593                     void *customdata);
594 void        WM_draw_cb_exit(struct wmWindow *win, void *handle);
595 void            WM_redraw_windows(struct bContext *C);
596
597                         /* Region drawing */
598 void                WM_draw_region_free(struct ARegion *ar);
599 struct GPUViewport *WM_draw_region_get_viewport(struct ARegion *ar, int view);
600 struct GPUViewport *WM_draw_region_get_bound_viewport(struct ARegion *ar);
601
602 void        WM_main_playanim(int argc, const char **argv);
603
604 /* debugging only, convenience function to write on crash */
605 bool write_crash_blend(void);
606
607                         /* Lock the interface for any communication */
608 void        WM_set_locked_interface(struct wmWindowManager *wm, bool lock);
609
610 #ifdef WITH_INPUT_NDOF
611 void        WM_event_ndof_pan_get(const struct wmNDOFMotionData *ndof, float r_pan[3], const bool use_zoom);
612 void        WM_event_ndof_rotate_get(const struct wmNDOFMotionData *ndof, float r_rot[3]);
613
614 float       WM_event_ndof_to_axis_angle(const struct wmNDOFMotionData *ndof, float axis[3]);
615 void        WM_event_ndof_to_quat(const struct wmNDOFMotionData *ndof, float q[4]);
616 #endif /* WITH_INPUT_NDOF */
617
618 float       WM_event_tablet_data(const struct wmEvent *event, int *pen_flip, float tilt[2]);
619 bool        WM_event_is_tablet(const struct wmEvent *event);
620
621 #ifdef WITH_INPUT_IME
622 bool        WM_event_is_ime_switch(const struct wmEvent *event);
623 #endif
624
625 const char *WM_window_cursor_keymap_status_get(const struct wmWindow *win, int button_index, int type_index);
626 void WM_window_cursor_keymap_status_refresh(struct bContext *C, struct wmWindow *win);
627
628 void WM_window_status_area_tag_redraw(struct wmWindow *win);
629 struct ScrArea *WM_window_status_area_find(struct wmWindow *win, struct bScreen *sc);
630 bool WM_window_modal_keymap_status_draw(
631         struct bContext *C, struct wmWindow *win,
632         struct uiLayout *layout);
633
634 /* wm_tooltip.c */
635 typedef struct ARegion *(*wmTooltipInitFn)(
636         struct bContext *C, struct ARegion *ar,
637         int *pass, double *r_pass_delay, bool *r_exit_on_event);
638
639 void WM_tooltip_immediate_init(
640         struct bContext *C, struct wmWindow *win, struct ARegion *ar,
641         wmTooltipInitFn init);
642 void WM_tooltip_timer_init_ex(
643         struct bContext *C, struct wmWindow *win, struct ARegion *ar,
644         wmTooltipInitFn init, double delay);
645 void WM_tooltip_timer_init(
646         struct bContext *C, struct wmWindow *win, struct ARegion *ar,
647         wmTooltipInitFn init);
648 void WM_tooltip_timer_clear(struct bContext *C, struct wmWindow *win);
649 void WM_tooltip_clear(struct bContext *C, struct wmWindow *win);
650 void WM_tooltip_init(struct bContext *C, struct wmWindow *win);
651 void WM_tooltip_refresh(struct bContext *C, struct wmWindow *win);
652 double WM_tooltip_time_closed(void);
653
654 #ifdef __cplusplus
655 }
656 #endif
657
658 #endif /* __WM_API_H__ */