Struct TextInput 

pub struct TextInput<T: ClipboardProvider> { /* private fields */ }

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

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 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 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 fn selection_end_offset(&self) -> Utf8CodeUnitLength

The byte offset of the selection_end()

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, )

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 fn handle_keydown_aux( &mut self, key: Key, mods: Modifiers, macos: bool, ) -> KeyReaction

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, )

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.