Package org.gnome.gdk

Class ScrollEvent

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gdk.Event

org.gnome.gdk.ScrollEvent

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class ScrollEvent
extends Event

An event related to a scrolling motion.

Nested Class Summary

Nested classes/interfaces inherited from class org.gnome.gdk.Event

Event.EventImpl

Constructor Summary

Constructors

Constructor	Description
ScrollEvent(MemorySegment address)	Create a ScrollEvent proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected ScrollEvent	asParent()	Returns this instance as if it were its parent type.
void	getDeltas(Out<Double> deltaX, Out<Double> deltaY)	Extracts the scroll deltas of a scroll event.
ScrollDirection	getDirection()	Extracts the direction of a scroll event.
static Type	getType()	Get the GType of the ScrollEvent class
ScrollUnit	getUnit()	Extracts the scroll delta unit of a scroll event.
boolean	isStop()	Check whether a scroll event is a stop scroll event.

Methods inherited from class org.gnome.gdk.Event

eventsGetAngle, eventsGetCenter, eventsGetDistance, getAxes, getAxis, getDevice, getDeviceTool, getDisplay, getEventSequence, getEventType, getHistory, getModifierState, getPointerEmulated, getPosition, getSeat, getSurface, getTime, ref, triggersContextMenu, unref

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getMemoryLayout, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScrollEvent

public ScrollEvent(MemorySegment address)

Create a ScrollEvent proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the ScrollEvent class

Returns:

the GType

asParent

protected ScrollEvent asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class Event

getDeltas

public void getDeltas(Out<Double> deltaX,
 Out<Double> deltaY)

Extracts the scroll deltas of a scroll event.

The deltas will be zero unless the scroll direction is ScrollDirection.SMOOTH.

For the representation unit of these deltas, see getUnit().

Parameters:

deltaX - return location for x scroll delta

deltaY - return location for y scroll delta

getDirection

public ScrollDirection getDirection()

Extracts the direction of a scroll event.

Returns:

the scroll direction of this ScrollEvent

getUnit

public ScrollUnit getUnit()

Extracts the scroll delta unit of a scroll event.

The unit will always be ScrollUnit.WHEEL if the scroll direction is not ScrollDirection.SMOOTH.

Returns:

the scroll unit.

isStop

public boolean isStop()

Check whether a scroll event is a stop scroll event.

Scroll sequences with smooth scroll information may provide a stop scroll event once the interaction with the device finishes, e.g. by lifting a finger. This stop scroll event is the signal that a widget may trigger kinetic scrolling based on the current velocity.

Stop scroll events always have a delta of 0/0.

Returns:

true if the event is a scroll stop event