inspector: Use some of the new GtkSearchEntry API

Avoid repetitive, manual event handling in various places
in GtkInspector.

gtk/gtksearchentry.c

@@ -31,6 +31,7 @@
 #include "gtksearchentry.h"
 #include "gtkmarshalers.h"
 #include "gtkintl.h"
+#include "gtkbindings.h"
 
 /**
  * SECTION:gtksearchentry
@@ -60,6 +61,9 @@
 
 enum {
   SEARCH_CHANGED,
+  NEXT_MATCH,
+  PREVIOUS_MATCH,
+  STOP_SEARCH,
   LAST_SIGNAL
 };
 
@@ -67,6 +71,8 @@ static guint signals[LAST_SIGNAL] = { 0 };
 
 typedef struct {
   guint delayed_changed_id;
+  gboolean content_changed;
+  gboolean search_stopped;
 } GtkSearchEntryPrivate;
 
 static void gtk_search_entry_icon_release  (GtkEntry             *entry,
@@ -88,6 +94,28 @@ G_DEFINE_TYPE_WITH_CODE (GtkSearchEntry, gtk_search_entry, GTK_TYPE_ENTRY,
  * that we cannot now have one without breaking ABI */
 #define GET_PRIV(e) ((GtkSearchEntryPrivate *) gtk_search_entry_get_instance_private ((GtkSearchEntry *) (e)))
 
+static void
+gtk_search_entry_preedit_changed (GtkEntry    *entry,
+                                  const gchar *preedit)
+{
+  GtkSearchEntryPrivate *priv = GET_PRIV (entry);
+
+  priv->content_changed = TRUE;
+}
+
+static void
+gtk_search_entry_notify (GObject    *object,
+                         GParamSpec *pspec)
+{
+  GtkSearchEntryPrivate *priv = GET_PRIV (object);
+
+  if (strcmp (pspec->name, "text") == 0)
+    priv->content_changed = TRUE;
+
+  if (G_OBJECT_CLASS (gtk_search_entry_parent_class)->notify)
+    G_OBJECT_CLASS (gtk_search_entry_parent_class)->notify (object, pspec);
+}
+
 static void
 gtk_search_entry_finalize (GObject *object)
 {
@@ -99,17 +127,33 @@ gtk_search_entry_finalize (GObject *object)
   G_OBJECT_CLASS (gtk_search_entry_parent_class)->finalize (object);
 }
 
