Skip to content

Document CompletionInfo input methods #575

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

Open
jonathanpeppers wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document CompletionInfo input methods #575

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2ff5b2
Document CompletionInfo input methods
jonathanpeppers Aug 15, 2026
3a187f8
Link Parcelable descriptor documentation
jonathanpeppers Aug 15, 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
59 changes: 42 additions & 17 deletions docs/xml/Android.Views.InputMethods/CompletionInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,11 +141,16 @@
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="index">To be added.</param>
<param name="text">To be added.</param>
<param name="id">An identifier passed through unchanged at the editor's discretion.</param>
<param name="index">The original position of this completion, typically its index in the editor's completion list.</param>
<param name="text">The text inserted into the editor when this completion is selected.</param>
<summary>Create a simple completion with just text, no label.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/inputmethod/CompletionInfo#CompletionInfo(long,%20int,%20java.lang.CharSequence)" title="Reference documentation">Java documentation for <code>android.view.inputmethod.CompletionInfo.CompletionInfo(long, int, java.lang.CharSequence)</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>
<since version="Added in API level 3" />
Expand Down Expand Up @@ -224,12 +229,17 @@
<Parameter Name="label" Type="System.String" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="index">To be added.</param>
<param name="text">To be added.</param>
<param name="label">To be added.</param>
<param name="id">An identifier passed through unchanged at the editor's discretion.</param>
<param name="index">The original position of this completion, typically its index in the editor's completion list.</param>
<param name="text">The text inserted into the editor when this completion is selected.</param>
<param name="label">The text that the input method editor should display in its completion list.</param>
<summary>Create a full completion with both text and label.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/inputmethod/CompletionInfo#CompletionInfo(long,%20int,%20java.lang.CharSequence,%20java.lang.CharSequence)" title="Reference documentation">Java documentation for <code>android.view.inputmethod.CompletionInfo.CompletionInfo(long, int, java.lang.CharSequence, java.lang.CharSequence)</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>
<since version="Added in API level 3" />
Expand All @@ -256,7 +266,7 @@
</ReturnValue>
<Docs>
<summary>Used to make this class parcelable.</summary>
<value>To be added.</value>
<value>A creator that generates <c>CompletionInfo</c> instances from a <c>Parcel</c>.</value>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -298,8 +308,13 @@
<Docs>
<summary>Describe the kinds of special objects contained in this Parcelable's
marshalled representation.</summary>
<returns>To be added.</returns>
<returns>A bitmask of special object types marshaled by this instance; it is <c>0</c> or includes <see cref="F:Android.OS.IParcelable.ContentsFileDescriptor" />.</returns>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/os/Parcelable#describeContents()" title="Reference documentation">Java documentation for <code>android.os.Parcelable.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>
<since version="Added in API level 3" />
Expand Down Expand Up @@ -327,7 +342,7 @@
<Docs>
<summary>Return the abstract identifier for this completion, typically
corresponding to the id associated with it in the original adapter.</summary>
<value>To be added.</value>
<value>The abstract identifier for this completion, typically the identifier associated with it in the original adapter.</value>
<remarks>
<para>Return the abstract identifier for this completion, typically
corresponding to the id associated with it in the original adapter.</para>
Expand Down Expand Up @@ -397,9 +412,14 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Returns the user-visible label for the completion, or <c>null</c> when the plain text should be shown.</summary>
<value>The label shown to the user instead of the actual completion text, or <c>null</c> to show that text.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/inputmethod/CompletionInfo#getLabel()" title="Reference documentation">Java documentation for <code>android.view.inputmethod.CompletionInfo.getLabel()</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>
Expand All @@ -426,7 +446,7 @@
<Docs>
<summary>Return the user-visible label for the completion, or null if the plain
text should be shown.</summary>
<value>To be added.</value>
<value>The label shown to the user instead of the actual completion text, or <c>null</c> to show that text.</value>
<remarks>
<para>Return the user-visible label for the completion, or null if the plain
text should be shown. If non-null, this will be what the user sees as
Expand Down Expand Up @@ -467,7 +487,7 @@
<Docs>
<summary>Return the original position of this completion, typically
corresponding to its position in the original adapter.</summary>
<value>To be added.</value>
<value>The original position of this completion, typically its position in the original adapter.</value>
<remarks>
<para>Return the original position of this completion, typically
corresponding to its position in the original adapter.</para>
Expand Down Expand Up @@ -499,9 +519,14 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Returns the actual text associated with this completion.</summary>
<value>The text inserted into the editor when the user selects this completion.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/inputmethod/CompletionInfo#getText()" title="Reference documentation">Java documentation for <code>android.view.inputmethod.CompletionInfo.getText()</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>
Expand All @@ -527,7 +552,7 @@
</ReturnValue>
<Docs>
<summary>Return the actual text associated with this completion.</summary>
<value>To be added.</value>
<value>The text inserted into the editor when the user selects this completion.</value>
<remarks>
<para>Return the actual text associated with this completion. This is the
real text that will be inserted into the editor if the user selects it.</para>
Expand Down