Struct Preedit 

pub struct Preedit {
    pub text: String,
    pub cursor_range: Option<(usize, usize)>,
}

IME composition (preedit) state.

Represents the intermediate text that has been entered but not yet committed by the input method.

Fields

text: String

The composition string currently being typed.

cursor_range: Option<(usize, usize)>

Byte offset range of the cursor within the preedit text, if any. The first element is the start, the second is the end (exclusive).

Implementations

impl Preedit

pub fn new( text: impl Into<String>, cursor_range: Option<(usize, usize)>, ) -> Self

Create a new Preedit with the given text and optional cursor range.

pub fn is_empty(&self) -> bool

Returns true when there is no active composition text.

pub fn underline_segments( &self, x_start: f32, y_baseline: f32, char_width: f32, ) -> Vec<DecorationSegment>

Generate underline DecorationSegments for the preedit text.

x_start is the x-coordinate (in logical pixels) where the preedit text begins. y_baseline is the y-coordinate of the text baseline. char_width is used as an approximate advance width per character.

Returns an empty Vec when the preedit text is empty.

pub fn composition_window_rect( &self, caret_x: f32, caret_y: f32, char_width: f32, line_height: f32, ) -> (f32, f32, f32, f32)

Compute the composition window rectangle relative to the insertion caret.

Returns (x, y, width, height) in logical pixels. The width is the approximate pixel width of the preedit text; the height equals line_height.

Trait Implementations

impl Clone for Preedit

fn clone(&self) -> Preedit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Preedit

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

Formats the value using the given formatter.

impl Default for Preedit

fn default() -> Preedit

Returns the “default value” for a type.