Skip to content

Document Android inline widgets #436

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
+95 −27
Merged

Document Android inline widgets #436

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
53ceed5
Document Android inline widgets
jonathanpeppers Aug 14, 2026
f77c0a8
Document inline Z-order result
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
36 changes: 27 additions & 9 deletions docs/xml/Android.Widget.Inline/InlineContentView.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,19 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Returns whether the surface backing this view appears on top of its parent.</summary>
<value>Whether the surface backing this view appears on top of its parent.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/widget/inline/InlineContentView#isZOrderedOnTop()" title="Reference documentation">Java documentation for <code>android.widget.inline.InlineContentView.isZOrderedOnTop()</code>.</a>
</format>
</para>
<para>
<format type="text/html">
<a href="https://android.googlesource.com/platform/frameworks/base/+/refs/heads/main/core/java/android/widget/inline/InlineContentView.java" title="AOSP source documentation">AOSP documentation for <code>InlineContentView.isZOrderedOnTop</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>
Expand Down Expand Up @@ -178,13 +183,26 @@
<Parameter Name="b" Type="System.Int32" />
</Parameters>
<Docs>
<param name="changed">To be added.</param>
<param name="l">To be added.</param>
<param name="t">To be added.</param>
<param name="r">To be added.</param>
<param name="b">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="changed">Whether this view has a new size or position.</param>
<param name="l">The left position, relative to the parent.</param>
<param name="t">The top position, relative to the parent.</param>
<param name="r">The right position, relative to the parent.</param>
<param name="b">The bottom position, relative to the parent.</param>
<summary>Called from layout when this view should assign a size and position to each of its children.</summary>
<remarks>
<para>Called from layout when this view should assign a size and position to each of its children.
Derived classes with children should override this method and call <c>layout</c> on each child.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/widget/inline/InlineContentView#onLayout(boolean,%20int,%20int,%20int,%20int)" title="Reference documentation">Java documentation for <code>android.widget.inline.InlineContentView.onLayout(boolean, int, int, int, int)</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>
</Member>
<Member MemberName="SetSurfaceControlCallback">
Expand Down Expand Up @@ -260,7 +278,7 @@
<Docs>
<param name="onTop">Whether to show the surface on top of this view's window.</param>
<summary>Controls whether the backing surface is placed on top of this view's window.</summary>
<returns>To be added.</returns>
<returns>Whether the Z ordering changed.</returns>
<remarks>
Comment thread
jonathanpeppers marked this conversation as resolved.
<para>Controls whether the backing surface is placed on top of this view's window. Normally, it is
placed on top of the window, to allow interaction with the inlined UI. Via this method, you
Expand Down
25 changes: 20 additions & 5 deletions docs/xml/Android.Widget.Inline/InlinePresentationSpec+Builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
<Parameters />
<Docs>
<summary>Builds the instance.</summary>
<returns>To be added.</returns>
<returns>The built <c>InlinePresentationSpec</c>.</returns>
<remarks>
<para>Builds the instance. This builder should not be touched after calling this!</para>
<para>
Expand Down Expand Up @@ -183,10 +183,25 @@
<Parameter Name="value" Type="Android.OS.Bundle" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="value">The extras encoding the UI style information.</param>
<summary>Sets the extras encoding the UI style information.</summary>
<returns>This builder.</returns>
<remarks>
<para>The style bundles can be created using the relevant Style classes and their builders in
the androidx autofill library, for example <c>androidx.autofill.inline.UiVersions.StylesBuilder</c>.</para>
<para>The style must be set for the suggestion to render properly.</para>
<para>There should be no remote objects in the bundle; remote objects are removed before transmission.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/widget/inline/InlinePresentationSpec.Builder#setStyle(android.os.Bundle)" title="Reference documentation">Java documentation for <code>android.widget.inline.InlinePresentationSpec.Builder.setStyle(android.os.Bundle)</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>
</Member>
<Member MemberName="ThresholdClass">
Expand Down
61 changes: 48 additions & 13 deletions docs/xml/Android.Widget.Inline/InlinePresentationSpec.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,20 @@
<ReturnType>Android.OS.IParcelableCreator</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Creates <c>InlinePresentationSpec</c> instances from a <c>Parcel</c>.</summary>
<value>A creator that creates <c>InlinePresentationSpec</c> instances from a <c>Parcel</c>.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/os/Parcelable" title="Reference documentation">Java documentation for <code>android.os.Parcelable</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>
</Member>
<Member MemberName="DescribeContents">
Expand Down Expand Up @@ -116,9 +127,21 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Describes the kinds of special objects contained in this Parcelable instance's marshaled representation.</summary>
<returns><c>0</c>.</returns>
<remarks>
<para>Describes the kinds of special objects contained in this Parcelable instance's marshaled representation.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/widget/inline/InlinePresentationSpec#describeContents()" title="Reference documentation">Java documentation for <code>android.widget.inline.InlinePresentationSpec.describeContents()</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>
</Member>
<Member MemberName="JniPeerMembers">
Expand Down Expand Up @@ -178,7 +201,7 @@
</ReturnValue>
<Docs>
<summary>The maximal size of the suggestion.</summary>
<value>To be added.</value>
<value>The maximal size of the suggestion.</value>
<remarks>
<para>The maximal size of the suggestion.</para>
<para>
Expand Down Expand Up @@ -219,7 +242,7 @@
</ReturnValue>
<Docs>
<summary>The minimal size of the suggestion.</summary>
<value>To be added.</value>
<value>The minimal size of the suggestion.</value>
<remarks>
<para>The minimal size of the suggestion.</para>
<para>
Expand Down Expand Up @@ -260,7 +283,7 @@
</ReturnValue>
<Docs>
<summary>The extras encoding the UI style information.</summary>
<value>To be added.</value>
<value>The extras encoding the UI style information.</value>
<remarks>
<para>The extras encoding the UI style information.</para>
<para>The style bundles can be created using the relevant Style classes and their builders in
Expand Down Expand Up @@ -377,10 +400,22 @@
</Parameter>
</Parameters>
<Docs>
<param name="dest">To be added.</param>
<param name="flags">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="dest">The parcel in which to write this object.</param>
<param name="flags">Additional flags about how the object should be written.</param>
<summary>Flattens this object into a parcel.</summary>
<remarks>
<para>Flattens this object into a parcel.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/widget/inline/InlinePresentationSpec#writeToParcel(android.os.Parcel,%20int)" title="Reference documentation">Java documentation for <code>android.widget.inline.InlinePresentationSpec.writeToParcel(android.os.Parcel, int)</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>
</Member>
</Members>
Expand Down