Struct TextInput 

pub struct TextInput { /* private fields */ }

One line of editable text.

The field owns the caret, the selection, and any composition in flight; the committed text belongs to the caller, which is why a host that refuses a change simply does not apply it and the field keeps showing what is true. A secret field publishes its shape and never its content.

Implementations

impl TextInput

pub fn new( ident: impl Into<Ident>, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

pub fn placeholder(self, placeholder: impl Into<SharedString>) -> Self

pub fn name(self, name: impl Into<SharedString>) -> Self

Names the field for a reader without drawing anything. Use it when a surrounding control carries the visible label.

pub fn set_name( &mut self, name: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

Names the field after it has been built.

pub fn text(self, text: impl Into<SharedString>) -> Self

Seeds the initial text, with the caret at the end.

pub fn invalid(self, invalid: bool) -> Self

pub fn required(self, required: bool) -> Self

pub fn read_only(self, read_only: bool) -> Self

Keeps the value focusable and selectable while refusing editing, IME, and accessibility value changes.

pub fn secret(self, secret: bool) -> Self

Renders as dots and keeps the text out of every snapshot and export.

pub fn bare(self, bare: bool) -> Self

Drops the input’s own border and background.

For a control that composes the input with something else — a step button, a token list — and draws one crate::controls::field::field_shell around the lot, so a composed field is not two nested frames.

pub fn max_length(self, max_length: usize) -> Self

Refuses input past a length in bytes of UTF-8.

pub fn value(&self) -> &SharedString

pub fn is_empty(&self) -> bool

pub fn set_value( &mut self, value: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

Replaces the text from the host side, for example when a form resets.

pub fn set_placeholder( &mut self, placeholder: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

pub fn set_text_quietly( &mut self, value: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

Replaces the text without reporting a change.

For a composing control that is putting its owner’s value on screen: nobody asked for that text, so reporting it as an edit would send the host a change it made itself.

pub fn set_disabled(&mut self, disabled: bool, cx: &mut Context<'_, Self>)

pub fn set_read_only(&mut self, read_only: bool, cx: &mut Context<'_, Self>)

pub fn set_invalid(&mut self, invalid: bool, cx: &mut Context<'_, Self>)

pub fn is_disabled(&self) -> bool

pub fn is_secret(&self) -> bool

pub fn selected_range(&self) -> Range<usize>

pub fn cursor_offset(&self) -> usize

Trait Implementations

impl Debug for TextInput

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

Formats the value using the given formatter.

impl Disableable for TextInput

fn disabled(self, disabled: bool) -> Self

impl EntityInputHandler for TextInput

fn text_for_range( &mut self, range_utf16: Range<usize>, actual_range: &mut Option<Range<usize>>, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<String>

See InputHandler::text_for_range for details

fn selected_text_range( &mut self, _ignore_disabled_input: bool, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<UTF16Selection>

See InputHandler::selected_text_range for details

fn marked_text_range( &self, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<Range<usize>>

See InputHandler::marked_text_range for details

fn unmark_text(&mut self, _window: &mut Window, _cx: &mut Context<'_, Self>)

See InputHandler::unmark_text for details

fn replace_text_in_range( &mut self, range_utf16: Option<Range<usize>>, new_text: &str, _window: &mut Window, cx: &mut Context<'_, Self>, )

See InputHandler::replace_text_in_range for details

fn replace_and_mark_text_in_range( &mut self, range_utf16: Option<Range<usize>>, new_text: &str, new_selected_range_utf16: Option<Range<usize>>, _window: &mut Window, cx: &mut Context<'_, Self>, )

See InputHandler::replace_and_mark_text_in_range for details

fn bounds_for_range( &mut self, range_utf16: Range<usize>, bounds: Bounds<Pixels>, _window: &mut Window, cx: &mut Context<'_, Self>, ) -> Option<Bounds<Pixels>>

See InputHandler::bounds_for_range for details

fn character_index_for_point( &mut self, point: Point<Pixels>, _window: &mut Window, cx: &mut Context<'_, Self>, ) -> Option<usize>

See InputHandler::character_index_for_point for details

fn set_selected_text_range( &mut self, _range_utf16: Range<usize>, _window: &mut Window, _cx: &mut Context<'_, Self>, )

See InputHandler::set_selected_text_range for details

fn text_length_utf16( &mut self, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<usize>

See InputHandler::text_length_utf16 for details

fn accepts_text_input( &self, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> bool

See InputHandler::accepts_text_input for details

impl EventEmitter<TextInputEvent> for TextInput

impl Focusable for TextInput

fn focus_handle(&self, _cx: &App) -> FocusHandle

Returns the focus handle associated with this view.

impl Render for TextInput

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.

impl Sizable for TextInput

fn control_size(self, size: ControlSize) -> Self

fn xs(self) -> Self

fn small(self) -> Self

fn medium(self) -> Self

fn large(self) -> Self