Top | ![]() |
![]() |
![]() |
![]() |
GdkContentProvider * | content | Read / Write / Construct Only |
GdkDisplay * | display | Read / Write / Construct Only |
GdkContentFormats * | formats | Read |
void | action-changed | Run Last |
void | cancel | Run Last |
void | dnd-finished | Run Last |
void | drop-performed | Run Last |
These functions provide a low level interface for drag and drop. The X backend of GDK supports both the Xdnd and Motif drag and drop protocols transparently, the Win32 backend supports the WM_DROPFILES protocol.
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.
void gdk_drop_reply (GdkDragContext *context
,gboolean accepted
,guint32 time_
);
Accepts or rejects a drop.
This function is called by the drag destination in response to a drop initiated by the drag source.
void gdk_drag_drop_done (GdkDragContext *context
,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
context
.
The GdkDragContext 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.
Since: 3.20
GdkDragContext * gdk_drag_begin (GdkWindow *window
,GdkDevice *device
,GdkContentProvider *content
,GdkDragAction actions
,gint dx
,gint dy
);
Starts a drag and creates a new drag context for it.
This function is called by the drag source.
window |
the source window for this drag |
|
device |
the device that controls this drag |
|
content |
the offered content. |
[transfer none] |
actions |
the actions supported by this drag |
|
dx |
the x offset to |
|
dy |
the y offset to |
void gdk_drop_finish (GdkDragContext *context
,gboolean success
,guint32 time_
);
Ends the drag operation after a drop.
This function is called by the drag destination.
context |
||
success |
|
|
time_ |
the timestamp for this operation |
void gdk_drag_status (GdkDragContext *context
,GdkDragAction action
,guint32 time_
);
Selects one of the actions offered by the drag source.
This function is called by the drag destination in response to
gdk_drag_motion()
called by the drag source.
gboolean
gdk_drag_drop_succeeded (GdkDragContext *context
);
Returns whether the dropped data has been successfully
transferred. This function is intended to be used while
handling a GDK_DROP_FINISHED
event, its return value is
meaningless at other times.
Since: 2.6
GdkDisplay *
gdk_drag_context_get_display (GdkDragContext *context
);
Gets the GdkDisplay that the drag context was created for.
GdkDragAction
gdk_drag_context_get_actions (GdkDragContext *context
);
Determines the bitmask of actions proposed by the source if
gdk_drag_context_get_suggested_action()
returns GDK_ACTION_ASK
.
Since: 2.22
GdkDragAction
gdk_drag_context_get_suggested_action (GdkDragContext *context
);
Determines the suggested drag action of the context.
Since: 2.22
GdkDragAction
gdk_drag_context_get_selected_action (GdkDragContext *context
);
Determines the action chosen by the drag destination.
Since: 2.22
GdkContentFormats *
gdk_drag_context_get_formats (GdkDragContext *context
);
Retrieves the formats supported by this context.
Since: 3.94
GdkDevice *
gdk_drag_context_get_device (GdkDragContext *context
);
Returns the GdkDevice associated to the drag context.
GdkWindow *
gdk_drag_context_get_source_window (GdkDragContext *context
);
Returns the GdkWindow where the DND operation started.
Since: 2.22
GdkWindow *
gdk_drag_context_get_dest_window (GdkDragContext *context
);
Returns the destination window for the DND operation.
Since: 3.0
GdkWindow *
gdk_drag_context_get_drag_window (GdkDragContext *context
);
Returns the window on which the drag icon should be rendered
during the drag operation. Note that the window may not be
available until the drag operation has begun. GDK will move
the window in accordance with the ongoing drag operation.
The window is owned by context
and will be destroyed when
the drag operation is over.
Since: 3.20
void gdk_drag_context_set_hotspot (GdkDragContext *context
,gint hot_x
,gint hot_y
);
Sets the position of the drag window that will be kept under the cursor hotspot. Initially, the hotspot is at the top left corner of the drag window.
context |
||
hot_x |
x coordinate of the drag window hotspot |
|
hot_y |
y coordinate of the drag window hotspot |
Since: 3.20
typedef struct _GdkDragContext GdkDragContext;
The GdkDragContext struct contains only private fields and should not be accessed directly.
Used in GdkDragContext to the reason of a cancelled DND operation.
Since: 3.20
Used in GdkDragContext to indicate what the destination should do with the dropped data.
Means nothing, and should not be used. |
||
Copy the data. |
||
Move the data, i.e. first copy it, then delete it from the source using the DELETE target of the X selection protocol. |
||
Add a link to the data. Note that this is only useful if source and destination agree on what it means. |
||
Special action which tells the source that the destination will do something that the source doesn’t understand. |
||
Ask the user what to do with the data. |
“content”
property“content” GdkContentProvider *
The GdkContentProvider or NULL
if the context is not a source-side
context.
Flags: Read / Write / Construct Only
Since: 3.94
“display”
property“display” GdkDisplay *
The GdkDisplay that the drag context belongs to.
Flags: Read / Write / Construct Only
Since: 3.94
“formats”
property“formats” GdkContentFormats *
The possible formats that the context can provide its data in.
Flags: Read
Since: 3.94
“action-changed”
signalvoid user_function (GdkDragContext *context, GdkDragAction action, gpointer user_data)
A new action is being chosen for the drag and drop operation.
context |
The object on which the signal is emitted |
|
action |
The action currently chosen |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.20
“cancel”
signalvoid user_function (GdkDragContext *context, GdkDragCancelReason reason, gpointer user_data)
The drag and drop operation was cancelled.
context |
The object on which the signal is emitted |
|
reason |
The reason the context was cancelled |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.20
“dnd-finished”
signalvoid user_function (GdkDragContext *context, gpointer user_data)
The drag and drop operation was finished, the drag destination finished reading all data. The drag source can now free all miscellaneous data.
context |
The object on which the signal is emitted |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.20
“drop-performed”
signalvoid user_function (GdkDragContext *context, gint time, gpointer user_data)
The drag and drop operation was performed on an accepting client.
context |
The object on which the signal is emitted |
|
time |
the time at which the drop happened. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.20