Enum ImeEvent

#[non_exhaustive]
pub enum ImeEvent {
    Enabled,
    Preedit {
        preedit: ImePreedit,
        pos: Option<Point>,
    },
    Commit {
        text: String,
    },
    End,
    Disabled,
}

Input Method Editor events for CJK and similar input.

Possible values cover enabled, preedit, commit, end, and disabled phases.

Examples

use ailloli_ui_core::event::ImeEvent;
assert_eq!(ImeEvent::commit("文").committed_text(), Some("文"));

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 platform enabled text composition for the focused input.

Preedit

Composition started or updated.

Fields

preedit: ImePreedit

Current validated composition payload.

pos: Option<Point>

Associated cursor position in logical window coordinates when available.

Commit

Final committed text.

Fields

text: String

UTF-8 text to insert; an empty commit is preserved.

End

Composition ended or cleared.

Disabled

The platform disabled text composition for the focused input.

Implementations

impl ImeEvent

pub const fn enabled() -> Self

Creates an IME-enabled notification.

Examples

use ailloli_ui_core::event::ImeEvent;
assert!(matches!(ImeEvent::enabled(), ImeEvent::Enabled));

pub const fn preedit(preedit: ImePreedit, pos: Option<Point>) -> Self

Creates a preedit update from an already constructed payload.

This const constructor does not call ImePreedit::validate; use Self::try_preedit for untrusted provider indices.

Examples

use ailloli_ui_core::event::{ImeEvent, ImePreedit};
assert!(ImeEvent::preedit(ImePreedit::new("文"), None).as_preedit().is_some());

pub fn try_preedit( text: impl Into<String>, selection: Option<(usize, usize)>, pos: Option<Point>, ) -> Result<Self, ImePreeditError>

Validates and creates a preedit update from raw UTF-8 byte indices.

Errors

Returns ImePreeditError for an invalid selection range.

Examples

use ailloli_ui_core::event::ImeEvent;
let event = ImeEvent::try_preedit("é", Some((0, 2)), None)?;
assert_eq!(event.as_preedit().unwrap().0.text(), "é");

pub fn commit(text: impl Into<String>) -> Self

Creates a committed-text event.

Examples

use ailloli_ui_core::event::ImeEvent;
assert_eq!(ImeEvent::commit("文").committed_text(), Some("文"));

pub const fn end() -> Self

Creates the legacy composition-end notification.

Examples

use ailloli_ui_core::event::ImeEvent;
assert!(matches!(ImeEvent::end(), ImeEvent::End));

pub const fn disabled() -> Self

Creates an IME-disabled notification.

Examples

use ailloli_ui_core::event::ImeEvent;
assert!(matches!(ImeEvent::disabled(), ImeEvent::Disabled));

pub const fn as_preedit(&self) -> Option<(&ImePreedit, Option<Point>)>

Returns the preedit payload and provider position, when applicable.

Examples

use ailloli_ui_core::{event::{ImeEvent, ImePreedit}, Point};
let event = ImeEvent::preedit(ImePreedit::new("文"), Some(Point::new(1.0, 2.0)));
assert_eq!(event.as_preedit().unwrap().1, Some(Point::new(1.0, 2.0)));

pub fn committed_text(&self) -> Option<&str>

Returns committed text when this is a commit event.

Examples

use ailloli_ui_core::event::ImeEvent;
assert_eq!(ImeEvent::enabled().committed_text(), None);

Trait Implementations

impl Clone for ImeEvent

fn clone(&self) -> ImeEvent

Returns a copy 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: &ImeEvent) -> bool

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

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 StructuralPartialEq for ImeEvent