ImeOptions

val Default: ImeOptions

Default ImeOptions. Please see parameter descriptions for default values.

ImeOptions(
    singleLine: Boolean = false,
    capitalization: KeyboardCapitalization = KeyboardCapitalization.None,
    autoCorrect: Boolean = true,
    keyboardType: KeyboardType = KeyboardType.Text,
    imeAction: ImeAction = ImeAction.Default,
    platformImeOptions: PlatformImeOptions? = null,
    hintLocales: LocaleList = LocaleList.Empty
)

fun copy(
    singleLine: Boolean = this.singleLine,
    capitalization: KeyboardCapitalization = this.capitalization,
    autoCorrect: Boolean = this.autoCorrect,
    keyboardType: KeyboardType = this.keyboardType,
    imeAction: ImeAction = this.imeAction,
    platformImeOptions: PlatformImeOptions? = this.platformImeOptions,
    hintLocales: LocaleList = this.hintLocales
): ImeOptions

open operator fun equals(other: Any?): Boolean

open fun hashCode(): Int

open fun toString(): String

val autoCorrect: Boolean

informs the IME whether to enable auto correct. Only applicable to text based KeyboardTypes such as KeyboardType.Email, KeyboardType.Uri. It will not be applied to KeyboardTypes such as KeyboardType.Number or KeyboardType.Decimal. Most of IME implementations ignore this value for KeyboardTypes such as KeyboardType.Text.

val capitalization: KeyboardCapitalization

informs the IME whether to automatically capitalize characters, words or sentences. Only applicable to only text based KeyboardTypes such as KeyboardType.Text, KeyboardType.Ascii. It will not be applied to KeyboardTypes such as KeyboardType.Number or KeyboardType.Decimal.

val hintLocales: LocaleList

List of the languages that the user is supposed to switch to no matter what input method subtype is currently used. This special "hint" can be used mainly for, but not limited to, multilingual users who want IMEs to switch language based on editor's context. Pass LocaleList.Empty to express the intention that a specific hint should not be set.

val imeAction: ImeAction

The IME action. This IME action is honored by IME and may show specific icons on the keyboard. For example, search icon may be shown if ImeAction.Search is specified. When singleLine is false, the IME might show return key rather than the action requested here.

val keyboardType: KeyboardType

The keyboard type to be used in this text field. Note that this input type is honored by IME and shows corresponding keyboard but this is not guaranteed. For example, some IME may send non-ASCII character even if you set KeyboardType.Ascii.

val platformImeOptions: PlatformImeOptions?

defines the platform specific IME options.

val singleLine: Boolean

informs the IME that the text field is single line and IME should not show return key.