Enum Class ScrollUnit

java.lang.Object

java.lang.Enum<ScrollUnit>

org.gnome.gdk.ScrollUnit

All Implemented Interfaces:

Serializable, Comparable<ScrollUnit>, Constable, Enumeration

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

Specifies the unit of scroll deltas.

When you get WHEEL, a delta of 1.0 means 1 wheel detent click in the south direction, 2.0 means 2 wheel detent clicks in the south direction... This is the same logic for negative values but in the north direction.

If you get SURFACE, are managing a scrollable view and get a value of 123, you have to scroll 123 surface logical pixels right if it's deltaX or down if it's deltaY. This is the same logic for negative values but you have to scroll left instead of right if it's deltaX and up instead of down if it's deltaY.

1 surface logical pixel is equal to 1 real screen pixel multiplied by the final scale factor of your graphical interface (the product of the desktop scale factor and eventually a custom scale factor in your app).

Since:

4.8

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
SURFACE	The delta is in surface pixels to scroll directly on screen.
WHEEL	The delta is in number of wheel clicks.

Method Summary

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

WHEEL

public static final ScrollUnit WHEEL

The delta is in number of wheel clicks.

SURFACE

public static final ScrollUnit SURFACE

The delta is in surface pixels to scroll directly on screen.

Method Details

values

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

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

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

Returns:

the GType