blob: 5ab4e2926156e06694f45e1f05742c08e33285a3 [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
29/******************************************************************
30 *
31 * IMPORTANT NOTICE:
32 *
33 * This file is part of Android's set of stable system headers
34 * exposed by the Android NDK (Native Development Kit).
35 *
36 * Third-party source AND binary code relies on the definitions
37 * here to be FROZEN ON ALL UPCOMING PLATFORM RELEASES.
38 *
39 * - DO NOT MODIFY ENUMS (EXCEPT IF YOU ADD NEW 32-BIT VALUES)
40 * - DO NOT MODIFY CONSTANTS OR FUNCTIONAL MACROS
41 * - DO NOT CHANGE THE SIGNATURE OF FUNCTIONS IN ANY WAY
42 * - DO NOT CHANGE THE LAYOUT OR SIZE OF STRUCTURES
43 */
44
45/*
46 * Structures and functions to receive and process input events in
47 * native code.
48 *
49 * NOTE: These functions MUST be implemented by /system/lib/libui.so
50 */
51
52#include <stdint.h>
53#include <sys/types.h>
54#include <android/keycodes.h>
55#include <android/looper.h>
56
57#ifdef __cplusplus
58extern "C" {
59#endif
60
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070061/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -070062 * Key states (may be returned by queries about the current state of a
63 * particular key code, scan code or switch).
64 */
65enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070066 /** The key state is unknown or the requested key itself is not supported. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070067 AKEY_STATE_UNKNOWN = -1,
68
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070069 /** The key is up. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070070 AKEY_STATE_UP = 0,
71
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070072 /** The key is down. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070073 AKEY_STATE_DOWN = 1,
74
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070075 /** The key is down but is a virtual key press that is being emulated by the system. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070076 AKEY_STATE_VIRTUAL = 2
77};
78
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070079/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -070080 * Meta key / modifer state.
81 */
82enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070083 /** No meta keys are pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070084 AMETA_NONE = 0,
85
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070086 /** This mask is used to check whether one of the ALT meta keys is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070087 AMETA_ALT_ON = 0x02,
88
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070089 /** This mask is used to check whether the left ALT meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070090 AMETA_ALT_LEFT_ON = 0x10,
91
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070092 /** This mask is used to check whether the right ALT meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070093 AMETA_ALT_RIGHT_ON = 0x20,
94
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070095 /** This mask is used to check whether one of the SHIFT meta keys is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070096 AMETA_SHIFT_ON = 0x01,
97
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -070098 /** This mask is used to check whether the left SHIFT meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -070099 AMETA_SHIFT_LEFT_ON = 0x40,
100
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700101 /** This mask is used to check whether the right SHIFT meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700102 AMETA_SHIFT_RIGHT_ON = 0x80,
103
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700104 /** This mask is used to check whether the SYM meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700105 AMETA_SYM_ON = 0x04,
106
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700107 /** This mask is used to check whether the FUNCTION meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700108 AMETA_FUNCTION_ON = 0x08,
109
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700110 /** This mask is used to check whether one of the CTRL meta keys is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700111 AMETA_CTRL_ON = 0x1000,
112
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700113 /** This mask is used to check whether the left CTRL meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700114 AMETA_CTRL_LEFT_ON = 0x2000,
115
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700116 /** This mask is used to check whether the right CTRL meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700117 AMETA_CTRL_RIGHT_ON = 0x4000,
118
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700119 /** This mask is used to check whether one of the META meta keys is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700120 AMETA_META_ON = 0x10000,
121
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700122 /** This mask is used to check whether the left META meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700123 AMETA_META_LEFT_ON = 0x20000,
124
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700125 /** This mask is used to check whether the right META meta key is pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700126 AMETA_META_RIGHT_ON = 0x40000,
127
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700128 /** This mask is used to check whether the CAPS LOCK meta key is on. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700129 AMETA_CAPS_LOCK_ON = 0x100000,
130
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700131 /** This mask is used to check whether the NUM LOCK meta key is on. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700132 AMETA_NUM_LOCK_ON = 0x200000,
133
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700134 /** This mask is used to check whether the SCROLL LOCK meta key is on. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700135 AMETA_SCROLL_LOCK_ON = 0x400000,
136};
137
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700138struct AInputEvent;
139/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700140 * Input events.
141 *
142 * Input events are opaque structures. Use the provided accessors functions to
143 * read their properties.
144 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700145typedef struct AInputEvent AInputEvent;
146
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700147/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700148 * Input event types.
149 */
150enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700151 /** Indicates that the input event is a key event. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700152 AINPUT_EVENT_TYPE_KEY = 1,
153
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700154 /** Indicates that the input event is a motion event. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700155 AINPUT_EVENT_TYPE_MOTION = 2
156};
157
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700158/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700159 * Key event actions.
160 */
161enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700162 /** The key has been pressed down. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700163 AKEY_EVENT_ACTION_DOWN = 0,
164
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700165 /** The key has been released. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700166 AKEY_EVENT_ACTION_UP = 1,
167
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700168 /**
169 * Multiple duplicate key events have occurred in a row, or a
170 * complex string is being delivered. The repeat_count property
171 * of the key event contains the number of times the given key
172 * code should be executed.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700173 */
174 AKEY_EVENT_ACTION_MULTIPLE = 2
175};
176
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700177/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700178 * Key event flags.
179 */
180enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700181 /** This mask is set if the device woke because of this key event. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700182 AKEY_EVENT_FLAG_WOKE_HERE = 0x1,
183
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700184 /** This mask is set if the key event was generated by a software keyboard. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700185 AKEY_EVENT_FLAG_SOFT_KEYBOARD = 0x2,
186
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700187 /** 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 -0700188 AKEY_EVENT_FLAG_KEEP_TOUCH_MODE = 0x4,
189
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700190 /**
191 * This mask is set if an event was known to come from a trusted
192 * part of the system. That is, the event is known to come from
193 * the user, and could not have been spoofed by a third party
194 * component.
195 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700196 AKEY_EVENT_FLAG_FROM_SYSTEM = 0x8,
197
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700198 /**
199 * This mask is used for compatibility, to identify enter keys that are
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700200 * coming from an IME whose enter key has been auto-labelled "next" or
201 * "done". This allows TextView to dispatch these as normal enter keys
202 * for old applications, but still do the appropriate action when
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700203 * receiving them.
204 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700205 AKEY_EVENT_FLAG_EDITOR_ACTION = 0x10,
206
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700207 /**
208 * When associated with up key events, this indicates that the key press
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700209 * has been canceled. Typically this is used with virtual touch screen
210 * keys, where the user can slide from the virtual key area on to the
211 * display: in that case, the application will receive a canceled up
212 * event and should not perform the action normally associated with the
213 * key. Note that for this to work, the application can not perform an
214 * action for a key until it receives an up or the long press timeout has
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700215 * expired.
216 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700217 AKEY_EVENT_FLAG_CANCELED = 0x20,
218
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700219 /**
220 * This key event was generated by a virtual (on-screen) hard key area.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700221 * Typically this is an area of the touchscreen, outside of the regular
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700222 * display, dedicated to "hardware" buttons.
223 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700224 AKEY_EVENT_FLAG_VIRTUAL_HARD_KEY = 0x40,
225
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700226 /**
227 * This flag is set for the first key repeat that occurs after the
228 * long press timeout.
229 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700230 AKEY_EVENT_FLAG_LONG_PRESS = 0x80,
231
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700232 /**
233 * Set when a key event has AKEY_EVENT_FLAG_CANCELED set because a long
234 * press action was executed while it was down.
235 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700236 AKEY_EVENT_FLAG_CANCELED_LONG_PRESS = 0x100,
237
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700238 /**
239 * Set for AKEY_EVENT_ACTION_UP when this event's key code is still being
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700240 * tracked from its initial down. That is, somebody requested that tracking
241 * started on the key down and a long press has not caused
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700242 * the tracking to be canceled.
243 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700244 AKEY_EVENT_FLAG_TRACKING = 0x200,
245
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700246 /**
247 * Set when a key event has been synthesized to implement default behavior
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700248 * for an event that the application did not handle.
249 * Fallback key events are generated by unhandled trackball motions
250 * (to emulate a directional keypad) and by certain unhandled key presses
251 * that are declared in the key map (such as special function numeric keypad
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700252 * keys when numlock is off).
253 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700254 AKEY_EVENT_FLAG_FALLBACK = 0x400,
255};
256
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700257/**
258 * Bit shift for the action bits holding the pointer index as
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700259 * defined by AMOTION_EVENT_ACTION_POINTER_INDEX_MASK.
260 */
261#define AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT 8
262
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700263/** Motion event actions */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700264enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700265 /** Bit mask of the parts of the action code that are the action itself. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700266 AMOTION_EVENT_ACTION_MASK = 0xff,
267
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700268 /**
269 * Bits in the action code that represent a pointer index, used with
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700270 * AMOTION_EVENT_ACTION_POINTER_DOWN and AMOTION_EVENT_ACTION_POINTER_UP. Shifting
271 * down by AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT provides the actual pointer
272 * index where the data for the pointer going up or down can be found.
273 */
274 AMOTION_EVENT_ACTION_POINTER_INDEX_MASK = 0xff00,
275
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700276 /** A pressed gesture has started, the motion contains the initial starting location. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700277 AMOTION_EVENT_ACTION_DOWN = 0,
278
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700279 /**
280 * A pressed gesture has finished, the motion contains the final release location
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700281 * as well as any intermediate points since the last down or move event.
282 */
283 AMOTION_EVENT_ACTION_UP = 1,
284
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700285 /**
286 * A change has happened during a press gesture (between AMOTION_EVENT_ACTION_DOWN and
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700287 * AMOTION_EVENT_ACTION_UP). The motion contains the most recent point, as well as
288 * any intermediate points since the last down or move event.
289 */
290 AMOTION_EVENT_ACTION_MOVE = 2,
291
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700292 /**
293 * The current gesture has been aborted.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700294 * You will not receive any more points in it. You should treat this as
295 * an up event, but not perform any action that you normally would.
296 */
297 AMOTION_EVENT_ACTION_CANCEL = 3,
298
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700299 /**
300 * A movement has happened outside of the normal bounds of the UI element.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700301 * This does not provide a full gesture, but only the initial location of the movement/touch.
302 */
303 AMOTION_EVENT_ACTION_OUTSIDE = 4,
304
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700305 /**
306 * A non-primary pointer has gone down.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700307 * The bits in AMOTION_EVENT_ACTION_POINTER_INDEX_MASK indicate which pointer changed.
308 */
309 AMOTION_EVENT_ACTION_POINTER_DOWN = 5,
310
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700311 /**
312 * A non-primary pointer has gone up.
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_UP = 6,
316
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700317 /**
318 * A change happened but the pointer is not down (unlike AMOTION_EVENT_ACTION_MOVE).
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700319 * The motion contains the most recent point, as well as any intermediate points since
320 * the last hover move event.
321 */
322 AMOTION_EVENT_ACTION_HOVER_MOVE = 7,
323
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700324 /**
325 * The motion event contains relative vertical and/or horizontal scroll offsets.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700326 * Use getAxisValue to retrieve the information from AMOTION_EVENT_AXIS_VSCROLL
327 * and AMOTION_EVENT_AXIS_HSCROLL.
328 * The pointer may or may not be down when this event is dispatched.
329 * This action is always delivered to the winder under the pointer, which
330 * may not be the window currently touched.
331 */
332 AMOTION_EVENT_ACTION_SCROLL = 8,
333
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700334 /** The pointer is not down but has entered the boundaries of a window or view. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700335 AMOTION_EVENT_ACTION_HOVER_ENTER = 9,
336
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700337 /** The pointer is not down but has exited the boundaries of a window or view. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700338 AMOTION_EVENT_ACTION_HOVER_EXIT = 10,
Michael Wright7b159c92015-05-14 14:48:03 +0100339
340 /* One or more buttons have been pressed. */
341 AMOTION_EVENT_ACTION_BUTTON_PRESS = 11,
342
343 /* One or more buttons have been released. */
344 AMOTION_EVENT_ACTION_BUTTON_RELEASE = 12,
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700345};
346
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700347/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700348 * Motion event flags.
349 */
350enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700351 /**
352 * This flag indicates that the window that received this motion event is partly
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700353 * or wholly obscured by another visible window above it. This flag is set to true
354 * even if the event did not directly pass through the obscured area.
355 * A security sensitive application can check this flag to identify situations in which
356 * a malicious application may have covered up part of its content for the purpose
357 * of misleading the user or hijacking touches. An appropriate response might be
358 * to drop the suspect touches or to take additional precautions to confirm the user's
359 * actual intent.
360 */
361 AMOTION_EVENT_FLAG_WINDOW_IS_OBSCURED = 0x1,
362};
363
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700364/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700365 * Motion event edge touch flags.
366 */
367enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700368 /** No edges intersected. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700369 AMOTION_EVENT_EDGE_FLAG_NONE = 0,
370
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700371 /** Flag indicating the motion event intersected the top edge of the screen. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700372 AMOTION_EVENT_EDGE_FLAG_TOP = 0x01,
373
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700374 /** Flag indicating the motion event intersected the bottom edge of the screen. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700375 AMOTION_EVENT_EDGE_FLAG_BOTTOM = 0x02,
376
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700377 /** Flag indicating the motion event intersected the left edge of the screen. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700378 AMOTION_EVENT_EDGE_FLAG_LEFT = 0x04,
379
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700380 /** Flag indicating the motion event intersected the right edge of the screen. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700381 AMOTION_EVENT_EDGE_FLAG_RIGHT = 0x08
382};
383
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700384/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700385 * Constants that identify each individual axis of a motion event.
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700386 * @anchor AMOTION_EVENT_AXIS
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700387 */
388enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700389 /**
390 * Axis constant: X axis of a motion event.
391 *
392 * - For a touch screen, reports the absolute X screen position of the center of
393 * the touch contact area. The units are display pixels.
394 * - For a touch pad, reports the absolute X surface position of the center of the touch
395 * contact area. The units are device-dependent.
396 * - For a mouse, reports the absolute X screen position of the mouse pointer.
397 * The units are display pixels.
398 * - For a trackball, reports the relative horizontal displacement of the trackball.
399 * The value is normalized to a range from -1.0 (left) to 1.0 (right).
400 * - For a joystick, reports the absolute X position of the joystick.
401 * The value is normalized to a range from -1.0 (left) to 1.0 (right).
402 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700403 AMOTION_EVENT_AXIS_X = 0,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700404 /**
405 * Axis constant: Y axis of a motion event.
406 *
407 * - For a touch screen, reports the absolute Y screen position of the center of
408 * the touch contact area. The units are display pixels.
409 * - For a touch pad, reports the absolute Y surface position of the center of the touch
410 * contact area. The units are device-dependent.
411 * - For a mouse, reports the absolute Y screen position of the mouse pointer.
412 * The units are display pixels.
413 * - For a trackball, reports the relative vertical displacement of the trackball.
414 * The value is normalized to a range from -1.0 (up) to 1.0 (down).
415 * - For a joystick, reports the absolute Y position of the joystick.
416 * The value is normalized to a range from -1.0 (up or far) to 1.0 (down or near).
417 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700418 AMOTION_EVENT_AXIS_Y = 1,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700419 /**
420 * Axis constant: Pressure axis of a motion event.
421 *
422 * - For a touch screen or touch pad, reports the approximate pressure applied to the surface
423 * by a finger or other tool. The value is normalized to a range from
424 * 0 (no pressure at all) to 1 (normal pressure), although values higher than 1
425 * may be generated depending on the calibration of the input device.
426 * - For a trackball, the value is set to 1 if the trackball button is pressed
427 * or 0 otherwise.
428 * - For a mouse, the value is set to 1 if the primary mouse button is pressed
429 * or 0 otherwise.
430 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700431 AMOTION_EVENT_AXIS_PRESSURE = 2,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700432 /**
433 * Axis constant: Size axis of a motion event.
434 *
435 * - For a touch screen or touch pad, reports the approximate size of the contact area in
436 * relation to the maximum detectable size for the device. The value is normalized
437 * to a range from 0 (smallest detectable size) to 1 (largest detectable size),
438 * although it is not a linear scale. This value is of limited use.
439 * To obtain calibrated size information, see
440 * {@link AMOTION_EVENT_AXIS_TOUCH_MAJOR} or {@link AMOTION_EVENT_AXIS_TOOL_MAJOR}.
441 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700442 AMOTION_EVENT_AXIS_SIZE = 3,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700443 /**
444 * Axis constant: TouchMajor axis of a motion event.
445 *
446 * - For a touch screen, reports the length of the major axis of an ellipse that
447 * represents the touch area at the point of contact.
448 * The units are display pixels.
449 * - For a touch pad, reports the length of the major axis of an ellipse that
450 * represents the touch area at the point of contact.
451 * The units are device-dependent.
452 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700453 AMOTION_EVENT_AXIS_TOUCH_MAJOR = 4,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700454 /**
455 * Axis constant: TouchMinor axis of a motion event.
456 *
457 * - For a touch screen, reports the length of the minor axis of an ellipse that
458 * represents the touch area at the point of contact.
459 * The units are display pixels.
460 * - For a touch pad, reports the length of the minor axis of an ellipse that
461 * represents the touch area at the point of contact.
462 * The units are device-dependent.
463 *
464 * When the touch is circular, the major and minor axis lengths will be equal to one another.
465 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700466 AMOTION_EVENT_AXIS_TOUCH_MINOR = 5,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700467 /**
468 * Axis constant: ToolMajor axis of a motion event.
469 *
470 * - For a touch screen, reports the length of the major axis of an ellipse that
471 * represents the size of the approaching finger or tool used to make contact.
472 * - For a touch pad, reports the length of the major axis of an ellipse that
473 * represents the size of the approaching finger or tool used to make contact.
474 * The units are device-dependent.
475 *
476 * When the touch is circular, the major and minor axis lengths will be equal to one another.
477 *
478 * The tool size may be larger than the touch size since the tool may not be fully
479 * in contact with the touch sensor.
480 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700481 AMOTION_EVENT_AXIS_TOOL_MAJOR = 6,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700482 /**
483 * Axis constant: ToolMinor axis of a motion event.
484 *
485 * - For a touch screen, reports the length of the minor axis of an ellipse that
486 * represents the size of the approaching finger or tool used to make contact.
487 * - For a touch pad, reports the length of the minor axis of an ellipse that
488 * represents the size of the approaching finger or tool used to make contact.
489 * The units are device-dependent.
490 *
491 * When the touch is circular, the major and minor axis lengths will be equal to one another.
492 *
493 * The tool size may be larger than the touch size since the tool may not be fully
494 * in contact with the touch sensor.
495 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700496 AMOTION_EVENT_AXIS_TOOL_MINOR = 7,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700497 /**
498 * Axis constant: Orientation axis of a motion event.
499 *
500 * - For a touch screen or touch pad, reports the orientation of the finger
501 * or tool in radians relative to the vertical plane of the device.
502 * An angle of 0 radians indicates that the major axis of contact is oriented
503 * upwards, is perfectly circular or is of unknown orientation. A positive angle
504 * indicates that the major axis of contact is oriented to the right. A negative angle
505 * indicates that the major axis of contact is oriented to the left.
506 * The full range is from -PI/2 radians (finger pointing fully left) to PI/2 radians
507 * (finger pointing fully right).
508 * - For a stylus, the orientation indicates the direction in which the stylus
509 * is pointing in relation to the vertical axis of the current orientation of the screen.
510 * The range is from -PI radians to PI radians, where 0 is pointing up,
511 * -PI/2 radians is pointing left, -PI or PI radians is pointing down, and PI/2 radians
512 * is pointing right. See also {@link AMOTION_EVENT_AXIS_TILT}.
513 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700514 AMOTION_EVENT_AXIS_ORIENTATION = 8,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700515 /**
516 * Axis constant: Vertical Scroll axis of a motion event.
517 *
518 * - For a mouse, reports the relative movement of the vertical scroll wheel.
519 * The value is normalized to a range from -1.0 (down) to 1.0 (up).
520 *
521 * This axis should be used to scroll views vertically.
522 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700523 AMOTION_EVENT_AXIS_VSCROLL = 9,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700524 /**
525 * Axis constant: Horizontal Scroll axis of a motion event.
526 *
527 * - For a mouse, reports the relative movement of the horizontal scroll wheel.
528 * The value is normalized to a range from -1.0 (left) to 1.0 (right).
529 *
530 * This axis should be used to scroll views horizontally.
531 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700532 AMOTION_EVENT_AXIS_HSCROLL = 10,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700533 /**
534 * Axis constant: Z axis of a motion event.
535 *
536 * - For a joystick, reports the absolute Z position of the joystick.
537 * The value is normalized to a range from -1.0 (high) to 1.0 (low).
538 * <em>On game pads with two analog joysticks, this axis is often reinterpreted
539 * to report the absolute X position of the second joystick instead.</em>
540 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700541 AMOTION_EVENT_AXIS_Z = 11,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700542 /**
543 * Axis constant: X Rotation axis of a motion event.
544 *
545 * - For a joystick, reports the absolute rotation angle about the X axis.
546 * The value is normalized to a range from -1.0 (counter-clockwise) to 1.0 (clockwise).
547 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700548 AMOTION_EVENT_AXIS_RX = 12,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700549 /**
550 * Axis constant: Y Rotation axis of a motion event.
551 *
552 * - For a joystick, reports the absolute rotation angle about the Y axis.
553 * The value is normalized to a range from -1.0 (counter-clockwise) to 1.0 (clockwise).
554 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700555 AMOTION_EVENT_AXIS_RY = 13,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700556 /**
557 * Axis constant: Z Rotation axis of a motion event.
558 *
559 * - For a joystick, reports the absolute rotation angle about the Z axis.
560 * The value is normalized to a range from -1.0 (counter-clockwise) to 1.0 (clockwise).
561 * On game pads with two analog joysticks, this axis is often reinterpreted
562 * to report the absolute Y position of the second joystick instead.
563 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700564 AMOTION_EVENT_AXIS_RZ = 14,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700565 /**
566 * Axis constant: Hat X axis of a motion event.
567 *
568 * - For a joystick, reports the absolute X position of the directional hat control.
569 * The value is normalized to a range from -1.0 (left) to 1.0 (right).
570 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700571 AMOTION_EVENT_AXIS_HAT_X = 15,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700572 /**
573 * Axis constant: Hat Y axis of a motion event.
574 *
575 * - For a joystick, reports the absolute Y position of the directional hat control.
576 * The value is normalized to a range from -1.0 (up) to 1.0 (down).
577 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700578 AMOTION_EVENT_AXIS_HAT_Y = 16,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700579 /**
580 * Axis constant: Left Trigger axis of a motion event.
581 *
582 * - For a joystick, reports the absolute position of the left trigger control.
583 * The value is normalized to a range from 0.0 (released) to 1.0 (fully pressed).
584 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700585 AMOTION_EVENT_AXIS_LTRIGGER = 17,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700586 /**
587 * Axis constant: Right Trigger axis of a motion event.
588 *
589 * - For a joystick, reports the absolute position of the right trigger control.
590 * The value is normalized to a range from 0.0 (released) to 1.0 (fully pressed).
591 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700592 AMOTION_EVENT_AXIS_RTRIGGER = 18,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700593 /**
594 * Axis constant: Throttle axis of a motion event.
595 *
596 * - For a joystick, reports the absolute position of the throttle control.
597 * The value is normalized to a range from 0.0 (fully open) to 1.0 (fully closed).
598 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700599 AMOTION_EVENT_AXIS_THROTTLE = 19,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700600 /**
601 * Axis constant: Rudder axis of a motion event.
602 *
603 * - For a joystick, reports the absolute position of the rudder control.
604 * The value is normalized to a range from -1.0 (turn left) to 1.0 (turn right).
605 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700606 AMOTION_EVENT_AXIS_RUDDER = 20,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700607 /**
608 * Axis constant: Wheel axis of a motion event.
609 *
610 * - For a joystick, reports the absolute position of the steering wheel control.
611 * The value is normalized to a range from -1.0 (turn left) to 1.0 (turn right).
612 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700613 AMOTION_EVENT_AXIS_WHEEL = 21,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700614 /**
615 * Axis constant: Gas axis of a motion event.
616 *
617 * - For a joystick, reports the absolute position of the gas (accelerator) control.
618 * The value is normalized to a range from 0.0 (no acceleration)
619 * to 1.0 (maximum acceleration).
620 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700621 AMOTION_EVENT_AXIS_GAS = 22,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700622 /**
623 * Axis constant: Brake axis of a motion event.
624 *
625 * - For a joystick, reports the absolute position of the brake control.
626 * The value is normalized to a range from 0.0 (no braking) to 1.0 (maximum braking).
627 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700628 AMOTION_EVENT_AXIS_BRAKE = 23,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700629 /**
630 * Axis constant: Distance axis of a motion event.
631 *
632 * - For a stylus, reports the distance of the stylus from the screen.
633 * A value of 0.0 indicates direct contact and larger values indicate increasing
634 * distance from the surface.
635 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700636 AMOTION_EVENT_AXIS_DISTANCE = 24,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700637 /**
638 * Axis constant: Tilt axis of a motion event.
639 *
640 * - For a stylus, reports the tilt angle of the stylus in radians where
641 * 0 radians indicates that the stylus is being held perpendicular to the
642 * surface, and PI/2 radians indicates that the stylus is being held flat
643 * against the surface.
644 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700645 AMOTION_EVENT_AXIS_TILT = 25,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700646 /**
647 * Axis constant: Generic 1 axis of a motion event.
648 * The interpretation of a generic axis is device-specific.
649 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700650 AMOTION_EVENT_AXIS_GENERIC_1 = 32,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700651 /**
652 * Axis constant: Generic 2 axis of a motion event.
653 * The interpretation of a generic axis is device-specific.
654 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700655 AMOTION_EVENT_AXIS_GENERIC_2 = 33,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700656 /**
657 * Axis constant: Generic 3 axis of a motion event.
658 * The interpretation of a generic axis is device-specific.
659 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700660 AMOTION_EVENT_AXIS_GENERIC_3 = 34,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700661 /**
662 * Axis constant: Generic 4 axis of a motion event.
663 * The interpretation of a generic axis is device-specific.
664 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700665 AMOTION_EVENT_AXIS_GENERIC_4 = 35,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700666 /**
667 * Axis constant: Generic 5 axis of a motion event.
668 * The interpretation of a generic axis is device-specific.
669 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700670 AMOTION_EVENT_AXIS_GENERIC_5 = 36,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700671 /**
672 * Axis constant: Generic 6 axis of a motion event.
673 * The interpretation of a generic axis is device-specific.
674 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700675 AMOTION_EVENT_AXIS_GENERIC_6 = 37,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700676 /**
677 * Axis constant: Generic 7 axis of a motion event.
678 * The interpretation of a generic axis is device-specific.
679 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700680 AMOTION_EVENT_AXIS_GENERIC_7 = 38,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700681 /**
682 * Axis constant: Generic 8 axis of a motion event.
683 * The interpretation of a generic axis is device-specific.
684 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700685 AMOTION_EVENT_AXIS_GENERIC_8 = 39,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700686 /**
687 * Axis constant: Generic 9 axis of a motion event.
688 * The interpretation of a generic axis is device-specific.
689 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700690 AMOTION_EVENT_AXIS_GENERIC_9 = 40,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700691 /**
692 * Axis constant: Generic 10 axis of a motion event.
693 * The interpretation of a generic axis is device-specific.
694 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700695 AMOTION_EVENT_AXIS_GENERIC_10 = 41,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700696 /**
697 * Axis constant: Generic 11 axis of a motion event.
698 * The interpretation of a generic axis is device-specific.
699 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700700 AMOTION_EVENT_AXIS_GENERIC_11 = 42,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700701 /**
702 * Axis constant: Generic 12 axis of a motion event.
703 * The interpretation of a generic axis is device-specific.
704 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700705 AMOTION_EVENT_AXIS_GENERIC_12 = 43,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700706 /**
707 * Axis constant: Generic 13 axis of a motion event.
708 * The interpretation of a generic axis is device-specific.
709 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700710 AMOTION_EVENT_AXIS_GENERIC_13 = 44,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700711 /**
712 * Axis constant: Generic 14 axis of a motion event.
713 * The interpretation of a generic axis is device-specific.
714 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700715 AMOTION_EVENT_AXIS_GENERIC_14 = 45,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700716 /**
717 * Axis constant: Generic 15 axis of a motion event.
718 * The interpretation of a generic axis is device-specific.
719 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700720 AMOTION_EVENT_AXIS_GENERIC_15 = 46,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700721 /**
722 * Axis constant: Generic 16 axis of a motion event.
723 * The interpretation of a generic axis is device-specific.
724 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700725 AMOTION_EVENT_AXIS_GENERIC_16 = 47,
726
727 // NOTE: If you add a new axis here you must also add it to several other files.
728 // Refer to frameworks/base/core/java/android/view/MotionEvent.java for the full list.
729};
730
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700731/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700732 * Constants that identify buttons that are associated with motion events.
733 * Refer to the documentation on the MotionEvent class for descriptions of each button.
734 */
735enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700736 /** primary */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700737 AMOTION_EVENT_BUTTON_PRIMARY = 1 << 0,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700738 /** secondary */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700739 AMOTION_EVENT_BUTTON_SECONDARY = 1 << 1,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700740 /** tertiary */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700741 AMOTION_EVENT_BUTTON_TERTIARY = 1 << 2,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700742 /** back */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700743 AMOTION_EVENT_BUTTON_BACK = 1 << 3,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700744 /** forward */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700745 AMOTION_EVENT_BUTTON_FORWARD = 1 << 4,
Michael Wright7b159c92015-05-14 14:48:03 +0100746 AMOTION_EVENT_BUTTON_STYLUS_PRIMARY = 1 << 5,
747 AMOTION_EVENT_BUTTON_STYLUS_SECONDARY = 1 << 6,
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700748};
749
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700750/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700751 * Constants that identify tool types.
752 * Refer to the documentation on the MotionEvent class for descriptions of each tool type.
753 */
754enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700755 /** unknown */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700756 AMOTION_EVENT_TOOL_TYPE_UNKNOWN = 0,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700757 /** finger */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700758 AMOTION_EVENT_TOOL_TYPE_FINGER = 1,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700759 /** stylus */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700760 AMOTION_EVENT_TOOL_TYPE_STYLUS = 2,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700761 /** mouse */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700762 AMOTION_EVENT_TOOL_TYPE_MOUSE = 3,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700763 /** eraser */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700764 AMOTION_EVENT_TOOL_TYPE_ERASER = 4,
765};
766
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700767/**
768 * Input source masks.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700769 *
770 * Refer to the documentation on android.view.InputDevice for more details about input sources
771 * and their correct interpretation.
772 */
773enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700774 /** mask */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700775 AINPUT_SOURCE_CLASS_MASK = 0x000000ff,
776
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700777 /** none */
Michael Wrightaadaca72013-03-11 14:20:14 -0700778 AINPUT_SOURCE_CLASS_NONE = 0x00000000,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700779 /** button */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700780 AINPUT_SOURCE_CLASS_BUTTON = 0x00000001,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700781 /** pointer */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700782 AINPUT_SOURCE_CLASS_POINTER = 0x00000002,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700783 /** navigation */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700784 AINPUT_SOURCE_CLASS_NAVIGATION = 0x00000004,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700785 /** position */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700786 AINPUT_SOURCE_CLASS_POSITION = 0x00000008,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700787 /** joystick */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700788 AINPUT_SOURCE_CLASS_JOYSTICK = 0x00000010,
789};
790
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700791/**
792 * Input sources.
793 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700794enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700795 /** unknown */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700796 AINPUT_SOURCE_UNKNOWN = 0x00000000,
797
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700798 /** keyboard */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700799 AINPUT_SOURCE_KEYBOARD = 0x00000100 | AINPUT_SOURCE_CLASS_BUTTON,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700800 /** dpad */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700801 AINPUT_SOURCE_DPAD = 0x00000200 | AINPUT_SOURCE_CLASS_BUTTON,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700802 /** gamepad */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700803 AINPUT_SOURCE_GAMEPAD = 0x00000400 | AINPUT_SOURCE_CLASS_BUTTON,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700804 /** touchscreen */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700805 AINPUT_SOURCE_TOUCHSCREEN = 0x00001000 | AINPUT_SOURCE_CLASS_POINTER,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700806 /** mouse */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700807 AINPUT_SOURCE_MOUSE = 0x00002000 | AINPUT_SOURCE_CLASS_POINTER,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700808 /** stylus */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700809 AINPUT_SOURCE_STYLUS = 0x00004000 | AINPUT_SOURCE_CLASS_POINTER,
Michael Wright7d3ad692015-06-23 19:04:31 +0100810 /** bluetooth stylus */
Michael Wright2f78b682015-06-12 15:25:08 +0100811 AINPUT_SOURCE_BLUETOOTH_STYLUS = 0x00008000 | AINPUT_SOURCE_STYLUS,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700812 /** trackball */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700813 AINPUT_SOURCE_TRACKBALL = 0x00010000 | AINPUT_SOURCE_CLASS_NAVIGATION,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700814 /** touchpad */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700815 AINPUT_SOURCE_TOUCHPAD = 0x00100000 | AINPUT_SOURCE_CLASS_POSITION,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700816 /** navigation */
Michael Wrightaadaca72013-03-11 14:20:14 -0700817 AINPUT_SOURCE_TOUCH_NAVIGATION = 0x00200000 | AINPUT_SOURCE_CLASS_NONE,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700818 /** joystick */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700819 AINPUT_SOURCE_JOYSTICK = 0x01000000 | AINPUT_SOURCE_CLASS_JOYSTICK,
820
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700821 /** any */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700822 AINPUT_SOURCE_ANY = 0xffffff00,
823};
824
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700825/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700826 * Keyboard types.
827 *
828 * Refer to the documentation on android.view.InputDevice for more details.
829 */
830enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700831 /** none */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700832 AINPUT_KEYBOARD_TYPE_NONE = 0,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700833 /** non alphabetic */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700834 AINPUT_KEYBOARD_TYPE_NON_ALPHABETIC = 1,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700835 /** alphabetic */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700836 AINPUT_KEYBOARD_TYPE_ALPHABETIC = 2,
837};
838
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700839/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700840 * Constants used to retrieve information about the range of motion for a particular
841 * coordinate of a motion event.
842 *
843 * Refer to the documentation on android.view.InputDevice for more details about input sources
844 * and their correct interpretation.
845 *
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700846 * @deprecated These constants are deprecated. Use {@link AMOTION_EVENT_AXIS AMOTION_EVENT_AXIS_*} constants instead.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700847 */
848enum {
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700849 /** x */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700850 AINPUT_MOTION_RANGE_X = AMOTION_EVENT_AXIS_X,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700851 /** y */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700852 AINPUT_MOTION_RANGE_Y = AMOTION_EVENT_AXIS_Y,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700853 /** pressure */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700854 AINPUT_MOTION_RANGE_PRESSURE = AMOTION_EVENT_AXIS_PRESSURE,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700855 /** size */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700856 AINPUT_MOTION_RANGE_SIZE = AMOTION_EVENT_AXIS_SIZE,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700857 /** touch major */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700858 AINPUT_MOTION_RANGE_TOUCH_MAJOR = AMOTION_EVENT_AXIS_TOUCH_MAJOR,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700859 /** touch minor */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700860 AINPUT_MOTION_RANGE_TOUCH_MINOR = AMOTION_EVENT_AXIS_TOUCH_MINOR,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700861 /** tool major */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700862 AINPUT_MOTION_RANGE_TOOL_MAJOR = AMOTION_EVENT_AXIS_TOOL_MAJOR,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700863 /** tool minor */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700864 AINPUT_MOTION_RANGE_TOOL_MINOR = AMOTION_EVENT_AXIS_TOOL_MINOR,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700865 /** orientation */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700866 AINPUT_MOTION_RANGE_ORIENTATION = AMOTION_EVENT_AXIS_ORIENTATION,
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700867};
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700868
869
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700870/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700871 * Input event accessors.
872 *
873 * Note that most functions can only be used on input events that are of a given type.
874 * Calling these functions on input events of other types will yield undefined behavior.
875 */
876
877/*** Accessors for all input events. ***/
878
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700879/** Get the input event type. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700880int32_t AInputEvent_getType(const AInputEvent* event);
881
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700882/** Get the id for the device that an input event came from.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700883 *
884 * Input events can be generated by multiple different input devices.
885 * Use the input device id to obtain information about the input
886 * device that was responsible for generating a particular event.
887 *
888 * An input device id of 0 indicates that the event didn't come from a physical device;
889 * other numbers are arbitrary and you shouldn't depend on the values.
890 * Use the provided input device query API to obtain information about input devices.
891 */
892int32_t AInputEvent_getDeviceId(const AInputEvent* event);
893
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700894/** Get the input event source. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700895int32_t AInputEvent_getSource(const AInputEvent* event);
896
897/*** Accessors for key events only. ***/
898
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700899/** Get the key event action. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700900int32_t AKeyEvent_getAction(const AInputEvent* key_event);
901
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700902/** Get the key event flags. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700903int32_t AKeyEvent_getFlags(const AInputEvent* key_event);
904
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700905/**
906 * Get the key code of the key event.
907 * This is the physical key that was pressed, not the Unicode character.
908 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700909int32_t AKeyEvent_getKeyCode(const AInputEvent* key_event);
910
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700911/**
912 * Get the hardware key id of this key event.
913 * These values are not reliable and vary from device to device.
914 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700915int32_t AKeyEvent_getScanCode(const AInputEvent* key_event);
916
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700917/** Get the meta key state. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700918int32_t AKeyEvent_getMetaState(const AInputEvent* key_event);
919
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700920/**
921 * Get the repeat count of the event.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700922 * For both key up an key down events, this is the number of times the key has
923 * repeated with the first down starting at 0 and counting up from there. For
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700924 * multiple key events, this is the number of down/up pairs that have occurred.
925 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700926int32_t AKeyEvent_getRepeatCount(const AInputEvent* key_event);
927
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700928/**
929 * Get the time of the most recent key down event, in the
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700930 * java.lang.System.nanoTime() time base. If this is a down event,
931 * this will be the same as eventTime.
932 * Note that when chording keys, this value is the down time of the most recently
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700933 * pressed key, which may not be the same physical key of this event.
934 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700935int64_t AKeyEvent_getDownTime(const AInputEvent* key_event);
936
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700937/**
938 * Get the time this event occurred, in the
939 * java.lang.System.nanoTime() time base.
940 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700941int64_t AKeyEvent_getEventTime(const AInputEvent* key_event);
942
943/*** Accessors for motion events only. ***/
944
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700945/** Get the combined motion event action code and pointer index. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700946int32_t AMotionEvent_getAction(const AInputEvent* motion_event);
947
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700948/** Get the motion event flags. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700949int32_t AMotionEvent_getFlags(const AInputEvent* motion_event);
950
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700951/**
952 * Get the state of any meta / modifier keys that were in effect when the
953 * event was generated.
954 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700955int32_t AMotionEvent_getMetaState(const AInputEvent* motion_event);
956
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700957/** Get the button state of all buttons that are pressed. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700958int32_t AMotionEvent_getButtonState(const AInputEvent* motion_event);
959
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700960/**
961 * Get a bitfield indicating which edges, if any, were touched by this motion event.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700962 * For touch events, clients can use this to determine if the user's finger was
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700963 * touching the edge of the display.
964 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700965int32_t AMotionEvent_getEdgeFlags(const AInputEvent* motion_event);
966
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700967/**
968 * Get the time when the user originally pressed down to start a stream of
969 * position events, in the java.lang.System.nanoTime() time base.
970 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700971int64_t AMotionEvent_getDownTime(const AInputEvent* motion_event);
972
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700973/**
974 * Get the time when this specific event was generated,
975 * in the java.lang.System.nanoTime() time base.
976 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700977int64_t AMotionEvent_getEventTime(const AInputEvent* motion_event);
978
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700979/**
980 * Get the X coordinate offset.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700981 * For touch events on the screen, this is the delta that was added to the raw
982 * screen coordinates to adjust for the absolute position of the containing windows
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700983 * and views.
984 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700985float AMotionEvent_getXOffset(const AInputEvent* motion_event);
986
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700987/**
988 * Get the Y coordinate offset.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700989 * For touch events on the screen, this is the delta that was added to the raw
990 * screen coordinates to adjust for the absolute position of the containing windows
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700991 * and views.
992 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700993float AMotionEvent_getYOffset(const AInputEvent* motion_event);
994
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700995/**
996 * Get the precision of the X coordinates being reported.
Mathias Agopiane1c61d32012-03-23 14:19:36 -0700997 * You can multiply this number with an X coordinate sample to find the
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -0700998 * actual hardware value of the X coordinate.
999 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001000float AMotionEvent_getXPrecision(const AInputEvent* motion_event);
1001
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001002/**
1003 * Get the precision of the Y coordinates being reported.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001004 * You can multiply this number with a Y coordinate sample to find the
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001005 * actual hardware value of the Y coordinate.
1006 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001007float AMotionEvent_getYPrecision(const AInputEvent* motion_event);
1008
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001009/**
1010 * Get the number of pointers of data contained in this event.
1011 * Always >= 1.
1012 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001013size_t AMotionEvent_getPointerCount(const AInputEvent* motion_event);
1014
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001015/**
1016 * Get the pointer identifier associated with a particular pointer
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001017 * data index in this event. The identifier tells you the actual pointer
1018 * number associated with the data, accounting for individual pointers
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001019 * going up and down since the start of the current gesture.
1020 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001021int32_t AMotionEvent_getPointerId(const AInputEvent* motion_event, size_t pointer_index);
1022
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001023/**
1024 * Get the tool type of a pointer for the given pointer index.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001025 * The tool type indicates the type of tool used to make contact such as a
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001026 * finger or stylus, if known.
1027 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001028int32_t AMotionEvent_getToolType(const AInputEvent* motion_event, size_t pointer_index);
1029
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001030/**
1031 * Get the original raw X coordinate of this event.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001032 * For touch events on the screen, this is the original location of the event
1033 * on the screen, before it had been adjusted for the containing window
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001034 * and views.
1035 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001036float AMotionEvent_getRawX(const AInputEvent* motion_event, size_t pointer_index);
1037
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001038/**
1039 * Get the original raw X coordinate of this event.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001040 * For touch events on the screen, this is the original location of the event
1041 * on the screen, before it had been adjusted for the containing window
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001042 * and views.
1043 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001044float AMotionEvent_getRawY(const AInputEvent* motion_event, size_t pointer_index);
1045
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001046/**
1047 * Get the current X coordinate of this event for the given pointer index.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001048 * Whole numbers are pixels; the value may have a fraction for input devices
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001049 * that are sub-pixel precise.
1050 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001051float AMotionEvent_getX(const AInputEvent* motion_event, size_t pointer_index);
1052
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001053/**
1054 * Get the current Y coordinate of this event for the given pointer index.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001055 * Whole numbers are pixels; the value may have a fraction for input devices
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001056 * that are sub-pixel precise.
1057 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001058float AMotionEvent_getY(const AInputEvent* motion_event, size_t pointer_index);
1059
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001060/**
1061 * Get the current pressure of this event for the given pointer index.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001062 * The pressure generally ranges from 0 (no pressure at all) to 1 (normal pressure),
1063 * although values higher than 1 may be generated depending on the calibration of
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001064 * the input device.
1065 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001066float AMotionEvent_getPressure(const AInputEvent* motion_event, size_t pointer_index);
1067
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001068/**
1069 * Get the current scaled value of the approximate size for the given pointer index.
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001070 * This represents some approximation of the area of the screen being
1071 * pressed; the actual value in pixels corresponding to the
1072 * touch is normalized with the device specific range of values
1073 * and scaled to a value between 0 and 1. The value of size can be used to
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001074 * determine fat touch events.
1075 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001076float AMotionEvent_getSize(const AInputEvent* motion_event, size_t pointer_index);
1077
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001078/**
1079 * Get the current length of the major axis of an ellipse that describes the touch area
1080 * at the point of contact for the given pointer index.
1081 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001082float AMotionEvent_getTouchMajor(const AInputEvent* motion_event, size_t pointer_index);
1083
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001084/**
1085 * Get the current length of the minor axis of an ellipse that describes the touch area
1086 * at the point of contact for the given pointer index.
1087 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001088float AMotionEvent_getTouchMinor(const AInputEvent* motion_event, size_t pointer_index);
1089
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001090/**
1091 * Get the current length of the major axis of an ellipse that describes the size
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001092 * of the approaching tool for the given pointer index.
1093 * The tool area represents the estimated size of the finger or pen that is
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001094 * touching the device independent of its actual touch area at the point of contact.
1095 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001096float AMotionEvent_getToolMajor(const AInputEvent* motion_event, size_t pointer_index);
1097
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001098/**
1099 * Get the current length of the minor axis of an ellipse that describes the size
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001100 * of the approaching tool for the given pointer index.
1101 * The tool area represents the estimated size of the finger or pen that is
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001102 * touching the device independent of its actual touch area at the point of contact.
1103 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001104float AMotionEvent_getToolMinor(const AInputEvent* motion_event, size_t pointer_index);
1105
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001106/**
1107 * Get the current orientation of the touch area and tool area in radians clockwise from
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001108 * vertical for the given pointer index.
1109 * An angle of 0 degrees indicates that the major axis of contact is oriented
1110 * upwards, is perfectly circular or is of unknown orientation. A positive angle
1111 * indicates that the major axis of contact is oriented to the right. A negative angle
1112 * indicates that the major axis of contact is oriented to the left.
1113 * The full range is from -PI/2 radians (finger pointing fully left) to PI/2 radians
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001114 * (finger pointing fully right).
1115 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001116float AMotionEvent_getOrientation(const AInputEvent* motion_event, size_t pointer_index);
1117
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001118/** Get the value of the request axis for the given pointer index. */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001119float AMotionEvent_getAxisValue(const AInputEvent* motion_event,
1120 int32_t axis, size_t pointer_index);
1121
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001122/**
1123 * Get the number of historical points in this event. These are movements that
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001124 * have occurred between this event and the previous event. This only applies
1125 * to AMOTION_EVENT_ACTION_MOVE events -- all other actions will have a size of 0.
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001126 * Historical samples are indexed from oldest to newest.
1127 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001128size_t AMotionEvent_getHistorySize(const AInputEvent* motion_event);
1129
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001130/**
1131 * Get the time that a historical movement occurred between this event and
1132 * the previous event, in the java.lang.System.nanoTime() time base.
1133 */
Andrew Hsieh26c24162013-05-27 12:26:04 +08001134int64_t AMotionEvent_getHistoricalEventTime(const AInputEvent* motion_event,
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001135 size_t history_index);
1136
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001137/**
1138 * Get the historical raw X coordinate of this event for the given pointer index that
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001139 * occurred between this event and the previous motion event.
1140 * For touch events on the screen, this is the original location of the event
1141 * on the screen, before it had been adjusted for the containing window
1142 * and views.
1143 * Whole numbers are pixels; the value may have a fraction for input devices
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001144 * that are sub-pixel precise.
1145 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001146float AMotionEvent_getHistoricalRawX(const AInputEvent* motion_event, size_t pointer_index,
1147 size_t history_index);
1148
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001149/**
1150 * Get the historical raw Y coordinate of this event for the given pointer index that
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001151 * occurred between this event and the previous motion event.
1152 * For touch events on the screen, this is the original location of the event
1153 * on the screen, before it had been adjusted for the containing window
1154 * and views.
1155 * Whole numbers are pixels; the value may have a fraction for input devices
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001156 * that are sub-pixel precise.
1157 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001158float AMotionEvent_getHistoricalRawY(const AInputEvent* motion_event, size_t pointer_index,
1159 size_t history_index);
1160
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001161/**
1162 * Get the historical X coordinate of this event for the given pointer index that
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001163 * occurred between this event and the previous motion event.
1164 * Whole numbers are pixels; the value may have a fraction for input devices
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001165 * that are sub-pixel precise.
1166 */
Andrew Hsieh26c24162013-05-27 12:26:04 +08001167float AMotionEvent_getHistoricalX(const AInputEvent* motion_event, size_t pointer_index,
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001168 size_t history_index);
1169
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001170/**
1171 * Get the historical Y coordinate of this event for the given pointer index that
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001172 * occurred between this event and the previous motion event.
1173 * Whole numbers are pixels; the value may have a fraction for input devices
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001174 * that are sub-pixel precise.
1175 */
Andrew Hsieh26c24162013-05-27 12:26:04 +08001176float AMotionEvent_getHistoricalY(const AInputEvent* motion_event, size_t pointer_index,
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001177 size_t history_index);
1178
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001179/**
1180 * Get the historical pressure of this event for the given pointer index that
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001181 * occurred between this event and the previous motion event.
1182 * The pressure generally ranges from 0 (no pressure at all) to 1 (normal pressure),
1183 * although values higher than 1 may be generated depending on the calibration of
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001184 * the input device.
1185 */
Andrew Hsieh26c24162013-05-27 12:26:04 +08001186float AMotionEvent_getHistoricalPressure(const AInputEvent* motion_event, size_t pointer_index,
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001187 size_t history_index);
1188
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001189/**
1190 * Get the current scaled value of the approximate size for the given pointer index that
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001191 * occurred between this event and the previous motion event.
1192 * This represents some approximation of the area of the screen being
1193 * pressed; the actual value in pixels corresponding to the
1194 * touch is normalized with the device specific range of values
1195 * and scaled to a value between 0 and 1. The value of size can be used to
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001196 * determine fat touch events.
1197 */
Andrew Hsieh26c24162013-05-27 12:26:04 +08001198float AMotionEvent_getHistoricalSize(const AInputEvent* motion_event, size_t pointer_index,
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001199 size_t history_index);
1200
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001201/**
1202 * Get the historical length of the major axis of an ellipse that describes the touch area
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001203 * at the point of contact for the given pointer index that
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001204 * occurred between this event and the previous motion event.
1205 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001206float AMotionEvent_getHistoricalTouchMajor(const AInputEvent* motion_event, size_t pointer_index,
1207 size_t history_index);
1208
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001209/**
1210 * Get the historical length of the minor axis of an ellipse that describes the touch area
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001211 * at the point of contact for the given pointer index that
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001212 * occurred between this event and the previous motion event.
1213 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001214float AMotionEvent_getHistoricalTouchMinor(const AInputEvent* motion_event, size_t pointer_index,
1215 size_t history_index);
1216
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001217/**
1218 * Get the historical length of the major axis of an ellipse that describes the size
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001219 * of the approaching tool for the given pointer index that
1220 * occurred between this event and the previous motion event.
1221 * The tool area represents the estimated size of the finger or pen that is
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001222 * touching the device independent of its actual touch area at the point of contact.
1223 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001224float AMotionEvent_getHistoricalToolMajor(const AInputEvent* motion_event, size_t pointer_index,
1225 size_t history_index);
1226
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001227/**
1228 * Get the historical length of the minor axis of an ellipse that describes the size
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001229 * of the approaching tool for the given pointer index that
1230 * occurred between this event and the previous motion event.
1231 * The tool area represents the estimated size of the finger or pen that is
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001232 * touching the device independent of its actual touch area at the point of contact.
1233 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001234float AMotionEvent_getHistoricalToolMinor(const AInputEvent* motion_event, size_t pointer_index,
1235 size_t history_index);
1236
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001237/**
1238 * Get the historical orientation of the touch area and tool area in radians clockwise from
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001239 * vertical for the given pointer index that
1240 * occurred between this event and the previous motion event.
1241 * An angle of 0 degrees indicates that the major axis of contact is oriented
1242 * upwards, is perfectly circular or is of unknown orientation. A positive angle
1243 * indicates that the major axis of contact is oriented to the right. A negative angle
1244 * indicates that the major axis of contact is oriented to the left.
1245 * The full range is from -PI/2 radians (finger pointing fully left) to PI/2 radians
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001246 * (finger pointing fully right).
1247 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001248float AMotionEvent_getHistoricalOrientation(const AInputEvent* motion_event, size_t pointer_index,
1249 size_t history_index);
1250
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001251/**
1252 * Get the historical value of the request axis for the given pointer index
1253 * that occurred between this event and the previous motion event.
1254 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001255float AMotionEvent_getHistoricalAxisValue(const AInputEvent* motion_event,
1256 int32_t axis, size_t pointer_index, size_t history_index);
1257
1258
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001259struct AInputQueue;
1260/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001261 * Input queue
1262 *
1263 * An input queue is the facility through which you retrieve input
1264 * events.
1265 */
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001266typedef struct AInputQueue AInputQueue;
1267
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001268/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001269 * Add this input queue to a looper for processing. See
1270 * ALooper_addFd() for information on the ident, callback, and data params.
1271 */
1272void AInputQueue_attachLooper(AInputQueue* queue, ALooper* looper,
1273 int ident, ALooper_callbackFunc callback, void* data);
1274
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001275/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001276 * Remove the input queue from the looper it is currently attached to.
1277 */
1278void AInputQueue_detachLooper(AInputQueue* queue);
1279
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001280/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001281 * Returns true if there are one or more events available in the
1282 * input queue. Returns 1 if the queue has events; 0 if
1283 * it does not have events; and a negative value if there is an error.
1284 */
1285int32_t AInputQueue_hasEvents(AInputQueue* queue);
1286
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001287/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001288 * Returns the next available event from the queue. Returns a negative
1289 * value if no events are available or an error has occurred.
1290 */
1291int32_t AInputQueue_getEvent(AInputQueue* queue, AInputEvent** outEvent);
1292
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001293/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001294 * Sends the key for standard pre-dispatching -- that is, possibly deliver
1295 * it to the current IME to be consumed before the app. Returns 0 if it
1296 * was not pre-dispatched, meaning you can process it right now. If non-zero
1297 * is returned, you must abandon the current event processing and allow the
1298 * event to appear again in the event queue (if it does not get consumed during
1299 * pre-dispatching).
1300 */
1301int32_t AInputQueue_preDispatchEvent(AInputQueue* queue, AInputEvent* event);
1302
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001303/**
Mathias Agopiane1c61d32012-03-23 14:19:36 -07001304 * Report that dispatching has finished with the given event.
1305 * This must be called after receiving an event with AInputQueue_get_event().
1306 */
1307void AInputQueue_finishEvent(AInputQueue* queue, AInputEvent* event, int handled);
1308
1309#ifdef __cplusplus
1310}
1311#endif
1312
1313#endif // _ANDROID_INPUT_H
Johan Euphrosinebf6d5e02015-03-27 17:15:43 -07001314
1315/** @} */