basic IME support rebase

core/src/element.rs

@@ -1,13 +1,11 @@
 use crate::event::{self, Event};
-use crate::layout;
-use crate::mouse;
-use crate::overlay;
 use crate::renderer;
 use crate::widget;
 use crate::widget::tree::{self, Tree};
-use crate::{
-    Clipboard, Color, Layout, Length, Rectangle, Shell, Vector, Widget,
-};
+use crate::IME;
+use crate::{layout, mouse};
+use crate::{overlay, Vector};
+use crate::{Clipboard, Color, Layout, Length, Rectangle, Shell, Widget};
 
 use std::any::Any;
 use std::borrow::Borrow;
@@ -385,6 +383,7 @@ where
         cursor: mouse::Cursor,
         renderer: &Renderer,
         clipboard: &mut dyn Clipboard,
+        ime: &dyn IME,
         shell: &mut Shell<'_, B>,
         viewport: &Rectangle,
     ) -> event::Status {
@@ -398,6 +397,7 @@ where
             cursor,
             renderer,
             clipboard,
+            ime,
             &mut local_shell,
             viewport,
         );
@@ -519,11 +519,13 @@ where
         cursor: mouse::Cursor,
         renderer: &Renderer,
         clipboard: &mut dyn Clipboard,
+        ime: &dyn IME,
         shell: &mut Shell<'_, Message>,
         viewport: &Rectangle,
     ) -> event::Status {
         self.element.widget.on_event(
-            state, event, layout, cursor, renderer, clipboard, shell, viewport,
+            state, event, layout, cursor, renderer, clipboard, ime, shell,
+            viewport,
         )
     }
 

core/src/event.rs

@@ -1,9 +1,9 @@
 //! Handle events of a user interface.
+use crate::ime;
 use crate::keyboard;
 use crate::mouse;
 use crate::touch;
 use crate::window;
-
 /// A user interface event.
 ///
 /// _**Note:** This type is largely incomplete! If you need to track
@@ -26,6 +26,9 @@ pub enum Event {
 
     /// A platform specific event
     PlatformSpecific(PlatformSpecific),
+
+    /// A ime event
+    IME(ime::Event),
 }
 
 /// A platform specific event

core/src/ime.rs

@@ -0,0 +1,65 @@
+//! Access the IME.
+
+mod event;
+
+pub use event::Event;
+
+/// IME Access interface.
+pub trait IME {
+    ///
+    fn set_ime_position(&self, x: i32, y: i32);
+
+    /// need to call if clicked position is  widget's region.
+    ///
+    /// IME willbe enabled.
+    fn inside(&self);
+
+    /// need to call if clicked position is not widget's region.
+    ///
+    /// used to determine disable ime.
+    fn outside(&self);
+
+    /// disable IME.
+    ///
+    fn password_mode(&self);
+
+    /// force ime enabled or disabled.
+    ///
+    /// this will block request until unlock_set_ime_allowed.
+    fn force_set_ime_allowed(&self, _allowed: bool);
+    /// remove request of force_set_ime_allowed
+    ///
+    fn unlock_set_ime_allowed(&self);
+
+    #[cfg(target_os = "macos")]
+    /// macos's strange behavior of set_ime_position workaround.
+    ///
+    /// on macos we can't move cadidate window by set_ime_position.
+    ///
+    /// we set ime candidate window position by these steps when IME::Commit event processed.
+    ///
+    /// * disable IME
+    /// * set candidate position
+    /// * enable IME
+    fn set_ime_position_with_reenable(&self, x: i32, y: i32);
+}
+
+/// A null implementation of the [`IME`] trait.
+#[derive(Debug, Clone, Copy)]
+pub struct Null;
+
+impl IME for Null {
+    fn set_ime_position(&self, _x: i32, _y: i32) {}
+
+    fn outside(&self) {}
+
+    fn password_mode(&self) {}
+
+    fn inside(&self) {}
+
+    fn force_set_ime_allowed(&self, _: bool) {}
+
+    fn unlock_set_ime_allowed(&self) {}
+    #[cfg(target_os = "macos")]
+    fn set_ime_position_with_reenable(&self, _x: i32, _y: i32) {}
+}

core/src/ime/event.rs

