gdk4/org.gtkkn.bindings.gdk/TouchpadGesturePhase

TouchpadGesturePhase

enum TouchpadGesturePhase : Enum<TouchpadGesturePhase>

Specifies the current state of a touchpad gesture.

All gestures are guaranteed to begin with an event with phase %GDK_TOUCHPAD_GESTURE_PHASE_BEGIN, followed by 0 or several events with phase %GDK_TOUCHPAD_GESTURE_PHASE_UPDATE.

A finished gesture may have 2 possible outcomes, an event with phase %GDK_TOUCHPAD_GESTURE_PHASE_END will be emitted when the gesture is considered successful, this should be used as the hint to perform any permanent changes.

Cancelled gestures may be so for a variety of reasons, due to hardware or the compositor, or due to the gesture recognition layers hinting the gesture did not finish resolutely (eg. a 3rd finger being added during a pinch gesture). In these cases, the last event will report the phase %GDK_TOUCHPAD_GESTURE_PHASE_CANCEL, this should be used as a hint to undo any visible/permanent changes that were done throughout the progress of the gesture.

Entries

BEGIN

The gesture has begun.

UPDATE

The gesture has been updated.

END

The gesture was finished, changes should be permanently applied.

CANCEL

The gesture was cancelled, all changes should be undone.

Types

Companion

object Companion

Properties

name

val name: String

nativeValue

val nativeValue: <Error class: unknown class>

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): TouchpadGesturePhase

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<TouchpadGesturePhase>

Returns an array containing the constants of this enum type, in the order they're declared.