wm_event_system.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2007 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "WM_api.hh"
 
struct ARegion;
struct bToolRef;
struct GHOST_TabletData;
struct ScrArea;
struct wmEvent;
struct wmKeyMap;
struct wmKeyMapItem;
enum wmOperatorCallContext;
 
#ifdef WITH_XR_OPENXR
struct wmXrActionData;
#endif
 
/* #wmKeyMap is in `DNA_windowmanager.h`, it's saveable. */
 
enum eWM_EventHandlerType {
  WM_HANDLER_TYPE_GIZMO = 1,
  WM_HANDLER_TYPE_UI,
  WM_HANDLER_TYPE_OP,
  WM_HANDLER_TYPE_DROPBOX,
  WM_HANDLER_TYPE_KEYMAP,
};
 
using EventHandlerPoll = bool (*)(const ARegion *region, const wmEvent *event);
 
struct wmEventHandler {
  wmEventHandler *next, *prev;
 
  eWM_EventHandlerType type;
  eWM_EventHandlerFlag flag;
 
  EventHandlerPoll poll;
};
 
struct wmEventHandler_KeymapPost {
  void (*post_fn)(wmKeyMap *keymap, wmKeyMapItem *kmi, void *user_data);
  void *user_data;
};
 
struct wmEventHandler_KeymapDynamic {
  wmEventHandler_KeymapDynamicFn keymap_fn;
  void *user_data;
};
 
struct wmEventHandler_Keymap {
  wmEventHandler head;
 
  wmKeyMap *keymap;
 
  wmEventHandler_KeymapPost post;
  wmEventHandler_KeymapDynamic dynamic;
 
  bToolRef *keymap_tool;
};
 
struct wmEventHandler_Gizmo {
  wmEventHandler head;
 
  struct wmGizmoMap *gizmo_map;
};
 
struct wmEventHandler_UI {
  wmEventHandler head;
 
  wmUIHandlerFunc handle_fn;
  wmUIHandlerRemoveFunc remove_fn;
  void *user_data;
 
  struct {
    ScrArea *area;
    ARegion *region;
    ARegion *region_popup;
  } context;
};
 
struct wmEventHandler_Op {
  wmEventHandler head;
 
  wmOperator *op;
 
  bool is_fileselect;
 
  struct {
    /* To override the window, and hence the screen. Set for few cases only, usually window/screen
     * can be taken from current context. */
    wmWindow *win;
 
    ScrArea *area;
    ARegion *region;
    short region_type;
  } context;
};
 
struct wmEventHandler_Dropbox {
  wmEventHandler head;
 
  ListBase *dropboxes;
};
 
/* `wm_event_system.cc` */
 
void wm_event_free_all(wmWindow *win);
void wm_event_free(wmEvent *event);
void wm_event_free_handler(wmEventHandler *handler);
 
void wm_event_do_handlers(bContext *C);
 
void wm_event_add_ghostevent(wmWindowManager *wm,
                             wmWindow *win,
                             int type,
                             const void *customdata,
                             const uint64_t event_time_ms);
#ifdef WITH_XR_OPENXR
void wm_event_add_xrevent(wmWindow *win, wmXrActionData *actiondata, short val);
#endif
 
void wm_event_do_depsgraph(bContext *C, bool is_after_open_file);
void wm_event_do_refresh_wm_and_depsgraph(bContext *C);
void wm_event_do_notifiers(bContext *C);
 
void wm_event_handler_ui_cancel_ex(bContext *C,
                                   wmWindow *win,
                                   ARegion *region,
                                   bool reactivate_button);
 
/* `wm_event_query.cc`. */
 
float wm_pressure_curve(float raw_pressure);
void wm_tablet_data_from_ghost(const GHOST_TabletData *tablet_data, wmTabletData *wmtab);
 
/* `wm_dropbox.cc`. */
 
void wm_dropbox_free();
void wm_drags_exit(wmWindowManager *wm, wmWindow *win);
void wm_drop_prepare(bContext *C, wmDrag *drag, wmDropBox *drop);
void wm_drop_end(bContext *C, wmDrag *drag, wmDropBox *drop);
void wm_drags_check_ops(bContext *C, const wmEvent *event);
wmOperatorCallContext wm_drop_operator_context_get(const wmDropBox *drop);
void wm_drags_draw(bContext *C, wmWindow *win);