Merge pull request #3135 from edwloef/subscribe_key_code

Add `physical_key` to key subscriptions

core/src/keyboard/key.rs

@@ -65,7 +65,7 @@ impl Key {
         let mut chars = s.chars();
         let c = chars.next()?;
 
-        if chars.next().is_none() && c <= '\u{ff}' {
+        if chars.next().is_none() && c < '\u{370}' {
             return Some(c);
         }
 

devtools/src/lib.rs

@@ -381,11 +381,13 @@ where
             program.subscription(&self.state).map(Event::Program);
         debug::subscriptions_tracked(subscription.units());
 
-        let hotkeys =
+        let hotkeys = futures::keyboard::listen()
-            futures::keyboard::on_key_press(|key, _modifiers| match key {
+            .filter_map(|event| match event {
-                keyboard::Key::Named(keyboard::key::Named::F12) => {
+                keyboard::Event::KeyPressed {
-                    Some(Message::ToggleComet)
+                    modified_key:
-                }
+                        keyboard::Key::Named(keyboard::key::Named::F12),
+                    ..
+                } => Some(Message::ToggleComet),
                 _ => None,
             })
             .map(Event::Message);

examples/layout/src/main.rs

@@ -58,12 +58,25 @@ impl Layout {
     fn subscription(&self) -> Subscription<Message> {
         use keyboard::key;
 
-        keyboard::on_key_release(|key, _modifiers| match key {
+        keyboard::listen().filter_map(|event| {
-            keyboard::Key::Named(key::Named::ArrowLeft) => {
+            let keyboard::Event::KeyPressed {
-                Some(Message::Previous)
+                modified_key,
+                repeat: false,
+                ..
+            } = event
+            else {
+                return None;
+            };
+
+            match modified_key {
+                keyboard::Key::Named(key::Named::ArrowLeft) => {
+                    Some(Message::Previous)
+                }
+                keyboard::Key::Named(key::Named::ArrowRight) => {
+                    Some(Message::Next)
+                }
+                _ => None,
             }
-            keyboard::Key::Named(key::Named::ArrowRight) => Some(Message::Next),
-            _ => None,
         })
     }
 

examples/pane_grid/src/main.rs

@@ -117,12 +117,17 @@ impl Example {
     }
 
     fn subscription(&self) -> Subscription<Message> {
-        keyboard::on_key_press(|key_code, modifiers| {
+        keyboard::listen().filter_map(|event| {
+            let keyboard::Event::KeyPressed { key, modifiers, .. } = event
+            else {
+                return None;
+            };
+
             if !modifiers.command() {
                 return None;
             }
 
-            handle_hotkey(key_code)
+            handle_hotkey(key)
         })
     }
 

examples/screenshot/src/main.rs

@@ -227,8 +227,12 @@ impl Example {
     fn subscription(&self) -> Subscription<Message> {
         use keyboard::key;
 
-        keyboard::on_key_press(|key, _modifiers| {
+        keyboard::listen().filter_map(|event| {
-            if let keyboard::Key::Named(key::Named::F5) = key {
+            if let keyboard::Event::KeyPressed {
+                modified_key: keyboard::Key::Named(key::Named::F5),
+                ..
+            } = event
+            {
                 Some(Message::Screenshot)
             } else {
                 None

examples/stopwatch/src/main.rs

@@ -65,13 +65,14 @@ impl Stopwatch {
             }
         };
 
-        fn handle_hotkey(
+        fn handle_hotkey(event: keyboard::Event) -> Option<Message> {
-            key: keyboard::Key,
-            _modifiers: keyboard::Modifiers,
-        ) -> Option<Message> {
             use keyboard::key;
 
-            match key.as_ref() {
+            let keyboard::Event::KeyPressed { modified_key, .. } = event else {
+                return None;
+            };
+
+            match modified_key.as_ref() {
                 keyboard::Key::Named(key::Named::Space) => {
                     Some(Message::Toggle)
                 }
@@ -80,7 +81,10 @@ impl Stopwatch {
             }
         }
 
-        Subscription::batch(vec![tick, keyboard::on_key_press(handle_hotkey)])
+        Subscription::batch(vec![
+            tick,
+            keyboard::listen().filter_map(handle_hotkey),
+        ])
     }
 
     fn view(&self) -> Element<'_, Message> {

examples/styling/src/main.rs

@@ -190,18 +190,26 @@ impl Styling {
     }
 
     fn subscription(&self) -> Subscription<Message> {
-        keyboard::on_key_press(|key, _modifiers| match key {
+        keyboard::listen().filter_map(|event| {
-            keyboard::Key::Named(
+            let keyboard::Event::KeyPressed {
-                keyboard::key::Named::ArrowUp | keyboard::key::Named::ArrowLeft,
+                modified_key: keyboard::Key::Named(modified_key),
-            ) => Some(Message::PreviousTheme),
+                repeat: false,
-            keyboard::Key::Named(
+                ..
+            } = event
+            else {
+                return None;
+            };
+
+            match modified_key {
+                keyboard::key::Named::ArrowUp
+                | keyboard::key::Named::ArrowLeft => {
+                    Some(Message::PreviousTheme)
+                }
                 keyboard::key::Named::ArrowDown
-                | keyboard::key::Named::ArrowRight,
+                | keyboard::key::Named::ArrowRight => Some(Message::NextTheme),
-            ) => Some(Message::NextTheme),
+                keyboard::key::Named::Space => Some(Message::ClearTheme),
-            keyboard::Key::Named(keyboard::key::Named::Space) => {
+                _ => None,
-                Some(Message::ClearTheme)
             }
-            _ => None,
         })
     }
 

examples/todos/src/main.rs

@@ -254,12 +254,12 @@ impl Todos {
     fn subscription(&self) -> Subscription<Message> {
         use keyboard::key;
 
-        keyboard::on_key_press(|key, modifiers| {
+        keyboard::listen().filter_map(|event| match event {
-            let keyboard::Key::Named(key) = key else {
+            keyboard::Event::KeyPressed {
-                return None;
+                key: keyboard::Key::Named(key),
-            };
+                modifiers,
-
+                ..
-            match (key, modifiers) {
+            } => match (key, modifiers) {
                 (key::Named::Tab, _) => Some(Message::TabPressed {
                     shift: modifiers.shift(),
                 }),
@@ -270,7 +270,8 @@ impl Todos {
                     Some(Message::ToggleFullscreen(window::Mode::Windowed))
                 }
                 _ => None,
-            }
+            },
+            _ => None,
         })
     }
 }

futures/src/keyboard.rs

@@ -1,56 +1,18 @@
 //! Listen to keyboard events.
-use crate::MaybeSend;
 use crate::core;
-use crate::core::event;
+use crate::core::keyboard::Event;
-use crate::core::keyboard::{Event, Key, Modifiers};
 use crate::subscription::{self, Subscription};
 
-/// Listens to keyboard key presses and calls the given function
+/// Returns a [`Subscription`] that listens to ignored keyboard events.
-/// to map them into actual messages.
+pub fn listen() -> Subscription<Event> {
-///
-/// If the function returns `None`, the key press will be simply
-/// ignored.
-pub fn on_key_press<Message>(
-    f: fn(Key, Modifiers) -> Option<Message>,
-) -> Subscription<Message>
-where
-    Message: MaybeSend + 'static,
-{
     #[derive(Hash)]
-    struct OnKeyPress;
+    struct Listen;
 
-    subscription::filter_map((OnKeyPress, f), move |event| match event {
+    subscription::filter_map(Listen, move |event| match event {
         subscription::Event::Interaction {
-            event:
+            event: core::Event::Keyboard(event),
-                core::Event::Keyboard(Event::KeyPressed { key, modifiers, .. }),
-            status: event::Status::Ignored,
             ..
-        } => f(key, modifiers),
+        } => Some(event),
-        _ => None,
-    })
-}
-
-/// Listens to keyboard key releases and calls the given function
-/// to map them into actual messages.
-///
-/// If the function returns `None`, the key release will be simply
-/// ignored.
-pub fn on_key_release<Message>(
-    f: fn(Key, Modifiers) -> Option<Message>,
-) -> Subscription<Message>
-where
-    Message: MaybeSend + 'static,
-{
-    #[derive(Hash)]
-    struct OnKeyRelease;
-
-    subscription::filter_map((OnKeyRelease, f), move |event| match event {
-        subscription::Event::Interaction {
-            event:
-                core::Event::Keyboard(Event::KeyReleased { key, modifiers, .. }),
-            status: event::Status::Ignored,
-            ..
-        } => f(key, modifiers),
         _ => None,
     })
 }

src/lib.rs

@@ -368,8 +368,8 @@
 //! visible widgets of your user interface, at every moment.
 //!
 //! As with tasks, some modules expose convenient functions that build a [`Subscription`] for you—like
-//! [`time::every`] which can be used to listen to time, or [`keyboard::on_key_press`] which will notify you
+//! [`time::every`] which can be used to listen to time, or [`keyboard::listen`] which will notify you
-//! of any key presses. But you can also create your own with [`Subscription::run`] and [`run_with`].
+//! of any keyboard events. But you can also create your own with [`Subscription::run`] and [`run_with`].
 //!
 //! [`run_with`]: Subscription::run_with
 //!
@@ -590,7 +590,7 @@ pub mod keyboard {
     //! Listen and react to keyboard events.
     pub use crate::core::keyboard::key;
     pub use crate::core::keyboard::{Event, Key, Location, Modifiers};
-    pub use iced_futures::keyboard::{on_key_press, on_key_release};
+    pub use iced_futures::keyboard::listen;
 }
 
 pub mod mouse {