Welcome to mirror list, hosted at ThFree Co, Russian Federation.

wm_event_system.h « windowmanager « blender « source - git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 9448bba9f3b6928cfc8d1b7701bf91cbde4274eb (plain)
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
/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2007 Blender Foundation.
 * All rights reserved.
 */

/** \file
 * \ingroup wm
 */

#ifndef __WM_EVENT_SYSTEM_H__
#define __WM_EVENT_SYSTEM_H__

/* 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 ScrArea;

/* wmKeyMap is in DNA_windowmanager.h, it's saveable */

struct wmEventHandler_KeymapFn {
	void (*handle_post_fn)(wmKeyMap *keymap, wmKeyMapItem *kmi, void *user_data);
	void  *user_data;
};

/** Custom types for handlers, for signaling, freeing */
enum eWM_EventHandlerType {
	WM_HANDLER_TYPE_DEFAULT,
	WM_HANDLER_TYPE_GIZMO,
	WM_HANDLER_TYPE_UI,
	WM_HANDLER_TYPE_OP,
	WM_HANDLER_TYPE_DROPBOX,
};

typedef struct wmEventHandler {
	struct wmEventHandler *next, *prev;

	enum eWM_EventHandlerType type;
	char flag;                          /* WM_HANDLER_BLOCKING, ... */

	/* keymap handler */
	wmKeyMap *keymap;                   /* pointer to builtin/custom keymaps */
	const rcti *bblocal, *bbwin;              /* optional local and windowspace bb */
	/* Run after the keymap item runs. */
	struct wmEventHandler_KeymapFn keymap_callback;

	struct bToolRef *keymap_tool;
} wmEventHandler;

/** #WM_HANDLER_TYPE_GIZMO */
typedef struct wmEventHandler_Gizmo {
	wmEventHandler base;

	/** Gizmo handler (never NULL). */
	struct wmGizmoMap *gizmo_map;
} wmEventHandler_Gizmo;

/** #WM_HANDLER_TYPE_UI */
typedef struct wmEventHandler_UI {
	wmEventHandler base;

	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 base;

	/** 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 {
		struct ScrArea *area;
		struct ARegion *region;
		short           region_type;
	} context;
} wmEventHandler_Op;

/** #WM_HANDLER_TYPE_DROPBOX */
typedef struct wmEventHandler_Dropbox {
	wmEventHandler base;

	/** 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 */
void        wm_event_do_handlers    (bContext *C);

void        wm_event_add_ghostevent (wmWindowManager *wm, wmWindow *win, int type, int time, void *customdata);

void        wm_event_do_depsgraph(bContext *C);
void        wm_event_do_refresh_wm_and_depsgraph(bContext *C);
void        wm_event_do_notifiers(bContext *C);

float       wm_pressure_curve(float raw_pressure);

/* wm_keymap.c */

/* wm_dropbox.c */
void        wm_dropbox_free(void);
void        wm_drags_check_ops(bContext *C, const wmEvent *event);
void        wm_drags_draw(bContext *C, wmWindow *win, rcti *rect);

#endif /* __WM_EVENT_SYSTEM_H__ */