+static void
+gtk_search_entry_stop_search (GtkSearchEntry *entry)
+{
+  GtkSearchEntryPrivate *priv = GET_PRIV (entry);
+
+  priv->search_stopped = TRUE;
+}
+
 static void
 gtk_search_entry_class_init (GtkSearchEntryClass *klass)
 {
   GObjectClass *object_class = G_OBJECT_CLASS (klass);
+  GtkBindingSet *binding_set;
 
   object_class->finalize = gtk_search_entry_finalize;
+  object_class->notify = gtk_search_entry_notify;
+
+  klass->stop_search = gtk_search_entry_stop_search;
 
   g_signal_override_class_handler ("icon-release",
                                    GTK_TYPE_SEARCH_ENTRY,
                                    G_CALLBACK (gtk_search_entry_icon_release));
 
+  g_signal_override_class_handler ("preedit-changed",
+                                   GTK_TYPE_SEARCH_ENTRY,
+                                   G_CALLBACK (gtk_search_entry_preedit_changed));
+
   /**
    * GtkSearchEntry::search-changed:
    * @entry: the entry on which the signal was emitted
@@ -127,6 +171,86 @@ gtk_search_entry_class_init (GtkSearchEntryClass *klass)
                   NULL, NULL,
                   _gtk_marshal_VOID__VOID,
                   G_TYPE_NONE, 0);
+
+  /**
+   * GtkSearchEntry::next-match:
+   * @entry: the entry on which the signal was emitted
+   *
+   * The ::next-match signal is a [keybinding signal][GtkBindingSignal]
+   * which gets emitted when the user initiates a move to the next match
+   * for the current search string.
+   *
+   * Applications should connect to it, to implement moving between
+   * matches.
+   *
+   * The default bindings for this signal is Ctrl-g.
+   *
+   * Since: 3.16
+   */
+  signals[NEXT_MATCH] =
+    g_signal_new (I_("next-match"),
+                  G_OBJECT_CLASS_TYPE (object_class),
+                  G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
+                  G_STRUCT_OFFSET (GtkSearchEntryClass, next_match),
+                  NULL, NULL,
+                  _gtk_marshal_VOID__VOID,
+                  G_TYPE_NONE, 0);
+
+  /**
+   * GtkSearchEntry::previous-match:
+   * @entry: the entry on which the signal was emitted
+   *
+   * The ::previous-match signal is a [keybinding signal][GtkBindingSignal]
+   * which gets emitted when the user initiates a move to the previous match
+   * for the current search string.
+   *
+   * Applications should connect to it, to implement moving between
+   * matches.
+   *
+   * The default bindings for this signal is Ctrl-Shift-g.
+   *
+   * Since: 3.16
+   */
+  signals[PREVIOUS_MATCH] =
+    g_signal_new (I_("previous-match"),
+                  G_OBJECT_CLASS_TYPE (object_class),
+                  G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
+                  G_STRUCT_OFFSET (GtkSearchEntryClass, previous_match),
+                  NULL, NULL,
+                  _gtk_marshal_VOID__VOID,
+                  G_TYPE_NONE, 0);
+
+  /**
+   * GtkSearchEntry::stop-search:
+   * @entry: the entry on which the signal was emitted
+   *
+   * The ::stop-search signal is a [keybinding signal][GtkBindingSignal]
+   * which gets emitted when the user stops a search via keyboard input.
+   *
+   * Applications should connect to it, to implement hiding the search
+   * entry in this case.
+   *
+   * The default bindings for this signal is Escape.
+   *
+   * Since: 3.16
+   */
+  signals[STOP_SEARCH] =
+    g_signal_new (I_("stop-search"),
+                  G_OBJECT_CLASS_TYPE (object_class),
+                  G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
+                  G_STRUCT_OFFSET (GtkSearchEntryClass, stop_search),
+                  NULL, NULL,
+                  _gtk_marshal_VOID__VOID,
+                  G_TYPE_NONE, 0);
+
+  binding_set = gtk_binding_set_by_class (klass);
+
+  gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
+                                "next-match", 0);
+  gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_SHIFT_MASK | GDK_CONTROL_MASK,
+                                "previous-match", 0);
+  gtk_binding_entry_add_signal (binding_set, GDK_KEY_Escape, 0,
+                                "stop-search", 0);
 }
 
 static void
@@ -253,3 +377,75 @@ gtk_search_entry_new (void)
 {
   return GTK_WIDGET (g_object_new (GTK_TYPE_SEARCH_ENTRY, NULL));
 }
