gdk_drag_drop_done ()

void
gdk_drag_drop_done (GdkDrag *drag,
                    gboolean success);

Inform GDK if the drop ended successfully. 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 gdk_drag_drop_done() call as effective, if this function is called multiple times, all subsequent calls will be ignored.

gdk_drag_begin ()

GdkDrag *
gdk_drag_begin (GdkSurface *surface,
                GdkDevice *device,
                GdkContentProvider *content,
                GdkDragAction actions,
                double dx,
                double dy);

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 gdk_drag_get_drag_surface().

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

Note: if actions include GDK_ACTION_MOVE, you need to listen for the “dnd-finished” signal and delete the data at the source if gdk_drag_get_selected_action() returns GDK_ACTION_MOVE.

gdk_drag_get_display ()

GdkDisplay *
gdk_drag_get_display (GdkDrag *drag);

Gets the GdkDisplay that the drag object was created for.

gdk_drag_get_content ()

GdkContentProvider *
gdk_drag_get_content (GdkDrag *drag);

Returns the GdkContentProvider associated to the GdkDrag object.

gdk_drag_get_actions ()

GdkDragAction
gdk_drag_get_actions (GdkDrag *drag);

Determines the bitmask of possible actions proposed by the source.

gdk_drag_get_selected_action ()

GdkDragAction
gdk_drag_get_selected_action (GdkDrag *drag);

Determines the action chosen by the drag destination.

gdk_drag_get_formats ()

GdkContentFormats *
gdk_drag_get_formats (GdkDrag *drag);

Retrieves the formats supported by this GdkDrag object.

gdk_drag_get_device ()

GdkDevice *
gdk_drag_get_device (GdkDrag *drag);

Returns the GdkDevice associated to the GdkDrag object.

gdk_drag_get_surface ()

GdkSurface *
gdk_drag_get_surface (GdkDrag *drag);

Returns the GdkSurface where the drag originates.

gdk_drag_get_drag_surface ()

GdkSurface *
gdk_drag_get_drag_surface (GdkDrag *drag);

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.

gdk_drag_set_hotspot ()

void
gdk_drag_set_hotspot (GdkDrag *drag,
                      int hot_x,
                      int hot_y);

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.

gdk_drag_action_is_unique ()

gboolean
gdk_drag_action_is_unique (GdkDragAction action);

Checks if action represents a single action or if it includes multiple flags that can be selected from.

When action is 0 - ie no action was given, TRUE is returned.

gdk_drag_surface_present ()

gboolean
gdk_drag_surface_present (GdkDragSurface *drag_surface,
                          int width,
                          int height);

Present drag_surface .

gdk_drop_get_display ()

GdkDisplay *
gdk_drop_get_display (GdkDrop *self);

Gets the GdkDisplay that self was created for.

gdk_drop_get_device ()

GdkDevice *
gdk_drop_get_device (GdkDrop *self);

Returns the GdkDevice performing the drop.

gdk_drop_get_surface ()

GdkSurface *
gdk_drop_get_surface (GdkDrop *self);

Returns the GdkSurface performing the drop.

gdk_drop_get_formats ()

GdkContentFormats *
gdk_drop_get_formats (GdkDrop *self);

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

gdk_drop_get_actions ()

GdkDragAction
gdk_drop_get_actions (GdkDrop *self);

Returns the possible actions for this GdkDrop. If this value contains multiple actions - ie gdk_drag_action_is_unique() returns FALSE for the result - gdk_drop_finish() must choose the action to use when accepting the drop. This will only happen if you passed GDK_ACTION_ASK as one of the possible actions in gdk_drop_status(). GDK_ACTION_ASK itself will not be included in the actions returned by this function.

This value may change over the lifetime of the GdkDrop both as a response to source side actions as well as to calls to gdk_drop_status() or gdk_drop_finish(). The source side will not change this value anymore once a drop has started.

gdk_drop_get_drag ()

GdkDrag *
gdk_drop_get_drag (GdkDrop *self);

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.

gdk_drop_status ()

