Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Include touchpad capture in View#requestPointerCapture docs

Browse Source 
Include information about how events from a touchpad are treated when
pointer capture is enabled.

Bug: 173741165
Test: None
Change-Id: Ia7ca0fca60e72d13ea57a35029f0fe3183cd1bda
This commit is contained in:
Prabir Pradhan
2020-11-20 13:21:11 -08:00
parent f7e5db73c9
commit 99441dfe3e
1 changed files with 22 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
core/java/android/view/View.java
View File

@@ -27933,10 +27933,26 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
* Requests pointer capture mode.
* <p>
* When the window has pointer capture, the mouse pointer icon will disappear and will not
* change its position. Further mouse will be dispatched with the source
* {@link InputDevice#SOURCE_MOUSE_RELATIVE}, and relative position changes will be available
* through {@link MotionEvent#getX} and {@link MotionEvent#getY}. Non-mouse events
* (touchscreens, or stylus) will not be affected.
* change its position. Enabling pointer capture will change the behavior of input devices in
* the following ways:
* <ul>
* <li>Events from a mouse will be delivered with the source
* {@link InputDevice#SOURCE_MOUSE_RELATIVE}, and relative position changes will be
* available through {@link MotionEvent#getX} and {@link MotionEvent#getY}.</li>
*
* <li>Events from a touchpad will be delivered with the source
* {@link InputDevice#SOURCE_TOUCHPAD}, where the absolute position of each of the pointers
* on the touchpad will be available through {@link MotionEvent#getX(int)} and
* {@link MotionEvent#getY(int)}, and their relative movements are stored in
* {@link MotionEvent#AXIS_RELATIVE_X} and {@link MotionEvent#AXIS_RELATIVE_Y}.</li>
*
* <li>Events from other types of devices, such as touchscreens, will not be affected.</li>
* </ul>
* <p>
* Events captured through pointer capture will be dispatched to
* {@link OnCapturedPointerListener#onCapturedPointer(View, MotionEvent)} if an
* {@link OnCapturedPointerListener} is set, and otherwise to
* {@link #onCapturedPointerEvent(MotionEvent)}.
* <p>
* If the window already has pointer capture, this call does nothing.
* <p>
@@ -27945,6 +27961,7 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
*
* @see #releasePointerCapture()
* @see #hasPointerCapture()
* @see #onPointerCaptureChange(boolean)
*/
public void requestPointerCapture() {
final ViewRootImpl viewRootImpl = getViewRootImpl();
@@ -27960,6 +27977,7 @@ public class View implements Drawable.Callback, KeyEvent.Callback,
* If the window does not have pointer capture, this call will do nothing.
* @see #requestPointerCapture()
* @see #hasPointerCapture()
* @see #onPointerCaptureChange(boolean)
*/
public void releasePointerCapture() {
final ViewRootImpl viewRootImpl = getViewRootImpl();