1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/* SPDX-License-Identifier: GPL-2.0-or-later
* Copyright 2007 Blender Foundation. All rights reserved. */
/** \file
* \ingroup wm
*/
#pragma once
/* return value of handler-operator call */
#define WM_HANDLER_CONTINUE 0
#define WM_HANDLER_BREAK 1
#define WM_HANDLER_HANDLED 2
#define WM_HANDLER_MODAL 4 /* MODAL|BREAK means unhandled */
struct ARegion;
struct GHOST_TabletData;
struct ScrArea;
enum wmOperatorCallContext;
#ifdef WITH_XR_OPENXR
struct wmXrActionData;
#endif
#ifdef __cplusplus
extern "C" {
#endif
/* wmKeyMap is in DNA_windowmanager.h, it's saveable */
/** Custom types for handlers, for signaling, freeing */
enum eWM_EventHandlerType {
WM_HANDLER_TYPE_GIZMO = 1,
WM_HANDLER_TYPE_UI,
WM_HANDLER_TYPE_OP,
WM_HANDLER_TYPE_DROPBOX,
WM_HANDLER_TYPE_KEYMAP,
};
typedef bool (*EventHandlerPoll)(const ARegion *region, const wmEvent *event);
typedef struct wmEventHandler {
struct wmEventHandler *next, *prev;
enum eWM_EventHandlerType type;
char flag; /* WM_HANDLER_BLOCKING, ... */
EventHandlerPoll poll;
} wmEventHandler;
/** Run after the keymap item runs. */
struct wmEventHandler_KeymapPost {
void (*post_fn)(wmKeyMap *keymap, wmKeyMapItem *kmi, void *user_data);
void *user_data;
};
/** Support for a getter function that looks up the keymap each access. */
struct wmEventHandler_KeymapDynamic {
wmEventHandler_KeymapDynamicFn *keymap_fn;
void *user_data;
};
/** #WM_HANDLER_TYPE_KEYMAP */
typedef struct wmEventHandler_Keymap {
wmEventHandler head;
/** Pointer to builtin/custom keymaps (never NULL). */
wmKeyMap *keymap;
struct wmEventHandler_KeymapPost post;
struct wmEventHandler_KeymapDynamic dynamic;
struct bToolRef *keymap_tool;
} wmEventHandler_Keymap;
/** #WM_HANDLER_TYPE_GIZMO */
typedef struct wmEventHandler_Gizmo {
wmEventHandler head;
/** Gizmo handler (never NULL). */
struct wmGizmoMap *gizmo_map;
} wmEventHandler_Gizmo;
/** #WM_HANDLER_TYPE_UI */
typedef struct wmEventHandler_UI {
wmEventHandler head;
wmUIHandlerFunc handle_fn; /* callback receiving events */
wmUIHandlerRemoveFunc remove_fn; /* callback when handler is removed */
void *user_data; /* user data pointer */
/** Store context for this handler for derived/modal handlers. */
struct {
struct ScrArea *area;
struct ARegion *region;
struct ARegion *menu;
} context;
} wmEventHandler_UI;
/** #WM_HANDLER_TYPE_OP */
typedef struct wmEventHandler_Op {
wmEventHandler head;
/** Operator can be NULL. */
wmOperator *op;
/** Hack, special case for file-select. */
bool is_fileselect;
/** Store context for this handler for derived/modal handlers. */
struct {
/* To override the window, and hence the screen. Set for few cases only, usually window/screen
* can be taken from current context. */
struct wmWindow *win;
struct ScrArea *area;
struct ARegion *region;
short region_type;
} context;
} wmEventHandler_Op;
/** #WM_HANDLER_TYPE_DROPBOX */
typedef struct wmEventHandler_Dropbox {
wmEventHandler head;
/** Never NULL. */
ListBase *dropboxes;
} wmEventHandler_Dropbox;
/* wm_event_system.c */
void wm_event_free_all(wmWindow *win);
void wm_event_free(wmEvent *event);
void wm_event_free_handler(wmEventHandler *handler);
/**
* Goes over entire hierarchy: events -> window -> screen -> area -> region.
*
* \note Called in main loop.
*/
void wm_event_do_handlers(bContext *C);
/**
* Windows store own event queues #wmWindow.event_queue (no #bContext here).
*/
void wm_event_add_ghostevent(wmWindowManager *wm, wmWindow *win, int type, void *customdata);
#ifdef WITH_XR_OPENXR
void wm_event_add_xrevent(wmWindow *win, struct wmXrActionData *actiondata, short val);
#endif
void wm_event_do_depsgraph(bContext *C, bool is_after_open_file);
/**
* Was part of #wm_event_do_notifiers,
* split out so it can be called once before entering the #WM_main loop.
* This ensures operators don't run before the UI and depsgraph are initialized.
*/
void wm_event_do_refresh_wm_and_depsgraph(bContext *C);
/**
* Called in main-loop.
*/
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.c */
/**
* Applies the global tablet pressure correction curve.
*/
float wm_pressure_curve(float raw_pressure);
void wm_tablet_data_from_ghost(const struct GHOST_TabletData *tablet_data, wmTabletData *wmtab);
/* wm_dropbox.c */
void wm_dropbox_free(void);
/**
* Additional work to cleanly end dragging. Additional because this doesn't actually remove the
* drag items. Should be called whenever dragging is stopped
* (successful or not, also when canceled).
*/
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);
/**
* Called in inner handler loop, region context.
*/
void wm_drags_check_ops(bContext *C, const wmEvent *event);
/**
* The operator of a dropbox should always be executed in the context determined by the mouse
* coordinates. The dropbox poll should check the context area and region as needed.
* So this always returns #WM_OP_INVOKE_DEFAULT.
*/
wmOperatorCallContext wm_drop_operator_context_get(const wmDropBox *drop);
/**
* Called in #wm_draw_window_onscreen.
*/
void wm_drags_draw(bContext *C, wmWindow *win);
#ifdef __cplusplus
}
#endif
|
