PointerInputScope

Kotlin |Java

interface PointerInputScope : Density

androidx.compose.ui.input.pointer.PointerInputScope

Receiver scope for Modifier.pointerInput that permits handling pointer input and sending custom input events.

Summary

Public methods
abstract suspend R	`handlePointerInput(handler: suspend HandlePointerInputScope.() -> R)` Suspend and install a pointer input handler that can await input events and respond to them immediately.

Inherited functions

From class Density

`Dp`	`toDp()` Convert Sp to Dp.
`Dp`	`toDp()` Convert an Int pixel value to Dp.
`Dp`	`toDp()` Convert a Float pixel value to a Dp
`Int`	`toIntPx()` Convert Dp to Int by rounding
`Int`	`toIntPx()` Convert Sp to Int by rounding
`Float`	`toPx()` Convert Dp to pixels. Pixels are used to paint to Canvas.
`Float`	`toPx()` Convert Sp to pixels. Pixels are used to paint to Canvas.
`Rect`	`toRect()` Convert a Bounds to a Rect.
`TextUnit`	`toSp()` Convert Dp to Sp. Sp is used for font size, etc.
`TextUnit`	`toSp()` Convert an Int pixel value to Sp.
`TextUnit`	`toSp()` Convert a Float pixel value to a Sp

Properties
abstract CustomEventDispatcher	`customEventDispatcher` customEventDispatcher permits dispatching custom input events to the rest of the UI in response to handling lower-level pointer input events.
abstract IntSize	`size` The measured size of the pointer input region.

Inherited properties

From class Density

Float

density

The logical density of the display. This is a scaling factor for the Dp unit.

Float

fontScale

Current user preference for the scaling factor for fonts.

Public methods

handlePointerInput

abstract suspend fun <R> handlePointerInput(handler: suspend HandlePointerInputScope.() -> R): R

Suspend and install a pointer input handler that can await input events and respond to them immediately. A call to handlePointerInput will resume with handler's result after it completes.

More than one handlePointerInput can run concurrently in the same PointerInputScope by using kotlinx.coroutines.launch. Handlers are dispatched to in the order in which they were installed.

Properties

customEventDispatcher

abstract val customEventDispatcher: CustomEventDispatcher

customEventDispatcher permits dispatching custom input events to the rest of the UI in response to handling lower-level pointer input events. Accessing customEventDispatcher before the first pointer input event is reported will throw IllegalStateException.

size

abstract val size: IntSize

The measured size of the pointer input region. Input events will be reported with a coordinate space of (0, 0) to (size.width, size,height) as the input region, with (0, 0) indicating the upper left corner.