+
+static gboolean
+is_keynav_event (GdkEvent *event)
+{
+  GdkModifierType state = 0;
+  guint keyval;
+
+  if (!gdk_event_get_keyval (event, &keyval))
+    return FALSE;
+
+  gdk_event_get_state (event, &state);
+
+  if (keyval == GDK_KEY_Tab       || keyval == GDK_KEY_KP_Tab ||
+      keyval == GDK_KEY_Up        || keyval == GDK_KEY_KP_Up ||
+      keyval == GDK_KEY_Down      || keyval == GDK_KEY_KP_Down ||
+      keyval == GDK_KEY_Left      || keyval == GDK_KEY_KP_Left ||
+      keyval == GDK_KEY_Right     || keyval == GDK_KEY_KP_Right ||
+      keyval == GDK_KEY_Home      || keyval == GDK_KEY_KP_Home ||
+      keyval == GDK_KEY_End       || keyval == GDK_KEY_KP_End ||
+      keyval == GDK_KEY_Page_Up   || keyval == GDK_KEY_KP_Page_Up ||
+      keyval == GDK_KEY_Page_Down || keyval == GDK_KEY_KP_Page_Down ||
+      ((state & (GDK_CONTROL_MASK | GDK_MOD1_MASK)) != 0))
+        return TRUE;
+
+  /* Other navigation events should get automatically
+   * ignored as they will not change the content of the entry
+   */
+  return FALSE;
+}
+
+/**
+ * gtk_search_entry_handle_event:
+ * @entry: a #GtkSearchEntry
+ * @event: a key event
+ *
+ * This function should be called when the top-level
+ * window which contains the search entry received a
+ * key event.
+ *
+ * If the key event is handled by the search bar and starts
+ * or continues a search, %GDK_EVENT_STOP will be returned.
+ * The caller should ensure that the entry is shown in
+ * this case, and not propagate the event further.
+ *
+ * Returns: %GDK_EVENT_STOP if the key press event resulted
+ *     in a search beginning or continuing, %GDK_EVENT_PROPAGATE
+ *     otherwise.
+ *
+ * Since: 3.16
+ */
+gboolean
+gtk_search_entry_handle_event (GtkSearchEntry *entry,
+                               GdkEvent       *event)
+{
+  GtkSearchEntryPrivate *priv = GET_PRIV (entry);
+  gboolean handled;
+
+  if (!gtk_widget_get_realized (GTK_WIDGET (entry)))
+    gtk_widget_realize (GTK_WIDGET (entry));
+
+  if (is_keynav_event (event) ||
+      event->key.keyval == GDK_KEY_space ||
+      event->key.keyval == GDK_KEY_Menu)
+    return GDK_EVENT_PROPAGATE;
+
+  priv->content_changed = FALSE;
+  priv->search_stopped = FALSE;
+
+  handled = gtk_widget_event (GTK_WIDGET (entry), event);
+
+  return handled && priv->content_changed && !priv->search_stopped ? GDK_EVENT_STOP : GDK_EVENT_PROPAGATE;
+}

gtk/gtksearchentry.h

@@ -56,11 +56,9 @@ struct _GtkSearchEntryClass
   GtkEntryClass parent_class;
 
   void (*search_changed) (GtkSearchEntry *entry);
-
-  /* Padding for future expansion */
-  void (*_gtk_reserved1) (void);
-  void (*_gtk_reserved2) (void);
-  void (*_gtk_reserved3) (void);
+  void (*next_match)     (GtkSearchEntry *entry);
+  void (*previous_match) (GtkSearchEntry *entry);
+  void (*stop_search)    (GtkSearchEntry *entry);
 };
 
 GDK_AVAILABLE_IN_3_6
@@ -69,6 +67,10 @@ GType           gtk_search_entry_get_type       (void) G_GNUC_CONST;
 GDK_AVAILABLE_IN_3_6
 GtkWidget*      gtk_search_entry_new            (void);
 
+GDK_AVAILABLE_IN_3_16
+gboolean        gtk_search_entry_handle_event   (GtkSearchEntry *entry,
+                                                 GdkEvent       *event);
+
 G_END_DECLS
 
 #endif /* __GTK_SEARCH_ENTRY_H__ */

gtk/inspector/object-tree.c

@@ -407,6 +407,14 @@ previous_match (GtkButton              *button,
     }
 }
 
+static void
+stop_search (GtkWidget              *entry,
+             GtkInspectorObjectTree *wt)
+{
+  gtk_entry_set_text (GTK_ENTRY (wt->priv->search_entry), "");
+  gtk_search_bar_set_search_mode (GTK_SEARCH_BAR (wt->priv->search_bar), FALSE);
+}
+
 static void
 gtk_inspector_object_tree_init (GtkInspectorObjectTree *wt)
 {
@@ -492,6 +500,7 @@ gtk_inspector_object_tree_class_init (GtkInspectorObjectTreeClass *klass)
   gtk_widget_class_bind_template_callback (widget_class, on_search_changed);
   gtk_widget_class_bind_template_callback (widget_class, next_match);
   gtk_widget_class_bind_template_callback (widget_class, previous_match);
+  gtk_widget_class_bind_template_callback (widget_class, stop_search);
 }
 
 typedef struct

gtk/inspector/object-tree.ui

@@ -30,6 +30,9 @@
                 <property name="visible">True</property>
                 <property name="max-width-chars">40</property>
                 <signal name="search-changed" handler="on_search_changed"/>
