Struct ElementInputHandler 

pub struct ElementInputHandler<V> { /* private fields */ }

Connects an EntityInputHandler view to the platform’s text input.

This is the usual way to install an EntityInputHandler. It implements InputHandler by forwarding each call to the view, with the element’s bounds filled in for the methods that need them. Create one during paint and pass it to Window::handle_input. The handler is active for the next frame only, so install it again on every paint.

Implementations

impl<V: 'static> ElementInputHandler<V>

pub fn new(element_bounds: Bounds<Pixels>, view: Entity<V>) -> Self

Creates a handler that forwards platform text input to view.

Pass the bounds of the element that is painting. They are returned from InputHandler::element_bounds and passed to EntityInputHandler::bounds_for_range. Call this in Element::paint, then pass the handler to Window::handle_input. The window installs the handler only while the given focus handle is focused.

Trait Implementations

impl<V: EntityInputHandler> InputHandler for ElementInputHandler<V>

fn selected_text_range( &mut self, ignore_disabled_input: bool, window: &mut Window, cx: &mut App, ) -> Option<UTF16Selection>

Get the range of the user’s currently selected text, if any Corresponds to selectedRange()

fn marked_text_range( &mut self, window: &mut Window, cx: &mut App, ) -> Option<Range<usize>>

Get the range of the currently marked text, if any Corresponds to markedRange()

fn text_for_range( &mut self, range_utf16: Range<usize>, adjusted_range: &mut Option<Range<usize>>, window: &mut Window, cx: &mut App, ) -> Option<String>

Get the text for the given document range in UTF-16 characters Corresponds to attributedSubstring(forProposedRange: actualRange:)

fn replace_text_in_range( &mut self, replacement_range: Option<Range<usize>>, text: &str, window: &mut Window, cx: &mut App, )

Replace the text in the given document range with the given text Corresponds to insertText(_:replacementRange:)

fn replace_and_mark_text_in_range( &mut self, range_utf16: Option<Range<usize>>, new_text: &str, new_selected_range: Option<Range<usize>>, window: &mut Window, cx: &mut App, )

Replace the text in the given document range with the given text, and mark the given text as part of an IME ‘composing’ state Corresponds to setMarkedText(_:selectedRange:replacementRange:)

fn unmark_text(&mut self, window: &mut Window, cx: &mut App)

Remove the IME ‘composing’ state from the document Corresponds to unmarkText()

fn paste(&mut self, item: ClipboardItem, window: &mut Window, cx: &mut App)

Insert a platform-initiated paste at the current selection.

fn bounds_for_range( &mut self, range_utf16: Range<usize>, window: &mut Window, cx: &mut App, ) -> Option<Bounds<Pixels>>

Get the bounds of the given document range in window coordinates. Corresponds to firstRect(forCharacterRange:actualRange:)

fn selection_bounds_for_range( &mut self, range_utf16: Range<usize>, window: &mut Window, cx: &mut App, ) -> Vec<Bounds<Pixels>>

Returns selection rectangles in document order, in window coordinates.

fn character_index_for_point( &mut self, point: Point<Pixels>, window: &mut Window, cx: &mut App, ) -> Option<usize>

Get the character offset for the given point in terms of UTF16 characters

fn set_selected_text_range( &mut self, range_utf16: Range<usize>, window: &mut Window, cx: &mut App, )

Set the range of the user’s currently selected text.

fn element_bounds( &mut self, _window: &mut Window, _cx: &mut App, ) -> Option<Bounds<Pixels>>

Get the bounds of the focused text element in window coordinates, if known.

fn text_length_utf16( &mut self, window: &mut Window, cx: &mut App, ) -> Option<usize>

Get the length of the document in UTF-16 characters, if known.

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

Returns whether this handler is accepting text input to be inserted.

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

Returns whether printable keys should be routed to the IME before keybinding matching when a non-ASCII input source (e.g. Japanese, Korean, Chinese IME) is active. This prevents multi-stroke keybindings like jj from intercepting keys that the IME should compose.

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

Get this handler’s preferences for platform text assistance.

fn text_input_editable_range( &mut self, window: &mut Window, cx: &mut App, ) -> Option<Range<usize>>

The contiguous range of text, in UTF-16 code units, that platform text input may read and edit around the current selection.

fn apple_press_and_hold_enabled(&mut self) -> bool

Allows a given input context to opt into getting raw key repeats instead of sending these to the platform. TODO: Ideally we should be able to set ApplePressAndHoldEnabled in NSUserDefaults (which is how iTerm does it) but it doesn’t seem to work for me.