[gtk+/gtk-2-24] filechooserbutton: Update the button's state only on programmatic changes to the filechooser's state

[Federico Mena Quintero <federico src gnome org>]

commit 9cfec7d3dbb054ced18a3e8f18a38a4c809ef4ea
Author: Federico Mena Quintero <federico gnome org>
Date:   Tue Mar 12 10:05:22 2013 -0600

    filechooserbutton: Update the button's state only on programmatic changes to the filechooser's state
    
    The idea is that the button will only update its state of the selection and current folder
    when changes to those are done either by the calling program (with the filechooser's API)
    or when the user actually confirms and dismisses the underlying GtkFileChooserDialog.
    
    If the user makes changes to the dialog but has not dismissed it yet, those changes
    will not be reflected in the button (as one would expect).
    
    This commit also makes sure the current-folder-changed and selection-changed signals
    are emitted at the right times.
    
    Signed-off-by: Federico Mena Quintero <federico gnome org>

 gtk/gtkfilechooserbutton.c |  100 ++++++++++++++++++++++++++++---------------
 1 files changed, 65 insertions(+), 35 deletions(-)
---
diff --git a/gtk/gtkfilechooserbutton.c b/gtk/gtkfilechooserbutton.c
index 053f891..aca64ae 100644
--- a/gtk/gtkfilechooserbutton.c
+++ b/gtk/gtkfilechooserbutton.c
@@ -143,7 +143,6 @@ struct _GtkFileChooserButtonPrivate
   GFile *current_folder_while_inactive;
 
   gulong combo_box_changed_id;
-  gulong dialog_file_activated_id;
   gulong dialog_folder_changed_id;
   gulong dialog_selection_changed_id;
   gulong fs_volumes_changed_id;
@@ -171,6 +170,22 @@ struct _GtkFileChooserButtonPrivate
 
   /* Whether the next async callback from GIO should emit the "selection-changed" signal */
   guint  is_changing_selection        : 1;
+
+  /* When GtkFileChooserButton's dialog is not active, any modifications to the
+   * dialog's state (as done by the calling program) will be reflected in the
+   * button immediately - the following two flags will be FALSE.
+   *
+   * But when the dialog is active, we only want the button to reflect
+   * modifications in the dialog's state if those modifications *are done by the
+   * calling program*, not by the user in the dialog.  So if the program calls
+   * gtk_file_chooser_select_file() while the dialog is active, that state will
+   * need to be reflected in the button, and either of these flags will be TRUE.
+   * But if the user frobs the dialog, we don't want the button to change its
+   * state until the user actually confirms the dialog and dismisses it; in this
+   * case, the flags will be FALSE.
+   */
+  guint folder_change_needs_notification    : 1;
+  guint selection_change_needs_notification : 1;
 };
 
 
@@ -304,8 +319,6 @@ static void     dialog_update_preview_cb         (GtkFileChooser *dialog,
                                                  gpointer        user_data);
 static void     dialog_selection_changed_cb      (GtkFileChooser *dialog,
                                                  gpointer        user_data);
