blob: 3b36d2e80c540190bcc6f600a9d85b6e6a175f53 [file] [log] [blame]
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070017/**
18 * @addtogroup Input
19 * @{
20 */
21
22/**
23 * @file input.h
24 */
25
Mathias Agopiane1c61d32012-03-23 14:19:36 -070026#ifndef _ANDROID_INPUT_H
27#define _ANDROID_INPUT_H
28
Dan Albert494ed552016-09-23 15:57:45 -070029#include <sys/cdefs.h>
30
Mathias Agopiane1c61d32012-03-23 14:19:36 -070031/******************************************************************
32 *
33 * IMPORTANT NOTICE:
34 *
35 * This file is part of Android's set of stable system headers
36 * exposed by the Android NDK (Native Development Kit).
37 *
38 * Third-party source AND binary code relies on the definitions
39 * here to be FROZEN ON ALL UPCOMING PLATFORM RELEASES.
40 *
41 * - DO NOT MODIFY ENUMS (EXCEPT IF YOU ADD NEW 32-BIT VALUES)
42 * - DO NOT MODIFY CONSTANTS OR FUNCTIONAL MACROS
43 * - DO NOT CHANGE THE SIGNATURE OF FUNCTIONS IN ANY WAY
44 * - DO NOT CHANGE THE LAYOUT OR SIZE OF STRUCTURES
45 */
46
47/*
48 * Structures and functions to receive and process input events in
49 * native code.
50 *
51 * NOTE: These functions MUST be implemented by /system/lib/libui.so
52 */
53
54#include <stdint.h>
55#include <sys/types.h>
56#include <android/keycodes.h>
57#include <android/looper.h>
58
Elliott Hughes9db409b2018-06-18 12:28:46 -070059#if !defined(__INTRODUCED_IN)
60#define __INTRODUCED_IN(__api_level) /* nothing */
61#endif
62
Mathias Agopiane1c61d32012-03-23 14:19:36 -070063#ifdef __cplusplus
64extern "C" {
65#endif
66
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070067/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -070068 * Key states (may be returned by queries about the current state of a
69 * particular key code, scan code or switch).
70 */
71enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070072 /** The key state is unknown or the requested key itself is not supported. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070073 AKEY_STATE_UNKNOWN = -1,
74
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070075 /** The key is up. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070076 AKEY_STATE_UP = 0,
77
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070078 /** The key is down. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070079 AKEY_STATE_DOWN = 1,
80
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070081 /** The key is down but is a virtual key press that is being emulated by the system. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070082 AKEY_STATE_VIRTUAL = 2
83};
84
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070085/**
Siarhei Vishniakou61fafdd2018-04-13 11:00:58 -050086 * Meta key / modifier state.
Mathias Agopiane1c61d32012-03-23 14:19:36 -070087 */
88enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070089 /** No meta keys are pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070090 AMETA_NONE = 0,
91
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070092 /** This mask is used to check whether one of the ALT meta keys is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070093 AMETA_ALT_ON = 0x02,
94
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070095 /** This mask is used to check whether the left ALT meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070096 AMETA_ALT_LEFT_ON = 0x10,
97
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070098 /** This mask is used to check whether the right ALT meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070099 AMETA_ALT_RIGHT_ON = 0x20,
100
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700101 /** This mask is used to check whether one of the SHIFT meta keys is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700102 AMETA_SHIFT_ON = 0x01,
103
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700104 /** This mask is used to check whether the left SHIFT meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700105 AMETA_SHIFT_LEFT_ON = 0x40,
106
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700107 /** This mask is used to check whether the right SHIFT meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700108 AMETA_SHIFT_RIGHT_ON = 0x80,
109
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700110 /** This mask is used to check whether the SYM meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700111 AMETA_SYM_ON = 0x04,
112
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700113 /** This mask is used to check whether the FUNCTION meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700114 AMETA_FUNCTION_ON = 0x08,
115
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700116 /** This mask is used to check whether one of the CTRL meta keys is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700117 AMETA_CTRL_ON = 0x1000,
118
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700119 /** This mask is used to check whether the left CTRL meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700120 AMETA_CTRL_LEFT_ON = 0x2000,
121
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700122 /** This mask is used to check whether the right CTRL meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700123 AMETA_CTRL_RIGHT_ON = 0x4000,
124
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700125 /** This mask is used to check whether one of the META meta keys is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700126 AMETA_META_ON = 0x10000,
127
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700128 /** This mask is used to check whether the left META meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700129 AMETA_META_LEFT_ON = 0x20000,
130
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700131 /** This mask is used to check whether the right META meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700132 AMETA_META_RIGHT_ON = 0x40000,
133
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700134 /** This mask is used to check whether the CAPS LOCK meta key is on. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700135 AMETA_CAPS_LOCK_ON = 0x100000,
136
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700137 /** This mask is used to check whether the NUM LOCK meta key is on. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700138 AMETA_NUM_LOCK_ON = 0x200000,
139
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700140 /** This mask is used to check whether the SCROLL LOCK meta key is on. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700141 AMETA_SCROLL_LOCK_ON = 0x400000,
142};
143
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700144struct AInputEvent;
145/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700146 * Input events.
147 *
148 * Input events are opaque structures. Use the provided accessors functions to
149 * read their properties.
150 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700151typedef struct AInputEvent AInputEvent;
152
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700153/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700154 * Input event types.
155 */
156enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700157 /** Indicates that the input event is a key event. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700158 AINPUT_EVENT_TYPE_KEY = 1,
159
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700160 /** Indicates that the input event is a motion event. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700161 AINPUT_EVENT_TYPE_MOTION = 2
162};
163
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700164/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700165 * Key event actions.
166 */
167enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700168 /** The key has been pressed down. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700169 AKEY_EVENT_ACTION_DOWN = 0,
170
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700171 /** The key has been released. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700172 AKEY_EVENT_ACTION_UP = 1,
173
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700174 /**
175 * Multiple duplicate key events have occurred in a row, or a
176 * complex string is being delivered. The repeat_count property
177 * of the key event contains the number of times the given key
178 * code should be executed.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700179 */
180 AKEY_EVENT_ACTION_MULTIPLE = 2
181};
182
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700183/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700184 * Key event flags.
185 */
186enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700187 /** This mask is set if the device woke because of this key event. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700188 AKEY_EVENT_FLAG_WOKE_HERE = 0x1,
189
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700190 /** This mask is set if the key event was generated by a software keyboard. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700191 AKEY_EVENT_FLAG_SOFT_KEYBOARD = 0x2,
192
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700193 /** This mask is set if we don't want the key event to cause us to leave touch mode. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700194 AKEY_EVENT_FLAG_KEEP_TOUCH_MODE = 0x4,
195
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700196 /**
197 * This mask is set if an event was known to come from a trusted
198 * part of the system. That is, the event is known to come from
199 * the user, and could not have been spoofed by a third party
200 * component.
201 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700202 AKEY_EVENT_FLAG_FROM_SYSTEM = 0x8,
203
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700204 /**
205 * This mask is used for compatibility, to identify enter keys that are
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700206 * coming from an IME whose enter key has been auto-labelled "next" or
207 * "done". This allows TextView to dispatch these as normal enter keys
208 * for old applications, but still do the appropriate action when
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700209 * receiving them.
210 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700211 AKEY_EVENT_FLAG_EDITOR_ACTION = 0x10,
212
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700213 /**
214 * When associated with up key events, this indicates that the key press
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700215 * has been canceled. Typically this is used with virtual touch screen
216 * keys, where the user can slide from the virtual key area on to the
217 * display: in that case, the application will receive a canceled up
218 * event and should not perform the action normally associated with the
219 * key. Note that for this to work, the application can not perform an
220 * action for a key until it receives an up or the long press timeout has
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700221 * expired.
222 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700223 AKEY_EVENT_FLAG_CANCELED = 0x20,
224
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700225 /**
226 * This key event was generated by a virtual (on-screen) hard key area.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700227 * Typically this is an area of the touchscreen, outside of the regular
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700228 * display, dedicated to "hardware" buttons.
229 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700230 AKEY_EVENT_FLAG_VIRTUAL_HARD_KEY = 0x40,
231
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700232 /**
233 * This flag is set for the first key repeat that occurs after the
234 * long press timeout.
235 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700236 AKEY_EVENT_FLAG_LONG_PRESS = 0x80,
237
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700238 /**
239 * Set when a key event has AKEY_EVENT_FLAG_CANCELED set because a long
240 * press action was executed while it was down.
241 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700242 AKEY_EVENT_FLAG_CANCELED_LONG_PRESS = 0x100,
243
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700244 /**
245 * Set for AKEY_EVENT_ACTION_UP when this event's key code is still being
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700246 * tracked from its initial down. That is, somebody requested that tracking
247 * started on the key down and a long press has not caused
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700248 * the tracking to be canceled.
249 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700250 AKEY_EVENT_FLAG_TRACKING = 0x200,
251
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700252 /**
253 * Set when a key event has been synthesized to implement default behavior
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700254 * for an event that the application did not handle.
255 * Fallback key events are generated by unhandled trackball motions
256 * (to emulate a directional keypad) and by certain unhandled key presses
257 * that are declared in the key map (such as special function numeric keypad
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700258 * keys when numlock is off).
259 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700260 AKEY_EVENT_FLAG_FALLBACK = 0x400,
261};
262
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700263/**
264 * Bit shift for the action bits holding the pointer index as
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700265 * defined by AMOTION_EVENT_ACTION_POINTER_INDEX_MASK.
266 */
267#define AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT 8
268
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700269/** Motion event actions */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700270enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700271 /** Bit mask of the parts of the action code that are the action itself. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700272 AMOTION_EVENT_ACTION_MASK = 0xff,
273
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700274 /**
275 * Bits in the action code that represent a pointer index, used with
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700276 * AMOTION_EVENT_ACTION_POINTER_DOWN and AMOTION_EVENT_ACTION_POINTER_UP. Shifting
277 * down by AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT provides the actual pointer
278 * index where the data for the pointer going up or down can be found.
279 */
280 AMOTION_EVENT_ACTION_POINTER_INDEX_MASK = 0xff00,
281
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700282 /** A pressed gesture has started, the motion contains the initial starting location. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700283 AMOTION_EVENT_ACTION_DOWN = 0,
284
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700285 /**
286 * A pressed gesture has finished, the motion contains the final release location
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700287 * as well as any intermediate points since the last down or move event.
288 */
289 AMOTION_EVENT_ACTION_UP = 1,
290
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700291 /**
292 * A change has happened during a press gesture (between AMOTION_EVENT_ACTION_DOWN and
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700293 * AMOTION_EVENT_ACTION_UP). The motion contains the most recent point, as well as
294 * any intermediate points since the last down or move event.
295 */
296 AMOTION_EVENT_ACTION_MOVE = 2,
297
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700298 /**
299 * The current gesture has been aborted.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700300 * You will not receive any more points in it. You should treat this as
301 * an up event, but not perform any action that you normally would.
302 */
303 AMOTION_EVENT_ACTION_CANCEL = 3,
304
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700305 /**
306 * A movement has happened outside of the normal bounds of the UI element.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700307 * This does not provide a full gesture, but only the initial location of the movement/touch.
308 */
309 AMOTION_EVENT_ACTION_OUTSIDE = 4,
310
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700311 /**
312 * A non-primary pointer has gone down.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700313 * The bits in AMOTION_EVENT_ACTION_POINTER_INDEX_MASK indicate which pointer changed.
314 */
315 AMOTION_EVENT_ACTION_POINTER_DOWN = 5,
316
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700317 /**
318 * A non-primary pointer has gone up.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700319 * The bits in AMOTION_EVENT_ACTION_POINTER_INDEX_MASK indicate which pointer changed.
320 */
321 AMOTION_EVENT_ACTION_POINTER_UP = 6,
322
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700323 /**
324 * A change happened but the pointer is not down (unlike AMOTION_EVENT_ACTION_MOVE).
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700325 * The motion contains the most recent point, as well as any intermediate points since
326 * the last hover move event.
327 */
328 AMOTION_EVENT_ACTION_HOVER_MOVE = 7,
329
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700330 /**
331 * The motion event contains relative vertical and/or horizontal scroll offsets.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700332 * Use getAxisValue to retrieve the information from AMOTION_EVENT_AXIS_VSCROLL
333 * and AMOTION_EVENT_AXIS_HSCROLL.
334 * The pointer may or may not be down when this event is dispatched.
335 * This action is always delivered to the winder under the pointer, which
336 * may not be the window currently touched.
337 */
338 AMOTION_EVENT_ACTION_SCROLL = 8,
339
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700340 /** The pointer is not down but has entered the boundaries of a window or view. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700341 AMOTION_EVENT_ACTION_HOVER_ENTER = 9,
342
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700343 /** The pointer is not down but has exited the boundaries of a window or view. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700344 AMOTION_EVENT_ACTION_HOVER_EXIT = 10,
Michael Wright7b159c92015-05-14 14:48:03 +0100345
346 /* One or more buttons have been pressed. */
347 AMOTION_EVENT_ACTION_BUTTON_PRESS = 11,
348
349 /* One or more buttons have been released. */
350 AMOTION_EVENT_ACTION_BUTTON_RELEASE = 12,
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700351};
352
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700353/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700354 * Motion event flags.
355 */
356enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700357 /**
358 * This flag indicates that the window that received this motion event is partly
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700359 * or wholly obscured by another visible window above it. This flag is set to true
360 * even if the event did not directly pass through the obscured area.
361 * A security sensitive application can check this flag to identify situations in which
362 * a malicious application may have covered up part of its content for the purpose
363 * of misleading the user or hijacking touches. An appropriate response might be
364 * to drop the suspect touches or to take additional precautions to confirm the user's
365 * actual intent.
366 */
367 AMOTION_EVENT_FLAG_WINDOW_IS_OBSCURED = 0x1,
368};
369
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700370/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700371 * Motion event edge touch flags.
372 */
373enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700374 /** No edges intersected. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700375 AMOTION_EVENT_EDGE_FLAG_NONE = 0,
376
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700377 /** Flag indicating the motion event intersected the top edge of the screen. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700378 AMOTION_EVENT_EDGE_FLAG_TOP = 0x01,
379
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700380 /** Flag indicating the motion event intersected the bottom edge of the screen. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700381 AMOTION_EVENT_EDGE_FLAG_BOTTOM = 0x02,
382
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700383 /** Flag indicating the motion event intersected the left edge of the screen. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700384 AMOTION_EVENT_EDGE_FLAG_LEFT = 0x04,
385
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700386 /** Flag indicating the motion event intersected the right edge of the screen. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700387 AMOTION_EVENT_EDGE_FLAG_RIGHT = 0x08
388};
389
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700390/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700391 * Constants that identify each individual axis of a motion event.
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700392 * @anchor AMOTION_EVENT_AXIS
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700393 */
394enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700395 /**
396 * Axis constant: X axis of a motion event.
397 *
398 * - For a touch screen, reports the absolute X screen position of the center of
399 * the touch contact area. The units are display pixels.
400 * - For a touch pad, reports the absolute X surface position of the center of the touch
401 * contact area. The units are device-dependent.
402 * - For a mouse, reports the absolute X screen position of the mouse pointer.
403 * The units are display pixels.
404 * - For a trackball, reports the relative horizontal displacement of the trackball.
405 * The value is normalized to a range from -1.0 (left) to 1.0 (right).
406 * - For a joystick, reports the absolute X position of the joystick.
407 * The value is normalized to a range from -1.0 (left) to 1.0 (right).
408 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700409 AMOTION_EVENT_AXIS_X = 0,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700410 /**
411 * Axis constant: Y axis of a motion event.
412 *
413 * - For a touch screen, reports the absolute Y screen position of the center of
414 * the touch contact area. The units are display pixels.
415 * - For a touch pad, reports the absolute Y surface position of the center of the touch
416 * contact area. The units are device-dependent.
417 * - For a mouse, reports the absolute Y screen position of the mouse pointer.
418 * The units are display pixels.
419 * - For a trackball, reports the relative vertical displacement of the trackball.
420 * The value is normalized to a range from -1.0 (up) to 1.0 (down).
421 * - For a joystick, reports the absolute Y position of the joystick.
422 * The value is normalized to a range from -1.0 (up or far) to 1.0 (down or near).
423 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700424 AMOTION_EVENT_AXIS_Y = 1,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700425 /**
426 * Axis constant: Pressure axis of a motion event.
427 *
428 * - For a touch screen or touch pad, reports the approximate pressure applied to the surface
429 * by a finger or other tool. The value is normalized to a range from
430 * 0 (no pressure at all) to 1 (normal pressure), although values higher than 1
431 * may be generated depending on the calibration of the input device.
432 * - For a trackball, the value is set to 1 if the trackball button is pressed
433 * or 0 otherwise.
434 * - For a mouse, the value is set to 1 if the primary mouse button is pressed
435 * or 0 otherwise.
436 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700437 AMOTION_EVENT_AXIS_PRESSURE = 2,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700438 /**
439 * Axis constant: Size axis of a motion event.
440 *
441 * - For a touch screen or touch pad, reports the approximate size of the contact area in
442 * relation to the maximum detectable size for the device. The value is normalized
443 * to a range from 0 (smallest detectable size) to 1 (largest detectable size),
444 * although it is not a linear scale. This value is of limited use.
445 * To obtain calibrated size information, see
446 * {@link AMOTION_EVENT_AXIS_TOUCH_MAJOR} or {@link AMOTION_EVENT_AXIS_TOOL_MAJOR}.
447 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700448 AMOTION_EVENT_AXIS_SIZE = 3,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700449 /**
450 * Axis constant: TouchMajor axis of a motion event.
451 *
452 * - For a touch screen, reports the length of the major axis of an ellipse that
453 * represents the touch area at the point of contact.
454 * The units are display pixels.
455 * - For a touch pad, reports the length of the major axis of an ellipse that
456 * represents the touch area at the point of contact.
457 * The units are device-dependent.
458 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700459 AMOTION_EVENT_AXIS_TOUCH_MAJOR = 4,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700460 /**
461 * Axis constant: TouchMinor axis of a motion event.
462 *
463 * - For a touch screen, reports the length of the minor axis of an ellipse that
464 * represents the touch area at the point of contact.
465 * The units are display pixels.
466 * - For a touch pad, reports the length of the minor axis of an ellipse that
467 * represents the touch area at the point of contact.
468 * The units are device-dependent.
469 *
470 * When the touch is circular, the major and minor axis lengths will be equal to one another.
471 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700472 AMOTION_EVENT_AXIS_TOUCH_MINOR = 5,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700473 /**
474 * Axis constant: ToolMajor axis of a motion event.
475 *
476 * - For a touch screen, reports the length of the major axis of an ellipse that
477 * represents the size of the approaching finger or tool used to make contact.
478 * - For a touch pad, reports the length of the major axis of an ellipse that
479 * represents the size of the approaching finger or tool used to make contact.
480 * The units are device-dependent.
481 *
482 * When the touch is circular, the major and minor axis lengths will be equal to one another.
483 *
484 * The tool size may be larger than the touch size since the tool may not be fully
485 * in contact with the touch sensor.
486 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700487 AMOTION_EVENT_AXIS_TOOL_MAJOR = 6,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700488 /**
489 * Axis constant: ToolMinor axis of a motion event.
490 *
491 * - For a touch screen, reports the length of the minor axis of an ellipse that
492 * represents the size of the approaching finger or tool used to make contact.
493 * - For a touch pad, reports the length of the minor axis of an ellipse that
494 * represents the size of the approaching finger or tool used to make contact.
495 * The units are device-dependent.
496 *
497 * When the touch is circular, the major and minor axis lengths will be equal to one another.
498 *
499 * The tool size may be larger than the touch size since the tool may not be fully
500 * in contact with the touch sensor.
501 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700502 AMOTION_EVENT_AXIS_TOOL_MINOR = 7,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700503 /**
504 * Axis constant: Orientation axis of a motion event.
505 *
506 * - For a touch screen or touch pad, reports the orientation of the finger
507 * or tool in radians relative to the vertical plane of the device.
508 * An angle of 0 radians indicates that the major axis of contact is oriented
509 * upwards, is perfectly circular or is of unknown orientation. A positive angle
510 * indicates that the major axis of contact is oriented to the right. A negative angle
511 * indicates that the major axis of contact is oriented to the left.
512 * The full range is from -PI/2 radians (finger pointing fully left) to PI/2 radians
513 * (finger pointing fully right).
514 * - For a stylus, the orientation indicates the direction in which the stylus
515 * is pointing in relation to the vertical axis of the current orientation of the screen.
516 * The range is from -PI radians to PI radians, where 0 is pointing up,
517 * -PI/2 radians is pointing left, -PI or PI radians is pointing down, and PI/2 radians
518 * is pointing right. See also {@link AMOTION_EVENT_AXIS_TILT}.
519 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700520 AMOTION_EVENT_AXIS_ORIENTATION = 8,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700521 /**
522 * Axis constant: Vertical Scroll axis of a motion event.
523 *
524 * - For a mouse, reports the relative movement of the vertical scroll wheel.
525 * The value is normalized to a range from -1.0 (down) to 1.0 (up).
526 *
527 * This axis should be used to scroll views vertically.
528 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700529 AMOTION_EVENT_AXIS_VSCROLL = 9,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700530 /**
531 * Axis constant: Horizontal Scroll axis of a motion event.
532 *
533 * - For a mouse, reports the relative movement of the horizontal scroll wheel.
534 * The value is normalized to a range from -1.0 (left) to 1.0 (right).
535 *
536 * This axis should be used to scroll views horizontally.
537 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700538 AMOTION_EVENT_AXIS_HSCROLL = 10,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700539 /**
540 * Axis constant: Z axis of a motion event.
541 *
542 * - For a joystick, reports the absolute Z position of the joystick.
543 * The value is normalized to a range from -1.0 (high) to 1.0 (low).
544 * <em>On game pads with two analog joysticks, this axis is often reinterpreted
545 * to report the absolute X position of the second joystick instead.</em>
546 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700547 AMOTION_EVENT_AXIS_Z = 11,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700548 /**
549 * Axis constant: X Rotation axis of a motion event.
550 *
551 * - For a joystick, reports the absolute rotation angle about the X axis.
552 * The value is normalized to a range from -1.0 (counter-clockwise) to 1.0 (clockwise).
553 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700554 AMOTION_EVENT_AXIS_RX = 12,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700555 /**
556 * Axis constant: Y Rotation axis of a motion event.
557 *
558 * - For a joystick, reports the absolute rotation angle about the Y axis.
559 * The value is normalized to a range from -1.0 (counter-clockwise) to 1.0 (clockwise).
560 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700561 AMOTION_EVENT_AXIS_RY = 13,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700562 /**
563 * Axis constant: Z Rotation axis of a motion event.
564 *
565 * - For a joystick, reports the absolute rotation angle about the Z axis.
566 * The value is normalized to a range from -1.0 (counter-clockwise) to 1.0 (clockwise).
567 * On game pads with two analog joysticks, this axis is often reinterpreted
568 * to report the absolute Y position of the second joystick instead.
569 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700570 AMOTION_EVENT_AXIS_RZ = 14,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700571 /**
572 * Axis constant: Hat X axis of a motion event.
573 *
574 * - For a joystick, reports the absolute X position of the directional hat control.
575 * The value is normalized to a range from -1.0 (left) to 1.0 (right).
576 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700577 AMOTION_EVENT_AXIS_HAT_X = 15,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700578 /**
579 * Axis constant: Hat Y axis of a motion event.
580 *
581 * - For a joystick, reports the absolute Y position of the directional hat control.
582 * The value is normalized to a range from -1.0 (up) to 1.0 (down).
583 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700584 AMOTION_EVENT_AXIS_HAT_Y = 16,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700585 /**
586 * Axis constant: Left Trigger axis of a motion event.
587 *
588 * - For a joystick, reports the absolute position of the left trigger control.
589 * The value is normalized to a range from 0.0 (released) to 1.0 (fully pressed).
590 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700591 AMOTION_EVENT_AXIS_LTRIGGER = 17,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700592 /**
593 * Axis constant: Right Trigger axis of a motion event.
594 *
595 * - For a joystick, reports the absolute position of the right trigger control.
596 * The value is normalized to a range from 0.0 (released) to 1.0 (fully pressed).
597 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700598 AMOTION_EVENT_AXIS_RTRIGGER = 18,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700599 /**
600 * Axis constant: Throttle axis of a motion event.
601 *
602 * - For a joystick, reports the absolute position of the throttle control.
603 * The value is normalized to a range from 0.0 (fully open) to 1.0 (fully closed).
604 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700605 AMOTION_EVENT_AXIS_THROTTLE = 19,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700606 /**
607 * Axis constant: Rudder axis of a motion event.
608 *
609 * - For a joystick, reports the absolute position of the rudder control.
610 * The value is normalized to a range from -1.0 (turn left) to 1.0 (turn right).
611 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700612 AMOTION_EVENT_AXIS_RUDDER = 20,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700613 /**
614 * Axis constant: Wheel axis of a motion event.
615 *
616 * - For a joystick, reports the absolute position of the steering wheel control.
617 * The value is normalized to a range from -1.0 (turn left) to 1.0 (turn right).
618 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700619 AMOTION_EVENT_AXIS_WHEEL = 21,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700620 /**
621 * Axis constant: Gas axis of a motion event.
622 *
623 * - For a joystick, reports the absolute position of the gas (accelerator) control.
624 * The value is normalized to a range from 0.0 (no acceleration)
625 * to 1.0 (maximum acceleration).
626 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700627 AMOTION_EVENT_AXIS_GAS = 22,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700628 /**
629 * Axis constant: Brake axis of a motion event.
630 *
631 * - For a joystick, reports the absolute position of the brake control.
632 * The value is normalized to a range from 0.0 (no braking) to 1.0 (maximum braking).
633 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700634 AMOTION_EVENT_AXIS_BRAKE = 23,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700635 /**
636 * Axis constant: Distance axis of a motion event.
637 *
638 * - For a stylus, reports the distance of the stylus from the screen.
639 * A value of 0.0 indicates direct contact and larger values indicate increasing
640 * distance from the surface.
641 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700642 AMOTION_EVENT_AXIS_DISTANCE = 24,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700643 /**
644 * Axis constant: Tilt axis of a motion event.
645 *
646 * - For a stylus, reports the tilt angle of the stylus in radians where
647 * 0 radians indicates that the stylus is being held perpendicular to the
648 * surface, and PI/2 radians indicates that the stylus is being held flat
649 * against the surface.
650 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700651 AMOTION_EVENT_AXIS_TILT = 25,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700652 /**
Prashant Malani1941ff52015-08-11 18:29:28 -0700653 * Axis constant: Generic scroll axis of a motion event.
654 *
655 * - This is used for scroll axis motion events that can't be classified as strictly
656 * vertical or horizontal. The movement of a rotating scroller is an example of this.
657 */
658 AMOTION_EVENT_AXIS_SCROLL = 26,
659 /**
Jun Mukaifa1706a2015-12-03 01:14:46 -0800660 * Axis constant: The movement of x position of a motion event.
661 *
662 * - For a mouse, reports a difference of x position between the previous position.
663 * This is useful when pointer is captured, in that case the mouse pointer doesn't
664 * change the location but this axis reports the difference which allows the app
665 * to see how the mouse is moved.
666 */
667 AMOTION_EVENT_AXIS_RELATIVE_X = 27,
668 /**
669 * Axis constant: The movement of y position of a motion event.
670 *
671 * Same as {@link RELATIVE_X}, but for y position.
672 */
673 AMOTION_EVENT_AXIS_RELATIVE_Y = 28,
674 /**
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700675 * Axis constant: Generic 1 axis of a motion event.
676 * The interpretation of a generic axis is device-specific.
677 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700678 AMOTION_EVENT_AXIS_GENERIC_1 = 32,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700679 /**
680 * Axis constant: Generic 2 axis of a motion event.
681 * The interpretation of a generic axis is device-specific.
682 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700683 AMOTION_EVENT_AXIS_GENERIC_2 = 33,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700684 /**
685 * Axis constant: Generic 3 axis of a motion event.
686 * The interpretation of a generic axis is device-specific.
687 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700688 AMOTION_EVENT_AXIS_GENERIC_3 = 34,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700689 /**
690 * Axis constant: Generic 4 axis of a motion event.
691 * The interpretation of a generic axis is device-specific.
692 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700693 AMOTION_EVENT_AXIS_GENERIC_4 = 35,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700694 /**
695 * Axis constant: Generic 5 axis of a motion event.
696 * The interpretation of a generic axis is device-specific.
697 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700698 AMOTION_EVENT_AXIS_GENERIC_5 = 36,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700699 /**
700 * Axis constant: Generic 6 axis of a motion event.
701 * The interpretation of a generic axis is device-specific.
702 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700703 AMOTION_EVENT_AXIS_GENERIC_6 = 37,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700704 /**
705 * Axis constant: Generic 7 axis of a motion event.
706 * The interpretation of a generic axis is device-specific.
707 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700708 AMOTION_EVENT_AXIS_GENERIC_7 = 38,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700709 /**
710 * Axis constant: Generic 8 axis of a motion event.
711 * The interpretation of a generic axis is device-specific.
712 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700713 AMOTION_EVENT_AXIS_GENERIC_8 = 39,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700714 /**
715 * Axis constant: Generic 9 axis of a motion event.
716 * The interpretation of a generic axis is device-specific.
717 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700718 AMOTION_EVENT_AXIS_GENERIC_9 = 40,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700719 /**
720 * Axis constant: Generic 10 axis of a motion event.
721 * The interpretation of a generic axis is device-specific.
722 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700723 AMOTION_EVENT_AXIS_GENERIC_10 = 41,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700724 /**
725 * Axis constant: Generic 11 axis of a motion event.
726 * The interpretation of a generic axis is device-specific.
727 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700728 AMOTION_EVENT_AXIS_GENERIC_11 = 42,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700729 /**
730 * Axis constant: Generic 12 axis of a motion event.
731 * The interpretation of a generic axis is device-specific.
732 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700733 AMOTION_EVENT_AXIS_GENERIC_12 = 43,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700734 /**
735 * Axis constant: Generic 13 axis of a motion event.
736 * The interpretation of a generic axis is device-specific.
737 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700738 AMOTION_EVENT_AXIS_GENERIC_13 = 44,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700739 /**
740 * Axis constant: Generic 14 axis of a motion event.
741 * The interpretation of a generic axis is device-specific.
742 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700743 AMOTION_EVENT_AXIS_GENERIC_14 = 45,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700744 /**
745 * Axis constant: Generic 15 axis of a motion event.
746 * The interpretation of a generic axis is device-specific.
747 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700748 AMOTION_EVENT_AXIS_GENERIC_15 = 46,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700749 /**
750 * Axis constant: Generic 16 axis of a motion event.
751 * The interpretation of a generic axis is device-specific.
752 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700753 AMOTION_EVENT_AXIS_GENERIC_16 = 47,
754
755 // NOTE: If you add a new axis here you must also add it to several other files.
756 // Refer to frameworks/base/core/java/android/view/MotionEvent.java for the full list.
757};
758
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700759/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700760 * Constants that identify buttons that are associated with motion events.
761 * Refer to the documentation on the MotionEvent class for descriptions of each button.
762 */
763enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700764 /** primary */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700765 AMOTION_EVENT_BUTTON_PRIMARY = 1 << 0,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700766 /** secondary */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700767 AMOTION_EVENT_BUTTON_SECONDARY = 1 << 1,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700768 /** tertiary */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700769 AMOTION_EVENT_BUTTON_TERTIARY = 1 << 2,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700770 /** back */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700771 AMOTION_EVENT_BUTTON_BACK = 1 << 3,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700772 /** forward */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700773 AMOTION_EVENT_BUTTON_FORWARD = 1 << 4,
Michael Wright7b159c92015-05-14 14:48:03 +0100774 AMOTION_EVENT_BUTTON_STYLUS_PRIMARY = 1 << 5,
775 AMOTION_EVENT_BUTTON_STYLUS_SECONDARY = 1 << 6,
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700776};
777
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700778/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700779 * Constants that identify tool types.
780 * Refer to the documentation on the MotionEvent class for descriptions of each tool type.
781 */
782enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700783 /** unknown */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700784 AMOTION_EVENT_TOOL_TYPE_UNKNOWN = 0,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700785 /** finger */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700786 AMOTION_EVENT_TOOL_TYPE_FINGER = 1,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700787 /** stylus */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700788 AMOTION_EVENT_TOOL_TYPE_STYLUS = 2,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700789 /** mouse */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700790 AMOTION_EVENT_TOOL_TYPE_MOUSE = 3,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700791 /** eraser */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700792 AMOTION_EVENT_TOOL_TYPE_ERASER = 4,
793};
794
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700795/**
796 * Input source masks.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700797 *
798 * Refer to the documentation on android.view.InputDevice for more details about input sources
799 * and their correct interpretation.
800 */
801enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700802 /** mask */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700803 AINPUT_SOURCE_CLASS_MASK = 0x000000ff,
804
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700805 /** none */
Michael Wrightaadaca72013-03-11 14:20:14 -0700806 AINPUT_SOURCE_CLASS_NONE = 0x00000000,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700807 /** button */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700808 AINPUT_SOURCE_CLASS_BUTTON = 0x00000001,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700809 /** pointer */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700810 AINPUT_SOURCE_CLASS_POINTER = 0x00000002,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700811 /** navigation */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700812 AINPUT_SOURCE_CLASS_NAVIGATION = 0x00000004,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700813 /** position */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700814 AINPUT_SOURCE_CLASS_POSITION = 0x00000008,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700815 /** joystick */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700816 AINPUT_SOURCE_CLASS_JOYSTICK = 0x00000010,
817};
818
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700819/**
820 * Input sources.
821 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700822enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700823 /** unknown */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700824 AINPUT_SOURCE_UNKNOWN = 0x00000000,
825
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700826 /** keyboard */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700827 AINPUT_SOURCE_KEYBOARD = 0x00000100 | AINPUT_SOURCE_CLASS_BUTTON,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700828 /** dpad */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700829 AINPUT_SOURCE_DPAD = 0x00000200 | AINPUT_SOURCE_CLASS_BUTTON,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700830 /** gamepad */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700831 AINPUT_SOURCE_GAMEPAD = 0x00000400 | AINPUT_SOURCE_CLASS_BUTTON,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700832 /** touchscreen */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700833 AINPUT_SOURCE_TOUCHSCREEN = 0x00001000 | AINPUT_SOURCE_CLASS_POINTER,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700834 /** mouse */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700835 AINPUT_SOURCE_MOUSE = 0x00002000 | AINPUT_SOURCE_CLASS_POINTER,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700836 /** stylus */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700837 AINPUT_SOURCE_STYLUS = 0x00004000 | AINPUT_SOURCE_CLASS_POINTER,
Michael Wright7d3ad692015-06-23 19:04:31 +0100838 /** bluetooth stylus */
Michael Wright2f78b682015-06-12 15:25:08 +0100839 AINPUT_SOURCE_BLUETOOTH_STYLUS = 0x00008000 | AINPUT_SOURCE_STYLUS,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700840 /** trackball */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700841 AINPUT_SOURCE_TRACKBALL = 0x00010000 | AINPUT_SOURCE_CLASS_NAVIGATION,
Vladislav Kaznacheev78f97b32016-12-15 18:14:58 -0800842 /** mouse relative */
843 AINPUT_SOURCE_MOUSE_RELATIVE = 0x00020000 | AINPUT_SOURCE_CLASS_NAVIGATION,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700844 /** touchpad */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700845 AINPUT_SOURCE_TOUCHPAD = 0x00100000 | AINPUT_SOURCE_CLASS_POSITION,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700846 /** navigation */
Michael Wrightaadaca72013-03-11 14:20:14 -0700847 AINPUT_SOURCE_TOUCH_NAVIGATION = 0x00200000 | AINPUT_SOURCE_CLASS_NONE,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700848 /** joystick */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700849 AINPUT_SOURCE_JOYSTICK = 0x01000000 | AINPUT_SOURCE_CLASS_JOYSTICK,
Prashant Malani1941ff52015-08-11 18:29:28 -0700850 /** rotary encoder */
851 AINPUT_SOURCE_ROTARY_ENCODER = 0x00400000 | AINPUT_SOURCE_CLASS_NONE,
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700852
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700853 /** any */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700854 AINPUT_SOURCE_ANY = 0xffffff00,
855};
856
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700857/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700858 * Keyboard types.
859 *
860 * Refer to the documentation on android.view.InputDevice for more details.
861 */
862enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700863 /** none */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700864 AINPUT_KEYBOARD_TYPE_NONE = 0,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700865 /** non alphabetic */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700866 AINPUT_KEYBOARD_TYPE_NON_ALPHABETIC = 1,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700867 /** alphabetic */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700868 AINPUT_KEYBOARD_TYPE_ALPHABETIC = 2,
869};
870
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700871/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700872 * Constants used to retrieve information about the range of motion for a particular
873 * coordinate of a motion event.
874 *
875 * Refer to the documentation on android.view.InputDevice for more details about input sources
876 * and their correct interpretation.
877 *
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700878 * @deprecated These constants are deprecated. Use {@link AMOTION_EVENT_AXIS AMOTION_EVENT_AXIS_*} constants instead.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700879 */
880enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700881 /** x */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700882 AINPUT_MOTION_RANGE_X = AMOTION_EVENT_AXIS_X,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700883 /** y */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700884 AINPUT_MOTION_RANGE_Y = AMOTION_EVENT_AXIS_Y,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700885 /** pressure */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700886 AINPUT_MOTION_RANGE_PRESSURE = AMOTION_EVENT_AXIS_PRESSURE,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700887 /** size */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700888 AINPUT_MOTION_RANGE_SIZE = AMOTION_EVENT_AXIS_SIZE,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700889 /** touch major */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700890 AINPUT_MOTION_RANGE_TOUCH_MAJOR = AMOTION_EVENT_AXIS_TOUCH_MAJOR,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700891 /** touch minor */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700892 AINPUT_MOTION_RANGE_TOUCH_MINOR = AMOTION_EVENT_AXIS_TOUCH_MINOR,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700893 /** tool major */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700894 AINPUT_MOTION_RANGE_TOOL_MAJOR = AMOTION_EVENT_AXIS_TOOL_MAJOR,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700895 /** tool minor */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700896 AINPUT_MOTION_RANGE_TOOL_MINOR = AMOTION_EVENT_AXIS_TOOL_MINOR,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700897 /** orientation */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700898 AINPUT_MOTION_RANGE_ORIENTATION = AMOTION_EVENT_AXIS_ORIENTATION,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700899};
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700900
901
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700902/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700903 * Input event accessors.
904 *
905 * Note that most functions can only be used on input events that are of a given type.
906 * Calling these functions on input events of other types will yield undefined behavior.
907 */
908
909/*** Accessors for all input events. ***/
910
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700911/** Get the input event type. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700912int32_t AInputEvent_getType(const AInputEvent* event);
913
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700914/** Get the id for the device that an input event came from.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700915 *
916 * Input events can be generated by multiple different input devices.
917 * Use the input device id to obtain information about the input
918 * device that was responsible for generating a particular event.
919 *
920 * An input device id of 0 indicates that the event didn't come from a physical device;
921 * other numbers are arbitrary and you shouldn't depend on the values.
922 * Use the provided input device query API to obtain information about input devices.
923 */
924int32_t AInputEvent_getDeviceId(const AInputEvent* event);
925
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700926/** Get the input event source. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700927int32_t AInputEvent_getSource(const AInputEvent* event);
928
929/*** Accessors for key events only. ***/
930
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700931/** Get the key event action. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700932int32_t AKeyEvent_getAction(const AInputEvent* key_event);
933
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700934/** Get the key event flags. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700935int32_t AKeyEvent_getFlags(const AInputEvent* key_event);
936
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700937/**
938 * Get the key code of the key event.
939 * This is the physical key that was pressed, not the Unicode character.
940 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700941int32_t AKeyEvent_getKeyCode(const AInputEvent* key_event);
942
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700943/**
944 * Get the hardware key id of this key event.
945 * These values are not reliable and vary from device to device.
946 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700947int32_t AKeyEvent_getScanCode(const AInputEvent* key_event);
948
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700949/** Get the meta key state. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700950int32_t AKeyEvent_getMetaState(const AInputEvent* key_event);
951
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700952/**
953 * Get the repeat count of the event.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700954 * For both key up an key down events, this is the number of times the key has
955 * repeated with the first down starting at 0 and counting up from there. For
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700956 * multiple key events, this is the number of down/up pairs that have occurred.
957 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700958int32_t AKeyEvent_getRepeatCount(const AInputEvent* key_event);
959
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700960/**
961 * Get the time of the most recent key down event, in the
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700962 * java.lang.System.nanoTime() time base. If this is a down event,
963 * this will be the same as eventTime.
964 * Note that when chording keys, this value is the down time of the most recently
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700965 * pressed key, which may not be the same physical key of this event.
966 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700967int64_t AKeyEvent_getDownTime(const AInputEvent* key_event);
968
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700969/**
970 * Get the time this event occurred, in the
971 * java.lang.System.nanoTime() time base.
972 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700973int64_t AKeyEvent_getEventTime(const AInputEvent* key_event);
974
975/*** Accessors for motion events only. ***/
976
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700977/** Get the combined motion event action code and pointer index. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700978int32_t AMotionEvent_getAction(const AInputEvent* motion_event);
979
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700980/** Get the motion event flags. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700981int32_t AMotionEvent_getFlags(const AInputEvent* motion_event);
982
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700983/**
984 * Get the state of any meta / modifier keys that were in effect when the
985 * event was generated.
986 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700987int32_t AMotionEvent_getMetaState(const AInputEvent* motion_event);
988
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700989/** Get the button state of all buttons that are pressed. */
Elliott Hughes9db409b2018-06-18 12:28:46 -0700990int32_t AMotionEvent_getButtonState(const AInputEvent* motion_event) __INTRODUCED_IN(14);
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700991
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700992/**
993 * Get a bitfield indicating which edges, if any, were touched by this motion event.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700994 * For touch events, clients can use this to determine if the user's finger was
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700995 * touching the edge of the display.
996 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700997int32_t AMotionEvent_getEdgeFlags(const AInputEvent* motion_event);
998
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700999/**
1000 * Get the time when the user originally pressed down to start a stream of
1001 * position events, in the java.lang.System.nanoTime() time base.
1002 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001003int64_t AMotionEvent_getDownTime(const AInputEvent* motion_event);
1004
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001005/**
1006 * Get the time when this specific event was generated,
1007 * in the java.lang.System.nanoTime() time base.
1008 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001009int64_t AMotionEvent_getEventTime(const AInputEvent* motion_event);
1010
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001011/**
1012 * Get the X coordinate offset.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001013 * For touch events on the screen, this is the delta that was added to the raw
1014 * screen coordinates to adjust for the absolute position of the containing windows
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001015 * and views.
1016 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001017float AMotionEvent_getXOffset(const AInputEvent* motion_event);
1018
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001019/**
1020 * Get the Y coordinate offset.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001021 * For touch events on the screen, this is the delta that was added to the raw
1022 * screen coordinates to adjust for the absolute position of the containing windows
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001023 * and views.
1024 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001025float AMotionEvent_getYOffset(const AInputEvent* motion_event);
1026
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001027/**
1028 * Get the precision of the X coordinates being reported.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001029 * You can multiply this number with an X coordinate sample to find the
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001030 * actual hardware value of the X coordinate.
1031 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001032float AMotionEvent_getXPrecision(const AInputEvent* motion_event);
1033
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001034/**
1035 * Get the precision of the Y coordinates being reported.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001036 * You can multiply this number with a Y coordinate sample to find the
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001037 * actual hardware value of the Y coordinate.
1038 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001039float AMotionEvent_getYPrecision(const AInputEvent* motion_event);
1040
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001041/**
1042 * Get the number of pointers of data contained in this event.
1043 * Always >= 1.
1044 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001045size_t AMotionEvent_getPointerCount(const AInputEvent* motion_event);
1046
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001047/**
1048 * Get the pointer identifier associated with a particular pointer
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001049 * data index in this event. The identifier tells you the actual pointer
1050 * number associated with the data, accounting for individual pointers
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001051 * going up and down since the start of the current gesture.
1052 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001053int32_t AMotionEvent_getPointerId(const AInputEvent* motion_event, size_t pointer_index);
1054
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001055/**
1056 * Get the tool type of a pointer for the given pointer index.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001057 * The tool type indicates the type of tool used to make contact such as a
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001058 * finger or stylus, if known.
1059 */
Elliott Hughes9db409b2018-06-18 12:28:46 -07001060int32_t AMotionEvent_getToolType(const AInputEvent* motion_event, size_t pointer_index) __INTRODUCED_IN(14);
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001061
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001062/**
1063 * Get the original raw X coordinate of this event.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001064 * For touch events on the screen, this is the original location of the event
1065 * on the screen, before it had been adjusted for the containing window
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001066 * and views.
1067 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001068float AMotionEvent_getRawX(const AInputEvent* motion_event, size_t pointer_index);
1069
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001070/**
1071 * Get the original raw X coordinate of this event.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001072 * For touch events on the screen, this is the original location of the event
1073 * on the screen, before it had been adjusted for the containing window
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001074 * and views.
1075 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001076float AMotionEvent_getRawY(const AInputEvent* motion_event, size_t pointer_index);
1077
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001078/**
1079 * Get the current X coordinate of this event for the given pointer index.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001080 * Whole numbers are pixels; the value may have a fraction for input devices
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001081 * that are sub-pixel precise.
1082 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001083float AMotionEvent_getX(const AInputEvent* motion_event, size_t pointer_index);
1084
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001085/**
1086 * Get the current Y coordinate of this event for the given pointer index.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001087 * Whole numbers are pixels; the value may have a fraction for input devices
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001088 * that are sub-pixel precise.
1089 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001090float AMotionEvent_getY(const AInputEvent* motion_event, size_t pointer_index);
1091
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001092/**
1093 * Get the current pressure of this event for the given pointer index.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001094 * The pressure generally ranges from 0 (no pressure at all) to 1 (normal pressure),
1095 * although values higher than 1 may be generated depending on the calibration of
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001096 * the input device.
1097 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001098float AMotionEvent_getPressure(const AInputEvent* motion_event, size_t pointer_index);
1099
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001100/**
1101 * Get the current scaled value of the approximate size for the given pointer index.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001102 * This represents some approximation of the area of the screen being
1103 * pressed; the actual value in pixels corresponding to the
1104 * touch is normalized with the device specific range of values
1105 * and scaled to a value between 0 and 1. The value of size can be used to
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001106 * determine fat touch events.
1107 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001108float AMotionEvent_getSize(const AInputEvent* motion_event, size_t pointer_index);
1109
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001110/**
1111 * Get the current length of the major axis of an ellipse that describes the touch area
1112 * at the point of contact for the given pointer index.
1113 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001114float AMotionEvent_getTouchMajor(const AInputEvent* motion_event, size_t pointer_index);
1115
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001116/**
1117 * Get the current length of the minor axis of an ellipse that describes the touch area
1118 * at the point of contact for the given pointer index.
1119 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001120float AMotionEvent_getTouchMinor(const AInputEvent* motion_event, size_t pointer_index);
1121
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001122/**
1123 * Get the current length of the major axis of an ellipse that describes the size
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001124 * of the approaching tool for the given pointer index.
1125 * The tool area represents the estimated size of the finger or pen that is
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001126 * touching the device independent of its actual touch area at the point of contact.
1127 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001128float AMotionEvent_getToolMajor(const AInputEvent* motion_event, size_t pointer_index);
1129
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001130/**
1131 * Get the current length of the minor axis of an ellipse that describes the size
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001132 * of the approaching tool for the given pointer index.
1133 * The tool area represents the estimated size of the finger or pen that is
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001134 * touching the device independent of its actual touch area at the point of contact.
1135 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001136float AMotionEvent_getToolMinor(const AInputEvent* motion_event, size_t pointer_index);
1137
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001138/**
1139 * Get the current orientation of the touch area and tool area in radians clockwise from
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001140 * vertical for the given pointer index.
1141 * An angle of 0 degrees indicates that the major axis of contact is oriented
1142 * upwards, is perfectly circular or is of unknown orientation. A positive angle
1143 * indicates that the major axis of contact is oriented to the right. A negative angle
1144 * indicates that the major axis of contact is oriented to the left.
1145 * The full range is from -PI/2 radians (finger pointing fully left) to PI/2 radians
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001146 * (finger pointing fully right).
1147 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001148float AMotionEvent_getOrientation(const AInputEvent* motion_event, size_t pointer_index);
1149
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001150/** Get the value of the request axis for the given pointer index. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001151float AMotionEvent_getAxisValue(const AInputEvent* motion_event,
Elliott Hughes9db409b2018-06-18 12:28:46 -07001152 int32_t axis, size_t pointer_index) __INTRODUCED_IN(13);
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001153
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001154/**
1155 * Get the number of historical points in this event. These are movements that
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001156 * have occurred between this event and the previous event. This only applies
1157 * to AMOTION_EVENT_ACTION_MOVE events -- all other actions will have a size of 0.
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001158 * Historical samples are indexed from oldest to newest.
1159 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001160size_t AMotionEvent_getHistorySize(const AInputEvent* motion_event);
1161
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001162/**
1163 * Get the time that a historical movement occurred between this event and
1164 * the previous event, in the java.lang.System.nanoTime() time base.
1165 */
Andrew Hsieh26c24162013-05-27 12:26:04 +08001166int64_t AMotionEvent_getHistoricalEventTime(const AInputEvent* motion_event,
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001167 size_t history_index);
1168
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001169/**
1170 * Get the historical raw X coordinate of this event for the given pointer index that
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001171 * occurred between this event and the previous motion event.
1172 * For touch events on the screen, this is the original location of the event
1173 * on the screen, before it had been adjusted for the containing window
1174 * and views.
1175 * Whole numbers are pixels; the value may have a fraction for input devices
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001176 * that are sub-pixel precise.
1177 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001178float AMotionEvent_getHistoricalRawX(const AInputEvent* motion_event, size_t pointer_index,
1179 size_t history_index);
1180
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001181/**
1182 * Get the historical raw Y coordinate of this event for the given pointer index that
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001183 * occurred between this event and the previous motion event.
1184 * For touch events on the screen, this is the original location of the event
1185 * on the screen, before it had been adjusted for the containing window
1186 * and views.
1187 * Whole numbers are pixels; the value may have a fraction for input devices
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001188 * that are sub-pixel precise.
1189 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001190float AMotionEvent_getHistoricalRawY(const AInputEvent* motion_event, size_t pointer_index,
1191 size_t history_index);
1192
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001193/**
1194 * Get the historical X coordinate of this event for the given pointer index that
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001195 * occurred between this event and the previous motion event.
1196 * Whole numbers are pixels; the value may have a fraction for input devices
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001197 * that are sub-pixel precise.
1198 */
Andrew Hsieh26c24162013-05-27 12:26:04 +08001199float AMotionEvent_getHistoricalX(const AInputEvent* motion_event, size_t pointer_index,
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001200 size_t history_index);
1201
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001202/**
1203 * Get the historical Y coordinate of this event for the given pointer index that
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001204 * occurred between this event and the previous motion event.
1205 * Whole numbers are pixels; the value may have a fraction for input devices
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001206 * that are sub-pixel precise.
1207 */
Andrew Hsieh26c24162013-05-27 12:26:04 +08001208float AMotionEvent_getHistoricalY(const AInputEvent* motion_event, size_t pointer_index,
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001209 size_t history_index);
1210
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001211/**
1212 * Get the historical pressure of this event for the given pointer index that
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001213 * occurred between this event and the previous motion event.
1214 * The pressure generally ranges from 0 (no pressure at all) to 1 (normal pressure),
1215 * although values higher than 1 may be generated depending on the calibration of
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001216 * the input device.
1217 */
Andrew Hsieh26c24162013-05-27 12:26:04 +08001218float AMotionEvent_getHistoricalPressure(const AInputEvent* motion_event, size_t pointer_index,
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001219 size_t history_index);
1220
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001221/**
1222 * Get the current scaled value of the approximate size for the given pointer index that
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001223 * occurred between this event and the previous motion event.
1224 * This represents some approximation of the area of the screen being
1225 * pressed; the actual value in pixels corresponding to the
1226 * touch is normalized with the device specific range of values
1227 * and scaled to a value between 0 and 1. The value of size can be used to
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001228 * determine fat touch events.
1229 */
Andrew Hsieh26c24162013-05-27 12:26:04 +08001230float AMotionEvent_getHistoricalSize(const AInputEvent* motion_event, size_t pointer_index,
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001231 size_t history_index);
1232
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001233/**
1234 * Get the historical length of the major axis of an ellipse that describes the touch area
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001235 * at the point of contact for the given pointer index that
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001236 * occurred between this event and the previous motion event.
1237 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001238float AMotionEvent_getHistoricalTouchMajor(const AInputEvent* motion_event, size_t pointer_index,
1239 size_t history_index);
1240
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001241/**
1242 * Get the historical length of the minor axis of an ellipse that describes the touch area
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001243 * at the point of contact for the given pointer index that
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001244 * occurred between this event and the previous motion event.
1245 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001246float AMotionEvent_getHistoricalTouchMinor(const AInputEvent* motion_event, size_t pointer_index,
1247 size_t history_index);
1248
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001249/**
1250 * Get the historical length of the major axis of an ellipse that describes the size
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001251 * of the approaching tool for the given pointer index that
1252 * occurred between this event and the previous motion event.
1253 * The tool area represents the estimated size of the finger or pen that is
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001254 * touching the device independent of its actual touch area at the point of contact.
1255 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001256float AMotionEvent_getHistoricalToolMajor(const AInputEvent* motion_event, size_t pointer_index,
1257 size_t history_index);
1258
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001259/**
1260 * Get the historical length of the minor axis of an ellipse that describes the size
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001261 * of the approaching tool for the given pointer index that
1262 * occurred between this event and the previous motion event.
1263 * The tool area represents the estimated size of the finger or pen that is
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001264 * touching the device independent of its actual touch area at the point of contact.
1265 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001266float AMotionEvent_getHistoricalToolMinor(const AInputEvent* motion_event, size_t pointer_index,
1267 size_t history_index);
1268
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001269/**
1270 * Get the historical orientation of the touch area and tool area in radians clockwise from
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001271 * vertical for the given pointer index that
1272 * occurred between this event and the previous motion event.
1273 * An angle of 0 degrees indicates that the major axis of contact is oriented
1274 * upwards, is perfectly circular or is of unknown orientation. A positive angle
1275 * indicates that the major axis of contact is oriented to the right. A negative angle
1276 * indicates that the major axis of contact is oriented to the left.
1277 * The full range is from -PI/2 radians (finger pointing fully left) to PI/2 radians
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001278 * (finger pointing fully right).
1279 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001280float AMotionEvent_getHistoricalOrientation(const AInputEvent* motion_event, size_t pointer_index,
1281 size_t history_index);
1282
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001283/**
1284 * Get the historical value of the request axis for the given pointer index
1285 * that occurred between this event and the previous motion event.
1286 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001287float AMotionEvent_getHistoricalAxisValue(const AInputEvent* motion_event,
Elliott Hughes9db409b2018-06-18 12:28:46 -07001288 int32_t axis, size_t pointer_index, size_t history_index) __INTRODUCED_IN(13);
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001289
1290
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001291struct AInputQueue;
1292/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001293 * Input queue
1294 *
1295 * An input queue is the facility through which you retrieve input
1296 * events.
1297 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001298typedef struct AInputQueue AInputQueue;
1299
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001300/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001301 * Add this input queue to a looper for processing. See
1302 * ALooper_addFd() for information on the ident, callback, and data params.
1303 */
1304void AInputQueue_attachLooper(AInputQueue* queue, ALooper* looper,
1305 int ident, ALooper_callbackFunc callback, void* data);
1306
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001307/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001308 * Remove the input queue from the looper it is currently attached to.
1309 */
1310void AInputQueue_detachLooper(AInputQueue* queue);
1311
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001312/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001313 * Returns true if there are one or more events available in the
1314 * input queue. Returns 1 if the queue has events; 0 if
1315 * it does not have events; and a negative value if there is an error.
1316 */
1317int32_t AInputQueue_hasEvents(AInputQueue* queue);
1318
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001319/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001320 * Returns the next available event from the queue. Returns a negative
1321 * value if no events are available or an error has occurred.
1322 */
1323int32_t AInputQueue_getEvent(AInputQueue* queue, AInputEvent** outEvent);
1324
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001325/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001326 * Sends the key for standard pre-dispatching -- that is, possibly deliver
1327 * it to the current IME to be consumed before the app. Returns 0 if it
1328 * was not pre-dispatched, meaning you can process it right now. If non-zero
1329 * is returned, you must abandon the current event processing and allow the
1330 * event to appear again in the event queue (if it does not get consumed during
1331 * pre-dispatching).
1332 */
1333int32_t AInputQueue_preDispatchEvent(AInputQueue* queue, AInputEvent* event);
1334
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001335/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001336 * Report that dispatching has finished with the given event.
1337 * This must be called after receiving an event with AInputQueue_get_event().
1338 */
1339void AInputQueue_finishEvent(AInputQueue* queue, AInputEvent* event, int handled);
1340
1341#ifdef __cplusplus
1342}
1343#endif
1344
1345#endif // _ANDROID_INPUT_H
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001346
1347/** @} */