[gtk+/wip/carlosg/event-delivery: 68/72] gtkmain: Add API to get the target of a GdkEvent

[Timm Bäder <baedert src gnome org>]

commit 21f216588f37fddd2c4d375f6ac5e32e52a53b92
Author: Carlos Garnacho <carlosg gnome org>
Date:   Thu May 4 13:49:34 2017 +0200

    gtkmain: Add API to get the target of a GdkEvent
    
    This can be used on grabbing situations to determine the target of
    the event. This mainly matters for GtkMenu.

 gtk/gtkmain.c |   47 +++++++++++++++++++++++++++++++++++++++++++++++
 gtk/gtkmain.h |    7 +++++++
 2 files changed, 54 insertions(+), 0 deletions(-)
---
diff --git a/gtk/gtkmain.c b/gtk/gtkmain.c
index 5a19d4c..846b45d 100644
--- a/gtk/gtkmain.c
+++ b/gtk/gtkmain.c
@@ -1334,6 +1334,7 @@ synth_crossing_for_motion (GtkWidget     *widget,
   gdouble x, y;
 
   event = gdk_event_new (enter ? GDK_ENTER_NOTIFY : GDK_LEAVE_NOTIFY);
+  gdk_event_set_user_data (event, G_OBJECT (widget));
   gdk_event_set_device (event, gdk_event_get_device (source));
   gdk_event_set_source_device (event, gdk_event_get_source_device (source));
 
@@ -1677,6 +1678,8 @@ gtk_main_do_event (GdkEvent *event)
   if (check_event_in_child_popover (event_widget, grab_widget))
     grab_widget = event_widget;
 
+  gdk_event_set_user_data (event, G_OBJECT (event_widget));
+
   /* If the widget receiving events is actually blocked by another
    * device GTK+ grab
    */
@@ -2360,6 +2363,50 @@ gtk_get_event_widget (GdkEvent *event)
   return widget;
 }
 
+/**
+ * gtk_get_event_target:
+ * @event: a #GdkEvent
+ *
+ * If @event is %NULL or the event was not associated with any widget,
+ * returns %NULL, otherwise returns the widget that is the deepmost
+ * receiver of the event.
+ *
+ * Returns: (transfer none) (nullable): the target widget, or %NULL
+ *
+ * Since: 3.90
+ */
+GtkWidget *
+gtk_get_event_target (GdkEvent *event)
+{
+  return GTK_WIDGET (gdk_event_get_user_data (event));
+}
+
+/**
+ * gtk_get_event_target_with_type:
+ * @event: a #GdkEvent
+ *
+ * If @event is %NULL or the event was not associated with any widget,
+ * returns %NULL, otherwise returns first widget found from the event
+ * target to the toplevel that matches @type.
+ *
+ * Returns: (transfer none) (nullable): the widget in the target stack
+ * with the given type, or %NULL
+ *
+ * Since: 3.90
+ */
+GtkWidget *
+gtk_get_event_target_with_type (GdkEvent *event,
+                                GType     type)
+{
+  GtkWidget *target;
+
+  target = gtk_get_event_target (event);
+  while (target && !g_type_is_a (G_OBJECT_TYPE (target), type))
+    target = gtk_widget_get_parent (target);
+
+  return target;
+}
+
 static gboolean
 propagate_event_up (GtkWidget *widget,
                     GdkEvent  *event,
diff --git a/gtk/gtkmain.h b/gtk/gtkmain.h
index 49e19c9..47681be 100644
--- a/gtk/gtkmain.h
+++ b/gtk/gtkmain.h
@@ -151,6 +151,13 @@ GdkDevice *gtk_get_current_event_device (void);
 GDK_AVAILABLE_IN_ALL
 GtkWidget *gtk_get_event_widget         (GdkEvent        *event);
 
+GDK_AVAILABLE_IN_3_90
+GtkWidget *gtk_get_event_target         (GdkEvent        *event);
+
+GDK_AVAILABLE_IN_3_90
+GtkWidget *gtk_get_event_target_with_type (GdkEvent *event,
+                                           GType     type);
+
 GDK_AVAILABLE_IN_ALL
 void       gtk_propagate_event          (GtkWidget       *widget,
                                          GdkEvent        *event);