14dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar/* 24dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * Copyright (C) 2015 The Android Open Source Project 34dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 44dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * Licensed under the Apache License, Version 2.0 (the "License"); 54dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * you may not use this file except in compliance with the License. 64dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * You may obtain a copy of the License at 74dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 84dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * http://www.apache.org/licenses/LICENSE-2.0 94dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 104dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * Unless required by applicable law or agreed to in writing, software 114dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * distributed under the License is distributed on an "AS IS" BASIS, 124dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 134dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * See the License for the specific language governing permissions and 144dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * limitations under the License. 154dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 164dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 174dbd11ef441f637f32edd585248da0c914622a38Yigit Boyarpackage android.support.v4.view; 184dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 194dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar/** 204dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * Helper class for accessing values in {@link android.view.InputDevice}. 214dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 22c5847d13e40f5d52459f5c0dab32dc08f1a9a683Chris Banespublic final class InputDeviceCompat { 234dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 244dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 254dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * A mask for input source classes. 264dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 274dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * Each distinct input source constant has one or more input source class bits set to 284dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * specify the desired interpretation for its input events. 294dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 304dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_CLASS_MASK = 0x000000ff; 314dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 324dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 334dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source has no class. 344dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 354dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * It is up to the application to determine how to handle the device based on the device type. 364dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 374dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_CLASS_NONE = 0x00000000; 384dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 394dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 404dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source has buttons or keys. 414dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * Examples: {@link #SOURCE_KEYBOARD}, {@link #SOURCE_DPAD}. 424dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 434dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * A {@link android.view.KeyEvent} should be interpreted as a button or key press. 444dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 454dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_CLASS_BUTTON = 0x00000001; 464dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 474dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 484dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is a pointing device associated with a display. 494dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * Examples: {@link #SOURCE_TOUCHSCREEN}, {@link #SOURCE_MOUSE}. 504dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 514dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * A {@link android.view.MotionEvent} should be interpreted as absolute coordinates in 524dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * display units according to the {@link android.view.View} hierarchy. Pointer down/up 534dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * indicated when 544dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * the finger touches the display or when the selection button is pressed/released. 554dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 564dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * Use {@link android.view.InputDevice#getMotionRange} to query the range of the pointing 574dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * device. Some devices permit 584dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * touches outside the display area so the effective range may be somewhat smaller or larger 594dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * than the actual display size. 604dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 614dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_CLASS_POINTER = 0x00000002; 624dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 634dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 644dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is a trackball navigation device. 654dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * Examples: {@link #SOURCE_TRACKBALL}. 664dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 674dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * A {@link android.view.MotionEvent} should be interpreted as relative movements in 684dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * device-specific 694dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * units used for navigation purposes. Pointer down/up indicates when the selection button 704dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * is pressed/released. 714dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 724dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * Use {@link android.view.InputDevice#getMotionRange} to query the range of motion. 734dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 744dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_CLASS_TRACKBALL = 0x00000004; 754dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 764dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 774dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is an absolute positioning device not associated with a display 784dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * (unlike {@link #SOURCE_CLASS_POINTER}). 794dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 804dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * A {@link android.view.MotionEvent} should be interpreted as absolute coordinates in 814dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * device-specific surface units. 824dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 834dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * Use {@link android.view.InputDevice#getMotionRange} to query the range of positions. 844dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 854dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_CLASS_POSITION = 0x00000008; 864dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 874dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 884dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is a joystick. 894dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 904dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * A {@link android.view.MotionEvent} should be interpreted as absolute joystick movements. 914dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 924dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * Use {@link android.view.InputDevice#getMotionRange} to query the range of positions. 934dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 944dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_CLASS_JOYSTICK = 0x00000010; 954dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 964dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 974dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is unknown. 984dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 994dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_UNKNOWN = 0x00000000; 1004dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 1014dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 1024dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is a keyboard. 1034dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 1044dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * This source indicates pretty much anything that has buttons. Use 1054dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * {@link android.view.InputDevice#getKeyboardType()} to determine whether the keyboard has 1064dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * alphabetic keys 1074dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * and can be used to enter text. 1084dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 1094dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * @see #SOURCE_CLASS_BUTTON 1104dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 1114dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_KEYBOARD = 0x00000100 | SOURCE_CLASS_BUTTON; 1124dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 1134dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 1144dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is a DPad. 1154dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 1164dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * @see #SOURCE_CLASS_BUTTON 1174dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 1184dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_DPAD = 0x00000200 | SOURCE_CLASS_BUTTON; 1194dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 1204dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 1214dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is a game pad. 1224dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * (It may also be a {@link #SOURCE_JOYSTICK}). 1234dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 1244dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * @see #SOURCE_CLASS_BUTTON 1254dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 1264dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_GAMEPAD = 0x00000400 | SOURCE_CLASS_BUTTON; 1274dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 1284dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 1294dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is a touch screen pointing device. 1304dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 1314dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * @see #SOURCE_CLASS_POINTER 1324dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 1334dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_TOUCHSCREEN = 0x00001000 | SOURCE_CLASS_POINTER; 1344dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 1354dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 1364dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is a mouse pointing device. 1374dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * This code is also used for other mouse-like pointing devices such as trackpads 1384dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * and trackpoints. 1394dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 1404dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * @see #SOURCE_CLASS_POINTER 1414dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 1424dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_MOUSE = 0x00002000 | SOURCE_CLASS_POINTER; 1434dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 1444dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 1454dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is a stylus pointing device. 1464dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * <p> 1474dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * Note that this bit merely indicates that an input device is capable of obtaining 1484dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * input from a stylus. To determine whether a given touch event was produced 1494dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * by a stylus, examine the tool type returned by {@link android.view.MotionEvent#getToolType(int)} 1504dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * for each individual pointer. 1514dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * </p><p> 1524dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * A single touch event may multiple pointers with different tool types, 1534dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * such as an event that has one pointer with tool type 1544dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * {@link android.view.MotionEvent#TOOL_TYPE_FINGER} and another pointer with tool type 1554dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * {@link android.view.MotionEvent#TOOL_TYPE_STYLUS}. So it is important to examine 1564dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * the tool type of each pointer, regardless of the source reported 1574dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * by {@link android.view.MotionEvent#getSource()}. 1584dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * </p> 1594dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 1604dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * @see #SOURCE_CLASS_POINTER 1614dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 1624dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_STYLUS = 0x00004000 | SOURCE_CLASS_POINTER; 1634dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 1644dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 1654dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is a trackball. 1664dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 1674dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * @see #SOURCE_CLASS_TRACKBALL 1684dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 1694dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_TRACKBALL = 0x00010000 | SOURCE_CLASS_TRACKBALL; 1704dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 1714dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 1724dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is a touch pad or digitizer tablet that is not 1734dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * associated with a display (unlike {@link #SOURCE_TOUCHSCREEN}). 1744dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 1754dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * @see #SOURCE_CLASS_POSITION 1764dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 1774dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_TOUCHPAD = 0x00100000 | SOURCE_CLASS_POSITION; 1784dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 1794dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 1804dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is a touch device whose motions should be interpreted as navigation events. 1814dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 1824dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * For example, an upward swipe should be as an upward focus traversal in the same manner as 1834dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * pressing up on a D-Pad would be. Swipes to the left, right and down should be treated in a 1844dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * similar manner. 1854dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 1864dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * @see #SOURCE_CLASS_NONE 1874dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 1884dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_TOUCH_NAVIGATION = 0x00200000 | SOURCE_CLASS_NONE; 1894dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 1904dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 1912998aa5b8adb4e54a9fcd8f76298110879c677f5Aaron Whyte * The input source is a rotating encoder device whose motions should be interpreted as akin to 1922998aa5b8adb4e54a9fcd8f76298110879c677f5Aaron Whyte * those of a scroll wheel. 1932998aa5b8adb4e54a9fcd8f76298110879c677f5Aaron Whyte * 1942998aa5b8adb4e54a9fcd8f76298110879c677f5Aaron Whyte * @see #SOURCE_CLASS_NONE 1952998aa5b8adb4e54a9fcd8f76298110879c677f5Aaron Whyte */ 1962998aa5b8adb4e54a9fcd8f76298110879c677f5Aaron Whyte public static final int SOURCE_ROTARY_ENCODER = 0x00400000 | SOURCE_CLASS_NONE; 1972998aa5b8adb4e54a9fcd8f76298110879c677f5Aaron Whyte 1982998aa5b8adb4e54a9fcd8f76298110879c677f5Aaron Whyte /** 1994dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is a joystick. 2004dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * (It may also be a {@link #SOURCE_GAMEPAD}). 2014dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 2024dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * @see #SOURCE_CLASS_JOYSTICK 2034dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 2044dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_JOYSTICK = 0x01000000 | SOURCE_CLASS_JOYSTICK; 2054dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 2064dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 2074dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The input source is a device connected through HDMI-based bus. 2084dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * 2094dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * The key comes in through HDMI-CEC or MHL signal line, and is treated as if it were 2104dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * generated by a locally connected DPAD or keyboard. 2114dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 2124dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_HDMI = 0x02000000 | SOURCE_CLASS_BUTTON; 2134dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar 2144dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar /** 2154dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * A special input source constant that is used when filtering input devices 2164dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar * to match devices that provide any type of input source. 2174dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar */ 2184dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar public static final int SOURCE_ANY = 0xffffff00; 219c5847d13e40f5d52459f5c0dab32dc08f1a9a683Chris Banes 220c5847d13e40f5d52459f5c0dab32dc08f1a9a683Chris Banes private InputDeviceCompat() {} 2214dbd11ef441f637f32edd585248da0c914622a38Yigit Boyar} 222