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