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