+                <signal name="next-match" handler="next_match"/>
+                <signal name="previous-match" handler="previous_match"/>
+                <signal name="stop-search" handler="stop_search"/>
               </object>
             </child>
             <child>

gtk/inspector/prop-list.c

@@ -80,117 +80,20 @@ search_close_clicked (GtkWidget            *button,
   gtk_stack_set_visible_child_name (GTK_STACK (pl->priv->search_stack), "title");
 }
 
-static gboolean
-is_keynav_event (GdkEvent *event)
-{
-  GdkModifierType state = 0;
-  guint keyval;
-
-  if (!gdk_event_get_keyval (event, &keyval))
-    return FALSE;
-
-  gdk_event_get_state (event, &state);
-
-  if (keyval == GDK_KEY_Tab       || keyval == GDK_KEY_KP_Tab ||
-      keyval == GDK_KEY_Up        || keyval == GDK_KEY_KP_Up ||
-      keyval == GDK_KEY_Down      || keyval == GDK_KEY_KP_Down ||
-      keyval == GDK_KEY_Left      || keyval == GDK_KEY_KP_Left ||
-      keyval == GDK_KEY_Right     || keyval == GDK_KEY_KP_Right ||
-      keyval == GDK_KEY_Home      || keyval == GDK_KEY_KP_Home ||
-      keyval == GDK_KEY_End       || keyval == GDK_KEY_KP_End ||
-      keyval == GDK_KEY_Page_Up   || keyval == GDK_KEY_KP_Page_Up ||
-      keyval == GDK_KEY_Page_Down || keyval == GDK_KEY_KP_Page_Down ||
-      ((state & (GDK_CONTROL_MASK | GDK_MOD1_MASK)) != 0))
-        return TRUE;
-
-  /* Other navigation events should get automatically
-   * ignored as they will not change the content of the entry
-   */
-  return FALSE;
-}
-
-static void
-preedit_changed_cb (GtkEntry  *entry,
-                    GtkWidget *popup,
-                    gboolean  *preedit_changed)
-{
-  *preedit_changed = TRUE;
-}
-
 static gboolean
 key_press_event (GtkWidget            *window,
                  GdkEvent             *event,
                  GtkInspectorPropList *pl)
 {
-  gboolean handled;
-  gboolean preedit_changed;
-  guint preedit_change_id;
-  gboolean res;
-  gchar *old_text, *new_text;
-
   if (!gtk_widget_get_mapped (GTK_WIDGET (pl)))
     return GDK_EVENT_PROPAGATE;
 
-  if (is_keynav_event (event) ||
-      event->key.keyval == GDK_KEY_space ||
-      event->key.keyval == GDK_KEY_Menu)
-    return GDK_EVENT_PROPAGATE;
- 
-  if (event->key.keyval == GDK_KEY_Return ||
-      event->key.keyval == GDK_KEY_ISO_Enter ||
-      event->key.keyval == GDK_KEY_KP_Enter)
-    {
-      GtkTreeSelection *selection;
-      GtkTreeModel *model;
-      GtkTreeIter iter;
-      GtkTreePath *path;
-
-      selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (pl->priv->tree));
-      if (gtk_tree_selection_get_selected (selection, &model, &iter))
-        {
-          path = gtk_tree_model_get_path (model, &iter);
-          gtk_tree_view_row_activated (GTK_TREE_VIEW (pl->priv->tree),
-                                       path,
-                                       pl->priv->name_column);
-          gtk_tree_path_free (path);
-
-          return GDK_EVENT_STOP;
-        }
-      else
-        return GDK_EVENT_PROPAGATE;
-    }
-
-  if (event->key.keyval == GDK_KEY_Escape)
-    {
-      gtk_entry_set_text (GTK_ENTRY (pl->priv->search_entry), "");
-      gtk_stack_set_visible_child_name (GTK_STACK (pl->priv->search_stack), "title");
-      return GDK_EVENT_STOP;
-    }
-
-  if (!gtk_widget_get_realized (pl->priv->search_entry))
-    gtk_widget_realize (pl->priv->search_entry);
-
-  handled = FALSE;
-  preedit_changed = FALSE;
-  preedit_change_id = g_signal_connect (pl->priv->search_entry, "preedit-changed",
-                                        G_CALLBACK (preedit_changed_cb), &preedit_changed);
-
-  old_text = g_strdup (gtk_entry_get_text (GTK_ENTRY (pl->priv->search_entry)));
-  res = gtk_widget_event (pl->priv->search_entry, event);
-  new_text = g_strdup (gtk_entry_get_text (GTK_ENTRY (pl->priv->search_entry)));
-
-  g_signal_handler_disconnect (pl->priv->search_entry, preedit_change_id);
-
-  if ((res && g_strcmp0 (new_text, old_text) != 0) || preedit_changed)
+  if (gtk_search_entry_handle_event (GTK_SEARCH_ENTRY (pl->priv->search_entry), event))
     {
       gtk_stack_set_visible_child_name (GTK_STACK (pl->priv->search_stack), "search");
-      handled = TRUE;
+      return GDK_EVENT_STOP;
     }
