Drag

abstract class Drag(val gdkDragPointer: <Error class: unknown class><<Error class: unknown class>>)(source)

The GdkDrag object represents the source of an ongoing DND operation.

A GdkDrag is created when a drag is started, and stays alive for duration of the DND operation. After a drag has been started with func@Gdk.Drag.begin, the caller gets informed about the status of the ongoing drag operation with signals on the GdkDrag object.

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.

Inheritors

DragImpl

Constructors

Drag

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

Types

Companion

object Companion

DragImpl

class DragImpl(pointer: <Error class: unknown class><<Error class: unknown class>>) : Drag

The DragImpl type represents a native instance of the abstract Drag class.

Properties

actions

open val actions: DragAction

The possible actions of this drag.

content

open val content: ContentProvider

The GdkContentProvider.

device

open val device: Device

The GdkDevice that is performing the drag.

display

open val display: Display

The GdkDisplay that the drag belongs to.

formats

open val formats: ContentFormats

The possible formats that the drag can provide its data in.

gdkDragPointer

val gdkDragPointer: <Error class: unknown class><<Error class: unknown class>>

selectedAction

open val selectedAction: DragAction

The currently selected action of the drag.

surface

open val surface: Surface

The surface where the drag originates.

Functions

dropDone

open fun dropDone(success: Boolean)

Informs GDK that the drop ended.

emitCancel

fun emitCancel(reason: DragCancelReason)

Emits the "cancel" signal. See onCancel.

emitDndFinished

fun emitDndFinished()

Emits the "dnd-finished" signal. See onDndFinished.

emitDropPerformed

fun emitDropPerformed()

Emits the "drop-performed" signal. See onDropPerformed.

getDragSurface

open fun getDragSurface(): Surface?

Returns the surface on which the drag icon should be rendered during the drag operation.

onCancel

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

Emitted when the drag operation is cancelled.

onDndFinished

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

Emitted when the destination side has finished reading all data.

onDropPerformed

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

Emitted when the drop operation is performed on an accepting client.

setHotspot

open fun setHotspot(hotX: <Error class: unknown class>, hotY: <Error class: unknown class>)

Sets the position of the drag surface that will be kept under the cursor hotspot.