1999-08-16 18:51:52 +00:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
|
|
|
Drag and Drop
|
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
2002-11-23 23:02:10 +00:00
|
|
|
Functions for controlling drag and drop handling
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
<para>
|
2000-02-02 03:23:11 +00:00
|
|
|
These functions provide a low level interface for drag and drop.
|
2001-11-28 23:41:12 +00:00
|
|
|
The X backend of GDK supports both the Xdnd and Motif drag and drop protocols
|
|
|
|
transparently, the Win32 backend supports the WM_DROPFILES protocol.
|
2000-02-02 03:23:11 +00:00
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
GTK+ provides a higher level abstraction based on top of these functions,
|
|
|
|
and so they are not normally needed in GTK+ applications.
|
|
|
|
See the <link linkend="gtk-Drag-and-Drop">Drag and Drop</link> section of
|
|
|
|
the GTK+ documentation for more information.
|
1999-08-16 18:51:52 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_get_selection ##### -->
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
2002-10-24 21:24:20 +00:00
|
|
|
@context:
|
|
|
|
@Returns:
|
1999-08-16 18:51:52 +00:00
|
|
|
|
2002-11-02 18:18:50 +00:00
|
|
|
|
1999-08-16 18:51:52 +00:00
|
|
|
<!-- ##### FUNCTION gdk_drag_abort ##### -->
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
2002-10-24 21:24:20 +00:00
|
|
|
@context:
|
2002-11-08 19:41:50 +00:00
|
|
|
@time_:
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drop_reply ##### -->
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
2002-10-24 21:24:20 +00:00
|
|
|
@context:
|
|
|
|
@ok:
|
2002-11-08 19:41:50 +00:00
|
|
|
@time_:
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_context_new ##### -->
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
2002-10-24 21:24:20 +00:00
|
|
|
@Returns:
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_drop ##### -->
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
2002-10-24 21:24:20 +00:00
|
|
|
@context:
|
2002-11-08 19:41:50 +00:00
|
|
|
@time_:
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_find_window ##### -->
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
2002-10-24 21:24:20 +00:00
|
|
|
@context:
|
|
|
|
@drag_window:
|
|
|
|
@x_root:
|
|
|
|
@y_root:
|
|
|
|
@dest_window:
|
|
|
|
@protocol:
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
|
Documentation fixes.
Sun Oct 13 18:50:14 2002 Soeren Sandmann <sandmann@daimi.au.dk>
* gtkmenu.c, gtkmenu.sgml, gtkitemfactory.c, gdkwindow.c,
gtkwindow.c, gtkpaned.sgml, gtkdialog.c, gtkbox.h, gtkbutton.sgml,
gtktreemodel.sgml,gtktable.sgml, gtktable.c:
Documentation fixes.
#85719, #90759, #95169, Owen Taylor;
#89221, Yao Zhang, Matthias Clasen;
#95592, Joost Faassen;
#92637, Vitaly Tishkov;
#94616, Ben Martin;
#94772, sbaillie@bigpond.net.au;
2002-10-13 17:17:14 +00:00
|
|
|
<!-- ##### FUNCTION gdk_drag_find_window_for_screen ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@context:
|
|
|
|
@drag_window:
|
|
|
|
@screen:
|
|
|
|
@x_root:
|
|
|
|
@y_root:
|
|
|
|
@dest_window:
|
|
|
|
@protocol:
|
|
|
|
|
|
|
|
|
1999-08-16 18:51:52 +00:00
|
|
|
<!-- ##### FUNCTION gdk_drag_context_ref ##### -->
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
2002-10-24 21:24:20 +00:00
|
|
|
@context:
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_begin ##### -->
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
2002-10-24 21:24:20 +00:00
|
|
|
@window:
|
|
|
|
@targets:
|
|
|
|
@Returns:
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_motion ##### -->
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
2002-10-24 21:24:20 +00:00
|
|
|
@context:
|
|
|
|
@dest_window:
|
|
|
|
@protocol:
|
|
|
|
@x_root:
|
|
|
|
@y_root:
|
|
|
|
@suggested_action:
|
|
|
|
@possible_actions:
|
2002-11-08 19:41:50 +00:00
|
|
|
@time_:
|
2002-11-02 18:18:50 +00:00
|
|
|
@Returns:
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drop_finish ##### -->
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
2002-10-24 21:24:20 +00:00
|
|
|
@context:
|
|
|
|
@success:
|
2002-11-08 19:41:50 +00:00
|
|
|
@time_:
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_get_protocol ##### -->
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
2002-10-24 21:24:20 +00:00
|
|
|
@xid:
|
|
|
|
@protocol:
|
|
|
|
@Returns:
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
|
2002-04-30 18:07:51 +00:00
|
|
|
<!-- ##### FUNCTION gdk_drag_get_protocol_for_display ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@xid:
|
|
|
|
@protocol:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
1999-08-16 18:51:52 +00:00
|
|
|
<!-- ##### ENUM GdkDragProtocol ##### -->
|
|
|
|
<para>
|
2001-12-02 22:27:26 +00:00
|
|
|
Used in #GdkDragContext to indicate the protocol according to
|
2001-11-28 23:41:12 +00:00
|
|
|
which DND is done.
|
1999-08-16 18:51:52 +00:00
|
|
|
</para>
|
|
|
|
|
2001-11-28 23:41:12 +00:00
|
|
|
@GDK_DRAG_PROTO_MOTIF: The Motif DND protocol.
|
|
|
|
@GDK_DRAG_PROTO_XDND: The Xdnd protocol.
|
|
|
|
@GDK_DRAG_PROTO_ROOTWIN: An extension to the Xdnd protocol for
|
|
|
|
unclaimed root window drops.
|
2001-12-23 22:55:17 +00:00
|
|
|
@GDK_DRAG_PROTO_NONE: no protocol.
|
2001-11-28 23:41:12 +00:00
|
|
|
@GDK_DRAG_PROTO_WIN32_DROPFILES: The simple WM_DROPFILES protocol.
|
2001-12-23 22:55:17 +00:00
|
|
|
@GDK_DRAG_PROTO_OLE2: The complex OLE2 DND protocol (not implemented).
|
2001-11-28 23:41:12 +00:00
|
|
|
@GDK_DRAG_PROTO_LOCAL: Intra-application DND.
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_context_unref ##### -->
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
2002-10-24 21:24:20 +00:00
|
|
|
@context:
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GdkDragContext ##### -->
|
|
|
|
<para>
|
2001-11-28 23:41:12 +00:00
|
|
|
A <structname>GdkDragContext</structname> holds information about a
|
|
|
|
drag in progress. It is used on both source and destination sides.
|
1999-08-16 18:51:52 +00:00
|
|
|
</para>
|
|
|
|
|
2001-12-23 22:55:17 +00:00
|
|
|
@parent_instance:
|
2001-11-28 23:41:12 +00:00
|
|
|
@protocol: the DND protocol which governs this drag.
|
|
|
|
@is_source: %TRUE if the context is used on the source side.
|
|
|
|
@source_window: the source of this drag.
|
2001-12-23 22:55:17 +00:00
|
|
|
@dest_window: the destination window of this drag.
|
2001-12-02 22:27:26 +00:00
|
|
|
@targets: a list of targets offered by the source.
|
|
|
|
@actions: a bitmask of actions proposed by the source when
|
|
|
|
@suggested_action is %GDK_ACTION_ASK.
|
|
|
|
@suggested_action: the action suggested by the source.
|
|
|
|
@action: the action chosen by the destination.
|
2001-11-28 23:41:12 +00:00
|
|
|
@start_time: a timestamp recording the start time of this drag.
|
|
|
|
|
1999-08-16 18:51:52 +00:00
|
|
|
<!-- ##### ENUM GdkDragAction ##### -->
|
|
|
|
<para>
|
2001-12-02 22:27:26 +00:00
|
|
|
Used in #GdkDragContext to indicate what the destination
|
|
|
|
should do with the dropped data.
|
1999-08-16 18:51:52 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
@GDK_ACTION_DEFAULT:
|
2001-12-23 22:55:17 +00:00
|
|
|
@GDK_ACTION_COPY: Copy the data.
|
2001-12-02 22:27:26 +00:00
|
|
|
@GDK_ACTION_MOVE: Move the data, i.e. first copy it, then delete
|
|
|
|
it from the source using the DELETE target of the X selection protocol.
|
|
|
|
@GDK_ACTION_LINK: Add a link to the data. Note that this is only
|
|
|
|
useful if source and destination agree on what it means.
|
|
|
|
@GDK_ACTION_PRIVATE: Special action which tells the source that the
|
|
|
|
destination will do something that the source doesn't understand.
|
2001-12-23 22:55:17 +00:00
|
|
|
@GDK_ACTION_ASK: Ask the user what to do with the data.
|
1999-08-16 18:51:52 +00:00
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_status ##### -->
|
|
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
2002-10-24 21:24:20 +00:00
|
|
|
@context:
|
|
|
|
@action:
|
2002-11-08 19:41:50 +00:00
|
|
|
@time_:
|
2001-12-23 22:55:17 +00:00
|
|
|
|
|
|
|
|