widget/gonk/libui/android_input.h

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

     1 /*
     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  */
    17 #ifndef _ANDROID_INPUT_H
    18 #define _ANDROID_INPUT_H
    20 /******************************************************************
    21  *
    22  * IMPORTANT NOTICE:
    23  *
    24  *   This file is part of Android's set of stable system headers
    25  *   exposed by the Android NDK (Native Development Kit).
    26  *
    27  *   Third-party source AND binary code relies on the definitions
    28  *   here to be FROZEN ON ALL UPCOMING PLATFORM RELEASES.
    29  *
    30  *   - DO NOT MODIFY ENUMS (EXCEPT IF YOU ADD NEW 32-BIT VALUES)
    31  *   - DO NOT MODIFY CONSTANTS OR FUNCTIONAL MACROS
    32  *   - DO NOT CHANGE THE SIGNATURE OF FUNCTIONS IN ANY WAY
    33  *   - DO NOT CHANGE THE LAYOUT OR SIZE OF STRUCTURES
    34  */
    36 /*
    37  * Structures and functions to receive and process input events in
    38  * native code.
    39  *
    40  * NOTE: These functions MUST be implemented by /system/lib/libui.so
    41  */
    43 #include <stdint.h>
    44 #include <sys/types.h>
    45 #include "android_keycodes.h"
    46 #include <android/looper.h>
    48 #ifdef __cplusplus
    49 extern "C" {
    50 #endif
    52 /*
    53  * Key states (may be returned by queries about the current state of a
    54  * particular key code, scan code or switch).
    55  */
    56 enum {
    57     /* The key state is unknown or the requested key itself is not supported. */
    58     AKEY_STATE_UNKNOWN = -1,
    60     /* The key is up. */
    61     AKEY_STATE_UP = 0,
    63     /* The key is down. */
    64     AKEY_STATE_DOWN = 1,
    66     /* The key is down but is a virtual key press that is being emulated by the system. */
    67     AKEY_STATE_VIRTUAL = 2
    68 };
    70 /*
    71  * Meta key / modifer state.
    72  */
    73 enum {
    74     /* No meta keys are pressed. */
    75     AMETA_NONE = 0,
    77     /* This mask is used to check whether one of the ALT meta keys is pressed. */
    78     AMETA_ALT_ON = 0x02,
    80     /* This mask is used to check whether the left ALT meta key is pressed. */
    81     AMETA_ALT_LEFT_ON = 0x10,
    83     /* This mask is used to check whether the right ALT meta key is pressed. */
    84     AMETA_ALT_RIGHT_ON = 0x20,
    86     /* This mask is used to check whether one of the SHIFT meta keys is pressed. */
    87     AMETA_SHIFT_ON = 0x01,
    89     /* This mask is used to check whether the left SHIFT meta key is pressed. */
    90     AMETA_SHIFT_LEFT_ON = 0x40,
    92     /* This mask is used to check whether the right SHIFT meta key is pressed. */
    93     AMETA_SHIFT_RIGHT_ON = 0x80,
    95     /* This mask is used to check whether the SYM meta key is pressed. */
    96     AMETA_SYM_ON = 0x04,
    98     /* This mask is used to check whether the FUNCTION meta key is pressed. */
    99     AMETA_FUNCTION_ON = 0x08,
   101     /* This mask is used to check whether one of the CTRL meta keys is pressed. */
   102     AMETA_CTRL_ON = 0x1000,
   104     /* This mask is used to check whether the left CTRL meta key is pressed. */
   105     AMETA_CTRL_LEFT_ON = 0x2000,
   107     /* This mask is used to check whether the right CTRL meta key is pressed. */
   108     AMETA_CTRL_RIGHT_ON = 0x4000,
   110     /* This mask is used to check whether one of the META meta keys is pressed. */
   111     AMETA_META_ON = 0x10000,
   113     /* This mask is used to check whether the left META meta key is pressed. */
   114     AMETA_META_LEFT_ON = 0x20000,
   116     /* This mask is used to check whether the right META meta key is pressed. */
   117     AMETA_META_RIGHT_ON = 0x40000,
   119     /* This mask is used to check whether the CAPS LOCK meta key is on. */
   120     AMETA_CAPS_LOCK_ON = 0x100000,
   122     /* This mask is used to check whether the NUM LOCK meta key is on. */
   123     AMETA_NUM_LOCK_ON = 0x200000,
   125     /* This mask is used to check whether the SCROLL LOCK meta key is on. */
   126     AMETA_SCROLL_LOCK_ON = 0x400000,
   127 };
   129 /*
   130  * Input events.
   131  *
   132  * Input events are opaque structures.  Use the provided accessors functions to
   133  * read their properties.
   134  */
   135 struct AInputEvent;
   136 typedef struct AInputEvent AInputEvent;
   138 /*
   139  * Input event types.
   140  */
   141 enum {
   142     /* Indicates that the input event is a key event. */
   143     AINPUT_EVENT_TYPE_KEY = 1,
   145     /* Indicates that the input event is a motion event. */
   146     AINPUT_EVENT_TYPE_MOTION = 2
   147 };
   149 /*
   150  * Key event actions.
   151  */
   152 enum {
   153     /* The key has been pressed down. */
   154     AKEY_EVENT_ACTION_DOWN = 0,
   156     /* The key has been released. */
   157     AKEY_EVENT_ACTION_UP = 1,
   159     /* Multiple duplicate key events have occurred in a row, or a complex string is
   160      * being delivered.  The repeat_count property of the key event contains the number
   161      * of times the given key code should be executed.
   162      */
   163     AKEY_EVENT_ACTION_MULTIPLE = 2
   164 };
   166 /*
   167  * Key event flags.
   168  */
   169 enum {
   170     /* This mask is set if the device woke because of this key event. */
   171     AKEY_EVENT_FLAG_WOKE_HERE = 0x1,
   173     /* This mask is set if the key event was generated by a software keyboard. */
   174     AKEY_EVENT_FLAG_SOFT_KEYBOARD = 0x2,
   176     /* This mask is set if we don't want the key event to cause us to leave touch mode. */
   177     AKEY_EVENT_FLAG_KEEP_TOUCH_MODE = 0x4,
   179     /* This mask is set if an event was known to come from a trusted part
   180      * of the system.  That is, the event is known to come from the user,
   181      * and could not have been spoofed by a third party component. */
   182     AKEY_EVENT_FLAG_FROM_SYSTEM = 0x8,
   184     /* This mask is used for compatibility, to identify enter keys that are
   185      * coming from an IME whose enter key has been auto-labelled "next" or
   186      * "done".  This allows TextView to dispatch these as normal enter keys
   187      * for old applications, but still do the appropriate action when
   188      * receiving them. */
   189     AKEY_EVENT_FLAG_EDITOR_ACTION = 0x10,
   191     /* When associated with up key events, this indicates that the key press
   192      * has been canceled.  Typically this is used with virtual touch screen
   193      * keys, where the user can slide from the virtual key area on to the
   194      * display: in that case, the application will receive a canceled up
   195      * event and should not perform the action normally associated with the
   196      * key.  Note that for this to work, the application can not perform an
   197      * action for a key until it receives an up or the long press timeout has
   198      * expired. */
   199     AKEY_EVENT_FLAG_CANCELED = 0x20,
   201     /* This key event was generated by a virtual (on-screen) hard key area.
   202      * Typically this is an area of the touchscreen, outside of the regular
   203      * display, dedicated to "hardware" buttons. */
   204     AKEY_EVENT_FLAG_VIRTUAL_HARD_KEY = 0x40,
   206     /* This flag is set for the first key repeat that occurs after the
   207      * long press timeout. */
   208     AKEY_EVENT_FLAG_LONG_PRESS = 0x80,
   210     /* Set when a key event has AKEY_EVENT_FLAG_CANCELED set because a long
   211      * press action was executed while it was down. */
   212     AKEY_EVENT_FLAG_CANCELED_LONG_PRESS = 0x100,
   214     /* Set for AKEY_EVENT_ACTION_UP when this event's key code is still being
   215      * tracked from its initial down.  That is, somebody requested that tracking
   216      * started on the key down and a long press has not caused
   217      * the tracking to be canceled. */
   218     AKEY_EVENT_FLAG_TRACKING = 0x200,
   220     /* Set when a key event has been synthesized to implement default behavior
   221      * for an event that the application did not handle.
   222      * Fallback key events are generated by unhandled trackball motions
   223      * (to emulate a directional keypad) and by certain unhandled key presses
   224      * that are declared in the key map (such as special function numeric keypad
   225      * keys when numlock is off). */
   226     AKEY_EVENT_FLAG_FALLBACK = 0x400,
   227 };
   229 /*
   230  * Motion event actions.
   231  */
   233 /* Bit shift for the action bits holding the pointer index as
   234  * defined by AMOTION_EVENT_ACTION_POINTER_INDEX_MASK.
   235  */
   236 #define AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT 8
   238 enum {
   239     /* Bit mask of the parts of the action code that are the action itself.
   240      */
   241     AMOTION_EVENT_ACTION_MASK = 0xff,
   243     /* Bits in the action code that represent a pointer index, used with
   244      * AMOTION_EVENT_ACTION_POINTER_DOWN and AMOTION_EVENT_ACTION_POINTER_UP.  Shifting
   245      * down by AMOTION_EVENT_ACTION_POINTER_INDEX_SHIFT provides the actual pointer
   246      * index where the data for the pointer going up or down can be found.
   247      */
   248     AMOTION_EVENT_ACTION_POINTER_INDEX_MASK  = 0xff00,
   250     /* A pressed gesture has started, the motion contains the initial starting location.
   251      */
   252     AMOTION_EVENT_ACTION_DOWN = 0,
   254     /* A pressed gesture has finished, the motion contains the final release location
   255      * as well as any intermediate points since the last down or move event.
   256      */
   257     AMOTION_EVENT_ACTION_UP = 1,
   259     /* A change has happened during a press gesture (between AMOTION_EVENT_ACTION_DOWN and
   260      * AMOTION_EVENT_ACTION_UP).  The motion contains the most recent point, as well as
   261      * any intermediate points since the last down or move event.
   262      */
   263     AMOTION_EVENT_ACTION_MOVE = 2,
   265     /* The current gesture has been aborted.
   266      * You will not receive any more points in it.  You should treat this as
   267      * an up event, but not perform any action that you normally would.
   268      */
   269     AMOTION_EVENT_ACTION_CANCEL = 3,
   271     /* A movement has happened outside of the normal bounds of the UI element.
   272      * This does not provide a full gesture, but only the initial location of the movement/touch.
   273      */
   274     AMOTION_EVENT_ACTION_OUTSIDE = 4,
   276     /* A non-primary pointer has gone down.
   277      * The bits in AMOTION_EVENT_ACTION_POINTER_INDEX_MASK indicate which pointer changed.
   278      */
   279     AMOTION_EVENT_ACTION_POINTER_DOWN = 5,
   281     /* A non-primary pointer has gone up.
   282      * The bits in AMOTION_EVENT_ACTION_POINTER_INDEX_MASK indicate which pointer changed.
   283      */
   284     AMOTION_EVENT_ACTION_POINTER_UP = 6,
   286     /* A change happened but the pointer is not down (unlike AMOTION_EVENT_ACTION_MOVE).
   287      * The motion contains the most recent point, as well as any intermediate points since
   288      * the last hover move event.
   289      */
   290     AMOTION_EVENT_ACTION_HOVER_MOVE = 7,
   292     /* The motion event contains relative vertical and/or horizontal scroll offsets.
   293      * Use getAxisValue to retrieve the information from AMOTION_EVENT_AXIS_VSCROLL
   294      * and AMOTION_EVENT_AXIS_HSCROLL.
   295      * The pointer may or may not be down when this event is dispatched.
   296      * This action is always delivered to the winder under the pointer, which
   297      * may not be the window currently touched.
   298      */
   299     AMOTION_EVENT_ACTION_SCROLL = 8,
   301     /* The pointer is not down but has entered the boundaries of a window or view.
   302      */
   303     AMOTION_EVENT_ACTION_HOVER_ENTER = 9,
   305     /* The pointer is not down but has exited the boundaries of a window or view.
   306      */
   307     AMOTION_EVENT_ACTION_HOVER_EXIT = 10,
   308 };
   310 /*
   311  * Motion event flags.
   312  */
   313 enum {
   314     /* This flag indicates that the window that received this motion event is partly
   315      * or wholly obscured by another visible window above it.  This flag is set to true
   316      * even if the event did not directly pass through the obscured area.
   317      * A security sensitive application can check this flag to identify situations in which
   318      * a malicious application may have covered up part of its content for the purpose
   319      * of misleading the user or hijacking touches.  An appropriate response might be
   320      * to drop the suspect touches or to take additional precautions to confirm the user's
   321      * actual intent.
   322      */
   323     AMOTION_EVENT_FLAG_WINDOW_IS_OBSCURED = 0x1,
   324 };
   326 /*
   327  * Motion event edge touch flags.
   328  */
   329 enum {
   330     /* No edges intersected */
   331     AMOTION_EVENT_EDGE_FLAG_NONE = 0,
   333     /* Flag indicating the motion event intersected the top edge of the screen. */
   334     AMOTION_EVENT_EDGE_FLAG_TOP = 0x01,
   336     /* Flag indicating the motion event intersected the bottom edge of the screen. */
   337     AMOTION_EVENT_EDGE_FLAG_BOTTOM = 0x02,
   339     /* Flag indicating the motion event intersected the left edge of the screen. */
   340     AMOTION_EVENT_EDGE_FLAG_LEFT = 0x04,
   342     /* Flag indicating the motion event intersected the right edge of the screen. */
   343     AMOTION_EVENT_EDGE_FLAG_RIGHT = 0x08
   344 };
   346 /*
   347  * Constants that identify each individual axis of a motion event.
   348  * Refer to the documentation on the MotionEvent class for descriptions of each axis.
   349  */
   350 enum {
   351     AMOTION_EVENT_AXIS_X = 0,
   352     AMOTION_EVENT_AXIS_Y = 1,
   353     AMOTION_EVENT_AXIS_PRESSURE = 2,
   354     AMOTION_EVENT_AXIS_SIZE = 3,
   355     AMOTION_EVENT_AXIS_TOUCH_MAJOR = 4,
   356     AMOTION_EVENT_AXIS_TOUCH_MINOR = 5,
   357     AMOTION_EVENT_AXIS_TOOL_MAJOR = 6,
   358     AMOTION_EVENT_AXIS_TOOL_MINOR = 7,
   359     AMOTION_EVENT_AXIS_ORIENTATION = 8,
   360     AMOTION_EVENT_AXIS_VSCROLL = 9,
   361     AMOTION_EVENT_AXIS_HSCROLL = 10,
   362     AMOTION_EVENT_AXIS_Z = 11,
   363     AMOTION_EVENT_AXIS_RX = 12,
   364     AMOTION_EVENT_AXIS_RY = 13,
   365     AMOTION_EVENT_AXIS_RZ = 14,
   366     AMOTION_EVENT_AXIS_HAT_X = 15,
   367     AMOTION_EVENT_AXIS_HAT_Y = 16,
   368     AMOTION_EVENT_AXIS_LTRIGGER = 17,
   369     AMOTION_EVENT_AXIS_RTRIGGER = 18,
   370     AMOTION_EVENT_AXIS_THROTTLE = 19,
   371     AMOTION_EVENT_AXIS_RUDDER = 20,
   372     AMOTION_EVENT_AXIS_WHEEL = 21,
   373     AMOTION_EVENT_AXIS_GAS = 22,
   374     AMOTION_EVENT_AXIS_BRAKE = 23,
   375     AMOTION_EVENT_AXIS_DISTANCE = 24,
   376     AMOTION_EVENT_AXIS_TILT = 25,
   377     AMOTION_EVENT_AXIS_GENERIC_1 = 32,
   378     AMOTION_EVENT_AXIS_GENERIC_2 = 33,
   379     AMOTION_EVENT_AXIS_GENERIC_3 = 34,
   380     AMOTION_EVENT_AXIS_GENERIC_4 = 35,
   381     AMOTION_EVENT_AXIS_GENERIC_5 = 36,
   382     AMOTION_EVENT_AXIS_GENERIC_6 = 37,
   383     AMOTION_EVENT_AXIS_GENERIC_7 = 38,
   384     AMOTION_EVENT_AXIS_GENERIC_8 = 39,
   385     AMOTION_EVENT_AXIS_GENERIC_9 = 40,
   386     AMOTION_EVENT_AXIS_GENERIC_10 = 41,
   387     AMOTION_EVENT_AXIS_GENERIC_11 = 42,
   388     AMOTION_EVENT_AXIS_GENERIC_12 = 43,
   389     AMOTION_EVENT_AXIS_GENERIC_13 = 44,
   390     AMOTION_EVENT_AXIS_GENERIC_14 = 45,
   391     AMOTION_EVENT_AXIS_GENERIC_15 = 46,
   392     AMOTION_EVENT_AXIS_GENERIC_16 = 47,
   394     // NOTE: If you add a new axis here you must also add it to several other files.
   395     //       Refer to frameworks/base/core/java/android/view/MotionEvent.java for the full list.
   396 };
   398 /*
   399  * Constants that identify buttons that are associated with motion events.
   400  * Refer to the documentation on the MotionEvent class for descriptions of each button.
   401  */
   402 enum {
   403     AMOTION_EVENT_BUTTON_PRIMARY = 1 << 0,
   404     AMOTION_EVENT_BUTTON_SECONDARY = 1 << 1,
   405     AMOTION_EVENT_BUTTON_TERTIARY = 1 << 2,
   406     AMOTION_EVENT_BUTTON_BACK = 1 << 3,
   407     AMOTION_EVENT_BUTTON_FORWARD = 1 << 4,
   408 };
   410 /*
   411  * Constants that identify tool types.
   412  * Refer to the documentation on the MotionEvent class for descriptions of each tool type.
   413  */
   414 enum {
   415     AMOTION_EVENT_TOOL_TYPE_UNKNOWN = 0,
   416     AMOTION_EVENT_TOOL_TYPE_FINGER = 1,
   417     AMOTION_EVENT_TOOL_TYPE_STYLUS = 2,
   418     AMOTION_EVENT_TOOL_TYPE_MOUSE = 3,
   419     AMOTION_EVENT_TOOL_TYPE_ERASER = 4,
   420 };
   422 /*
   423  * Input sources.
   424  *
   425  * Refer to the documentation on android.view.InputDevice for more details about input sources
   426  * and their correct interpretation.
   427  */
   428 enum {
   429     AINPUT_SOURCE_CLASS_MASK = 0x000000ff,
   431     AINPUT_SOURCE_CLASS_NONE = 0x00000000,
   432     AINPUT_SOURCE_CLASS_BUTTON = 0x00000001,
   433     AINPUT_SOURCE_CLASS_POINTER = 0x00000002,
   434     AINPUT_SOURCE_CLASS_NAVIGATION = 0x00000004,
   435     AINPUT_SOURCE_CLASS_POSITION = 0x00000008,
   436     AINPUT_SOURCE_CLASS_JOYSTICK = 0x00000010,
   437 };
   439 enum {
   440     AINPUT_SOURCE_UNKNOWN = 0x00000000,
   442     AINPUT_SOURCE_KEYBOARD = 0x00000100 | AINPUT_SOURCE_CLASS_BUTTON,
   443     AINPUT_SOURCE_DPAD = 0x00000200 | AINPUT_SOURCE_CLASS_BUTTON,
   444     AINPUT_SOURCE_GAMEPAD = 0x00000400 | AINPUT_SOURCE_CLASS_BUTTON,
   445     AINPUT_SOURCE_TOUCHSCREEN = 0x00001000 | AINPUT_SOURCE_CLASS_POINTER,
   446     AINPUT_SOURCE_MOUSE = 0x00002000 | AINPUT_SOURCE_CLASS_POINTER,
   447     AINPUT_SOURCE_STYLUS = 0x00004000 | AINPUT_SOURCE_CLASS_POINTER,
   448     AINPUT_SOURCE_TRACKBALL = 0x00010000 | AINPUT_SOURCE_CLASS_NAVIGATION,
   449     AINPUT_SOURCE_TOUCHPAD = 0x00100000 | AINPUT_SOURCE_CLASS_POSITION,
   450     AINPUT_SOURCE_TOUCH_NAVIGATION = 0x00200000 | AINPUT_SOURCE_CLASS_NONE,
   451     AINPUT_SOURCE_JOYSTICK = 0x01000000 | AINPUT_SOURCE_CLASS_JOYSTICK,
   453     AINPUT_SOURCE_ANY = 0xffffff00,
   454 };
   456 /*
   457  * Keyboard types.
   458  *
   459  * Refer to the documentation on android.view.InputDevice for more details.
   460  */
   461 enum {
   462     AINPUT_KEYBOARD_TYPE_NONE = 0,
   463     AINPUT_KEYBOARD_TYPE_NON_ALPHABETIC = 1,
   464     AINPUT_KEYBOARD_TYPE_ALPHABETIC = 2,
   465 };
   467 /*
   468  * Constants used to retrieve information about the range of motion for a particular
   469  * coordinate of a motion event.
   470  *
   471  * Refer to the documentation on android.view.InputDevice for more details about input sources
   472  * and their correct interpretation.
   473  *
   474  * DEPRECATION NOTICE: These constants are deprecated.  Use AMOTION_EVENT_AXIS_* constants instead.
   475  */
   476 enum {
   477     AINPUT_MOTION_RANGE_X = AMOTION_EVENT_AXIS_X,
   478     AINPUT_MOTION_RANGE_Y = AMOTION_EVENT_AXIS_Y,
   479     AINPUT_MOTION_RANGE_PRESSURE = AMOTION_EVENT_AXIS_PRESSURE,
   480     AINPUT_MOTION_RANGE_SIZE = AMOTION_EVENT_AXIS_SIZE,
   481     AINPUT_MOTION_RANGE_TOUCH_MAJOR = AMOTION_EVENT_AXIS_TOUCH_MAJOR,
   482     AINPUT_MOTION_RANGE_TOUCH_MINOR = AMOTION_EVENT_AXIS_TOUCH_MINOR,
   483     AINPUT_MOTION_RANGE_TOOL_MAJOR = AMOTION_EVENT_AXIS_TOOL_MAJOR,
   484     AINPUT_MOTION_RANGE_TOOL_MINOR = AMOTION_EVENT_AXIS_TOOL_MINOR,
   485     AINPUT_MOTION_RANGE_ORIENTATION = AMOTION_EVENT_AXIS_ORIENTATION,
   486 } __attribute__ ((deprecated));
   489 /*
   490  * Input event accessors.
   491  *
   492  * Note that most functions can only be used on input events that are of a given type.
   493  * Calling these functions on input events of other types will yield undefined behavior.
   494  */
   496 /*** Accessors for all input events. ***/
   498 /* Get the input event type. */
   499 int32_t AInputEvent_getType(const AInputEvent* event);
   501 /* Get the id for the device that an input event came from.
   502  *
   503  * Input events can be generated by multiple different input devices.
   504  * Use the input device id to obtain information about the input
   505  * device that was responsible for generating a particular event.
   506  *
   507  * An input device id of 0 indicates that the event didn't come from a physical device;
   508  * other numbers are arbitrary and you shouldn't depend on the values.
   509  * Use the provided input device query API to obtain information about input devices.
   510  */
   511 int32_t AInputEvent_getDeviceId(const AInputEvent* event);
   513 /* Get the input event source. */
   514 int32_t AInputEvent_getSource(const AInputEvent* event);
   516 /*** Accessors for key events only. ***/
   518 /* Get the key event action. */
   519 int32_t AKeyEvent_getAction(const AInputEvent* key_event);
   521 /* Get the key event flags. */
   522 int32_t AKeyEvent_getFlags(const AInputEvent* key_event);
   524 /* Get the key code of the key event.
   525  * This is the physical key that was pressed, not the Unicode character. */
   526 int32_t AKeyEvent_getKeyCode(const AInputEvent* key_event);
   528 /* Get the hardware key id of this key event.
   529  * These values are not reliable and vary from device to device. */
   530 int32_t AKeyEvent_getScanCode(const AInputEvent* key_event);
   532 /* Get the meta key state. */
   533 int32_t AKeyEvent_getMetaState(const AInputEvent* key_event);
   535 /* Get the repeat count of the event.
   536  * For both key up an key down events, this is the number of times the key has
   537  * repeated with the first down starting at 0 and counting up from there.  For
   538  * multiple key events, this is the number of down/up pairs that have occurred. */
   539 int32_t AKeyEvent_getRepeatCount(const AInputEvent* key_event);
   541 /* Get the time of the most recent key down event, in the
   542  * java.lang.System.nanoTime() time base.  If this is a down event,
   543  * this will be the same as eventTime.
   544  * Note that when chording keys, this value is the down time of the most recently
   545  * pressed key, which may not be the same physical key of this event. */
   546 int64_t AKeyEvent_getDownTime(const AInputEvent* key_event);
   548 /* Get the time this event occurred, in the
   549  * java.lang.System.nanoTime() time base. */
   550 int64_t AKeyEvent_getEventTime(const AInputEvent* key_event);
   552 /*** Accessors for motion events only. ***/
   554 /* Get the combined motion event action code and pointer index. */
   555 int32_t AMotionEvent_getAction(const AInputEvent* motion_event);
   557 /* Get the motion event flags. */
   558 int32_t AMotionEvent_getFlags(const AInputEvent* motion_event);
   560 /* Get the state of any meta / modifier keys that were in effect when the
   561  * event was generated. */
   562 int32_t AMotionEvent_getMetaState(const AInputEvent* motion_event);
   564 /* Get the button state of all buttons that are pressed. */
   565 int32_t AMotionEvent_getButtonState(const AInputEvent* motion_event);
   567 /* Get a bitfield indicating which edges, if any, were touched by this motion event.
   568  * For touch events, clients can use this to determine if the user's finger was
   569  * touching the edge of the display. */
   570 int32_t AMotionEvent_getEdgeFlags(const AInputEvent* motion_event);
   572 /* Get the time when the user originally pressed down to start a stream of
   573  * position events, in the java.lang.System.nanoTime() time base. */
   574 int64_t AMotionEvent_getDownTime(const AInputEvent* motion_event);
   576 /* Get the time when this specific event was generated,
   577  * in the java.lang.System.nanoTime() time base. */
   578 int64_t AMotionEvent_getEventTime(const AInputEvent* motion_event);
   580 /* Get the X coordinate offset.
   581  * For touch events on the screen, this is the delta that was added to the raw
   582  * screen coordinates to adjust for the absolute position of the containing windows
   583  * and views. */
   584 float AMotionEvent_getXOffset(const AInputEvent* motion_event);
   586 /* Get the precision of the Y coordinates being reported.
   587  * For touch events on the screen, this is the delta that was added to the raw
   588  * screen coordinates to adjust for the absolute position of the containing windows
   589  * and views. */
   590 float AMotionEvent_getYOffset(const AInputEvent* motion_event);
   592 /* Get the precision of the X coordinates being reported.
   593  * You can multiply this number with an X coordinate sample to find the
   594  * actual hardware value of the X coordinate. */
   595 float AMotionEvent_getXPrecision(const AInputEvent* motion_event);
   597 /* Get the precision of the Y coordinates being reported.
   598  * You can multiply this number with a Y coordinate sample to find the
   599  * actual hardware value of the Y coordinate. */
   600 float AMotionEvent_getYPrecision(const AInputEvent* motion_event);
   602 /* Get the number of pointers of data contained in this event.
   603  * Always >= 1. */
   604 size_t AMotionEvent_getPointerCount(const AInputEvent* motion_event);
   606 /* Get the pointer identifier associated with a particular pointer
   607  * data index in this event.  The identifier tells you the actual pointer
   608  * number associated with the data, accounting for individual pointers
   609  * going up and down since the start of the current gesture. */
   610 int32_t AMotionEvent_getPointerId(const AInputEvent* motion_event, size_t pointer_index);
   612 /* Get the tool type of a pointer for the given pointer index.
   613  * The tool type indicates the type of tool used to make contact such as a
   614  * finger or stylus, if known. */
   615 int32_t AMotionEvent_getToolType(const AInputEvent* motion_event, size_t pointer_index);
   617 /* Get the original raw X coordinate of this event.
   618  * For touch events on the screen, this is the original location of the event
   619  * on the screen, before it had been adjusted for the containing window
   620  * and views. */
   621 float AMotionEvent_getRawX(const AInputEvent* motion_event, size_t pointer_index);
   623 /* Get the original raw X coordinate of this event.
   624  * For touch events on the screen, this is the original location of the event
   625  * on the screen, before it had been adjusted for the containing window
   626  * and views. */
   627 float AMotionEvent_getRawY(const AInputEvent* motion_event, size_t pointer_index);
   629 /* Get the current X coordinate of this event for the given pointer index.
   630  * Whole numbers are pixels; the value may have a fraction for input devices
   631  * that are sub-pixel precise. */
   632 float AMotionEvent_getX(const AInputEvent* motion_event, size_t pointer_index);
   634 /* Get the current Y coordinate of this event for the given pointer index.
   635  * Whole numbers are pixels; the value may have a fraction for input devices
   636  * that are sub-pixel precise. */
   637 float AMotionEvent_getY(const AInputEvent* motion_event, size_t pointer_index);
   639 /* Get the current pressure of this event for the given pointer index.
   640  * The pressure generally ranges from 0 (no pressure at all) to 1 (normal pressure),
   641  * although values higher than 1 may be generated depending on the calibration of
   642  * the input device. */
   643 float AMotionEvent_getPressure(const AInputEvent* motion_event, size_t pointer_index);
   645 /* Get the current scaled value of the approximate size for the given pointer index.
   646  * This represents some approximation of the area of the screen being
   647  * pressed; the actual value in pixels corresponding to the
   648  * touch is normalized with the device specific range of values
   649  * and scaled to a value between 0 and 1.  The value of size can be used to
   650  * determine fat touch events. */
   651 float AMotionEvent_getSize(const AInputEvent* motion_event, size_t pointer_index);
   653 /* Get the current length of the major axis of an ellipse that describes the touch area
   654  * at the point of contact for the given pointer index. */
   655 float AMotionEvent_getTouchMajor(const AInputEvent* motion_event, size_t pointer_index);
   657 /* Get the current length of the minor axis of an ellipse that describes the touch area
   658  * at the point of contact for the given pointer index. */
   659 float AMotionEvent_getTouchMinor(const AInputEvent* motion_event, size_t pointer_index);
   661 /* Get the current length of the major axis of an ellipse that describes the size
   662  * of the approaching tool for the given pointer index.
   663  * The tool area represents the estimated size of the finger or pen that is
   664  * touching the device independent of its actual touch area at the point of contact. */
   665 float AMotionEvent_getToolMajor(const AInputEvent* motion_event, size_t pointer_index);
   667 /* Get the current length of the minor axis of an ellipse that describes the size
   668  * of the approaching tool for the given pointer index.
   669  * The tool area represents the estimated size of the finger or pen that is
   670  * touching the device independent of its actual touch area at the point of contact. */
   671 float AMotionEvent_getToolMinor(const AInputEvent* motion_event, size_t pointer_index);
   673 /* Get the current orientation of the touch area and tool area in radians clockwise from
   674  * vertical for the given pointer index.
   675  * An angle of 0 degrees indicates that the major axis of contact is oriented
   676  * upwards, is perfectly circular or is of unknown orientation.  A positive angle
   677  * indicates that the major axis of contact is oriented to the right.  A negative angle
   678  * indicates that the major axis of contact is oriented to the left.
   679  * The full range is from -PI/2 radians (finger pointing fully left) to PI/2 radians
   680  * (finger pointing fully right). */
   681 float AMotionEvent_getOrientation(const AInputEvent* motion_event, size_t pointer_index);
   683 /* Get the value of the request axis for the given pointer index. */
   684 float AMotionEvent_getAxisValue(const AInputEvent* motion_event,
   685         int32_t axis, size_t pointer_index);
   687 /* Get the number of historical points in this event.  These are movements that
   688  * have occurred between this event and the previous event.  This only applies
   689  * to AMOTION_EVENT_ACTION_MOVE events -- all other actions will have a size of 0.
   690  * Historical samples are indexed from oldest to newest. */
   691 size_t AMotionEvent_getHistorySize(const AInputEvent* motion_event);
   693 /* Get the time that a historical movement occurred between this event and
   694  * the previous event, in the java.lang.System.nanoTime() time base. */
   695 int64_t AMotionEvent_getHistoricalEventTime(AInputEvent* motion_event,
   696         size_t history_index);
   698 /* Get the historical raw X coordinate of this event for the given pointer index that
   699  * occurred between this event and the previous motion event.
   700  * For touch events on the screen, this is the original location of the event
   701  * on the screen, before it had been adjusted for the containing window
   702  * and views.
   703  * Whole numbers are pixels; the value may have a fraction for input devices
   704  * that are sub-pixel precise. */
   705 float AMotionEvent_getHistoricalRawX(const AInputEvent* motion_event, size_t pointer_index,
   706         size_t history_index);
   708 /* Get the historical raw Y coordinate of this event for the given pointer index that
   709  * occurred between this event and the previous motion event.
   710  * For touch events on the screen, this is the original location of the event
   711  * on the screen, before it had been adjusted for the containing window
   712  * and views.
   713  * Whole numbers are pixels; the value may have a fraction for input devices
   714  * that are sub-pixel precise. */
   715 float AMotionEvent_getHistoricalRawY(const AInputEvent* motion_event, size_t pointer_index,
   716         size_t history_index);
   718 /* Get the historical X coordinate of this event for the given pointer index that
   719  * occurred between this event and the previous motion event.
   720  * Whole numbers are pixels; the value may have a fraction for input devices
   721  * that are sub-pixel precise. */
   722 float AMotionEvent_getHistoricalX(AInputEvent* motion_event, size_t pointer_index,
   723         size_t history_index);
   725 /* Get the historical Y coordinate of this event for the given pointer index that
   726  * occurred between this event and the previous motion event.
   727  * Whole numbers are pixels; the value may have a fraction for input devices
   728  * that are sub-pixel precise. */
   729 float AMotionEvent_getHistoricalY(AInputEvent* motion_event, size_t pointer_index,
   730         size_t history_index);
   732 /* Get the historical pressure of this event for the given pointer index that
   733  * occurred between this event and the previous motion event.
   734  * The pressure generally ranges from 0 (no pressure at all) to 1 (normal pressure),
   735  * although values higher than 1 may be generated depending on the calibration of
   736  * the input device. */
   737 float AMotionEvent_getHistoricalPressure(AInputEvent* motion_event, size_t pointer_index,
   738         size_t history_index);
   740 /* Get the current scaled value of the approximate size for the given pointer index that
   741  * occurred between this event and the previous motion event.
   742  * This represents some approximation of the area of the screen being
   743  * pressed; the actual value in pixels corresponding to the
   744  * touch is normalized with the device specific range of values
   745  * and scaled to a value between 0 and 1.  The value of size can be used to
   746  * determine fat touch events. */
   747 float AMotionEvent_getHistoricalSize(AInputEvent* motion_event, size_t pointer_index,
   748         size_t history_index);
   750 /* Get the historical length of the major axis of an ellipse that describes the touch area
   751  * at the point of contact for the given pointer index that
   752  * occurred between this event and the previous motion event. */
   753 float AMotionEvent_getHistoricalTouchMajor(const AInputEvent* motion_event, size_t pointer_index,
   754         size_t history_index);
   756 /* Get the historical length of the minor axis of an ellipse that describes the touch area
   757  * at the point of contact for the given pointer index that
   758  * occurred between this event and the previous motion event. */
   759 float AMotionEvent_getHistoricalTouchMinor(const AInputEvent* motion_event, size_t pointer_index,
   760         size_t history_index);
   762 /* Get the historical length of the major axis of an ellipse that describes the size
   763  * of the approaching tool for the given pointer index that
   764  * occurred between this event and the previous motion event.
   765  * The tool area represents the estimated size of the finger or pen that is
   766  * touching the device independent of its actual touch area at the point of contact. */
   767 float AMotionEvent_getHistoricalToolMajor(const AInputEvent* motion_event, size_t pointer_index,
   768         size_t history_index);
   770 /* Get the historical length of the minor axis of an ellipse that describes the size
   771  * of the approaching tool for the given pointer index that
   772  * occurred between this event and the previous motion event.
   773  * The tool area represents the estimated size of the finger or pen that is
   774  * touching the device independent of its actual touch area at the point of contact. */
   775 float AMotionEvent_getHistoricalToolMinor(const AInputEvent* motion_event, size_t pointer_index,
   776         size_t history_index);
   778 /* Get the historical orientation of the touch area and tool area in radians clockwise from
   779  * vertical for the given pointer index that
   780  * occurred between this event and the previous motion event.
   781  * An angle of 0 degrees indicates that the major axis of contact is oriented
   782  * upwards, is perfectly circular or is of unknown orientation.  A positive angle
   783  * indicates that the major axis of contact is oriented to the right.  A negative angle
   784  * indicates that the major axis of contact is oriented to the left.
   785  * The full range is from -PI/2 radians (finger pointing fully left) to PI/2 radians
   786  * (finger pointing fully right). */
   787 float AMotionEvent_getHistoricalOrientation(const AInputEvent* motion_event, size_t pointer_index,
   788         size_t history_index);
   790 /* Get the historical value of the request axis for the given pointer index
   791  * that occurred between this event and the previous motion event. */
   792 float AMotionEvent_getHistoricalAxisValue(const AInputEvent* motion_event,
   793         int32_t axis, size_t pointer_index, size_t history_index);
   796 /*
   797  * Input queue
   798  *
   799  * An input queue is the facility through which you retrieve input
   800  * events.
   801  */
   802 struct AInputQueue;
   803 typedef struct AInputQueue AInputQueue;
   805 /*
   806  * Add this input queue to a looper for processing.  See
   807  * ALooper_addFd() for information on the ident, callback, and data params.
   808  */
   809 void AInputQueue_attachLooper(AInputQueue* queue, ALooper* looper,
   810         int ident, ALooper_callbackFunc callback, void* data);
   812 /*
   813  * Remove the input queue from the looper it is currently attached to.
   814  */
   815 void AInputQueue_detachLooper(AInputQueue* queue);
   817 /*
   818  * Returns true if there are one or more events available in the
   819  * input queue.  Returns 1 if the queue has events; 0 if
   820  * it does not have events; and a negative value if there is an error.
   821  */
   822 int32_t AInputQueue_hasEvents(AInputQueue* queue);
   824 /*
   825  * Returns the next available event from the queue.  Returns a negative
   826  * value if no events are available or an error has occurred.
   827  */
   828 int32_t AInputQueue_getEvent(AInputQueue* queue, AInputEvent** outEvent);
   830 /*
   831  * Sends the key for standard pre-dispatching -- that is, possibly deliver
   832  * it to the current IME to be consumed before the app.  Returns 0 if it
   833  * was not pre-dispatched, meaning you can process it right now.  If non-zero
   834  * is returned, you must abandon the current event processing and allow the
   835  * event to appear again in the event queue (if it does not get consumed during
   836  * pre-dispatching).
   837  */
   838 int32_t AInputQueue_preDispatchEvent(AInputQueue* queue, AInputEvent* event);
   840 /*
   841  * Report that dispatching has finished with the given event.
   842  * This must be called after receiving an event with AInputQueue_get_event().
   843  */
   844 void AInputQueue_finishEvent(AInputQueue* queue, AInputEvent* event, int handled);
   846 #ifdef __cplusplus
   847 }
   848 #endif
   850 #endif // _ANDROID_INPUT_H

mercurial