]> Pileus Git - ~andy/gtk/blobdiff - docs/reference/gtk/tmpl/gtkdnd.sgml
2.9.0
[~andy/gtk] / docs / reference / gtk / tmpl / gtkdnd.sgml
index 5d860b9fe719e7f3da0f9ceca318845298020ad6..91aa05f8ced2d04c9cdff2d63d4999f52365787b 100644 (file)
@@ -2,7 +2,7 @@
 Drag and Drop
 
 <!-- ##### SECTION Short_Description ##### -->
-Functions for controlling drag and drop handling.
+Functions for controlling drag and drop handling
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
@@ -24,90 +24,51 @@ in the #GtkWidget class.
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
 <!-- ##### ENUM GtkDestDefaults ##### -->
 <para>
-The #GtkDestfaults enumeration specifies the various
+The #GtkDestDefaults enumeration specifies the various
 types of action that will be taken on behalf
 of the user for a drag destination site.
 </para>
-<informaltable pgwide=1 frame="none" role="enum">
-<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
-<tbody>
 
-<row>
-<entry><symbol>GTK_DEST_DEFAULT_MOTION</symbol></entry>
-<entry>
+@GTK_DEST_DEFAULT_MOTION: 
    If set for a widget, GTK+, during a drag over this
    widget will check if the drag matches this widget's
    list of possible targets and actions.
-   GTK+ will then call gtk_drag_status() as appropriate.
-</entry>
-</row>
-
-<row>
-<entry><symbol>GTK_DEST_DEFAULT_HIGHLIGHT</symbol></entry>
-<entry>
+   GTK+ will then call gdk_drag_status() as appropriate.
+@GTK_DEST_DEFAULT_HIGHLIGHT: 
    If set for a widget, GTK+ will draw a highlight on
    this widget as long as a drag is over this widget
-   and the widget drag format and action are acceptable.</entry>
-</row>
-
-<row>
-<entry><symbol>GTK_DEST_DEFAULT_DROP</symbol></entry>
-<entry>
+   and the widget drag format and action are acceptable.
+@GTK_DEST_DEFAULT_DROP: 
    If set for a widget, when a drop occurs, GTK+ will
    will check if the drag matches this widget's
    list of possible targets and actions. If so, 
-   GTK+ will call gtk_drag_data_get() on behalf 
+   GTK+ will call gtk_drag_get_data() on behalf 
    of the widget. Whether or not the drop is successful,
    GTK+ will call gtk_drag_finish(). If the action
    was a move, then if the drag was successful, then
    %TRUE will be passed for the @delete parameter
    to gtk_drag_finish().
-</entry>
-</row>
-
-<row>
-<entry><symbol>GTK_DEST_DEFAULT_ALL</symbol></entry>
-<entry>
+@GTK_DEST_DEFAULT_ALL: 
    If set, specifies that all default actions should
    be taken.
-</entry>
-</row>
-
-</tbody></tgroup></informaltable>
-
-@GTK_DEST_DEFAULT_MOTION: 
-@GTK_DEST_DEFAULT_HIGHLIGHT: 
-@GTK_DEST_DEFAULT_DROP: 
-@GTK_DEST_DEFAULT_ALL: 
 
 <!-- ##### ENUM GtkTargetFlags ##### -->
 <para>
 The #GtkTargetFlags enumeration is used to specify
 constraints on an entry in a #GtkTargetTable. 
 </para>
-<variablelist>
- <varlistentry><term> %GTK_TARGET_SAME_APP </term>
- <listitem>
-   <para>
+
+@GTK_TARGET_SAME_APP: 
    If this is set, the target will only be selected
    for drags within a single application.
-   </para>
- </listitem>
- </varlistentry>
- <varlistentry><term> %GTK_TARGET_SAME_WIDGET </term>
- <listitem>
-   <para>
+@GTK_TARGET_SAME_WIDGET: 
    If this is set, the target will only be selected
    for drags within a single widget.
-   </para>
- </listitem>
- </varlistentry>
-</variablelist>
-
-@GTK_TARGET_SAME_APP: 
-@GTK_TARGET_SAME_WIDGET: 
 
 <!-- ##### FUNCTION gtk_drag_dest_set ##### -->
 <para>
@@ -119,7 +80,7 @@ Sets a widget as a potential drop destination.
  on behalf of a widget for drops onto that widget. The @targets
  and @actions fields only are used if %GTK_DEST_DEFAULT_MOTION
  or %GTK_DEST_DEFAULT_DROP are given.
-@targets: a pointer to an array of #GtkTargetEntry indicating
+@targets: a pointer to an array of #GtkTargetEntry<!-- -->s indicating
  the drop types that this widget will accept.
 @n_targets: the number of entries in @targets.
 @actions: a bitmask of possible actions for a drop onto this
@@ -135,7 +96,7 @@ Sets this widget as a proxy for drops to another window.
 @proxy_window: the window to which to forward drag events
 @protocol: the drag protocol which the @proxy_window accepts
            (You can use gdk_drag_get_protocol() to determine this)
