docs: Small clarifications to DND docs
authorMatthias Clasen <mclasen@redhat.com>
Sat, 4 Jan 2020 17:06:36 +0000 (12:06 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Sat, 4 Jan 2020 17:48:39 +0000 (12:48 -0500)
Clear up the documentation around ASK handling
a bit.

gdk/gdkdrop.c
gdk/gdktypes.h

index ae606cb73ccd2a44e849e560ab5ef2005aedae7e..eb04ca26ad70d01d863a8c5b07d171c303e00909 100644 (file)
@@ -448,7 +448,10 @@ gdk_drop_get_surface (GdkDrop *self)
  * Returns the possible actions for this #GdkDrop. If this value
  * contains multiple actions - ie gdk_drag_action_is_unique()
  * returns %FALSE for the result - gdk_drag_finish() must choose
- * the action to use when accepting the drop.
+ * the action to use when accepting the drop. This will only
+ * happen if you passed %GDK_ACTION_ASK as one of the possible
+ * actions in gdk_drag_status(). %GDK_ACTION_ASK itself will not
+ * be included in the actions returned by this function.
  *
  * This value may change over the lifetime of the #GdkDrop both
  * as a response to source side actions as well as to calls to
index faa842ae85f04d97dcb0fb9f5a4372152ec89ad2..c5e237fffc0cf2990782154a79bcc9ca6786e977 100644 (file)
@@ -568,11 +568,12 @@ typedef enum
  * @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.
+ *  useful if source and destination agree on what it means, and is not
+ *  supported on all platforms.
  * @GDK_ACTION_ASK: Ask the user what to do with the data.
  *
- * Used in #GdkDrag to indicate what the destination
- * should do with the dropped data.
+ * Used in #GdkDrop and #GdkDrag to indicate the actions that the
+ * destination can and should do with the dropped data.
  */
 typedef enum
 {