-
-  g_free (old_text);
-  g_free (new_text);
-
- return handled ? GDK_EVENT_STOP : GDK_EVENT_PROPAGATE;
+  return GDK_EVENT_PROPAGATE;
 }
 
 static void

gtk/inspector/prop-list.ui

@@ -29,6 +29,7 @@
               <object class="GtkSearchEntry" id="search_entry">
                 <property name="visible">True</property>
                 <property name="max-width-chars">40</property>
+                <signal name="stop-search" handler="search_close_clicked"/>
               </object>
             </child>
             <child>

gtk/inspector/style-prop-list.c

@@ -67,117 +67,20 @@ search_close_clicked (GtkWidget                 *button,
   gtk_stack_set_visible_child_name (GTK_STACK (pl->priv->search_stack), "title");
 }
 
-static gboolean
-is_keynav_event (GdkEvent *event)
-{
-  GdkModifierType state = 0;
-  guint keyval;
-
-  if (!gdk_event_get_keyval (event, &keyval))
-    return FALSE;
-
-  gdk_event_get_state (event, &state);
-
-  if (keyval == GDK_KEY_Tab       || keyval == GDK_KEY_KP_Tab ||
-      keyval == GDK_KEY_Up        || keyval == GDK_KEY_KP_Up ||
-      keyval == GDK_KEY_Down      || keyval == GDK_KEY_KP_Down ||
-      keyval == GDK_KEY_Left      || keyval == GDK_KEY_KP_Left ||
-      keyval == GDK_KEY_Right     || keyval == GDK_KEY_KP_Right ||
-      keyval == GDK_KEY_Home      || keyval == GDK_KEY_KP_Home ||
-      keyval == GDK_KEY_End       || keyval == GDK_KEY_KP_End ||
-      keyval == GDK_KEY_Page_Up   || keyval == GDK_KEY_KP_Page_Up ||
-      keyval == GDK_KEY_Page_Down || keyval == GDK_KEY_KP_Page_Down ||
-      ((state & (GDK_CONTROL_MASK | GDK_MOD1_MASK)) != 0))
-        return TRUE;
-
-  /* Other navigation events should get automatically
-   * ignored as they will not change the content of the entry
-   */
-  return FALSE;
-}
-
-static void
-preedit_changed_cb (GtkEntry  *entry,
-                    GtkWidget *popup,
-                    gboolean  *preedit_changed)
-{
-  *preedit_changed = TRUE;
-}
-
 static gboolean
 key_press_event (GtkWidget                 *window,
                  GdkEvent                  *event,
                  GtkInspectorStylePropList *pl)
 {
-  gboolean handled;
-  gboolean preedit_changed;
-  guint preedit_change_id;
-  gboolean res;
-  gchar *old_text, *new_text;
-
   if (!gtk_widget_get_mapped (GTK_WIDGET (pl)))
     return GDK_EVENT_PROPAGATE;
 
-  if (is_keynav_event (event) ||
-      event->key.keyval == GDK_KEY_space ||
-      event->key.keyval == GDK_KEY_Menu)
-    return GDK_EVENT_PROPAGATE;
-
-  if (event->key.keyval == GDK_KEY_Return ||
-      event->key.keyval == GDK_KEY_ISO_Enter ||
-      event->key.keyval == GDK_KEY_KP_Enter)
-    {
-      GtkTreeSelection *selection;
-      GtkTreeModel *model;
-      GtkTreeIter iter;
-      GtkTreePath *path;
-
-      selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (pl->priv->tree));
-      if (gtk_tree_selection_get_selected (selection, &model, &iter))
-        {
-          path = gtk_tree_model_get_path (model, &iter);
-          gtk_tree_view_row_activated (GTK_TREE_VIEW (pl->priv->tree),
-                                       path,
-                                       pl->priv->name_column);
-          gtk_tree_path_free (path);
-
-          return GDK_EVENT_STOP;
-        }
-      else
-        return GDK_EVENT_PROPAGATE;
-    }
-
-  if (event->key.keyval == GDK_KEY_Escape)
-    {
-      gtk_entry_set_text (GTK_ENTRY (pl->priv->search_entry), "");
-      gtk_stack_set_visible_child_name (GTK_STACK (pl->priv->search_stack), "title");
-      return GDK_EVENT_STOP;
-    }
-
-  if (!gtk_widget_get_realized (pl->priv->search_entry))
-    gtk_widget_realize (pl->priv->search_entry);
-
-  handled = FALSE;
-  preedit_changed = FALSE;
-  preedit_change_id = g_signal_connect (pl->priv->search_entry, "preedit-changed",
-                                        G_CALLBACK (preedit_changed_cb), &preedit_changed);
-
-  old_text = g_strdup (gtk_entry_get_text (GTK_ENTRY (pl->priv->search_entry)));
-  res = gtk_widget_event (pl->priv->search_entry, event);
-  new_text = g_strdup (gtk_entry_get_text (GTK_ENTRY (pl->priv->search_entry)));
-
-  g_signal_handler_disconnect (pl->priv->search_entry, preedit_change_id);
-
-  if ((res && g_strcmp0 (new_text, old_text) != 0) || preedit_changed)
+  if (gtk_search_entry_handle_event (GTK_SEARCH_ENTRY (pl->priv->search_entry), event))
     {
       gtk_stack_set_visible_child_name (GTK_STACK (pl->priv->search_stack), "search");
-      handled = TRUE;
+      return GDK_EVENT_STOP;
     }
