From 410ec88ad5918b0919a1ad3d0afb4ca331565a12 Mon Sep 17 00:00:00 2001
From: Sebastian Wiesner <sebastian@swsnr.de>
Date: Wed, 1 Jan 2025 11:22:12 +0100
Subject: [PATCH] Turn scan network into an app action

It never was a window action, semantically: It changed the discovery
state of the global app model, and hence affected the entire app.

Let's make this apparent by lifting the action to the app, which also
removes the redundant property and overall simplifies state tracking.
---
 resources/gtk/help-overlay.blp             |  2 +-
 resources/gtk/help-overlay.ui              |  2 +-
 resources/ui/turnon-application-window.blp |  6 ++---
 resources/ui/turnon-application-window.ui  |  6 ++---
 src/app.rs                                 | 30 +++++++++++++++-------
 src/app/widgets/application_window.rs      | 13 +---------
 6 files changed, 30 insertions(+), 29 deletions(-)

diff --git a/resources/gtk/help-overlay.blp b/resources/gtk/help-overlay.blp
index 313e9a5..2a94ca7 100644
--- a/resources/gtk/help-overlay.blp
+++ b/resources/gtk/help-overlay.blp
@@ -27,7 +27,7 @@ Gtk.ShortcutsWindow help_overlay {
 
       Gtk.ShortcutsShortcut {
         title: C_("shortcut description", "Toggle network scanning");
-        accelerator: "F5";
+        action-name: "app.scan-network";
       }
     }
 
diff --git a/resources/gtk/help-overlay.ui b/resources/gtk/help-overlay.ui
index 58bd643..a257707 100644
--- a/resources/gtk/help-overlay.ui
+++ b/resources/gtk/help-overlay.ui
@@ -23,7 +23,7 @@ corresponding .blp file and regenerate this file with blueprint-compiler.
             <child>
               <object class="GtkShortcutsShortcut">
                 <property name="title" translatable="yes" context="shortcut description">Toggle network scanning</property>
-                <property name="accelerator">F5</property>
+                <property name="action-name">app.scan-network</property>
               </object>
             </child>
           </object>
