Struct TextInput 

pub struct TextInput<T: ClipboardProvider> {
    rope: Rope,
    mode: Lines,
    edit_point: RopeIndex,
    selection_origin: Option<RopeIndex>,
    selection_direction: SelectionDirection,
    clipboard_provider: T,
    max_length: Option<Utf16CodeUnitLength>,
    min_length: Option<Utf16CodeUnitLength>,
    was_last_change_by_set_content: bool,
    currently_dragging: bool,
}

Encapsulated state for handling keyboard input in a single or multiline text input control.

Fields

rope: Rope

mode: Lines

The type of TextInput this is. When in multi-line mode, the TextInput will automatically split all inserted text into lines and incorporate them into the Self::rope. When in single line mode, the inserted text will be stripped of newlines.

edit_point: RopeIndex

Current cursor input point

selection_origin: Option<RopeIndex>

The current selection goes from the selection_origin until the edit_point. Note that the selection_origin may be after the edit_point, in the case of a backward selection.

selection_direction: SelectionDirection

clipboard_provider: T

max_length: Option<Utf16CodeUnitLength>

The maximum number of UTF-16 code units this text input is allowed to hold.

https://html.spec.whatwg.org/multipage/#attr-fe-maxlength

min_length: Option<Utf16CodeUnitLength>

was_last_change_by_set_content: bool

Was last change made by set_content?

currently_dragging: bool

Whether or not we are currently dragging in this TextInput.

Implementations

impl<T: ClipboardProvider> TextInput<T>

pub fn new( lines: Lines, initial: DOMString, clipboard_provider: T, ) -> TextInput<T>

Instantiate a new text input control

pub fn edit_point(&self) -> RopeIndex

pub fn selection_origin(&self) -> Option<RopeIndex>

pub fn selection_origin_or_edit_point(&self) -> RopeIndex

The selection origin, or the edit point if there is no selection. Note that the selection origin may be after the edit point, in the case of a backward selection.

pub fn selection_direction(&self) -> SelectionDirection

pub fn set_max_length(&mut self, length: Option<Utf16CodeUnitLength>)

pub fn set_min_length(&mut self, length: Option<Utf16CodeUnitLength>)

pub(crate) fn was_last_change_by_set_content(&self) -> bool

Was last edit made by set_content?

pub fn delete_char(&mut self, direction: Direction) -> bool

Remove a character at the current editing point

Returns true if any character was deleted

pub fn insert<S: Into<String>>(&mut self, string: S)

Insert a string at the current editing point or replace the selection if one exists.

pub fn selection_start(&self) -> RopeIndex

The start of the selection (or the edit point, if there is no selection). Always less than or equal to selection_end(), regardless of the selection direction.

pub(crate) fn selection_start_utf16(&self) -> Utf16CodeUnitLength

fn selection_start_offset(&self) -> Utf8CodeUnitLength

The byte offset of the selection_start()

pub fn selection_end(&self) -> RopeIndex

The end of the selection (or the edit point, if there is no selection). Always greater than or equal to selection_start(), regardless of the selection direction.

pub(crate) fn selection_end_utf16(&self) -> Utf16CodeUnitLength

pub fn selection_end_offset(&self) -> Utf8CodeUnitLength

The byte offset of the selection_end()

pub(crate) fn has_uncollapsed_selection(&self) -> bool

Whether or not there is an active uncollapsed selection. This means that the selection origin is set and it differs from the edit point.

pub(crate) fn sorted_selection_offsets_range(&self) -> Range<Utf8CodeUnitLength>

Return the selection range as byte offsets from the start of the content.

If there is no selection, returns an empty range at the edit point.

pub(crate) fn sorted_selection_character_offsets_range(&self) -> Range<usize>

Return the selection range as character offsets from the start of the content.

If there is no selection, returns an empty range at the edit point.

pub(crate) fn selection_state(&self) -> SelectionState

The state of the current selection. Can be used to compare whether selection state has changed.

fn assert_ok_selection(&self)

fn selection_slice(&self) -> RopeSlice<'_>

pub(crate) fn get_selection_text(&self) -> Option<String>

