Add Ui.input_mut & InputState.ignore_key

CHANGELOG.md

@@ -6,8 +6,9 @@ NOTE: [`epaint`](epaint/CHANGELOG.md), [`eframe`](eframe/CHANGELOG.md), [`egui_w
 
 
 ## Unreleased
-*  `Ui::input_mut` to modify how subsequent widgets see the `InputState` and a convenience `InputState::ignore_key` for shortcuts or hotkeys. 
+
 ### Added ⭐
+*  `Ui::input_mut` to modify how subsequent widgets see the `InputState` and a convenience `InputState::ignore_key` for shortcuts or hotkeys ([#1212](https://github.com/emilk/egui/pull/1212)). 
 * Much improved font selection ([#1154](https://github.com/emilk/egui/pull/1154)):
   * You can now select any font size and family using `RichText::size` amd `RichText::family` and the new `FontId`.
   * Easily change text styles with `Style::text_styles`.

egui/src/input_state.rs

@@ -194,19 +194,19 @@ impl InputState {
 
     // Ignore a key if it was pressed or released this frame. Useful for hotkeys.
     // Returns if the key was pressed this frame
-    pub fn ignore_key(&mut self, ignore_key: Key, modifiers: Modifiers) -> bool {
-        self.events = std::mem::take(&mut self.events).into_iter().filter(|event| {
+    pub fn consume_key(&mut self, key: Key, modifiers: Modifiers) -> bool {
+        self.events.retain(|event| {
             !matches!(
                 event,
                 Event::Key {
-                    key,
-                    modifiers: mods,
+                    key: ev_key,
+                    modifiers: ev_mods,
                     ..
-                } if *key == ignore_key && *mods == modifiers
+                } if *ev_key == key && *ev_mods == modifiers
             )
-        }).collect();
+        });
 
-        self.keys_down.remove(&ignore_key)
+        self.keys_down.remove(&key)
     }
 
     /// Was the given key pressed this frame?

egui/src/ui.rs

@@ -346,7 +346,7 @@ impl Ui {
     /// like for [`Self::input()`].
     /// ```
     /// # egui::__run_test_ui(|ui| {
-    /// ui.input_mut().time = 0.0;
+    /// ui.input_mut().consume_key(egui::Key::Enter, egui::Modifiers::default());
     /// # });
     /// ```
     #[inline]