Enum Ime

pub enum Ime {
    Enabled,
    Preedit(String, Option<(usize, usize)>),
    Commit(String),
    DeleteSurrounding {
        before_bytes: usize,
        after_bytes: usize,
    },
    Disabled,
}

Expand description

Describes input method events.

The Ime events must be applied in the order they arrive.

This is also called a “composition event”.

Most keypresses using a latin-like keyboard layout simply generate a WindowEvent::KeyboardInput. However, one couldn’t possibly have a key for every single unicode character that the user might want to type

so the solution operating systems employ is to allow the user to type these using a sequence of keypresses instead.

A prominent example of this is accents - many keyboard layouts allow you to first click the “accent key”, and then the character you want to apply the accent to. In this case, some platforms will generate the following event sequence:

// Press "`" key
Ime::Preedit("`", Some((0, 0)))
// Press "E" key
Ime::Preedit("", None) // Synthetic event generated by winit to clear preedit.
Ime::Commit("é")

Additionally, certain input devices are configured to display a candidate box that allow the user to select the desired character interactively. (To properly position this box, you must use [Window::set_ime_cursor_area].)

An example of a keyboard layout which uses candidate boxes is pinyin. On a latin keyboard the following event sequence could be obtained:

// Press "A" key
Ime::Preedit("a", Some((1, 1)))
// Press "B" key
Ime::Preedit("a b", Some((3, 3)))
// Press left arrow key
Ime::Preedit("a b", Some((1, 1)))
// Press space key
Ime::Preedit("啊b", Some((3, 3)))
// Press space key
Ime::Preedit("", None) // Synthetic event generated by winit to clear preedit.
Ime::Commit("啊不")

Variants§

§

Enabled

Notifies when the IME was enabled.

After getting this event you could receive Preedit and Commit events. You should also start performing IME related requests like [Window::set_ime_cursor_area].

§

Preedit(String, Option<(usize, usize)>)

Notifies when a new composing text should be set at the cursor position.

The value represents a pair of the preedit string and the cursor begin position and end position. When it’s None, the cursor should be hidden. When String is an empty string this indicates that preedit was cleared.

The cursor position is byte-wise indexed, assuming UTF-8.

§

Commit(String)

Notifies when text should be inserted into the editor widget.

Right before this event winit will send empty Self::Preedit event.

§

DeleteSurrounding

Delete text surrounding the cursor or selection.

This event does not affect either the pre-edit string. This means that the application must first remove the pre-edit, then execute the deletion, then insert the removed text back.

This event assumes text is stored in UTF-8.

Fields

§before_bytes: usize

Bytes to remove before the selection

§after_bytes: usize

Bytes to remove after the selection

§

Disabled

Notifies when the IME was disabled.

After receiving this event you won’t get any more Preedit or Commit events until the next Enabled event. You should also stop issuing IME related requests like [Window::set_ime_cursor_area] and clear pending preedit text.

Trait Implementations§

§

impl Clone for Ime

§

fn clone(&self) -> Ime

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

§

impl Debug for Ime

§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

§

impl<'de> Deserialize<'de> for Ime

§

fn deserialize<D>( deserializer: D, ) -> Result<Ime, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

§

impl Hash for Ime

§

fn hash<H>(&self, state: &mut H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

§

impl PartialEq for Ime

§

fn eq(&self, other: &Ime) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

§

impl Serialize for Ime

§

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

§

impl Eq for Ime

§

impl StructuralPartialEq for Ime

Auto Trait Implementations§

§

Ime

Enum Ime Copy item path

Variants§

Enabled

Preedit(String, Option<(usize, usize)>)

Commit(String)

DeleteSurrounding

Fields

Disabled

Trait Implementations§

impl Clone for Ime

fn clone(&self) -> Ime

fn clone_from(&mut self, source: &Self)

impl Debug for Ime

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

impl<'de> Deserialize<'de> for Ime

fn deserialize<__D>( __deserializer: __D, ) -> Result<Ime, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

impl Hash for Ime

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

impl PartialEq for Ime

fn eq(&self, other: &Ime) -> bool

fn ne(&self, other: &Rhs) -> bool

impl Serialize for Ime

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

impl Eq for Ime

impl StructuralPartialEq for Ime

Auto Trait Implementations§

impl Freeze for Ime

impl RefUnwindSafe for Ime

impl Send for Ime

impl Sync for Ime

impl Unpin for Ime

impl UnwindSafe for Ime

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> Downcast for Twhere T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,

Enum Ime

fn deserialize<D>( deserializer: D, ) -> Result<Ime, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

fn hash<H>(&self, state: &mut H)
where __H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T> Downcast for T
where T: Any,

impl<T> DowncastSync for T
where T: Any + Send + Sync,

impl<T, U> Into<U> for T
where U: From<T>,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,