void
gdk_drop_status (GdkDrop *self,
                 GdkDragAction actions,
                 GdkDragAction 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 gdk_drop_get_actions(). Those actions may change in the future, even depending on the actions you provide here.

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

This function should be called by drag destinations in response to GDK_DRAG_ENTER or GDK_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.

gdk_drop_finish ()

void
gdk_drop_finish (GdkDrop *self,
                 GdkDragAction action);

Ends the drag operation after a drop.

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

gdk_drop_read_async ()

void
gdk_drop_read_async (GdkDrop *self,
                     const char **mime_types,
                     int io_priority,
                     GCancellable *cancellable,
                     GAsyncReadyCallback callback,
                     gpointer user_data);

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

gdk_drop_read_finish ()

GInputStream *
gdk_drop_read_finish (GdkDrop *self,
                      GAsyncResult *result,
                      const char **out_mime_type,
                      GError **error);

Finishes an async drop read operation, see gdk_drop_read_async().

gdk_drop_read_value_async ()

void
gdk_drop_read_value_async (GdkDrop *self,
                           GType type,
                           int io_priority,
                           GCancellable *cancellable,
                           GAsyncReadyCallback callback,
                           gpointer user_data);

Asynchronously request the drag operation's contents converted to the given type . When the operation is finished callback will be called. You can then call gdk_drop_read_value_finish() to get the resulting GValue.

For local drag'n'drop operations that are available in the given GType, the value will be copied directly. Otherwise, GDK will try to use gdk_content_deserialize_async() to convert the data.

gdk_drop_read_value_finish ()

const GValue *
gdk_drop_read_value_finish (GdkDrop *self,
                            GAsyncResult *result,
                            GError **error);

Finishes an async drop read started with gdk_drop_read_value_async().

GdkDrag

typedef struct _GdkDrag GdkDrag;

The GdkDrag struct contains only private fields and should not be accessed directly.

GdkDrop

typedef struct _GdkDrop GdkDrop;

The GdkDrop struct contains only private fields and should not be accessed directly.

enum GdkDragCancelReason

Used in GdkDrag to the reason of a cancelled DND operation.

enum GdkDragAction

Used in GdkDrop and GdkDrag to indicate the actions that the destination can and should do with the dropped data.

GDK_ACTION_ALL

#define GDK_ACTION_ALL (GDK_ACTION_COPY | GDK_ACTION_MOVE | GDK_ACTION_LINK)

Defines all possible DND actions. This can be used in gdk_drop_status() messages when any drop can be accepted or a more specific drop method is not yet known.

GdkDragSurface

typedef struct _GdkDragSurface GdkDragSurface;

A GdkDragSurface is an interface implemented by GdkSurfaces used during a DND operation.

GdkDragSurfaceInterface

typedef struct _GdkDragSurfaceInterface GdkDragSurfaceInterface;

The GdkDragSurfaceInterface implementation is private to GDK.

The “actions” property

  “actions”                  GdkDragAction

The possible actions.

Owner: GdkDrag

Flags: Read / Write

The “content” property

  “content”                  GdkContentProvider *

The GdkContentProvider.

Owner: GdkDrag

Flags: Read / Write / Construct Only

The “device” property

  “device”                   GdkDevice *

The GdkDevice that is performing the drag.

Owner: GdkDrag

Flags: Read / Write / Construct Only

The “display” property

  “display”                  GdkDisplay *

The GdkDisplay that the drag belongs to.

Owner: GdkDrag

Flags: Read

The “formats” property

  “formats”                  GdkContentFormats *

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

Owner: GdkDrag

Flags: Read / Write / Construct Only

The “selected-action” property

  “selected-action”          GdkDragAction

The currently selected action.

Owner: GdkDrag

Flags: Read / Write

The “surface” property

  “surface”                  GdkSurface *

The surface where the drag originates.

Owner: GdkDrag

Flags: Read / Write / Construct Only

The “actions” property

  “actions”                  GdkDragAction

The possible actions for this drop

Owner: GdkDrop

Flags: Read / Write / Construct Only

Default value: GDK_ACTION_COPY | GDK_ACTION_MOVE | GDK_ACTION_LINK

The “device” property

  “device”                   GdkDevice *

The GdkDevice performing the drop

Owner: GdkDrop

Flags: Read / Write / Construct Only

The “display” property

  “display”                  GdkDisplay *

The GdkDisplay that the drop belongs to.

Owner: GdkDrop

Flags: Read

The “drag” property

  “drag”                     GdkDrag *

The GdkDrag that initiated this drop

Owner: GdkDrop

Flags: Read / Write / Construct Only

The “formats” property

  “formats”                  GdkContentFormats *

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

Owner: GdkDrop

Flags: Read / Write / Construct Only

The “surface” property

  “surface”                  GdkSurface *

The GdkSurface the drop happens on

Owner: GdkDrop

Flags: Read / Write / Construct Only

The “cancel” signal

void
user_function (GdkDrag            *drag,
               GdkDragCancelReason reason,
               gpointer            user_data)

The drag operation was cancelled.

Flags: Run Last

The “dnd-finished” signal

void
user_function (GdkDrag *drag,
               gpointer user_data)

The drag operation was finished, the destination finished reading all data. The drag object can now free all miscellaneous data.

Flags: Run Last

The “drop-performed” signal

void
user_function (GdkDrag *drag,
               gpointer user_data)

The drag operation was performed on an accepting client.

Flags: Run Last