diff --git a/resources/ui/turnon-application-window.blp b/resources/ui/turnon-application-window.blp
index 6c7950f..c095250 100644
--- a/resources/ui/turnon-application-window.blp
+++ b/resources/ui/turnon-application-window.blp
@@ -22,9 +22,9 @@ template $TurnOnApplicationWindow: Adw.ApplicationWindow {
 
       [start]
       Gtk.ToggleButton toggle_scan_network {
-        action-name: "win.toggle-scan-network";
+        action-name: "app.scan-network";
         icon-name: "waves-and-screen-symbolic";
-        tooltip-text: C_("application-window.action.win.scan-network.tooltip", "Scan the network for devices");
+        tooltip-text: C_("application-window.action.app.scan-network.tooltip", "Scan the network for devices");
       }
 
       [end]
@@ -79,7 +79,7 @@ template $TurnOnApplicationWindow: Adw.ApplicationWindow {
 
                 Gtk.Button {
                   label: C_("application-window.status-page.button.label", "Scan network");
-                  action-name: "win.toggle-scan-network";
+                  action-name: "app.scan-network";
 
                   styles [
                     "pill",
diff --git a/resources/ui/turnon-application-window.ui b/resources/ui/turnon-application-window.ui
index 290c2a1..d982af4 100644
--- a/resources/ui/turnon-application-window.ui
+++ b/resources/ui/turnon-application-window.ui
@@ -22,9 +22,9 @@ corresponding .blp file and regenerate this file with blueprint-compiler.
             </child>
             <child type="start">
               <object class="GtkToggleButton" id="toggle_scan_network">
-                <property name="action-name">win.toggle-scan-network</property>
+                <property name="action-name">app.scan-network</property>
                 <property name="icon-name">waves-and-screen-symbolic</property>
-                <property name="tooltip-text" translatable="yes" context="application-window.action.win.scan-network.tooltip">Scan the network for devices</property>
+                <property name="tooltip-text" translatable="yes" context="application-window.action.app.scan-network.tooltip">Scan the network for devices</property>
               </object>
             </child>
             <child type="end">
@@ -81,7 +81,7 @@ corresponding .blp file and regenerate this file with blueprint-compiler.
                                 <child>
                                   <object class="GtkButton">
                                     <property name="label" translatable="yes" context="application-window.status-page.button.label">Scan network</property>
-                                    <property name="action-name">win.toggle-scan-network</property>
+                                    <property name="action-name">app.scan-network</property>
                                     <style>
                                       <class name="pill"/>
                                       <class name="suggested-action"/>
diff --git a/src/app.rs b/src/app.rs
index da6e47a..959d0cc 100644
--- a/src/app.rs
+++ b/src/app.rs
@@ -111,6 +111,18 @@ impl TurnOnApplication {
                     dialog.present(app.active_window().as_ref());
                 })
                 .build(),
+            ActionEntry::builder("scan-network")
+                .state(false.into())
+                .change_state(|app: &TurnOnApplication, action, state| {
+                    // The default activate handler should safely toggle the boolean state of this action
+                    // so we can expect the state to be set at this point.
+                    let state = state.unwrap();
+                    app.devices()
+                        .discovered_devices()
+                        .set_discovery_enabled(state.get::<bool>().unwrap());
+                    action.set_state(state);
+                })
+                .build(),
             ActionEntry::builder("quit")
                 .activate(|app: &TurnOnApplication, _, _| app.quit())
                 .build(),
@@ -122,8 +134,17 @@ impl TurnOnApplication {
         ];
         self.add_action_entries(actions);
 
+        // We do _not_ add a global shortcut for app.add-device because we handle adding devices a bit more flexible:
+        //
+        // Device rows have their own action to add a new device, which enables adding a new device from a discovered
+        // device with pre-filled fields.  We use the Ctrl+N shortcut for this action too, so that the user gets a
+        // prefilled dialog when they press Ctrl+N while a discovered device is focused, or an empty dialog otherwise.
+        //
+        // If we set a global shortcut here, it'd always override the shortcut of the device rows, and users would
+        // always just get the empty dialog.
         self.set_accels_for_action("window.close", &["<Control>w"]);
         self.set_accels_for_action("app.quit", &["<Control>q"]);
+        self.set_accels_for_action("app.scan-network", &["F5"]);
     }
 }
 
@@ -366,15 +387,6 @@ mod imp {
                         window.add_css_class("devel");
                     }
                     window.bind_model(&self.devices);
-                    window.connect_scan_network_notify(glib::clone!(
-                        #[strong]
-                        app,
-                        move |window| {
-                            app.devices()
-                                .discovered_devices()
-                                .set_discovery_enabled(window.scan_network());
-                        }
-                    ));
                     window.present();
                 }
             }
diff --git a/src/app/widgets/application_window.rs b/src/app/widgets/application_window.rs
index aacc2f6..914119c 100644
--- a/src/app/widgets/application_window.rs
+++ b/src/app/widgets/application_window.rs
@@ -34,7 +34,7 @@ impl TurnOnApplicationWindow {
 }
 
 mod imp {
-    use std::cell::{Cell, RefCell};
+    use std::cell::RefCell;
     use std::rc::Rc;
     use std::time::Duration;
 
@@ -58,8 +58,6 @@ mod imp {
     pub struct TurnOnApplicationWindow {
         settings: gio::Settings,
         #[property(get, set)]
-        scan_network: Cell<bool>,
-        #[property(get, set)]
         startpage_icon_name: RefCell<String>,
         #[template_child]
         devices_list: TemplateChild<gtk::ListBox>,
@@ -228,7 +226,6 @@ mod imp {
                     gio::SettingsBackend::NONE,
                     None,
                 ),
-                scan_network: Default::default(),
                 startpage_icon_name: Default::default(),
                 devices_list: Default::default(),
                 feedback: Default::default(),
@@ -237,15 +234,7 @@ mod imp {
 
         fn class_init(klass: &mut Self::Class) {
             klass.bind_template();
-
-            klass.install_property_action("win.toggle-scan-network", "scan-network");
-
             klass.add_binding_action(Key::N, ModifierType::CONTROL_MASK, "app.add-device");
-            klass.add_binding_action(
-                Key::F5,
-                ModifierType::NO_MODIFIER_MASK,
-                "win.toggle-scan-network",
-            );
         }
 
         fn instance_init(obj: &InitializingObject<Self>) {