[gnome-control-center] keyboard: switch to the reset button

[Georges Basile Stavracas Neto <gbsneto src gnome org>]

commit 20f52da5e2158ff507201e8f42360f56c11abc57
Author: Georges Basile Stavracas Neto <georges stavracas gmail com>
Date:   Sun Jan 29 10:12:21 2017 -0200

    keyboard: switch to the reset button
    
    Per the mockups [1], when editing a custom shortcut, there is
    a reset button right after the current shortcut. When there
    is no shortcut set, it shows a "Set Shortcut" button instead.
    The current UI to edit a shortcut, however, diverges from
    the proposed one since we use an "Edit" button instead.
    
    Fix that by swapping the Edit button with a reset button, and
    adapt the code to not depend on the edit button anymore.
    
    [1] 
https://raw.githubusercontent.com/gnome-design-team/gnome-mockups/master/system-settings/keyboard/keyboard-wires.png
    
    https://bugzilla.gnome.org/show_bug.cgi?id=777845

 panels/keyboard/cc-keyboard-shortcut-editor.c |   59 +++++++++++++------------
 panels/keyboard/shortcut-editor.ui            |   18 +++++---
 2 files changed, 42 insertions(+), 35 deletions(-)
---
diff --git a/panels/keyboard/cc-keyboard-shortcut-editor.c b/panels/keyboard/cc-keyboard-shortcut-editor.c
index 315fb63..0540f03 100644
--- a/panels/keyboard/cc-keyboard-shortcut-editor.c
+++ b/panels/keyboard/cc-keyboard-shortcut-editor.c
@@ -33,13 +33,13 @@ struct _CcKeyboardShortcutEditor
   GtkWidget          *command_entry;
   GtkWidget          *custom_shortcut_accel_label;
   GtkWidget          *custom_shortcut_stack;
-  GtkWidget          *edit_button;
   GtkWidget          *headerbar;
   GtkWidget          *name_entry;
   GtkWidget          *new_shortcut_conflict_label;
   GtkWidget          *remove_button;
   GtkWidget          *replace_button;
   GtkWidget          *reset_button;
+  GtkWidget          *reset_custom_button;
   GtkWidget          *set_button;
   GtkWidget          *shortcut_accel_label;
   GtkWidget          *shortcut_conflict_label;
@@ -290,7 +290,7 @@ setup_custom_shortcut (CcKeyboardShortcutEditor *self)
         {
           gtk_stack_set_visible_child_name (GTK_STACK (self->stack), "custom");
           gtk_stack_set_visible_child_name (GTK_STACK (self->custom_shortcut_stack), "label");
-          gtk_widget_show (self->edit_button);
+          gtk_widget_show (self->reset_custom_button);
         }
 
       valid = accel_valid &&
@@ -327,12 +327,6 @@ setup_custom_shortcut (CcKeyboardShortcutEditor *self)
   /* Setup the accelerator label */
   gtk_shortcut_label_set_accelerator (shortcut_label, accel);
 
-  /*
-   * When the user finishes typing the new shortcut, it gets immediately
-   * applied and the toggle button gets inactive.
-   */
-  gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (self->edit_button), FALSE);
-
   self->edited = TRUE;
 
   release_grab (self);
@@ -389,8 +383,6 @@ setup_custom_shortcut (CcKeyboardShortcutEditor *self)
   set_header_mode (self, mode);
 
   self->collision_item = collision_item;
-
-  g_free (accel);
 }
 
 static void
@@ -425,12 +417,6 @@ cancel_button_clicked_cb (GtkWidget                *button,
 static void
 change_custom_shortcut_button_clicked_cb (CcKeyboardShortcutEditor *self)
 {
-  /*
-   * Setting the edit button to active performs a grab and let the
-   * shortcut editor dialog know we're actually editing a shortcut.
-   */
-  gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (self->edit_button), TRUE);
-
   gtk_stack_set_visible_child_name (GTK_STACK (self->stack), "change-shortcut");
   set_header_mode (self, HEADER_MODE_NONE);
 }
@@ -475,6 +461,16 @@ replace_button_clicked_cb (CcKeyboardShortcutEditor *self)
 }
 
 static void
