androidx.compose.ui.input.pointer

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

Represents a pointer icon to use in Modifier.pointerHoverIcon or Modifier.stylusHoverIcon.

A Modifier.Element that can interact with pointer input.

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

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).

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

Data structure for "historical" pointer moves.

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

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

Indicates the primary reason that the PointerEvent was sent.

An ID for a given pointer.

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).

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.

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.

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

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

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

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

Calls watcher with each MotionEvent that the layout area or any child pointerInput receives.

Modifier that lets a developer define a pointer icon to display when the cursor is hovered over the element.

Create a modifier for processing pointer input within the region of the modified element.

A special PointerInputModifier that provides access to the underlying MotionEvents originally dispatched to Compose.

Modifier that lets a developer define a pointer icon to display when a stylus is hovered over the element.

Creates PointerIcon from android.view.PointerIcon

Creates PointerIcon from pointer icon type (see android.view.PointerIcon.getSystemIcon

Supports suspending pointer event handling.

This function is deprecated. Partial consumption has been deprecated.

True if this PointerInputChange represents a pointer coming in contact with the screen and that change has not been consumed.

True if this PointerInputChange represents a pointer coming in contact with the screen, whether or not that change has been consumed.

True if this PointerInputChange represents a pointer breaking contact with the screen and that change has not been consumed.

True if this PointerInputChange represents a pointer breaking contact with the screen, whether or not that change has been consumed.

This function is deprecated. Use consume() instead

This function is deprecated. Partial consumption has been deprecated.

This function is deprecated. Partial consumption has been deprecated.

Returns the index of first button pressed as used in isPressed or -1 if no button is pressed.

Returns the index of last button pressed as used in isPressed or -1 if no button is pressed.

This function is deprecated. Use isOutOfBounds() that supports minimum touch target

Returns true if the pointer has moved outside of the pointer region.

Returns true when the button at buttonIndex is pressed and false when it isn't pressed.

The distance that the pointer has moved on the screen minus any distance that has been consumed.

This function is deprecated. Partial consumption has been deprecated.

The distance that the pointer has moved on the screen, ignoring the fact that it might have been consumed.

True if this PointerInputChange represents a pointer moving on the screen and some of that movement has not been consumed.

True if this PointerInputChange represents a pointer moving on the screen ignoring how much of that movement may have been consumed.

Returns true if any button is pressed or false if all buttons are released.

true when the AltGraph key is pressed.

true when the Alt key is pressed.

true when the back button (mouse back button) is pressed or false when it isn't pressed or there is no mouse button assigned to "back."

true when the keyboard's Caps Lock is on.

true when the Control key is pressed.

true when the forward button (mouse forward button) is pressed or false when it isn't pressed or there is no button assigned to "forward."

true when the Function key is pressed.

true when the Meta key is pressed.

true when the keyboard's Num Lock is on.

true when the primary button (left mouse button) is pressed or false when it isn't pressed.

true when the keyboard's Scroll Lock is on.

true when the secondary button (right mouse button) is pressed or false when it isn't pressed.

true when the Shift key is pressed.

true when the Sym key is pressed.

true when the tertiary button (middle mouse button) is pressed or false when it isn't pressed.