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
|
/*
* Copyright © Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 2 or 3,
* as published by the Free Software Foundation.
*
* 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MIR_TOOLKIT_EVENT_H_
#define MIR_TOOLKIT_EVENT_H_
#include <mir_toolkit/events/enums.h>
#include <stddef.h>
#include <stdint.h>
#include "mir_toolkit/common.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef struct MirWindowEvent MirWindowEvent;
typedef struct MirResizeEvent MirResizeEvent;
typedef struct MirPromptSessionEvent MirPromptSessionEvent;
typedef struct MirOrientationEvent MirOrientationEvent;
typedef struct MirCloseWindowEvent MirCloseWindowEvent;
typedef struct MirInputEvent MirInputEvent;
typedef struct MirWindowOutputEvent MirWindowOutputEvent;
typedef struct MirInputDeviceStateEvent MirInputDeviceStateEvent;
typedef struct MirWindowPlacementEvent MirWindowPlacementEvent;
typedef struct MirEvent MirEvent;
#ifdef __cplusplus
}
#endif
#include "mir_toolkit/events/input/input_event.h"
#include "mir_toolkit/events/resize_event.h"
#include "mir_toolkit/events/window_event.h"
#include "mir_toolkit/events/orientation_event.h"
#include "mir_toolkit/events/prompt_session_event.h"
#include "mir_toolkit/events/window_output_event.h"
#include "mir_toolkit/events/input_device_state_event.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* Retrieves the type of a MirEvent. Now preferred over direct access to ev->type.
* In particular ev->type will never be mir_event_type_input and mir_event_get_type
* is the only way to ensure mir_event_get_input_event will succeed.
*
* \param [in] event The event
* \return The event type
*/
MirEventType mir_event_get_type(MirEvent const* event);
/**
* Retrieve the MirInputEvent associated with a MirEvent of
* type mir_event_type_input. See <mir_toolkit/events/input/input_event.h>
* for accessors.
*
* \param [in] event The event
* \return The associated MirInputEvent
*/
MirInputEvent const* mir_event_get_input_event(MirEvent const* event);
/**
* Retrieve the MirWindowEvent associated with a MirEvent of
* type mir_event_type_window. See <mir_toolkit/events/surface_event.h>
* for accessors.
*
* \param [in] event The event
* \return The associated MirWindowEvent
*/
MirWindowEvent const* mir_event_get_window_event(MirEvent const* event);
/**
* Retrieve the MirResizeEvent associated with a MirEvent of
* type mir_event_type_resize. See <mir_toolkits/events/resize_event.h>
* for accessors.
*
* \param [in] event The event
* \return The associated MirResizeEvent
*/
MirResizeEvent const* mir_event_get_resize_event(MirEvent const* event);
/**
* Retrieve the MirPromptSessionEvent associated with a MirEvent of
* type mir_event_type_prompt_session_state_change. See <mir_toolkits/events/prompt_session_event.h>
* for accessors.
*
* \param [in] event The event
* \return The associated MirPromptSessionEvent
*/
MirPromptSessionEvent const* mir_event_get_prompt_session_event(MirEvent const* event);
/**
* Retrieve the MirOrientationEvent associated with a MirEvent of
* type mir_event_type_orientation. See <mir_toolkit/events/orientation_event.h>
* for accessors.
*
* \param [in] event The event
* \return The associated MirOrientationEvent
*/
MirOrientationEvent const* mir_event_get_orientation_event(MirEvent const* event);
/**
* Retrieve the MirWindowOutputEvent associated with a MirEvent of type
* mir_event_type_window_output. The event signifies that the properties
* of the output the window is displayed upon have changed.
*
* A MirWindowOutputEvent is generated either when the properties of the
* output the window is primarily on change (for example: by user configuration
* of resolution) or when the output the window is primarily on changes
* (for example: when a user moves the window from one monitor to another).
*
* \param [in] event The event
* \return The associated MirWindowOutputEvent
*/
MirWindowOutputEvent const* mir_event_get_window_output_event(MirEvent const* event);
/**
* Retrieve the MirInputDeviceStateEvent associated with a MirEvent of
* type mir_event_type_input_device_state. The event signifies that the
* client has not received the most recent input events, and thus receives
* a state update for all attached devices.
*
* \param [in] event The event
* \return The associated MirInputConfigurationEvent
*/
MirInputDeviceStateEvent const* mir_event_get_input_device_state_event(MirEvent const* event);
/**
* Retrieve the MirWindowPlacementEvent associated with a MirEvent of
* type mir_event_type_window_placement. The event signifies that the
* the server has fulfilled a request for relative window placement.
*
* \param [in] event The event
* \return The associated MirWindowPlacementEvent
*/
MirWindowPlacementEvent const* mir_event_get_window_placement_event(MirEvent const* event);
/*
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
* _________________________
*< Don't use mir_event_ref >
* -------------------------
* \ ^__^
* \ (oo)\_______
* (__)\ )\/\
* ||----w |
* || ||
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
* NOTICE: mir_event_ref and mir_event_unref are implemented in terms of copy
* until such time that direct MirEvent access is deprecated. This means you
* must use the return value as your new reference.
*/
/**
* Reference this MirEvent and return a pointer to the
* newly referenced instance
*
* \param[in] event The event to reference
* \return The event pointer to now use
*/
[[deprecated("Not meaningful: legacy of mirclient API")]]
MirEvent const* mir_event_ref(MirEvent const* event) __attribute__((warn_unused_result));
/**
* Release a reference to a MirEvent.
*
* \param[in] event The event to un-reference
*/
[[deprecated("Not meaningful: legacy of mirclient API")]]
void mir_event_unref(MirEvent const* event);
#ifdef __cplusplus
}
#endif
#endif /* MIR_TOOLKIT_EVENT_H_ */
|
