Enum Class TouchpadGesturePhase

java.lang.Object

java.lang.Enum<TouchpadGesturePhase>

org.gnome.gdk.TouchpadGesturePhase

All Implemented Interfaces:

Serializable, Comparable<TouchpadGesturePhase>, Constable, Enumeration

@Generated("org.javagi.JavaGI")
public enum TouchpadGesturePhase
extends Enum<TouchpadGesturePhase>
implements Enumeration

Specifies the current state of a touchpad gesture.

All gestures are guaranteed to begin with an event with phase BEGIN, followed by 0 or several events with phase UPDATE.

A finished gesture may have 2 possible outcomes, an event with 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 CANCEL, this should be used as a hint to undo any visible/permanent changes that were done throughout the progress of the gesture.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BEGIN	The gesture has begun.
CANCEL	The gesture was cancelled, all changes should be undone.
END	The gesture was finished, changes should be permanently applied.
UPDATE	The gesture has been updated.

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the TouchpadGesturePhase class.
int	getValue()	Get the numeric value of this enum
static TouchpadGesturePhase	of(int value)	Create a new TouchpadGesturePhase for the provided value
static TouchpadGesturePhase	of(MemorySegment address)	Create a new TouchpadGesturePhase for the value in the provided memory address.
static TouchpadGesturePhase	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TouchpadGesturePhase[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BEGIN

public static final TouchpadGesturePhase BEGIN

The gesture has begun.

UPDATE

public static final TouchpadGesturePhase UPDATE

The gesture has been updated.

END

public static final TouchpadGesturePhase END

The gesture was finished, changes should be permanently applied.

CANCEL

public static final TouchpadGesturePhase CANCEL

The gesture was cancelled, all changes should be undone.

Method Details

values

public static TouchpadGesturePhase[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TouchpadGesturePhase valueOf(String name)

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

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

of

public static TouchpadGesturePhase of(int value)

Create a new TouchpadGesturePhase for the provided value

Parameters:

value - the enum value

Returns:

the enum for the provided value

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

of

public static TouchpadGesturePhase of(MemorySegment address)

Create a new TouchpadGesturePhase for the value in the provided memory address.

Parameters:

address - the memory address holding a enum value

Returns:

the enum for the value in the provided memory address

getType

public static @Nullable Type getType()

Get the GType of the TouchpadGesturePhase class.

Returns:

the GType