dragsource: Document prepare
authorMatthias Clasen <mclasen@redhat.com>
Tue, 7 Jan 2020 01:20:45 +0000 (20:20 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Wed, 8 Jan 2020 23:48:22 +0000 (18:48 -0500)
gtk/gtkdragsource.c

index 022043283ff675b9e543d1e9d4c76a1e86556255..9975c5bb07e6a962d984083cbd2e9768fbd9be31 100644 (file)
@@ -306,6 +306,18 @@ gtk_drag_source_class_init (GtkDragSourceClass *class)
 
   g_object_class_install_properties (object_class, NUM_PROPERTIES, properties);
 
+  /**
+   * GtkDragSource::prepare:
+   * @source: the #GtkDragSource
+   * @x: the X coordinate of the drag starting point
+   * @y: the Y coordinate fo the drag starting point
+   *
+   * The ::prepare signal is emitted when a drag is about to be initiated. It can
+   * be used to set up #GtkDragSource:content and #GtkDragSource:actions just in time,
+   * or to start the drag conditionally.
+   *
+   * Returns: %TRUE to start the drag
+   */
   signals[PREPARE] =
       g_signal_new (I_("prepare"),
                     G_TYPE_FROM_CLASS (class),