Pileus Git - ~andy/gtk/blob - docs/reference/gdk/tmpl/dnd.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Drag and Drop
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Functions for controlling drag and drop handling
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 These functions provide a low level interface for drag and drop.
  10 The X backend of GDK supports both the Xdnd and Motif drag and drop protocols
  11 transparently, the Win32 backend supports the WM_DROPFILES protocol.
  12 </para>
  13 <para>
  14 GTK+ provides a higher level abstraction based on top of these functions,
  15 and so they are not normally needed in GTK+ applications.
  16 See the <link linkend="gtk-Drag-and-Drop">Drag and Drop</link> section of
  17 the GTK+ documentation for more information.
  18 </para>
  19
  20 <!-- ##### SECTION See_Also ##### -->
  21 <para>
  22
  23 </para>
  24
  25 <!-- ##### SECTION Stability_Level ##### -->
  26
  27
  28 <!-- ##### SECTION Image ##### -->
  29
  30
  31 <!-- ##### FUNCTION gdk_drag_get_selection ##### -->
  32 <para>
  33 </para>
  34
  35 @context:
  36 @Returns:
  37
  38
  39 <!-- ##### FUNCTION gdk_drag_abort ##### -->
  40 <para>
  41 </para>
  42
  43 @context:
  44 @time_:
  45
  46
  47 <!-- ##### FUNCTION gdk_drop_reply ##### -->
  48 <para>
  49 </para>
  50
  51 @context:
  52 @ok:
  53 @time_:
  54
  55
  56 <!-- ##### FUNCTION gdk_drag_context_new ##### -->
  57 <para>
  58 </para>
  59
  60 @void:
  61 @Returns:
  62
  63
  64 <!-- ##### FUNCTION gdk_drag_drop ##### -->
  65 <para>
  66 </para>
  67
  68 @context:
  69 @time_:
  70
  71
  72 <!-- ##### FUNCTION gdk_drag_find_window ##### -->
  73 <para>
  74 </para>
  75
  76 @context:
  77 @drag_window:
  78 @x_root:
  79 @y_root:
  80 @dest_window:
  81 @protocol:
  82
  83
  84 <!-- ##### FUNCTION gdk_drag_find_window_for_screen ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @context:
  90 @drag_window:
  91 @screen:
  92 @x_root:
  93 @y_root:
  94 @dest_window:
  95 @protocol:
  96
  97
  98 <!-- ##### FUNCTION gdk_drag_begin ##### -->
  99 <para>
 100 </para>
 101
 102 @window:
 103 @targets:
 104 @Returns:
 105
 106
 107 <!-- ##### FUNCTION gdk_drag_motion ##### -->
 108 <para>
 109 </para>
 110
 111 @context:
 112 @dest_window:
 113 @protocol:
 114 @x_root:
 115 @y_root:
 116 @suggested_action:
 117 @possible_actions:
 118 @time_:
 119 @Returns:
 120
 121
 122 <!-- ##### FUNCTION gdk_drop_finish ##### -->
 123 <para>
 124 </para>
 125
 126 @context:
 127 @success:
 128 @time_:
 129
 130
 131 <!-- ##### FUNCTION gdk_drag_get_protocol ##### -->
 132 <para>
 133 </para>
 134
 135 @xid:
 136 @protocol:
 137 @Returns:
 138
 139
 140 <!-- ##### FUNCTION gdk_drag_get_protocol_for_display ##### -->
 141 <para>
 142
 143 </para>
 144
 145 @display:
 146 @xid:
 147 @protocol:
 148 @Returns:
 149
 150
 151 <!-- ##### ENUM GdkDragProtocol ##### -->
 152 <para>
 153 Used in #GdkDragContext to indicate the protocol according to
 154 which DND is done.
 155 </para>
 156
 157 @GDK_DRAG_PROTO_MOTIF: The Motif DND protocol.
 158 @GDK_DRAG_PROTO_XDND: The Xdnd protocol.
 159 @GDK_DRAG_PROTO_ROOTWIN: An extension to the Xdnd protocol for
 160   unclaimed root window drops.
 161 @GDK_DRAG_PROTO_NONE: no protocol.
 162 @GDK_DRAG_PROTO_WIN32_DROPFILES: The simple WM_DROPFILES protocol.
 163 @GDK_DRAG_PROTO_OLE2: The complex OLE2 DND protocol (not implemented).
 164 @GDK_DRAG_PROTO_LOCAL: Intra-application DND.
 165
 166 <!-- ##### STRUCT GdkDragContext ##### -->
 167 <para>
 168 A <structname>GdkDragContext</structname> holds information about a
 169 drag in progress. It is used on both source and destination sides.
 170 </para>
 171
 172 @parent_instance: the parent instance
 173 @protocol: the DND protocol which governs this drag.
 174 @is_source: %TRUE if the context is used on the source side.
 175 @source_window: the source of this drag.
 176 @dest_window: the destination window of this drag.
 177 @targets: a list of targets offered by the source.
 178 @actions: a bitmask of actions proposed by the source when
 179    @suggested_action is %GDK_ACTION_ASK.
 180 @suggested_action: the action suggested by the source.
 181 @action: the action chosen by the destination.
 182 @start_time: a timestamp recording the start time of this drag.
 183
 184 <!-- ##### ENUM GdkDragAction ##### -->
 185 <para>
 186 Used in #GdkDragContext to indicate what the destination
 187 should do with the dropped data.
 188 </para>
 189
 190 @GDK_ACTION_DEFAULT: Means nothing, and should not be used.
 191 @GDK_ACTION_COPY: Copy the data.
 192 @GDK_ACTION_MOVE: Move the data, i.e. first copy it, then delete
 193   it from the source using the DELETE target of the X selection protocol.
 194 @GDK_ACTION_LINK: Add a link to the data. Note that this is only
 195   useful if source and destination agree on what it means.
 196 @GDK_ACTION_PRIVATE: Special action which tells the source that the
 197   destination will do something that the source doesn't understand.
 198 @GDK_ACTION_ASK: Ask the user what to do with the data.
 199
 200 <!-- ##### FUNCTION gdk_drag_status ##### -->
 201 <para>
 202 </para>
 203
 204 @context:
 205 @action:
 206 @time_:
 207
 208
 209 <!-- ##### FUNCTION gdk_drag_drop_succeeded ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @context:
 215 @Returns:
 216
 217