forked from AuroraMiddleware/gtk
101d44881c
* gdk/gdkdrawable.h (gdk_drawable_ref, gdk_drawable_unref),
gdk/gdkcolor.h (gdk_colormap_ref, gdk_colormap_unref),
gdk/gdkdnd.h (gdk_drag_context_ref, gdk_drag_context_unref),
gdk/gdkgc.h (gdk_gc_ref, gdk_gc_unref): Deprecate.
* gdk/gdkvisual.h: Use GDK_DISABLE_DEPRECATED, not
GTK_DISABLE_DEPRECATED.
* gdk/gdkcolor.c (gdk_colormap_ref, gdk_colormap_unref),
gdk/gdkgc.c (gdk_gc_ref, gdk_gc_unref): Document.
* gdk/tmpl/colors.sgml, gdk/tmpl/pixmaps.sgml, gdk/tmpl/dnd.sgml,
gdk/tmpl/gcs.sgml: Document ref and unref functions as deprecated.
203 lines
4.1 KiB
Plaintext
203 lines
4.1 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
Drag and Drop
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
functions for controlling drag and drop handling.
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
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.
|
|
</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.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### FUNCTION gdk_drag_get_selection ##### -->
|
|
<para>
|
|
Returns the selection atom for the current source window.
|
|
</para>
|
|
|
|
@context: a #GdkDragContext.
|
|
@Returns: the selection atom.
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_abort ##### -->
|
|
<para>
|
|
Aborts a drag without dropping.
|
|
</para>
|
|
|
|
@context: a #GdkDragContext.
|
|
@time: the timestamp for this operation.
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drop_reply ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@context:
|
|
@ok:
|
|
@time:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_context_new ##### -->
|
|
<para>
|
|
Creates a new #GdkDragContext.
|
|
</para>
|
|
|
|
@Returns: the newly created #GdkDragContext.
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_drop ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@context:
|
|
@time:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_find_window ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@context:
|
|
@drag_window:
|
|
@x_root:
|
|
@y_root:
|
|
@dest_window:
|
|
@protocol:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_context_ref ##### -->
|
|
<para>
|
|
Deprecated function; use g_object_ref() instead.
|
|
</para>
|
|
|
|
@context: a #GdkDragContext.
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_begin ##### -->
|
|
<para>
|
|
Creates a new drag context with @window as @source_window and @targets
|
|
as list of targets.
|
|
</para>
|
|
|
|
@window: the source window for this drag.
|
|
@targets: the list of targets.
|
|
@Returns: a newly created #GdkDragContext.
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_motion ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@context:
|
|
@dest_window:
|
|
@protocol:
|
|
@x_root:
|
|
@y_root:
|
|
@suggested_action:
|
|
@possible_actions:
|
|
@time:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drop_finish ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@context:
|
|
@success:
|
|
@time:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_drag_get_protocol ##### -->
|
|
<para>
|
|
Finds out the DND protocol supported by a window.
|
|
</para>
|
|
|
|
@xid: the X id of the destination window.
|
|
@protocol: location where the supported DND protocol is returned.
|
|
@Returns: the X id of the window where the drop should happen. This
|
|
may be @xid or the X id of a proxy window, or None if @xid doesn't
|
|
support Drag and Drop.
|
|
|
|
|
|
<!-- ##### ENUM GdkDragProtocol ##### -->
|
|
<para>
|
|
Is used in #GdkDragContext to indicate the protocol according to
|
|
which DND is done.
|
|
</para>
|
|
|
|
@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.
|
|
@GDK_DRAG_PROTO_NONE: no protocol.
|
|
@GDK_DRAG_PROTO_WIN32_DROPFILES: The simple WM_DROPFILES protocol.
|
|
@GDK_DRAG_PROTO_OLE2: The complex OLE2 DND protocol (not implemented).
|
|
@GDK_DRAG_PROTO_LOCAL: Intra-application DND.
|
|
|
|
<!-- ##### FUNCTION gdk_drag_context_unref ##### -->
|
|
<para>
|
|
Deprecated function; use g_object_unref() instead.
|
|
</para>
|
|
|
|
@context: a #GdkDragContext.
|
|
|
|
|
|
<!-- ##### STRUCT GdkDragContext ##### -->
|
|
<para>
|
|
A <structname>GdkDragContext</structname> holds information about a
|
|
drag in progress. It is used on both source and destination sides.
|
|
</para>
|
|
|
|
@parent_instance:
|
|
@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.
|
|
@dest_window: the destination window of this drag.
|
|
@targets: a list of targets accepted on the destination.
|
|
@actions: a bitmask of all possible actions.
|
|
@suggested_action: the suggested action.
|
|
@action:
|
|
@start_time: a timestamp recording the start time of this drag.
|
|
|
|
|
|
<!-- ##### ENUM GdkDragAction ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@GDK_ACTION_DEFAULT:
|
|
@GDK_ACTION_COPY:
|
|
@GDK_ACTION_MOVE:
|
|
@GDK_ACTION_LINK:
|
|
@GDK_ACTION_PRIVATE:
|
|
@GDK_ACTION_ASK:
|
|
|
|
<!-- ##### FUNCTION gdk_drag_status ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@context:
|
|
@action:
|
|
@time:
|
|
|
|
|