Package org.gnome.gdk

Class Drop

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gdk.Drop

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

Drop.DropImpl

@Generated("io.github.jwharm.JavaGI")
public abstract class Drop
extends GObject

The GdkDrop object represents the target of an ongoing DND operation.

Possible drop sites get informed about the status of the ongoing drag operation with events of type EventType.DRAG_ENTER, EventType.DRAG_LEAVE, EventType.DRAG_MOTION and EventType.DROP_START. The GdkDrop object can be obtained from these Event types using DNDEvent.getDrop().

The actual data transfer is initiated from the target side via an async read, using one of the GdkDrop methods for this purpose: readAsync(java.lang.String[], int, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) or readValueAsync(org.gnome.glib.Type, int, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback).

GTK provides a higher level abstraction based on top of these functions, and so they are not normally needed in GTK applications. See the "Drag and Drop" section of the GTK documentation for more information.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Drop.Builder<B extends Drop.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	Drop.DropImpl	The DropImpl type represents a native instance of the abstract Drop class.

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Drop	asParent()	Returns this instance as if it were its parent type.
static Drop.Builder<? extends Drop.Builder>	builder()	A Drop.Builder object constructs a Drop with the specified properties.
void	finish(Set<DragAction> action)	Ends the drag operation after a drop.
void	finish(DragAction... action)	Ends the drag operation after a drop.
Set<DragAction>	getActions()	Returns the possible actions for this GdkDrop.
Device	getDevice()	Returns the GdkDevice performing the drop.
Display	getDisplay()	Gets the GdkDisplay that this Drop was created for.
Drag	getDrag()	If this is an in-app drag-and-drop operation, returns the GdkDrag that corresponds to this drop.
ContentFormats	getFormats()	Returns the GdkContentFormats that the drop offers the data to be read in.
Surface	getSurface()	Returns the GdkSurface performing the drop.
static Type	getType()	Get the GType of the Drop class
void	readAsync(String[] mimeTypes, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously read the dropped data from a GdkDrop in a format that complies with one of the mime types.
InputStream	readFinish(AsyncResult result, Out<String> outMimeType)	Finishes an async drop read operation.
void	readValueAsync(Type type, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously request the drag operation's contents converted to the given type.
Value	readValueFinish(AsyncResult result)	Finishes an async drop read.
void	status(Set<DragAction> actions, Set<DragAction> preferred)	Selects all actions that are potentially supported by the destination.
void	status(DragAction actions, DragAction... preferred)	Selects all actions that are potentially supported by the destination.

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, 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

Drop

public Drop(MemorySegment address)

Create a Drop 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 Drop class

Returns:

the GType

asParent

protected Drop 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 GObject

finish

public void finish(Set<DragAction> action)

Ends the drag operation after a drop.

The action must be a single action selected from the actions available via getActions().

Parameters:

action - the action performed by the destination or 0 if the drop failed

finish

public void finish(DragAction... action)

Ends the drag operation after a drop.

The action must be a single action selected from the actions available via getActions().

Parameters:

action - the action performed by the destination or 0 if the drop failed

getActions

public Set<DragAction> getActions()

Returns the possible actions for this GdkDrop.

If this value contains multiple actions - i.e. DragAction.isUnique() returns false for the result - finish(java.util.Set<org.gnome.gdk.DragAction>) must choose the action to use when accepting the drop. This will only happen if you passed DragAction.ASK as one of the possible actions in status(java.util.Set<org.gnome.gdk.DragAction>, java.util.Set<org.gnome.gdk.DragAction>). DragAction.ASK itself will not be included in the actions returned by this function.

This value may change over the lifetime of the Drop both as a response to source side actions as well as to calls to status(java.util.Set<org.gnome.gdk.DragAction>, java.util.Set<org.gnome.gdk.DragAction>) or finish(java.util.Set<org.gnome.gdk.DragAction>). The source side will not change this value anymore once a drop has started.

Returns:

The possible GdkDragActions

getDevice

public Device getDevice()

Returns the GdkDevice performing the drop.

Returns:

The GdkDevice performing the drop.

getDisplay

public Display getDisplay()

Gets the GdkDisplay that this Drop was created for.

Returns:

a GdkDisplay

getDrag

public Drag getDrag()

If this is an in-app drag-and-drop operation, returns the GdkDrag that corresponds to this drop.

If it is not, null is returned.

Returns:

the corresponding GdkDrag

getFormats

public ContentFormats getFormats()

Returns the GdkContentFormats that the drop offers the data to be read in.

Returns:

The possible GdkContentFormats

getSurface

public Surface getSurface()

Returns the GdkSurface performing the drop.

Returns:

The GdkSurface performing the drop.

readAsync

public void readAsync(String[] mimeTypes,
 int ioPriority,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously read the dropped data from a GdkDrop in a format that complies with one of the mime types.

Parameters:

mimeTypes - pointer to an array of mime types

ioPriority - the I/O priority for the read operation

cancellable - optional GCancellable object

callback - a GAsyncReadyCallback to call when the request is satisfied

readFinish

public InputStream readFinish(AsyncResult result,
 Out<String> outMimeType)
                       throws GErrorException

Finishes an async drop read operation.

Note that you must not use blocking read calls on the returned stream in the GTK thread, since some platforms might require communication with GTK to complete the data transfer. You can use async APIs such as g_input_stream_read_bytes_async().

See readAsync(java.lang.String[], int, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback).

Parameters:

result - a GAsyncResult

outMimeType - return location for the used mime type

Returns:

the GInputStream

Throws:

GErrorException - see GError

readValueAsync

public void readValueAsync(Type type,
 int ioPriority,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously request the drag operation's contents converted to the given type.

For local drag-and-drop operations that are available in the given GType, the value will be copied directly. Otherwise, GDK will try to use Gdk.contentDeserializeAsync(org.gnome.gio.InputStream, java.lang.String, org.gnome.glib.Type, int, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) to convert the data.

Parameters:

type - a GType to read

ioPriority - the I/O priority of the request.

cancellable - optional GCancellable object, null to ignore.

callback - callback to call when the request is satisfied

readValueFinish

public Value readValueFinish(AsyncResult result)
                      throws GErrorException

Finishes an async drop read.

See readValueAsync(org.gnome.glib.Type, int, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback).

Parameters:

result - a GAsyncResult

Returns:

a GValue containing the result.

Throws:

GErrorException - see GError

status

public void status(Set<DragAction> actions,
 Set<DragAction> preferred)

Selects all actions that are potentially supported by the destination.

When calling this function, do not restrict the passed in actions to the ones provided by getActions(). Those actions may change in the future, even depending on the actions you provide here.

The preferred action is a hint to the drag-and-drop mechanism about which action to use when multiple actions are possible.

This function should be called by drag destinations in response to EventType.DRAG_ENTER or EventType.DRAG_MOTION events. If the destination does not yet know the exact actions it supports, it should set any possible actions first and then later call this function again.

Parameters:

actions - Supported actions of the destination, or 0 to indicate that a drop will not be accepted

preferred - A unique action that's a member of actions indicating the preferred action

status

public void status(DragAction actions,
 DragAction... preferred)

Selects all actions that are potentially supported by the destination.

When calling this function, do not restrict the passed in actions to the ones provided by getActions(). Those actions may change in the future, even depending on the actions you provide here.

The preferred action is a hint to the drag-and-drop mechanism about which action to use when multiple actions are possible.

This function should be called by drag destinations in response to EventType.DRAG_ENTER or EventType.DRAG_MOTION events. If the destination does not yet know the exact actions it supports, it should set any possible actions first and then later call this function again.

Parameters:

actions - Supported actions of the destination, or 0 to indicate that a drop will not be accepted

preferred - A unique action that's a member of actions indicating the preferred action

builder

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

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