+reset_custom_clicked_cb (CcKeyboardShortcutEditor *self)
+{
+  if (self->item)
+    cc_keyboard_manager_reset_shortcut (self->manager, self->item);
+
+  gtk_stack_set_visible_child_name (GTK_STACK (self->custom_shortcut_stack), "button");
+  gtk_widget_hide (self->reset_custom_button);
+}
+
+static void
 reset_item_clicked_cb (CcKeyboardShortcutEditor *self)
 {
   gchar *accel;
@@ -538,6 +534,8 @@ setup_keyboard_item (CcKeyboardShortcutEditor *self,
   /* Setup the custom entries */
   if (is_custom)
     {
+      gboolean is_accel_empty;
+
       g_signal_handlers_block_by_func (self->command_entry, command_entry_changed_cb, self);
       g_signal_handlers_block_by_func (self->name_entry, name_entry_changed_cb, self);
 
@@ -549,11 +547,14 @@ setup_keyboard_item (CcKeyboardShortcutEditor *self,
       gtk_entry_set_text (GTK_ENTRY (self->command_entry), item->command);
       gtk_widget_set_sensitive (self->command_entry, item->cmd_editable);
 
-      /* Untoggle the edit button */
-      gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (self->edit_button), FALSE);
+      /* If there is no accelerator set for this custom shortcut, show the "Set Shortcut" button. */
+      is_accel_empty = !accel || accel[0] == '\0';
 
+      gtk_stack_set_visible_child_name (GTK_STACK (self->custom_shortcut_stack),
+                                        is_accel_empty ? "button" : "label");
+
+      gtk_widget_set_visible (self->reset_custom_button, !is_accel_empty);
       gtk_widget_show (self->remove_button);
-      gtk_widget_show (self->edit_button);
 
       g_signal_handlers_unblock_by_func (self->command_entry, command_entry_changed_cb, self);
       g_signal_handlers_unblock_by_func (self->name_entry, name_entry_changed_cb, self);
@@ -634,14 +635,18 @@ cc_keyboard_shortcut_editor_key_press_event (GtkWidget   *widget,
 {
   CcKeyboardShortcutEditor *self;
   GdkModifierType real_mask;
-  gboolean is_custom;
-  gboolean editing;
+  gboolean editing, is_custom;
   guint keyval_lower;
 
   self = CC_KEYBOARD_SHORTCUT_EDITOR (widget);
-
   is_custom = is_custom_shortcut (self);
-  editing = !is_custom || gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (self->edit_button));
+
+  /* Being in the "change-shortcut" page is the only check we must
+   * perform to decide if we're editing a shortcut. */
+  if (is_custom)
+    editing = g_str_equal (gtk_stack_get_visible_child_name (GTK_STACK (self->stack)), "change-shortcut");
+  else
+    editing = g_str_equal (gtk_stack_get_visible_child_name (GTK_STACK (self->standard_shortcut_stack)), 
"change-shortcut");
 
   if (!editing)
     return GTK_WIDGET_CLASS (cc_keyboard_shortcut_editor_parent_class)->key_press_event (widget, event);
@@ -671,9 +676,7 @@ cc_keyboard_shortcut_editor_key_press_event (GtkWidget   *widget,
     {
       self->edited = FALSE;
 
-      gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (self->edit_button), FALSE);
       release_grab (self);
-
       cancel_editing (self);
 
       return GDK_EVENT_STOP;
@@ -691,7 +694,6 @@ cc_keyboard_shortcut_editor_key_press_event (GtkWidget   *widget,
       gtk_shortcut_label_set_accelerator (GTK_SHORTCUT_LABEL (self->custom_shortcut_accel_label), "");
       gtk_shortcut_label_set_accelerator (GTK_SHORTCUT_LABEL (self->shortcut_accel_label), "");
 
-      gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (self->edit_button), FALSE);
       release_grab (self);
 
       self->edited = FALSE;
@@ -826,13 +828,13 @@ cc_keyboard_shortcut_editor_class_init (CcKeyboardShortcutEditorClass *klass)
   gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, command_entry);
   gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, custom_shortcut_accel_label);
   gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, custom_shortcut_stack);
-  gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, edit_button);
   gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, headerbar);
   gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, name_entry);
   gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, new_shortcut_conflict_label);
   gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, remove_button);
   gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, replace_button);
   gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, reset_button);
