{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

androidx.compose.ui.text.input

Interfaces

EditCommand

EditCommand is a command representation for the platform IME API function calls.

InputEventCallback

This interface is deprecated. This function is not being used by any APIs.

OffsetMapping

Provides bidirectional offset mapping between original and transformed text.

PlatformTextInput

Represents the text input plugin system to instances of PlatformTextInputAdapter, and provides methods that allow adapters to interact with it.

PlatformTextInputAdapter

See kdoc on actual interfaces.

PlatformTextInputPlugin

See kdoc on actual interfaces.

PlatformTextInputPluginRegistry

The entry point to the text input plugin API.

PlatformTextInputService

Platform specific text input service.

VisualTransformation

Interface used for changing visual output of the input field.

Classes

BackspaceCommand

Represents a backspace operation at the cursor position.

CommitTextCommand

Commit final text to the text box and set the new cursor position.

DeleteAllCommand

Deletes all the text in the buffer.

DeleteSurroundingTextCommand

Delete lengthBeforeCursor characters of text before the current cursor position, and delete lengthAfterCursor characters of text after the current cursor position, excluding the selection.

DeleteSurroundingTextInCodePointsCommand

A variant of DeleteSurroundingTextCommand.

EditProcessor

Helper class to apply EditCommands on an internal buffer.

EditingBuffer

The editing buffer

FinishComposingTextCommand

Finishes the composing text that is currently active.

ImeAction

Signals the keyboard what type of action should be displayed.

ImeOptions

The IME configuration options for TextInputService.

KeyboardCapitalization

Options to request software keyboard to capitalize the text.

KeyboardType

Values representing the different available Keyboard Types.

MoveCursorCommand

Moves the cursor with amount characters.

PasswordVisualTransformation

The Visual Filter can be used for password Input Field.

PlatformTextInputPluginRegistryImpl

Implementation of PlatformTextInputPluginRegistry that manages a map of adapters to cached services and allows retrieval of the first active one.

PlatformTextInputPluginRegistryImpl.AdapterHandle
SetComposingRegionCommand

Mark a certain region of text as composing text.

SetComposingTextCommand

Replace the currently composing text with the given text, and set the new cursor position.

SetSelectionCommand

Sets the selection on the text.

TextFieldValue

A class holding information about the editing state.

TextFieldValueKt
TextInputService

Handles communication with the IME.

TextInputSession

Represents a input session for interactions between a soft keyboard and editable text.

TransformedText

The transformed text with offset offset mapping

ImeAction.Companion
ImeOptions.Companion
KeyboardCapitalization.Companion
KeyboardType.Companion
OffsetMapping.Companion
TextFieldValue.Companion
VisualTransformation.Companion