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