@@ -0,0 +1,19 @@
+/// A IME event.
+///
+/// _**Note:** This type is largely incomplete! If you need to track
+/// additional events, feel free to [open an issue] and share your use case!_
+///
+/// [open an issue]: https://github.com/iced-rs/iced/issues
+#[derive(Debug, Clone, PartialEq, Eq)]
+pub enum Event {
+    /// IME enabled.
+    IMEEnabled,
+
+    /// selecting input.
+    IMEPreedit(String, Option<(usize, usize)>),
+
+    /// enter input.
+    IMECommit(String),
+    /// Notifies when the IME was disabled.
+    IMEDisabled,
+}

core/src/lib.rs

@@ -22,6 +22,7 @@ pub mod event;
 pub mod font;
 pub mod gradient;
 pub mod image;
+pub mod ime;
 pub mod keyboard;
 pub mod layout;
 pub mod mouse;
@@ -62,6 +63,7 @@ pub use event::Event;
 pub use font::Font;
 pub use gradient::Gradient;
 pub use hasher::Hasher;
+pub use ime::IME;
 pub use layout::Layout;
 pub use length::Length;
 pub use overlay::Overlay;

core/src/overlay.rs

@@ -6,12 +6,13 @@ pub use element::Element;
 pub use group::Group;
 
 use crate::event::{self, Event};
-use crate::layout;
 use crate::mouse;
 use crate::renderer;
 use crate::widget;
 use crate::widget::Tree;
-use crate::{Clipboard, Layout, Point, Rectangle, Shell, Size, Vector};
+use crate::{
+    layout, Clipboard, Layout, Point, Rectangle, Shell, Size, Vector, IME,
+};
 
 /// An interactive component that can be displayed on top of other widgets.
 pub trait Overlay<Message, Renderer>
@@ -70,6 +71,7 @@ where
         _cursor: mouse::Cursor,
         _renderer: &Renderer,
         _clipboard: &mut dyn Clipboard,
+        _ime: &dyn IME,
         _shell: &mut Shell<'_, Message>,
     ) -> event::Status {
         event::Status::Ignored

core/src/overlay/element.rs

@@ -1,10 +1,10 @@
 pub use crate::Overlay;
 
 use crate::event::{self, Event};
-use crate::layout;
 use crate::mouse;
 use crate::renderer;
 use crate::widget;
+use crate::{layout, IME};
 use crate::{Clipboard, Layout, Point, Rectangle, Shell, Size, Vector};
 
 use std::any::Any;
@@ -82,10 +82,11 @@ where
         cursor: mouse::Cursor,
         renderer: &Renderer,
         clipboard: &mut dyn Clipboard,
+        ime: &dyn IME,
         shell: &mut Shell<'_, Message>,
     ) -> event::Status {
         self.overlay
-            .on_event(event, layout, cursor, renderer, clipboard, shell)
+            .on_event(event, layout, cursor, renderer, clipboard, ime, shell)
     }
 
     /// Returns the current [`mouse::Interaction`] of the [`Element`].
@@ -236,6 +237,7 @@ where
         cursor: mouse::Cursor,
         renderer: &Renderer,
         clipboard: &mut dyn Clipboard,
+        ime: &dyn IME,
         shell: &mut Shell<'_, B>,
     ) -> event::Status {
         let mut local_messages = Vec::new();
@@ -247,6 +249,7 @@ where
             cursor,
             renderer,
             clipboard,
+            ime,
             &mut local_shell,
         );
 

core/src/overlay/group.rs

@@ -4,8 +4,10 @@ use crate::mouse;
 use crate::overlay;
 use crate::renderer;
 use crate::widget;
+
 use crate::{
     Clipboard, Event, Layout, Overlay, Point, Rectangle, Shell, Size, Vector,
+    IME,
 };
 
 /// An [`Overlay`] container that displays multiple overlay [`overlay::Element`]
@@ -85,6 +87,7 @@ where
         cursor: mouse::Cursor,
         renderer: &Renderer,
         clipboard: &mut dyn Clipboard,
+        ime: &dyn IME,
         shell: &mut Shell<'_, Message>,
     ) -> event::Status {
         self.children
@@ -97,6 +100,7 @@ where
                     cursor,
                     renderer,
                     clipboard,
+                    ime,
                     shell,
                 )
             })

core/src/widget.rs

@@ -12,9 +12,9 @@ pub use tree::Tree;
 
 use crate::event::{self, Event};
 use crate::layout::{self, Layout};
-use crate::mouse;
 use crate::overlay;
 use crate::renderer;
+use crate::{mouse, IME};
 use crate::{Clipboard, Length, Rectangle, Shell};
 
 /// A component that displays information and allows interaction.
