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

androidx.compose.ui.input.pointer

Interfaces

AwaitPointerEventScope

Receiver scope for awaiting pointer events in a call to PointerInputScope.awaitPointerEventScope.

PointerIcon

Represents a pointer icon to use in Modifier.pointerHoverIcon

PointerInputModifier

A Modifier.Element that can interact with pointer input.

PointerInputScope

Receiver scope for Modifier.pointerInput that permits handling pointer input.

SuspendingPointerInputModifierNode

Extends PointerInputModifierNode with a handler to execute asynchronously when an event occurs and a function to reset that handler (cancels the existing coroutine and essentially resets the handler's execution).

Classes

ConsumedData

This class is deprecated. Use PointerInputChange.isConsumed and PointerInputChange.consume() instead

HistoricalChange

Data structure for "historical" pointer moves.

NativePointerButtons
NativePointerKeyboardModifiers
PointerButtons

Contains the state of pointer buttons (e.g. mouse and stylus buttons).

PointerEvent

Describes a pointer input change event that has occurred at a particular point in time.

PointerEventKt
PointerEventTimeoutCancellationException

An exception thrown from AwaitPointerEventScope.withTimeout when the execution time of the coroutine is too long.

PointerEventType

Indicates the primary reason that the PointerEvent was sent.

PointerIconKt
PointerId

An ID for a given pointer.

PointerInputChange

Describes a change that has occurred for a particular pointer, as well as how much of the change has been consumed (meaning, used by a node in the UI).

PointerInputFilter

A PointerInputFilter represents a single entity that receives PointerInputChanges), interprets them, and consumes the aspects of the changes that it is react to such that other PointerInputFilters don't also react to them.

PointerInteropFilterKt
PointerKeyboardModifiers

Contains the state of modifier keys, such as Shift, Control, and Alt, as well as the state of the lock keys, such as Caps Lock and Num Lock.

PointerType

The device type that produces a PointerInputChange, such as a mouse or stylus.

RequestDisallowInterceptTouchEvent

Function that can be passed to pointerInteropFilter and then later invoked which provides an analog to ViewParent.requestDisallowInterceptTouchEvent.

SuspendingPointerInputFilterKt
PointerEventType.Companion
PointerIcon.Companion

A collection of common pointer icons used for the mouse cursor.

PointerType.Companion

Enums

PointerEventPass

The enumeration of passes where PointerInputChange traverses up and down the UI tree.