fn selection_utf16_len(&self) -> Utf16CodeUnitLength

The length of the selected text in UTF-16 code units.

pub fn replace_selection(&mut self, insert: &DOMString)

Replace the current selection with the given DOMString. If the Rope is in single line mode this will strip newlines, as opposed to Self::set_content, which does not.

pub fn modify_edit_point(&mut self, amount: isize, movement: RopeMovement)

pub fn modify_selection(&mut self, amount: isize, movement: RopeMovement)

pub fn modify_selection_or_edit_point( &mut self, amount: isize, movement: RopeMovement, select: Selection, )

fn update_selection_direction(&mut self)

Update the field selection_direction.

When the edit_point (or focus) is before the selection_origin (or anchor) you have a backward selection. Otherwise you have a forward selection.

pub fn handle_return(&mut self) -> KeyReaction

Deal with a newline input.

pub fn select_all(&mut self)

Select all text in the input control.

pub fn clear_selection(&mut self)

Remove the current selection.

pub(crate) fn clear_selection_to_end(&mut self)

Remove the current selection and set the edit point to the end of the content.

pub(crate) fn clear_selection_to_start(&mut self)

pub(crate) fn handle_keydown(&mut self, event: &KeyboardEvent) -> KeyReaction

Process a given KeyboardEvent and return an action for the caller to execute.

pub fn handle_keydown_aux( &mut self, key: Key, mods: Modifiers, macos: bool, ) -> KeyReaction

pub(crate) fn handle_compositionend( &mut self, event: &CompositionEvent, ) -> KeyReaction

pub(crate) fn handle_compositionupdate( &mut self, event: &CompositionEvent, ) -> KeyReaction

fn edit_point_for_mouse_event( &self, node: &Node, event: &MouseEvent, ) -> RopeIndex

pub(crate) fn handle_mouse_event( &mut self, node: &Node, mouse_event: &MouseEvent, ) -> bool

Handle a mouse even that has happened in this TextInput. Returns true if the selection in the input may have changed and false otherwise.

fn handle_mousedown(&mut self, node: &Node, mouse_event: &MouseEvent) -> bool

Handle a “mousedown” event that happened on this TextInput, belonging to the given Node.

Returns true if the TextInput changed at all or false otherwise.

pub(crate) fn is_empty(&self) -> bool

Whether the content is empty.

pub(crate) fn len_utf16(&self) -> Utf16CodeUnitLength

The total number of code units required to encode the content in utf16.

pub fn get_content(&self) -> DOMString

Get the current contents of the text input. Multiple lines are joined by \n.

pub fn set_content(&mut self, content: DOMString)

Set the current contents of the text input. If this is control supports multiple lines, any \n encountered will be stripped and force a new logical line.

Note that when the Rope is in single line mode, this will not strip newlines. Newline stripping only happens for incremental updates to the Rope as <input> elements currently need to store unsanitized values while being created.

pub fn set_selection_range_utf16( &mut self, start: Utf16CodeUnitLength, end: Utf16CodeUnitLength, direction: SelectionDirection, )

pub fn set_selection_range_utf8( &mut self, start: Utf8CodeUnitLength, end: Utf8CodeUnitLength, direction: SelectionDirection, )

pub(crate) fn handle_clipboard_event( &mut self, clipboard_event: &ClipboardEvent, ) -> ClipboardEventReaction

This implements step 3 onward from:

• https://www.w3.org/TR/clipboard-apis/#copy-action
• https://www.w3.org/TR/clipboard-apis/#cut-action
• https://www.w3.org/TR/clipboard-apis/#paste-action

Earlier steps should have already been run by the callers.

pub(crate) fn queue_input_event( &self, target: &EventTarget, data: Option<String>, is_composing: IsComposing, input_type: InputType, )

https://w3c.github.io/uievents/#event-type-input

Trait Implementations

impl<T> MallocSizeOf for TextInput<T>

where T: MallocSizeOf + ClipboardProvider,

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl<T> Traceable for TextInput<T>

where T: JSTraceable + ClipboardProvider,

unsafe fn trace(&self, tracer: *mut JSTracer)

Trace self.