Package org.gnome.gtk

Class EventControllerMotion

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.EventController

org.gnome.gtk.EventControllerMotion

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class EventControllerMotion
extends EventController

Tracks the pointer position.

The event controller offers Gtk.EventControllerMotion::enter and Gtk.EventControllerMotion::leave signals, as well as Gtk.EventControllerMotion:is-pointer and Gtk.EventControllerMotion:contains-pointer properties which are updated to reflect changes in the pointer position as it moves over the widget.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventControllerMotion.Builder<B extends EventControllerMotion.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	EventControllerMotion.EnterCallback	Functional interface declaration of the EnterCallback callback.
static class	EventControllerMotion.EventControllerMotionClass
static interface	EventControllerMotion.LeaveCallback	Functional interface declaration of the LeaveCallback callback.
static interface	EventControllerMotion.MotionCallback	Functional interface declaration of the MotionCallback callback.

Nested classes/interfaces inherited from class org.gnome.gtk.EventController

EventController.EventController$Impl, EventController.EventControllerClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
EventControllerMotion()	Creates a new EventControllerMotion.
EventControllerMotion(MemorySegment address)	Create a EventControllerMotion proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected EventControllerMotion	asParent()	Returns this instance as if it were its parent type.
static EventControllerMotion.Builder<? extends EventControllerMotion.Builder>	builder()	A EventControllerMotion.Builder object constructs a EventControllerMotion with the specified properties.
boolean	containsPointer()	Returns if a pointer is within this EventControllerMotion or one of its children.
void	emitEnter(double x, double y)	Emits the "enter" signal.
void	emitLeave()	Emits the "leave" signal.
void	emitMotion(double x, double y)	Emits the "motion" signal.
static @Nullable Type	getType()	Get the GType of the EventControllerMotion class
boolean	isPointer()	Returns if a pointer is within self, but not one of its children.
SignalConnection<EventControllerMotion.EnterCallback>	onEnter(EventControllerMotion.EnterCallback handler)	Signals that the pointer has entered the widget.
SignalConnection<EventControllerMotion.LeaveCallback>	onLeave(EventControllerMotion.LeaveCallback handler)	Signals that the pointer has left the widget.
SignalConnection<EventControllerMotion.MotionCallback>	onMotion(EventControllerMotion.MotionCallback handler)	Emitted when the pointer moves inside the widget.

Methods inherited from class org.gnome.gtk.EventController

getCurrentEvent, getCurrentEventDevice, getCurrentEventState, getCurrentEventTime, getName, getPropagationLimit, getPropagationPhase, getWidget, reset, setName, setPropagationLimit, setPropagationPhase, setStaticName

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

EventControllerMotion

public EventControllerMotion(MemorySegment address)

Create a EventControllerMotion proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

EventControllerMotion

public EventControllerMotion()

Creates a new EventControllerMotion.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the EventControllerMotion class

Returns:

the GType

asParent

protected EventControllerMotion 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 EventController

containsPointer

public boolean containsPointer()

Returns if a pointer is within this EventControllerMotion or one of its children.

Returns:

true if a pointer is within this EventControllerMotion or one of its children

isPointer

public boolean isPointer()

Returns if a pointer is within self, but not one of its children.

Returns:

true if a pointer is within this EventControllerMotion but not one of its children

onEnter

public SignalConnection<EventControllerMotion.EnterCallback> onEnter(EventControllerMotion.EnterCallback handler)

Signals that the pointer has entered the widget.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• EventControllerMotion.EnterCallback.run(double, double)

emitEnter

public void emitEnter(double x,
 double y)

Emits the "enter" signal. See onEnter(org.gnome.gtk.EventControllerMotion.EnterCallback).

onLeave

public SignalConnection<EventControllerMotion.LeaveCallback> onLeave(EventControllerMotion.LeaveCallback handler)

Signals that the pointer has left the widget.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• EventControllerMotion.LeaveCallback.run()

emitLeave

public void emitLeave()

Emits the "leave" signal. See onLeave(org.gnome.gtk.EventControllerMotion.LeaveCallback).

onMotion

public SignalConnection<EventControllerMotion.MotionCallback> onMotion(EventControllerMotion.MotionCallback handler)

Emitted when the pointer moves inside the widget.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• EventControllerMotion.MotionCallback.run(double, double)

emitMotion

public void emitMotion(double x,
 double y)

Emits the "motion" signal. See onMotion(org.gnome.gtk.EventControllerMotion.MotionCallback).

builder

public static EventControllerMotion.Builder<? extends EventControllerMotion.Builder> builder()

A EventControllerMotion.Builder object constructs a EventControllerMotion with the specified properties. Use the various set...() methods to set properties, and finish construction with EventControllerMotion.Builder.build().

Returns:

the builder object