ime: include ImePurpose in IME platform output

We want to include purpose hints in IME output, so that android
keyboards know that they are inputting multiline or password. The
softkeyboard behaves differently depending on the purpose.

For example, on multiline the keyboards enter button changes from
the done action to a newline.

For passwords, suggestions are turned off, etc.

Signed-off-by: William Casarin <[email protected]>

Author: jb55

Cargo.toml

@@ -102,7 +102,7 @@ web-sys = "0.3.70"
 web-time = "1.1.0" # Timekeeping for native and web
 wgpu = { version = "24.0.0", default-features = false }
 windows-sys = "0.59"
-winit = { default-features = false, git = "https://github.com/damus-io/winit", rev = "14d61a74bee0c9863abe7ef28efae2c4d8bd3743" }
+winit = { default-features = false, git = "https://github.com/damus-io/winit", rev = "eaff639ab0a14fccf595241f687be883154b267c" }
 
 [workspace.lints.rust]
 unsafe_code = "deny"

crates/egui-winit/src/lib.rs

@@ -907,6 +907,11 @@ impl State {
         let text_input_this_frame = ime.is_some();
         if self.text_input_last_frame != text_input_this_frame {
             if text_input_this_frame {
+                // Set ime purpose if we have it
+                if let Some(ime) = ime {
+                    window.set_ime_purpose(to_winit_ime_purpose(ime.purpose))
+                }
+
                 window.begin_ime_input();
             } else {
                 window.end_ime_input();
@@ -1531,11 +1536,7 @@ fn process_viewport_command(
             );
         }
         ViewportCommand::IMEAllowed(v) => window.set_ime_allowed(v),
-        ViewportCommand::IMEPurpose(p) => window.set_ime_purpose(match p {
-            egui::viewport::IMEPurpose::Password => winit::window::ImePurpose::Password,
-            egui::viewport::IMEPurpose::Terminal => winit::window::ImePurpose::Terminal,
-            egui::viewport::IMEPurpose::Normal => winit::window::ImePurpose::Normal,
-        }),
+        ViewportCommand::IMEPurpose(p) => window.set_ime_purpose(to_winit_ime_purpose(p)),
         ViewportCommand::Focus => {
             if !window.has_focus() {
                 window.focus_window();
@@ -1936,3 +1937,12 @@ pub fn short_window_event_description(event: &winit::event::WindowEvent) -> &'st
         WindowEvent::PanGesture { .. } => "WindowEvent::PanGesture",
     }
 }
+
+fn to_winit_ime_purpose(purpose: egui::viewport::IMEPurpose) -> winit::window::ImePurpose {
+    match purpose {
+        egui::viewport::IMEPurpose::Password => winit::window::ImePurpose::Password,
+        egui::viewport::IMEPurpose::Terminal => winit::window::ImePurpose::Terminal,
+        egui::viewport::IMEPurpose::Normal => winit::window::ImePurpose::Normal,
+        egui::viewport::IMEPurpose::Multiline => winit::window::ImePurpose::Multiline,
+    }
+}

crates/egui/src/data/output.rs

@@ -1,6 +1,6 @@
 //! All the data egui returns to the backend at the end of each frame.
 
-use crate::{RepaintCause, TextInputState, ViewportIdMap, ViewportOutput, WidgetType};
+use crate::{IMEPurpose, RepaintCause, TextInputState, ViewportIdMap, ViewportOutput, WidgetType};
 
 /// What egui emits each frame from [`crate::Context::run`].
 ///
@@ -70,6 +70,9 @@ impl FullOutput {
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 pub struct IMEOutput {
+    /// Multiline? Password?
+    pub purpose: IMEPurpose,
+
     /// Where the [`crate::TextEdit`] is located on screen.
     pub rect: crate::Rect,
 

crates/egui/src/viewport.rs

@@ -901,6 +901,7 @@ pub enum IMEPurpose {
     Normal,
     Password,
     Terminal,
+    Multiline,
 }
 
 #[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]

crates/egui/src/widgets/text_edit/builder.rs

@@ -14,9 +14,10 @@ use crate::{
     text_selection::{
         text_cursor_state::cursor_rect, visuals::paint_text_selection, CCursorRange, CursorRange,
     },
-    vec2, Align, Align2, Color32, Context, CursorIcon, Event, EventFilter, FontSelection, Id,
-    ImeEvent, Key, KeyboardShortcut, Margin, Modifiers, NumExt, Response, Sense, Shape, TextBuffer,
-    TextStyle, TextWrapMode, Ui, Vec2, Widget, WidgetInfo, WidgetText, WidgetWithState,
+    vec2, Align, Align2, Color32, Context, CursorIcon, Event, EventFilter, FontSelection,
+    IMEPurpose, Id, ImeEvent, Key, KeyboardShortcut, Margin, Modifiers, NumExt, Response, Sense,
+    Shape, TextBuffer, TextStyle, TextWrapMode, Ui, Vec2, Widget, WidgetInfo, WidgetText,
+    WidgetWithState,
 };
 
 use super::{TextEditOutput, TextEditState};
@@ -808,7 +809,16 @@ impl TextEdit<'_> {
                             .unwrap_or_default();
 
                         ui.ctx().output_mut(|o| {
+                            let purpose = if self.multiline {
+                                IMEPurpose::Multiline
+                            } else if self.password {
+                                IMEPurpose::Password
+                            } else {
+                                IMEPurpose::Normal
+                            };
+
                             o.ime = Some(crate::output::IMEOutput {
+                                purpose,
                                 rect: to_global * rect,
                                 cursor_rect: to_global * primary_cursor_rect,
                             });