-static void     dialog_file_activated_cb         (GtkFileChooser *dialog,
-                                                 gpointer        user_data);
 static void     dialog_current_folder_changed_cb (GtkFileChooser *dialog,
                                                  gpointer        user_data);
 static void     dialog_notify_cb                 (GObject        *dialog,
@@ -583,7 +596,10 @@ gtk_file_chooser_button_set_current_folder (GtkFileChooser    *chooser,
                                 GTK_FILE_CHOOSER_DELEGATE_QUARK);
 
   if (priv->active)
-    return gtk_file_chooser_set_current_folder_file (delegate, file, error);
+    {
+      priv->folder_change_needs_notification = TRUE;
+      return gtk_file_chooser_set_current_folder_file (delegate, file, error);
+    }
   else
     {
       if (priv->current_folder_while_inactive)
@@ -633,7 +649,10 @@ gtk_file_chooser_button_select_file (GtkFileChooser *chooser,
                                 GTK_FILE_CHOOSER_DELEGATE_QUARK);
 
   if (priv->active)
-    return gtk_file_chooser_select_file (delegate, file, error);
+    {
+      priv->selection_change_needs_notification = TRUE;
+      return gtk_file_chooser_select_file (delegate, file, error);
+    }
   else
     {
       if (priv->selection_while_inactive)
@@ -884,9 +903,6 @@ gtk_file_chooser_button_constructor (GType                  type,
   priv->dialog_folder_changed_id =
     g_signal_connect (priv->dialog, "current-folder-changed",
                      G_CALLBACK (dialog_current_folder_changed_cb), object);
-  priv->dialog_file_activated_id =
-    g_signal_connect (priv->dialog, "file-activated",
-                     G_CALLBACK (dialog_file_activated_cb), object);
   priv->dialog_selection_changed_id =
     g_signal_connect (priv->dialog, "selection-changed",
                      G_CALLBACK (dialog_selection_changed_cb), object);
@@ -2773,15 +2789,7 @@ open_dialog (GtkFileChooserButton *button)
 
   if (!priv->active)
     {
-      g_signal_handler_block (priv->dialog,
-                             priv->dialog_folder_changed_id);
-      g_signal_handler_block (priv->dialog,
-                             priv->dialog_file_activated_id);
-      g_signal_handler_block (priv->dialog,
-                             priv->dialog_selection_changed_id);
-
       restore_inactive_state (button);
-
       priv->active = TRUE;
     }
 
@@ -2894,29 +2902,59 @@ button_clicked_cb (GtkButton *real_button,
 }
 
 /* Dialog */
+
 static void
 dialog_current_folder_changed_cb (GtkFileChooser *dialog,
                                  gpointer        user_data)
 {
   GtkFileChooserButton *button = GTK_FILE_CHOOSER_BUTTON (user_data);
+  GtkFileChooserButtonPrivate *priv = button->priv;
+  gboolean update_from_dialog;
 
-  g_signal_emit_by_name (button, "current-folder-changed");
-}
+  if (!priv->active)
+    update_from_dialog = TRUE;
+  else if (priv->folder_change_needs_notification)
+    update_from_dialog = TRUE;
+  else
+    update_from_dialog = FALSE;
 
-static void
-dialog_file_activated_cb (GtkFileChooser *dialog,
-                         gpointer        user_data)
-{
-  g_signal_emit_by_name (user_data, "file-activated");
+  priv->folder_change_needs_notification = FALSE;
+
+  if (update_from_dialog)
+    {
+      save_inactive_state (button);
+
+      update_label_and_image (button);
+      update_combo_box (button);
+      g_signal_emit_by_name (button, "current-folder-changed");
+    }
 }
 
 static void
 dialog_selection_changed_cb (GtkFileChooser *dialog,
                             gpointer        user_data)
 {
-  update_label_and_image (user_data);
-  update_combo_box (user_data);
-  g_signal_emit_by_name (user_data, "selection-changed");
+  GtkFileChooserButton *button = GTK_FILE_CHOOSER_BUTTON (user_data);
+  GtkFileChooserButtonPrivate *priv = button->priv;
+  gboolean update_from_dialog;
+
+  if (!priv->active)
+    update_from_dialog = TRUE;
+  else if (priv->selection_change_needs_notification)
+    update_from_dialog = TRUE;
+  else
+    update_from_dialog = FALSE;
+
+  priv->selection_change_needs_notification = FALSE;
+
+  if (update_from_dialog)
+    {
+      save_inactive_state (button);
+
+      update_label_and_image (button);
+      update_combo_box (button);
+      g_signal_emit_by_name (button, "selection-changed");
+    }
 }
 
 static void
@@ -3003,15 +3041,7 @@ dialog_response_cb (GtkDialog *dialog,
     }
 
   if (priv->active)
-    {
-      g_signal_handler_unblock (priv->dialog,
-                               priv->dialog_folder_changed_id);
-      g_signal_handler_unblock (priv->dialog,
-                               priv->dialog_file_activated_id);
-      g_signal_handler_unblock (priv->dialog,
-                               priv->dialog_selection_changed_id);
-      priv->active = FALSE;
-    }
+    priv->active = FALSE;
 
   update_label_and_image (button);
   update_combo_box (button);