Skip to main content

CompositionEventData

Struct CompositionEventData 

Source
pub struct CompositionEventData {
    pub data: String,
    pub cursor_begin: usize,
    pub cursor_end: usize,
    pub seat_id: u64,
}
Expand description

Data carried by the three IME composition events.

Every desktop shell already runs a real IME client — Win32 WM_IME_* with candidate-window positioning, macOS NSTextInputClient, Wayland zwp_text_input_v3 preedit/commit, X11 XIM plus the xkb Compose layer — and all of it terminated in the engine’s text cache. The built-in text widgets therefore worked, but an app rendering its own composition (a code editor, a terminal, a chat box with inline candidates) had no way to see it, because the Composition* filters had no event to carry.

The shape is the intersection of what the platforms report, which is also what W3C CompositionEvent and Wayland preedit_string agree on.

Fields§

§data: String

The preedit (composition) text as it currently stands. Empty on CompositionStart, and on CompositionEnd this is the committed string — W3C defines compositionend.data as what was committed, not what was pending.

§cursor_begin: usize

Byte offset of the selection/caret start within data. Wayland sends this directly (preedit_string(text, cursor_begin, cursor_end)); Win32 derives it from GCS_CURSORPOS; macOS from the selectedRange passed to setMarkedText:selectedRange:replacementRange:.

§cursor_end: usize

Byte offset of the selection/caret end within data. Equal to cursor_begin for a collapsed caret.

§seat_id: u64

The SEAT whose input method this is (9b-ii-a-i-d-ii-c-i); the primary is PRIMARY_POINTER_SEAT. The Focus filter delivers a seat’s composition to that seat’s focused node.

Trait Implementations§

Source§

impl Clone for CompositionEventData

Source§

fn clone(&self) -> CompositionEventData

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CompositionEventData

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for CompositionEventData

Source§

impl PartialEq for CompositionEventData

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CompositionEventData

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

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

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.