-
-  g_free (old_text);
-  g_free (new_text);
-
-  return handled ? GDK_EVENT_STOP : GDK_EVENT_PROPAGATE;
+  return GDK_EVENT_PROPAGATE;
 }
 
 static void
@@ -210,8 +113,6 @@ gtk_inspector_style_prop_list_init (GtkInspectorStylePropList *pl)
                                                 NULL,
                                                 (GDestroyNotify) gtk_tree_iter_free);
 
-  g_signal_connect (pl, "hierarchy-changed", G_CALLBACK (hierarchy_changed), NULL);
-
   for (i = 0; i < _gtk_css_style_property_get_n_properties (); i++)
     {
       GtkCssStyleProperty *prop;
@@ -284,6 +185,7 @@ gtk_inspector_style_prop_list_class_init (GtkInspectorStylePropListClass *klass)
   gtk_widget_class_bind_template_child_private (widget_class, GtkInspectorStylePropList, object_title);
   gtk_widget_class_bind_template_child_private (widget_class, GtkInspectorStylePropList, name_column);
   gtk_widget_class_bind_template_callback (widget_class, search_close_clicked);
+  gtk_widget_class_bind_template_callback (widget_class, hierarchy_changed);
 }
 
 static gchar *

gtk/inspector/style-prop-list.ui

@@ -11,6 +11,7 @@
   </object>
   <template class="GtkInspectorStylePropList" parent="GtkBox">
     <property name="orientation">vertical</property>
+    <signal name="hierarchy-changed" handler="hierarchy_changed"/>
     <child>
       <object class="GtkStack" id="search_stack">
         <property name="visible">True</property>
@@ -27,6 +28,7 @@
               <object class="GtkSearchEntry" id="search_entry">
                 <property name="visible">True</property>
                 <property name="max-width-chars">40</property>
+                <signal name="stop-search" handler="search_close_clicked"/>
               </object>
             </child>
             <child>