leyoda/iced-yoda
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Unify keyboard subscriptions into listen

Browse source
This commit is contained in:
Héctor Ramón Jiménez 2025-12-02 18:35:50 +01:00
parent 0df5765e2f
commit 7e5b6f6802
No known key found for this signature in database
GPG key ID: 7CC46565708259A7
9 changed files with 77 additions and 96 deletions
Download patch file Download diff file Expand all files Collapse all files

17
devtools/src/lib.rs
View file

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

18
examples/layout/src/main.rs
View file

@ -58,12 +58,20 @@ impl Layout {
fn subscription(&self) -> Subscription<Message> {
use keyboard::key;
keyboard::on_key_release(|key, _physical_key, _modifiers| match key {
keyboard::Key::Named(key::Named::ArrowLeft) => {
Some(Message::Previous)
keyboard::listen().filter_map(|event| {
let keyboard::Event::KeyPressed { modified_key, .. } = 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,
})
}

7
examples/pane_grid/src/main.rs
View file

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

8
examples/screenshot/src/main.rs
View file

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

17
examples/stopwatch/src/main.rs
View file

@ -65,14 +65,14 @@ impl Stopwatch {
}
};
fn handle_hotkey(
key: keyboard::Key,
_physical_key: keyboard::key::Physical,
_modifiers: keyboard::Modifiers,
) -> Option<Message> {
fn handle_hotkey(event: keyboard::Event) -> 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)
}
@ -81,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> {

27
examples/styling/src/main.rs
View file

@ -190,18 +190,25 @@ impl Styling {
}
fn subscription(&self) -> Subscription<Message> {
keyboard::on_key_press(|key, _physical_key, _modifiers| match key {
keyboard::Key::Named(
keyboard::key::Named::ArrowUp | keyboard::key::Named::ArrowLeft,
) => Some(Message::PreviousTheme),
keyboard::Key::Named(
keyboard::listen().filter_map(|event| {
let keyboard::Event::KeyPressed {
modified_key: keyboard::Key::Named(modified_key),
..
} = 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,
) => Some(Message::NextTheme),
keyboard::Key::Named(keyboard::key::Named::Space) => {
Some(Message::ClearTheme)
| keyboard::key::Named::ArrowRight => Some(Message::NextTheme),
keyboard::key::Named::Space => Some(Message::ClearTheme),
_ => None,
}
_ => None,
})
}

15
examples/todos/src/main.rs
View file

@ -254,12 +254,12 @@ impl Todos {
fn subscription(&self) -> Subscription<Message> {
use keyboard::key;
keyboard::on_key_press(|key, _physical_key, modifiers| {
let keyboard::Key::Named(key) = key else {
return None;
};
match (key, modifiers) {
keyboard::listen().filter_map(|event| match event {
keyboard::Event::KeyPressed {
key: keyboard::Key::Named(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,
})
}
}

62
futures/src/keyboard.rs
View file

@ -1,66 +1,18 @@
//! Listen to keyboard events.
use crate::MaybeSend;
use crate::core;
use crate::core::event;
use crate::core::keyboard::{Event, Key, Modifiers, key};
use crate::core::keyboard::Event;
use crate::subscription::{self, Subscription};
/// Listens to keyboard key presses and calls the given function
/// to map them into actual messages.
///
/// If the function returns `None`, the key press will be simply
/// ignored.
pub fn on_key_press<Message>(
f: fn(Key, key::Physical, Modifiers) -> Option<Message>,
) -> Subscription<Message>
where
Message: MaybeSend + 'static,
{
/// Returns a [`Subscription`] that listens to ignored keyboard events.
pub fn listen() -> Subscription<Event> {
#[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:
core::Event::Keyboard(Event::KeyPressed {
key,
physical_key,
modifiers,
..
}),
status: event::Status::Ignored,
event: core::Event::Keyboard(event),
..
} => f(key, physical_key, modifiers),
_ => 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, key::Physical, 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,
physical_key,
modifiers,
..
}),
status: event::Status::Ignored,
..
} => f(key, physical_key, modifiers),
} => Some(event),
_ => None,
})
}

2
src/lib.rs
View file

@ -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 {