Package org.gnome.gtk

Class DropControllerMotion

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.EventController

org.gnome.gtk.DropControllerMotion

All Implemented Interfaces:

Proxy

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

An event controller tracking the pointer during Drag-and-Drop operations.

It is modeled after EventControllerMotion so if you have used that, this should feel really familiar.

This controller is not able to accept drops, use DropTarget for that purpose.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DropControllerMotion.Builder<B extends DropControllerMotion.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	DropControllerMotion.DropControllerMotionClass
static interface	DropControllerMotion.EnterCallback	Functional interface declaration of the EnterCallback callback.
static interface	DropControllerMotion.LeaveCallback	Functional interface declaration of the LeaveCallback callback.
static interface	DropControllerMotion.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
DropControllerMotion()	Creates a new DropControllerMotion.
DropControllerMotion(MemorySegment address)	Create a DropControllerMotion proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected DropControllerMotion	asParent()	Returns this instance as if it were its parent type.
static DropControllerMotion.Builder<? extends DropControllerMotion.Builder>	builder()	A DropControllerMotion.Builder object constructs a DropControllerMotion with the specified properties.
boolean	containsPointer()	Returns if a Drag-and-Drop operation is within the widget this DropControllerMotion 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.
@Nullable Drop	getDrop()	Returns the GdkDrop of a current Drag-and-Drop operation over the widget of self.
static @Nullable Type	getType()	Get the GType of the DropControllerMotion class
boolean	isPointer()	Returns if a Drag-and-Drop operation is within the widget self, not one of its children.
SignalConnection<DropControllerMotion.EnterCallback>	onEnter(DropControllerMotion.EnterCallback handler)	Signals that the pointer has entered the widget.
SignalConnection<DropControllerMotion.LeaveCallback>	onLeave(DropControllerMotion.LeaveCallback handler)	Signals that the pointer has left the widget.
SignalConnection<DropControllerMotion.MotionCallback>	onMotion(DropControllerMotion.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

DropControllerMotion

public DropControllerMotion(MemorySegment address)

Create a DropControllerMotion proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

DropControllerMotion

public DropControllerMotion()

Creates a new DropControllerMotion.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the DropControllerMotion class

Returns:

the GType

asParent

protected DropControllerMotion 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 Drag-and-Drop operation is within the widget this DropControllerMotion or one of its children.

Returns:

true if a dragging pointer is within this DropControllerMotion or one of its children.

getDrop

public @Nullable Drop getDrop()

Returns the GdkDrop of a current Drag-and-Drop operation over the widget of self.

Returns:

The GdkDrop currently happening within this DropControllerMotion

isPointer

public boolean isPointer()

Returns if a Drag-and-Drop operation is within the widget self, not one of its children.

Returns:

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

onEnter

public SignalConnection<DropControllerMotion.EnterCallback> onEnter(DropControllerMotion.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:

• DropControllerMotion.EnterCallback.run(double, double)

emitEnter

public void emitEnter(double x,
 double y)

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

onLeave

public SignalConnection<DropControllerMotion.LeaveCallback> onLeave(DropControllerMotion.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:

• DropControllerMotion.LeaveCallback.run()

emitLeave

public void emitLeave()

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

onMotion

public SignalConnection<DropControllerMotion.MotionCallback> onMotion(DropControllerMotion.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:

• DropControllerMotion.MotionCallback.run(double, double)

emitMotion

public void emitMotion(double x,
 double y)

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

builder

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

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

Returns:

the builder object