# PointerEventType

Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/pointer/PointerEvent.kt+class:androidx.compose.ui.input.pointer.PointerEventType) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.1.0) Common/AllAndroid/JVM
- Cmn

  ```
  value class PointerEventType
  ```

*** ** * ** ***

Indicates the primary reason that the `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEvent` was sent.

## Summary

| ### Public companion properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#Enter()` The cursor has entered the input region. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#Exit()` A cursor device or elevated stylus exited the input region. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#Move()` The cursor or one or more touch pointers was moved. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#PanEnd()` A pan ended. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#PanMove()` An intermediate pan move. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#PanStart()` A pan started. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#Press()` A button on the device was pressed or a new pointer was detected. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#Release()` A button on the device was released or a pointer was raised. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#ScaleChange()` An intermediate scale move. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#ScaleEnd()` A scale ended. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#ScaleStart()` A scale started. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#Scroll()` A scroll event was sent. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#Unknown()` An unknown reason for the event. | Cmn |

| ### Public functions |
|---|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#toString()()` | Cmn |

## Public companion properties

### Enter

Cmn Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.1.0)

```
val Enter: PointerEventType
```

The cursor has entered the input region. This will only be sent after the cursor is hovering when in the input region.

For example, the user's cursor is outside the input region and presses the button prior to entering the input region. The `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#Enter()` event will be sent when the button is released inside the input region.

### Exit

Cmn Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.1.0)

```
val Exit: PointerEventType
```

A cursor device or elevated stylus exited the input region. This will only follow an `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#Enter()` event, so if a cursor with the button pressed enters and exits region, neither `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#Enter()` nor `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#Exit()` will be sent for the input region. However, if a cursor enters the input region, then a button is pressed, then the cursor exits and reenters, `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#Enter()`, `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#Exit()`, and `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#Enter()` will be received.

### Move

Cmn Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.1.0)

```
val Move: PointerEventType
```

The cursor or one or more touch pointers was moved.

### PanEnd

Cmn

```
val PanEnd: PointerEventType
```

A pan ended. This can happen, for example, due to a trackpad gesture.

### PanMove

Cmn

```
val PanMove: PointerEventType
```

An intermediate pan move. This can happen, for example, due to a trackpad gesture recognized by the platform. This event indicates that the `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange#panOffset()`'s `https://developer.android.com/reference/kotlin/androidx/compose/ui/geometry/Offset` may be non-zero.

### PanStart

Cmn

```
val PanStart: PointerEventType
```

A pan started. This can happen, for example, due to a trackpad gesture recognized by the platform. Such a gesture will start with an event type of `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#PanStart()`, followed by some number of `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#PanMove()`s, and finally a `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#PanEnd()`

### Press

Cmn Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.1.0)

```
val Press: PointerEventType
```

A button on the device was pressed or a new pointer was detected.

### Release

Cmn Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.1.0)

```
val Release: PointerEventType
```

A button on the device was released or a pointer was raised.

### ScaleChange

Cmn

```
val ScaleChange: PointerEventType
```

An intermediate scale move. This can happen, for example, due to a trackpad gesture recognized by the platform. This event indicates that the `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange#scaleFactor()`'s `https://developer.android.com/reference/kotlin/androidx/compose/ui/geometry/Offset` may be different from 1.

### ScaleEnd

Cmn

```
val ScaleEnd: PointerEventType
```

A scale ended. This can happen, for example, due to a trackpad gesture recognized by the platform.

### ScaleStart

Cmn

```
val ScaleStart: PointerEventType
```

A scale started. This can happen, for example, due to a trackpad gesture recognized by the platform. Such a gesture will start with an event of `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#ScaleStart()`, followed by some number of `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#ScaleChange()`s, and finally a `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerEventType#ScaleEnd()`.

### Scroll

Cmn Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.1.0)

```
val Scroll: PointerEventType
```

A scroll event was sent. This can happen, for example, due to a mouse scroll wheel. This event indicates that the `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/pointer/PointerInputChange#scrollDelta()`'s `https://developer.android.com/reference/kotlin/androidx/compose/ui/geometry/Offset` is non-zero.

### Unknown

Cmn Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.1.0)

```
val Unknown: PointerEventType
```

An unknown reason for the event.

## Public functions

### toString

Cmn

```
open fun toString(): String
```