Enum ImeEvent 

#[non_exhaustive]
pub enum ImeEvent {
    Enabled,
    Preedit {
        value: String,
        cursor: Option<(usize, usize)>,
    },
    Commit(String),
    Disabled,
}

Platform input-method events.

A composition starts with ImeEvent::Preedit, may update the preedit text several times, and ends with ImeEvent::Commit (text was accepted) or ImeEvent::Disabled (composition was cancelled). Hosts that only care about the final text can handle Commit alone; text widgets show the preedit while it lasts and write it to the model on commit.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Enabled

The input method is now active for the focused text input.

Preedit

Composition in progress. value replaces the current selection (or sits at the caret when nothing is selected) and is not committed yet.

cursor is an optional byte range inside value (cursor, selection_end), in the units winit reports. It lets the widget place the caret inside the preedit, which CJK input relies on while the composition is being converted.

Fields

value: String

cursor: Option<(usize, usize)>

Commit(String)

Final text for the current composition. It replaces the selection the composition started with, so a commit after selecting text swaps the selection rather than inserting next to it.

Disabled

The input method lost focus or the composition was cancelled.

Implementations

impl ImeEvent

pub fn is_composing(&self) -> bool

Whether this event leaves a composition visible.

Trait Implementations

impl Clone for ImeEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImeEvent

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

Formats the value using the given formatter.

impl PartialEq for ImeEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ImeEvent