Drag

class Drag(**properties: Any)

Superclasses: Object

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

Methods

class Drag
begin(surface: Surface, device: Device, content: ContentProvider, actions: DragAction, dx: float, dy: float) → Drag | None

Starts a drag and creates a new drag context for it.

This function is called by the drag source. After this call, you probably want to set up the drag icon using the surface returned by get_drag_surface.

This function returns a reference to the Drag object, but GTK keeps its own reference as well, as long as the DND operation is going on.

Note: if actions include MOVE, you need to listen for the dnd_finished signal and delete the data at the source if get_selected_action returns MOVE.

Parameters:

  • surface – the source surface for this drag

  • device – the device that controls this drag

  • content – the offered content

  • actions – the actions supported by this drag

  • dx – the x offset to device’s position where the drag nominally started

  • dy – the y offset to device’s position where the drag nominally started

drop_done(success: bool) → None

Informs GDK that the drop ended.

Passing False for success may trigger a drag cancellation animation.

This function is called by the drag source, and should be the last call before dropping the reference to the drag.

The GdkDrag will only take the first drop_done call as effective, if this function is called multiple times, all subsequent calls will be ignored.

Parameters:

success – whether the drag was ultimatively successful

get_actions() → DragAction

Determines the bitmask of possible actions proposed by the source.

get_content() → ContentProvider

Returns the GdkContentProvider associated to the GdkDrag object.

get_device() → Device

Returns the GdkDevice associated to the GdkDrag object.

get_display() → Display

Gets the GdkDisplay that the drag object was created for.

get_drag_surface() → Surface | None

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

Note that the surface may not be available until the drag operation has begun. GDK will move the surface in accordance with the ongoing drag operation. The surface is owned by drag and will be destroyed when the drag operation is over.

get_formats() → ContentFormats

Retrieves the formats supported by this GdkDrag object.

get_selected_action() → DragAction

Determines the action chosen by the drag destination.

get_surface() → Surface

Returns the GdkSurface where the drag originates.

set_hotspot(hot_x: int, hot_y: int) → None

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

Initially, the hotspot is at the top left corner of the drag surface.

Parameters:

  • hot_x – x coordinate of the drag surface hotspot

  • hot_y – y coordinate of the drag surface hotspot

Properties

class Drag
props.actions: DragAction

The possible actions of this drag.

props.content: ContentProvider

The GdkContentProvider.

props.device: Device

The GdkDevice that is performing the drag.

props.display: Display

The GdkDisplay that the drag belongs to.

props.formats: ContentFormats

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

props.selected_action: DragAction

The currently selected action of the drag.

props.surface: Surface

The surface where the drag originates.

Signals

class Drag.signals
cancel(reason: DragCancelReason) → None

Emitted when the drag operation is cancelled.

Parameters:

reason – The reason the drag was cancelled

dnd_finished() → None

Emitted when the destination side has finished reading all data.

The drag object can now free all miscellaneous data.

drop_performed() → None

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