@@ -115,6 +115,7 @@ where
         _cursor: mouse::Cursor,
         _renderer: &Renderer,
         _clipboard: &mut dyn Clipboard,
+        _ime: &dyn IME,
         _shell: &mut Shell<'_, Message>,
         _viewport: &Rectangle,
     ) -> event::Status {

examples/integration/src/main.rs

@@ -12,7 +12,7 @@ use iced_winit::core::{Color, Font, Pixels, Size};
 use iced_winit::runtime::program;
 use iced_winit::runtime::Debug;
 use iced_winit::style::Theme;
-use iced_winit::{conversion, futures, winit, Clipboard};
+use iced_winit::{conversion, futures, winit, Clipboard, IME};
 
 use winit::{
     event::{Event, ModifiersState, WindowEvent},
@@ -62,7 +62,7 @@ pub fn main() -> Result<(), Box<dyn std::error::Error>> {
     let mut cursor_position = None;
     let mut modifiers = ModifiersState::default();
     let mut clipboard = Clipboard::connect(&window);
-
+    let ime = IME::new();
     // Initialize wgpu
     #[cfg(target_arch = "wasm32")]
     let default_backend = wgpu::Backends::GL;
@@ -208,9 +208,10 @@ pub fn main() -> Result<(), Box<dyn std::error::Error>> {
                             text_color: Color::WHITE,
                         },
                         &mut clipboard,
+                        &ime,
                         &mut debug,
                     );
-
+                    ime.apply_request(&window);
                     // and request a redraw
                     window.request_redraw();
                 }

examples/loading_spinners/src/circular.rs

@@ -2,6 +2,7 @@
 use iced::advanced::layout;
 use iced::advanced::renderer;
 use iced::advanced::widget::tree::{self, Tree};
+use iced::advanced::IME;
 use iced::advanced::{Clipboard, Layout, Renderer, Shell, Widget};
 use iced::event;
 use iced::mouse;
@@ -272,6 +273,7 @@ where
         _cursor: mouse::Cursor,
         _renderer: &iced::Renderer<Theme>,
         _clipboard: &mut dyn Clipboard,
+        _ime: &dyn IME,
         shell: &mut Shell<'_, Message>,
         _viewport: &Rectangle,
     ) -> event::Status {

examples/loading_spinners/src/linear.rs

@@ -1,7 +1,7 @@
 //! Show a linear progress indicator.
-use iced::advanced::layout;
 use iced::advanced::renderer::{self, Quad};
 use iced::advanced::widget::tree::{self, Tree};
+use iced::advanced::{layout, IME};
 use iced::advanced::{Clipboard, Layout, Shell, Widget};
 use iced::event;
 use iced::mouse;
@@ -193,6 +193,7 @@ where
         _cursor: mouse::Cursor,
         _renderer: &Renderer,
         _clipboard: &mut dyn Clipboard,
+        _ime: &dyn IME,
         shell: &mut Shell<'_, Message>,
         _viewport: &Rectangle,
     ) -> event::Status {

examples/modal/src/main.rs

@@ -225,7 +225,7 @@ mod modal {
     use iced::advanced::overlay;
     use iced::advanced::renderer;
     use iced::advanced::widget::{self, Widget};
-    use iced::advanced::{self, Clipboard, Shell};
+    use iced::advanced::{self, Clipboard, Shell, IME};
     use iced::alignment::Alignment;
     use iced::event;
     use iced::mouse;
@@ -310,6 +310,7 @@ mod modal {
             cursor: mouse::Cursor,
             renderer: &Renderer,
             clipboard: &mut dyn Clipboard,
+            ime: &dyn IME,
             shell: &mut Shell<'_, Message>,
             viewport: &Rectangle,
         ) -> event::Status {
@@ -320,6 +321,7 @@ mod modal {
                 cursor,
                 renderer,
                 clipboard,
+                ime,
                 shell,
                 viewport,
             )
@@ -440,6 +442,7 @@ mod modal {
             cursor: mouse::Cursor,
             renderer: &Renderer,
             clipboard: &mut dyn Clipboard,
+            ime: &dyn IME,
             shell: &mut Shell<'_, Message>,
         ) -> event::Status {
             let content_bounds = layout.children().next().unwrap().bounds();
@@ -463,6 +466,7 @@ mod modal {
                 cursor,
                 renderer,
                 clipboard,
+                ime,
                 shell,
                 &layout.bounds(),
             )