/usr/include/mirclient/mir_toolkit/events/event.h is in libmirclient-dev 0.21.0+16.04.20160330-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 | /*
* Copyright © 2014 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 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/>.
*
* Authored by: Robert Carr <robert.carr@canonical.com>
*/
#ifndef MIR_TOOLKIT_EVENT_H_
#define MIR_TOOLKIT_EVENT_H_
#include <stddef.h>
#include <stdint.h>
#include "mir_toolkit/common.h"
#ifdef __cplusplus
/**
* \addtogroup mir_toolkit
* @{
*/
extern "C" {
#endif
typedef enum
{
mir_event_type_key,
mir_event_type_motion,
mir_event_type_surface,
mir_event_type_resize,
mir_event_type_prompt_session_state_change,
mir_event_type_orientation,
mir_event_type_close_surface,
/* Type for new style input event will be returned from mir_event_get_type
when old style event type was mir_event_type_key or mir_event_type_motion */
mir_event_type_input,
mir_event_type_keymap,
mir_event_type_input_configuration,
mir_event_type_surface_output,
} MirEventType;
typedef struct MirSurfaceEvent MirSurfaceEvent;
typedef struct MirResizeEvent MirResizeEvent;
typedef struct MirPromptSessionEvent MirPromptSessionEvent;
typedef struct MirOrientationEvent MirOrientationEvent;
typedef struct MirCloseSurfaceEvent MirCloseSurfaceEvent;
typedef struct MirInputEvent MirInputEvent;
typedef struct MirKeymapEvent MirKeymapEvent;
typedef struct MirInputConfigurationEvent MirInputConfigurationEvent;
typedef struct MirSurfaceOutputEvent MirSurfaceOutputEvent;
typedef struct MirCookie MirCookie;
typedef union MirEvent MirEvent;
#ifdef __cplusplus
}
/**@}*/
#endif
#include "mir_toolkit/events/input/input_event.h"
#include "mir_toolkit/events/resize_event.h"
#include "mir_toolkit/events/surface_event.h"
#include "mir_toolkit/events/orientation_event.h"
#include "mir_toolkit/events/prompt_session_event.h"
#include "mir_toolkit/events/keymap_event.h"
#include "mir_toolkit/events/input_configuration_event.h"
#include "mir_toolkit/events/surface_output_event.h"
#ifdef __cplusplus
/**
* \addtogroup mir_toolkit
* @{
*/
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* ev);
/**
* 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* ev);
/**
* Retrieve the MirSurfaceEvent associated with a MirEvent of
* type mir_event_type_surface. See <mir_toolkit/events/surface_event.h>
* for accessors.
*
* \param [in] event The event
* \return The associated MirSurfaceEvent
*/
MirSurfaceEvent const* mir_event_get_surface_event(MirEvent const* ev);
/**
* 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* ev);
/**
* 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* ev);
/**
* 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* ev);
/**
* Retrieve the MirCloseSurfaceEvent associated with a MirEvent of
* type mir_event_type_close_surface. The event is a request to close
* the surface it is delivered to and has no accessors.
*
* \deprecated Use of this function is pointless as there is no way to use the
* return value.
*
* \todo This should be removed from the public API at the next API break.
*
* \param [in] event The event
* \return The associated MirCloseSurfaceEvent
*/
__attribute__ ((deprecated))
MirCloseSurfaceEvent const* mir_event_get_close_surface_event(MirEvent const* ev);
/**
* Retrieve the MirKeymapEvent associated with a MirEvent of
* type mir_event_type_keymap. The event signifies that the keymap
* applied for the relevant surface has changed.
*
* \param [in] event The event
* \return The associated MirKeymapEvent
*/
MirKeymapEvent const* mir_event_get_keymap_event(MirEvent const* ev);
/**
* Retrieve the MirInputConfiguration associated with a MirEvent of
* type mir_event_type_input_configuration. The event signifies that the
* input device configuration has changed.
*
* \param [in] event The event
* \return The associated MirInputConfigurationEvent
*/
MirInputConfigurationEvent const* mir_event_get_input_configuration_event(MirEvent const* ev);
/**
* Retrieve the MirSurfaceOutputEvent associated with a MirEvent of type
* mir_event_type_surface_output. The event signifies that the properties
* of the output the surface is displayed upon have changed.
*
* A MirSurfaceOutputEvent is generated either when the properties of the
* output the surface is primarily on change (for example: by user configuration
* of resolution) or when the output the surface is primarily on changes
* (for example: when a user moves the surface from one monitor to another).
*
* \param [in] event The event
* \return The associated MirSurfaceOutputEvent
*/
MirSurfaceOutputEvent const* mir_event_get_surface_output_event(MirEvent const* ev);
/*
*
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
* _________________________
*< Don't use mir_event_ref >
*-------------------------
* \ ^__^
* \ (oo)\_______
* (__)\ )\/\
* ||----w |
* || ||
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
* NOTICE: mir_event_ref and mir_event_unref are implemented in terms of copy until
* such point whereas direct MirEvent access as 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] The event to reference
* \return The event pointer to now use
*/
MirEvent const* mir_event_ref(MirEvent const* ev) __attribute__((warn_unused_result));
/**
* Release a reference to a MirEvent.
*
* \param[in] The event to un-reference
*/
void mir_event_unref(MirEvent const* ev);
#ifdef __cplusplus
}
/**@}*/
#endif
#endif /* MIR_TOOLKIT_EVENT_H_ */
|