Package ch.bailu.gtk.gtk

Class DropTargetAsync

java.lang.Object

ch.bailu.gtk.type.Type

ch.bailu.gtk.type.Pointer

ch.bailu.gtk.gobject.Object

ch.bailu.gtk.gtk.EventController

ch.bailu.gtk.gtk.DropTargetAsync

All Implemented Interfaces:

PointerInterface

public class DropTargetAsync
extends EventController

`GtkDropTargetAsync` is an event controller to receive Drag-and-Drop
operations, asynchronously.

It is the more complete but also more complex method of handling drop
operations compared to [class@Gtk.DropTarget], and you should only use
it if `GtkDropTarget` doesn't provide all the features you need.

To use a `GtkDropTargetAsync` to receive drops on a widget, you create
a `GtkDropTargetAsync` object, configure which data formats and actions
you support, connect to its signals, and then attach it to the widget
with [method@Gtk.Widget.add_controller].

During a drag operation, the first signal that a `GtkDropTargetAsync`
emits is [signal@Gtk.DropTargetAsync::accept], which is meant to determine
whether the target is a possible drop site for the ongoing drop. The
default handler for the ::accept signal accepts the drop if it finds
a compatible data format and an action that is supported on both sides.

If it is, and the widget becomes a target, you will receive a
[signal@Gtk.DropTargetAsync::drag-enter] signal, followed by
[signal@Gtk.DropTargetAsync::drag-motion] signals as the pointer moves,
optionally a [signal@Gtk.DropTargetAsync::drop] signal when a drop happens,
and finally a [signal@Gtk.DropTargetAsync::drag-leave] signal when the
pointer moves off the widget.

The ::drag-enter and ::drag-motion handler return a `GdkDragAction`
to update the status of the ongoing operation. The ::drop handler
should decide if it ultimately accepts the drop and if it does, it
should initiate the data transfer and finish the operation by calling
[method@Gdk.Drop.finish].

Between the ::drag-enter and ::drag-leave signals the widget is a
current drop target, and will receive the %GTK_STATE_FLAG_DROP_ACTIVE
state, which can be used by themes to style the widget as a drop target.

https://docs.gtk.org/gtk4/class.DropTargetAsync.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DropTargetAsync.OnAccept
static interface	DropTargetAsync.OnDragEnter
static interface	DropTargetAsync.OnDragLeave
static interface	DropTargetAsync.OnDragMotion
static interface	DropTargetAsync.OnDrop

Nested classes/interfaces inherited from class ch.bailu.gtk.gobject.Object

Object.OnBindingTransformFunc, Object.OnDestroyNotify, Object.OnDuplicateFunc, Object.OnNotify, Object.OnToggleNotify, Object.OnWeakNotify

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SIGNAL_ON_ACCEPT
static final String	SIGNAL_ON_DRAG_ENTER
static final String	SIGNAL_ON_DRAG_LEAVE
static final String	SIGNAL_ON_DRAG_MOTION
static final String	SIGNAL_ON_DROP

Fields inherited from class ch.bailu.gtk.gobject.Object

SIGNAL_ON_NOTIFY

Fields inherited from class ch.bailu.gtk.type.Pointer

NULL

Constructor Summary

Constructors

Constructor	Description
DropTargetAsync(ContentFormats formats, int actions)	Creates a new `GtkDropTargetAsync` object.
DropTargetAsync(PointerContainer pointer)

Method Summary

Modifier and Type	Method	Description
int	getActions()	Gets the actions that this drop target supports.
static ClassHandler	getClassHandler()
ContentFormats	getFormats()	Gets the data formats that this drop target accepts.
static int	getInstanceSize()
static long	getParentTypeID()
static TypeSystem.TypeSize	getParentTypeSize()
static long	getTypeID()
static TypeSystem.TypeSize	getTypeSize()
SignalHandler	onAccept(DropTargetAsync.OnAccept signal)	Connect to signal "accept".
SignalHandler	onDragEnter(DropTargetAsync.OnDragEnter signal)	Connect to signal "drag-enter".
SignalHandler	onDragLeave(DropTargetAsync.OnDragLeave signal)	Connect to signal "drag-leave".
SignalHandler	onDragMotion(DropTargetAsync.OnDragMotion signal)	Connect to signal "drag-motion".
SignalHandler	onDrop(DropTargetAsync.OnDrop signal)	Connect to signal "drop".
void	rejectDrop(Drop drop)	Sets the @drop as not accepted on this drag site.
void	setActions(int actions)	Sets the actions that this drop target supports.
void	setFormats(ContentFormats formats)	Sets the data formats that this drop target will accept.

Methods inherited from class ch.bailu.gtk.gtk.EventController

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

Methods inherited from class ch.bailu.gtk.gobject.Object

addToggleRef, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, disconnect, disconnect, dupData, dupData, dupQdata, forceFloating, freezeNotify, get, get, getData, getData, getProperty, getProperty, getQdata, interfaceFindProperty, interfaceInstallProperty, isFloating, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, replaceData, replaceData, replaceQdata, runDispose, set, set, setData, setData, setDataFull, setDataFull, setProperty, setProperty, setQdata, setQdataFull, stealData, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref

