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