Skip to content

Document Android.Window back events #424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathanpeppers merged 2 commits into from
Aug 14, 2026
+22 −10
Merged

Document Android.Window back events #424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8135b22
Document Android.Window back events
jonathanpeppers Aug 14, 2026
8456bf1
Address Android Window docs review
jonathanpeppers Aug 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/xml/Android.Window/BackEvent.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@
</ReturnValue>
<Docs>
<summary>Returns the frameTime of the BackEvent in milliseconds.</summary>
<value>To be added.</value>
<value>The frame time of this event, in milliseconds.</value>
<remarks>
<para>Returns the frameTime of the BackEvent in milliseconds. Useful for calculating velocity.</para>
<para>
Expand Down Expand Up @@ -386,7 +386,7 @@
</ReturnValue>
<Docs>
<summary>Returns a value between 0 and 1 on how far along the back gesture is.</summary>
<value>To be added.</value>
<value>A value from 0.0f to 1.0f, inclusive, representing the back gesture's progress.</value>
<remarks>
<para>Returns a value between 0 and 1 on how far along the back gesture is. This value is
driven by the horizontal location of the touch point, and should be used as the fraction to
Expand Down Expand Up @@ -441,7 +441,7 @@
</ReturnValue>
<Docs>
<summary>Returns the screen edge that the swipe starts from.</summary>
<value>To be added.</value>
<value>The screen edge from which the swipe begins.</value>
<remarks>
<para>Returns the screen edge that the swipe starts from.</para>
<para>
Expand Down Expand Up @@ -541,7 +541,7 @@
<Docs>
<summary>Returns the absolute X location of the touch point, or NaN if the event is from
a button press.</summary>
<value>To be added.</value>
<value>The absolute X location of the touch point, or <c>NaN</c> for a button press.</value>
<remarks>
<para>Returns the absolute X location of the touch point, or NaN if the event is from
a button press.</para>
Expand Down Expand Up @@ -584,7 +584,7 @@
<Docs>
<summary>Returns the absolute Y location of the touch point, or NaN if the event is from
a button press.</summary>
<value>To be added.</value>
<value>The absolute Y location of the touch point, or <c>NaN</c> for a button press.</value>
<remarks>
<para>Returns the absolute Y location of the touch point, or NaN if the event is from
a button press.</para>
Expand Down
22 changes: 17 additions & 5 deletions docs/xml/Android.Window/BackEventEdge.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,20 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Defines the edge from which a back swipe begins.</summary>
<remarks>
<para>The values correspond to the edge constants reported by <c>BackEvent</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/window/BackEvent" title="Reference documentation">Java documentation for <code>android.window.BackEvent</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
<Members>
<Member MemberName="Left">
Expand Down Expand Up @@ -40,7 +52,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The back swipe begins at the left edge of the screen.</summary>
</Docs>
</Member>
<Member MemberName="None">
Expand Down Expand Up @@ -68,7 +80,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The back event did not begin as an edge swipe, such as when invoked by 3-button navigation or a hardware back button.</summary>
</Docs>
</Member>
<Member MemberName="Right">
Expand Down Expand Up @@ -96,7 +108,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The back swipe begins at the right edge of the screen.</summary>
</Docs>
</Member>
</Members>
Expand Down