Struct PlatformInputHandler 

pub struct PlatformInputHandler { /* private fields */ }

Connects the platform’s input method (IME) to the focused InputHandler.

GPUI creates one for the focused element while it’s focused. Each method runs the matching InputHandler method inside an update of the window. If the window has closed, the methods return None or do nothing.

Implementations

impl PlatformInputHandler

pub fn new(cx: AsyncWindowContext, handler: Box<dyn InputHandler>) -> Self

Wraps handler so the platform can call it through the window context cx.

pub fn focus_id(&self) -> Option<FocusId>

Identifies the input field registered through Window::handle_input.

This identity survives adapter replacement during repaint. Backends can use it to detect a field change without restarting the keyboard session.

pub fn selected_text_range( &mut self, ignore_disabled_input: bool, ) -> Option<UTF16Selection>

Returns the selection, in UTF-16 units, or None if the handler has no selection.

pub fn marked_text_range(&mut self) -> Option<Range<usize>>

Returns the range of composing (marked) text in UTF-16 units, or None when no text is being composed.

pub fn text_for_range( &mut self, range_utf16: Range<usize>, adjusted: &mut Option<Range<usize>>, ) -> Option<String>

Returns the document text in range_utf16, or None if the handler has none.

adjusted receives the range the handler actually used, which may differ from the request.

pub fn replace_text_in_range( &mut self, replacement_range: Option<Range<usize>>, text: &str, )

Replaces replacement_range, in UTF-16 units, with text. None replaces the selection.

pub fn replace_and_mark_text_in_range( &mut self, range_utf16: Option<Range<usize>>, new_text: &str, new_selected_range: Option<Range<usize>>, )

Replaces range_utf16 with new_text and marks the new text as composing, as an IME does while the user types. new_selected_range sets the selection inside the composing text.

pub fn unmark_text(&mut self)

Ends the composition and keeps the marked text.

pub fn paste(&mut self, item: ClipboardItem)

Pastes item at the selection through InputHandler::paste.

pub fn bounds_for_range( &mut self, range_utf16: Range<usize>, ) -> Option<Bounds<Pixels>>

Returns the screen bounds of range_utf16, in logical pixels. The platform uses these to place the IME candidate window.

pub fn selection_bounds_for_range( &mut self, range_utf16: Range<usize>, ) -> Vec<Bounds<Pixels>>

Returns selection rectangles for a range of UTF-16 code units in document order.

The platform uses these logical-pixel bounds to position selection UI. A backend may return an empty vector when selection geometry is unavailable; IME candidate placement can still use bounds_for_range. If the window has closed, this also returns an empty vector.

pub fn apple_press_and_hold_enabled(&mut self) -> bool

Returns whether macOS press-and-hold should stay enabled for this handler.

pub fn dispatch_input(&mut self, input: &str, window: &mut Window, cx: &mut App)

Replaces the selection with input, using the handler’s InputHandler::replace_text_in_range.

pub fn compute_ime_candidate_bounds( marked_range: Option<Range<usize>>, selection: &UTF16Selection, bounds_for_range: impl FnMut(Range<usize>) -> Option<Bounds<Pixels>>, ) -> Option<Bounds<Pixels>>

Returns where the IME candidate window should appear.

While text is composing, this is the start of the composing text’s visual line, found by walking back from the caret until the line changes. Otherwise it’s the caret position. bounds_for_range returns the bounds of each position it’s asked for.

pub fn selected_bounds( &mut self, window: &mut Window, cx: &mut App, ) -> Option<Bounds<Pixels>>

Returns the IME candidate position for the current selection.

pub fn ime_candidate_bounds(&mut self) -> Option<Bounds<Pixels>>

Returns the IME candidate position for the current selection, through the window context.

pub fn character_index_for_point( &mut self, point: Point<Pixels>, ) -> Option<usize>

Returns the UTF-16 index of the character at point, in window coordinates, or None if there is none.

pub fn set_selected_text_range(&mut self, range_utf16: Range<usize>)

See InputHandler::set_selected_text_range.

pub fn element_bounds(&mut self) -> Option<Bounds<Pixels>>

See InputHandler::element_bounds.

pub fn text_length_utf16(&mut self) -> Option<usize>

See InputHandler::text_length_utf16.

pub fn accepts_text_input(&mut self, window: &mut Window, cx: &mut App) -> bool

Returns whether the handler accepts text input right now.

pub fn query_accepts_text_input(&mut self) -> bool

Returns whether the handler accepts text input. Returns true if the window is gone.

pub fn query_accepts_focused_text_input(&mut self) -> bool

Checks eligibility against the current focus, including before the next frame is drawn.

Unlike the legacy acceptance query, this fails closed when the window cannot be updated and requires registration through Window::handle_input.

pub fn query_prefers_ime_for_printable_keys(&mut self) -> bool

See InputHandler::prefers_ime_for_printable_keys.

This is not a pure delegation to the handler: while a multi-stroke binding is pending this returns false regardless of the handler’s preference, because the next printable key may complete a binding whose prefix already bypassed the IME.

pub fn text_input_configuration( &mut self, window: &mut Window, cx: &mut App, ) -> TextInputConfiguration

Returns the text input configuration the handler requests.

pub fn text_input_editable_range(&mut self) -> Option<Range<usize>>

See InputHandler::text_input_editable_range.