Methods inherited from class ch.bailu.gtk.type.Pointer

asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacks

Methods inherited from class ch.bailu.gtk.type.Type

asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.bailu.gtk.type.PointerInterface

asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull

Field Details

SIGNAL_ON_ACCEPT

public static final String SIGNAL_ON_ACCEPT

See Also:

• Constant Field Values

SIGNAL_ON_DRAG_ENTER

public static final String SIGNAL_ON_DRAG_ENTER

See Also:

• Constant Field Values

SIGNAL_ON_DRAG_LEAVE

public static final String SIGNAL_ON_DRAG_LEAVE

See Also:

• Constant Field Values

SIGNAL_ON_DRAG_MOTION

public static final String SIGNAL_ON_DRAG_MOTION

See Also:

• Constant Field Values

SIGNAL_ON_DROP

public static final String SIGNAL_ON_DROP

See Also:

• Constant Field Values

Constructor Details

DropTargetAsync

public DropTargetAsync(PointerContainer pointer)

DropTargetAsync

public DropTargetAsync(@Nullable
 ContentFormats formats,
 int actions)

Creates a new `GtkDropTargetAsync` object.

Parameters:

formats - the supported data formats

actions - the supported actions

Method Details

getClassHandler

public static ClassHandler getClassHandler()

getActions

public int getActions()

Gets the actions that this drop target supports.

Returns:

the actions that this drop target supports

getFormats

public ContentFormats getFormats()

Gets the data formats that this drop target accepts.

If the result is %NULL, all formats are expected to be supported.

Returns:

the supported data formats

rejectDrop

public void rejectDrop(@Nonnull
 Drop drop)

Sets the @drop as not accepted on this drag site.

This function should be used when delaying the decision
on whether to accept a drag or not until after reading
the data.

Parameters:

drop - the `GdkDrop` of an ongoing drag operation

setActions

public void setActions(int actions)

Sets the actions that this drop target supports.

Parameters:

actions - the supported actions

setFormats

public void setFormats(@Nullable
 ContentFormats formats)

Sets the data formats that this drop target will accept.

Parameters:

formats - the supported data formats or %NULL for any format

onAccept

public SignalHandler onAccept(DropTargetAsync.OnAccept signal)

Connect to signal "accept".
See DropTargetAsync.OnAccept.onAccept(ch.bailu.gtk.gdk.Drop) for signal description.
Field SIGNAL_ON_ACCEPT contains original signal name and can be used as resource reference.

Parameters:

signal - callback function (lambda).

Returns:

SignalHandler. Can be used to disconnect signal and to release callback function.

onDragEnter

public SignalHandler onDragEnter(DropTargetAsync.OnDragEnter signal)

Connect to signal "drag-enter".
See DropTargetAsync.OnDragEnter.onDragEnter(ch.bailu.gtk.gdk.Drop, double, double) for signal description.
Field SIGNAL_ON_DRAG_ENTER contains original signal name and can be used as resource reference.

Parameters:

signal - callback function (lambda).

Returns:

SignalHandler. Can be used to disconnect signal and to release callback function.

onDragLeave

public SignalHandler onDragLeave(DropTargetAsync.OnDragLeave signal)

Connect to signal "drag-leave".
See DropTargetAsync.OnDragLeave.onDragLeave(ch.bailu.gtk.gdk.Drop) for signal description.
Field SIGNAL_ON_DRAG_LEAVE contains original signal name and can be used as resource reference.

Parameters:

signal - callback function (lambda).

Returns:

SignalHandler. Can be used to disconnect signal and to release callback function.

onDragMotion

public SignalHandler onDragMotion(DropTargetAsync.OnDragMotion signal)

Connect to signal "drag-motion".
See DropTargetAsync.OnDragMotion.onDragMotion(ch.bailu.gtk.gdk.Drop, double, double) for signal description.
Field SIGNAL_ON_DRAG_MOTION contains original signal name and can be used as resource reference.

Parameters:

signal - callback function (lambda).

Returns:

SignalHandler. Can be used to disconnect signal and to release callback function.

onDrop

public SignalHandler onDrop(DropTargetAsync.OnDrop signal)

Connect to signal "drop".
See DropTargetAsync.OnDrop.onDrop(ch.bailu.gtk.gdk.Drop, double, double) for signal description.
Field SIGNAL_ON_DROP contains original signal name and can be used as resource reference.

Parameters:

signal - callback function (lambda).

Returns:

SignalHandler. Can be used to disconnect signal and to release callback function.

getTypeID

public static long getTypeID()

getParentTypeID

public static long getParentTypeID()

getTypeSize

public static TypeSystem.TypeSize getTypeSize()

getParentTypeSize

public static TypeSystem.TypeSize getParentTypeSize()

getInstanceSize

public static int getInstanceSize()