DropTarget

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_drop_target_get_type ()" ) ]
public class DropTarget : EventController

GtkDropTarget is an event controller implementing a simple way to receive Drag-and-Drop operations.

The most basic way to use a DropTarget to receive drops on a widget is to create it via DropTarget passing in the Type of the data you want to receive and connect to the GtkDropTarget: drop signal to receive the data.

DropTarget supports more options, such as:

* rejecting potential drops via the accept signal and the reject function to let other drop targets handle the drop * tracking an ongoing drag operation before the drop via the enter, motion and leave signals * configuring how to receive data by setting the preload property and listening for its availability via the value property

However, DropTarget is ultimately modeled in a synchronous way and only supports data transferred via Type. If you want full control over an ongoing drop, the DropTargetAsync object gives you this ability.

While a pointer is dragged over the drop target's widget and the drop has not been rejected, that widget will receive the gtk_state_flag_drop_active state, which can be used to style the widget.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public DragAction actions { get; set; }
The DragActions that this drop target supports
public Drop drop { get; }
The Drop that is currently being performed
public ContentFormats formats { owned get; }
The ContentFormats that determine the supported data formats
public bool preload { get; set; }
Whether the drop data should be preloaded when the pointer is only hovering over the widget but has not been released.
public Value value { get; }
The value for this drop operation or null if the data has not been loaded yet or no drop operation is going on.

Creation methods:

public DropTarget (Type type, DragAction actions)
Creates a new DropTarget object.

Methods:

public DragAction get_actions ()
Gets the actions that this drop target supports.
public unowned Drop? get_drop ()
Gets the currently handled drop operation.
public ContentFormats? get_formats ()
Gets the data formats that this drop target accepts.
public unowned Type[]? get_gtypes ()
Gets the list of supported Types for this.
public bool get_preload ()
Gets the value of the GtkDropTarget:preload property.
public unowned Value? get_value ()
Gets the value of the GtkDropTarget:value property.
public void reject ()
Rejects the ongoing drop operation.
public void set_actions (DragAction actions)
Sets the actions that this drop target supports.
public void set_gtypes (Type[]? types)
Sets the supported Type s for this drop target.
public void set_preload (bool preload)
Sets the GtkDropTarget:preload property.

Signals:

public signal bool accept (Drop drop)
The accept signal is emitted on the drop site when a drop operation is about to begin.
public signal DragAction enter (double x, double y)
The enter signal is emitted on the drop site when the pointer enters the widget.
public signal void leave ()
The leave signal is emitted on the drop site when the pointer leaves the widget.
public signal DragAction motion (double x, double y)
The motion signal is emitted while the pointer is moving over the drop target.
public signal bool on_drop (Value value, double x, double y)
The on_drop signal is emitted on the drop site when the user drops the data onto the widget.

Inherited Members:

All known members inherited from class Gtk.EventController

All known members inherited from class GLib.Object