Enum Class ScrollDirection

java.lang.Object

java.lang.Enum<ScrollDirection>

org.gnome.gdk.ScrollDirection

All Implemented Interfaces:

Serializable, Comparable<ScrollDirection>, Constable, Enumeration

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

Specifies the direction for scroll events.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOWN	the surface is scrolled down.
LEFT	the surface is scrolled to the left.
RIGHT	the surface is scrolled to the right.
SMOOTH	the scrolling is determined by the delta values in scroll events.
UP	the surface is scrolled up.

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the ScrollDirection class.
int	getValue()	Get the numeric value of this enum
static ScrollDirection	of(int value)	Create a new ScrollDirection for the provided value
static ScrollDirection	of(MemorySegment address)	Create a new ScrollDirection for the value in the provided memory address.
static ScrollDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScrollDirection[]	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

UP

public static final ScrollDirection UP

the surface is scrolled up.

DOWN

public static final ScrollDirection DOWN

the surface is scrolled down.

LEFT

public static final ScrollDirection LEFT

the surface is scrolled to the left.

RIGHT

public static final ScrollDirection RIGHT

the surface is scrolled to the right.

SMOOTH

public static final ScrollDirection SMOOTH

the scrolling is determined by the delta values in scroll events. See gdk_scroll_event_get_deltas()

Method Details

values

public static ScrollDirection[] 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 ScrollDirection 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 ScrollDirection of(int value)

Create a new ScrollDirection 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 ScrollDirection of(MemorySegment address)

Create a new ScrollDirection 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 ScrollDirection class.

Returns:

the GType