summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
author Vishnu Nair <vishnun@google.com> 2025-01-07 15:39:51 -0800
committer Vishnu Nair <vishnun@google.com> 2025-01-07 15:39:51 -0800
commit2fd24c02ab7b7bd2e7592eb08f1e60ee578ff5a3 (patch)
tree5a857ce87c0cae3e9ca2ef30c9d1e7590e3ec209 /include
parenta1635a6f52610fd4847f62c3c149dfdb73dfb5fb (diff)
Document what onKeyEvent/onMotionEvent return values mean
Change-Id: I9ca51a93af79360cd57aabba08d83f968618308c Fixes: 346593383 Test: n/a Flag: EXEMPT docs
Diffstat (limited to 'include')
-rw-r--r--include/android/surface_control_input_receiver.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/include/android/surface_control_input_receiver.h b/include/android/surface_control_input_receiver.h
index f0503f6324..59d3a31b30 100644
--- a/include/android/surface_control_input_receiver.h
+++ b/include/android/surface_control_input_receiver.h
@@ -39,11 +39,11 @@ __BEGIN_DECLS
*
* \param motionEvent The motion event. This must be released with AInputEvent_release.
*
+ * \return true if the event is handled by the client, false otherwise.
* Available since API level 35.
*/
typedef bool (*AInputReceiver_onMotionEvent)(void *_Null_unspecified context,
- AInputEvent *_Nonnull motionEvent)
- __INTRODUCED_IN(__ANDROID_API_V__);
+ AInputEvent *_Nonnull motionEvent);
/**
* The AInputReceiver_onKeyEvent callback is invoked when the registered input channel receives
* a key event.
@@ -53,11 +53,12 @@ typedef bool (*AInputReceiver_onMotionEvent)(void *_Null_unspecified context,
*
* \param keyEvent The key event. This must be released with AInputEvent_release.
*
+ * \return true if the event is handled by the client, false otherwise. System may generate
+ * a fallback key event if the event is not handled.
* Available since API level 35.
*/
typedef bool (*AInputReceiver_onKeyEvent)(void *_Null_unspecified context,
- AInputEvent *_Nonnull keyEvent)
- __INTRODUCED_IN(__ANDROID_API_V__);
+ AInputEvent *_Nonnull keyEvent);
typedef struct AInputReceiverCallbacks AInputReceiverCallbacks;