+  gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, reset_custom_button);
   gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, set_button);
   gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, shortcut_accel_label);
   gtk_widget_class_bind_template_child (widget_class, CcKeyboardShortcutEditor, shortcut_conflict_label);
@@ -848,6 +850,7 @@ cc_keyboard_shortcut_editor_class_init (CcKeyboardShortcutEditorClass *klass)
   gtk_widget_class_bind_template_callback (widget_class, name_entry_changed_cb);
   gtk_widget_class_bind_template_callback (widget_class, remove_button_clicked_cb);
   gtk_widget_class_bind_template_callback (widget_class, replace_button_clicked_cb);
+  gtk_widget_class_bind_template_callback (widget_class, reset_custom_clicked_cb);
   gtk_widget_class_bind_template_callback (widget_class, reset_item_clicked_cb);
   gtk_widget_class_bind_template_callback (widget_class, set_button_clicked_cb);
 }
@@ -952,7 +955,7 @@ cc_keyboard_shortcut_editor_set_mode (CcKeyboardShortcutEditor *self,
       gtk_widget_set_sensitive (self->command_entry, TRUE);
       gtk_widget_set_sensitive (self->name_entry, TRUE);
 
+      gtk_widget_hide (self->reset_custom_button);
       gtk_widget_hide (self->remove_button);
-      gtk_widget_hide (self->edit_button);
     }
 }
diff --git a/panels/keyboard/shortcut-editor.ui b/panels/keyboard/shortcut-editor.ui
index 09ce2c0..bebec36 100644
--- a/panels/keyboard/shortcut-editor.ui
+++ b/panels/keyboard/shortcut-editor.ui
@@ -205,7 +205,6 @@
                     <property name="visible">True</property>
                     <property name="can_focus">True</property>
                     <property name="hexpand">True</property>
-                    <property name="sensitive" bind-source="edit_button" bind-property="active" 
bind-flags="default|invert-boolean" />
                     <signal name="notify::text" handler="name_entry_changed_cb" 
object="CcKeyboardShortcutEditor" swapped="yes" />
                   </object>
                   <packing>
@@ -219,7 +218,6 @@
                     <property name="visible">True</property>
                     <property name="can_focus">True</property>
                     <property name="hexpand">True</property>
-                    <property name="sensitive" bind-source="edit_button" bind-property="active" 
bind-flags="default|invert-boolean" />
                     <signal name="notify::text" handler="command_entry_changed_cb" 
object="CcKeyboardShortcutEditor" swapped="yes" />
                   </object>
                   <packing>
@@ -229,12 +227,19 @@
                   </packing>
                 </child>
                 <child>
-                  <object class="GtkToggleButton" id="edit_button">
-                    <property name="label" translatable="yes">Edit</property>
+                  <object class="GtkButton" id="reset_custom_button">
                     <property name="visible">True</property>
                     <property name="can_focus">True</property>
-                    <property name="receives_default">True</property>
-                    <signal name="notify::active" handler="edit_custom_shortcut_button_toggled_cb" 
object="CcKeyboardShortcutEditor" swapped="yes" />
+                    <property name="relief">none</property>
+                    <property name="halign">end</property>
+                    <child>
+                      <object class="GtkImage">
+                        <property name="visible">True</property>
+                        <property name="can_focus">False</property>
+                        <property name="icon-name">edit-clear-symbolic</property>
+                      </object>
+                    </child>
+                    <signal name="clicked" handler="reset_custom_clicked_cb" 
object="CcKeyboardShortcutEditor" swapped="yes" />
                   </object>
                   <packing>
                     <property name="left_attach">2</property>
@@ -280,7 +285,6 @@
                     <property name="can_focus">False</property>
                     <property name="label" translatable="yes">Remove</property>
                     <property name="valign">end</property>
-                    <property name="sensitive" bind-source="edit_button" bind-property="active" 
bind-flags="default|invert-boolean" />
                     <signal name="clicked" handler="remove_button_clicked_cb" 
object="CcKeyboardShortcutEditor" swapped="yes" />
                     <style>
                       <class name="destructive-action" />