gtk4/org.gtkkn.bindings.gtk/DropTargetAsync

DropTargetAsync

open class DropTargetAsync(val gtkDropTargetAsyncPointer: <Error class: unknown class><<Error class: unknown class>>) : 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.

Constructors

DropTargetAsync

constructor(formats: <Error class: unknown class>? = null, actions: <Error class: unknown class>)

Creates a new GtkDropTargetAsync object.

constructor(gtkDropTargetAsyncPointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

actions

open var actions: <Error class: unknown class>

The GdkDragActions that this drop target supports.

formats

open var formats: <Error class: unknown class>?

The GdkContentFormats that determines the supported data formats.

gtkDropTargetAsyncPointer

val gtkDropTargetAsyncPointer: <Error class: unknown class><<Error class: unknown class>>

gtkEventControllerPointer

val gtkEventControllerPointer: <Error class: unknown class><<Error class: unknown class>>

name

open var name: String?

The name for this controller, typically used for debugging purposes.

propagationLimit

open var propagationLimit: PropagationLimit

The limit for which events this controller will handle.

propagationPhase

open var propagationPhase: PropagationPhase

The propagation phase at which this controller will handle events.

widget

open val widget: Widget?

The widget receiving the GdkEvents that the controller will handle.

Functions

emitDragLeave

fun emitDragLeave(drop: <Error class: unknown class>)

Emits the "drag-leave" signal. See onDragLeave.

getCurrentEvent

open fun getCurrentEvent(): <Error class: unknown class>?

Returns the event that is currently being handled by the controller.

getCurrentEventDevice

open fun getCurrentEventDevice(): <Error class: unknown class>?

Returns the device of the event that is currently being handled by the controller.

getCurrentEventState

open fun getCurrentEventState(): <Error class: unknown class>

Returns the modifier state of the event that is currently being handled by the controller.

getCurrentEventTime

open fun getCurrentEventTime(): <Error class: unknown class>

Returns the timestamp of the event that is currently being handled by the controller.

onAccept

fun onAccept(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>) -> Boolean): <Error class: unknown class>

Emitted on the drop site when a drop operation is about to begin.

onDragEnter

fun onDragEnter(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, <Error class: unknown class>, <Error class: unknown class>) -> <Error class: unknown class>): <Error class: unknown class>

Emitted on the drop site when the pointer enters the widget.

onDragLeave

fun onDragLeave(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>) -> Unit): <Error class: unknown class>

Emitted on the drop site when the pointer leaves the widget.

onDragMotion

fun onDragMotion(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, <Error class: unknown class>, <Error class: unknown class>) -> <Error class: unknown class>): <Error class: unknown class>

Emitted while the pointer is moving over the drop target.

onDrop

fun onDrop(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, <Error class: unknown class>, <Error class: unknown class>) -> Boolean): <Error class: unknown class>

Emitted on the drop site when the user drops the data onto the widget.

rejectDrop

open fun rejectDrop(drop: <Error class: unknown class>)

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

reset

open fun reset()

Resets the @controller to a clean state.

setStaticName

open fun setStaticName(name: String? = null)

Sets a name on the controller that can be used for debugging.