-@use_coordinates: If true, send the same coordinates to the
+@use_coordinates: If %TRUE, send the same coordinates to the
                   destination, because it is an embedded 
                   subwindow.
 
@@ -179,6 +140,48 @@ notification of drags.
 @target_list: 
 
 
+<!-- ##### FUNCTION gtk_drag_dest_add_text_targets ##### -->
+<para>
+
+</para>
+
+@widget: 
+
+
+<!-- ##### FUNCTION gtk_drag_dest_add_image_targets ##### -->
+<para>
+
+</para>
+
+@widget: 
+
+
+<!-- ##### FUNCTION gtk_drag_dest_add_uri_targets ##### -->
+<para>
+
+</para>
+
+@widget: 
+
+
+<!-- ##### FUNCTION gtk_drag_dest_set_track_motion ##### -->
+<para>
+
+</para>
+
+@widget: 
+@track_motion: 
+
+
+<!-- ##### FUNCTION gtk_drag_dest_get_track_motion ##### -->
+<para>
+
+</para>
+
+@widget: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_drag_finish ##### -->
 <para>
 Informs the drag source that the drop is finished, and
@@ -189,17 +192,17 @@ that the data of the drag will no longer be required.
 @success: a flag indicating whether the drop was successful
 @del: a flag indicating whether the source should delete the
       original data. (This should be %TRUE for a move)
-@time: the timestamp from the "drag_data_drop" signal.
+@time_: the timestamp from the "drag_data_drop" signal.
 
 
 <!-- ##### FUNCTION gtk_drag_get_data ##### -->
 <para>
-Get the data associated with a drag. When the data
+Gets the data associated with a drag. When the data
 is received or the retrieval fails, GTK+ will emit a 
 "drag_data_received" signal. Failure of the retrieval
 is indicated by the length field of the @selection_data
 signal parameter being negative. However, when gtk_drag_get_data() 
-is called implicitely because the %GTK_DRAG_DEFAULT_DROP was set, 
+is called implicitely because the %GTK_DEST_DEFAULT_DROP was set, 
 then the widget will not receive notification of failed
 drops.
 </para>
@@ -208,7 +211,7 @@ drops.
  signal.
 @context: the drag context
 @target: the target (form of the data) to retrieve.
-@time: a timestamp for retrieving the data. This will
+@time_: a timestamp for retrieving the data. This will
        generally be the time received in a "drag_data_motion"
        or "drag_data_drop" signal.
 
@@ -245,21 +248,15 @@ a widget.
 
 <!-- ##### FUNCTION gtk_drag_begin ##### -->
 <para>
-Initiates a drag on the source side. The function
-only needs to be used when the application is
-starting drags itself, and is not needed when
-gtk_drag_source_set() is used.
+
 </para>
 
-@widget: the source widget.
-@targets: The targets (data formats) in which the
- source can provide the data.
-@actions: A bitmask of the allowed drag actions for this
-          drag.
-@button: The button the user clicked to start the drag.
-@event: The event that triggered the start of the
-        drag. 
-@Returns: The context for this drag.
+@widget: 
+@targets: 
+@actions: 
+@button: 
+@event: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gtk_drag_set_icon_widget ##### -->
@@ -306,6 +303,17 @@ gtk_drag_source_set() is used.
 @hot_y: 
 
 
+<!-- ##### FUNCTION gtk_drag_set_icon_name ##### -->
+<para>
+
+</para>
+
+@context: 
+@icon_name: 
+@hot_x: 
+@hot_y: 
+
+
 <!-- ##### FUNCTION gtk_drag_set_icon_default ##### -->
 <para>
 </para>
@@ -381,6 +389,15 @@ widget. The widget must have a window.
 @stock_id: 
 
 
+<!-- ##### FUNCTION gtk_drag_source_set_icon_name ##### -->
+<para>
+
+</para>
+
+@widget: 
+@icon_name: 
+
+
 <!-- ##### FUNCTION gtk_drag_source_unset ##### -->
 <para>
 Undoes the effects of gtk_drag_source_set().
@@ -389,3 +406,45 @@ Undoes the effects of gtk_drag_source_set().
 @widget: a #GtkWidget
 
 
+<!-- ##### FUNCTION gtk_drag_source_set_target_list ##### -->
+<para>
+
+</para>
+
+@widget: 
+@target_list: 
+
+
+<!-- ##### FUNCTION gtk_drag_source_get_target_list ##### -->
+<para>
+
+</para>
+
+@widget: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_drag_source_add_text_targets ##### -->
+<para>
+
+</para>
+
+@widget: 
+
+
+<!-- ##### FUNCTION gtk_drag_source_add_image_targets ##### -->
+<para>
+
+</para>
+
+@widget: 
+
+
+<!-- ##### FUNCTION gtk_drag_source_add_uri_targets ##### -->
+<para>
+
+</para>
+
+@widget: 
+
+