Struct TextInput 

pub struct TextInput { /* private fields */ }

A single line of editable text. Reports ActionKind::Changed after every edit and ActionKind::Submitted on Enter.

Clicks place the caret (two select a word, three everything), dragging selects, the arrow keys and Home/End move (with Shift: select; with Ctrl, or Cmd on macOS: by word), Backspace and Delete remove characters or words, and input methods compose in place.

Implementations

impl TextInput

pub fn new(text: impl Into<String>) -> Self

An input holding text.

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

The input showing placeholder, dimmed, while it is empty.

pub fn text(&self) -> &str

The text.

pub fn set_text( &mut self, cx: &mut EventCx<'_>, text: impl Into<String>, ) -> Result<(), ParagraphError>

Replaces the text, the caret at its end.

Errors

ParagraphError::UnreadableFont if a font for text cannot be read; nothing changes.

Trait Implementations

impl Debug for TextInput

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

Formats the value using the given formatter.

impl Widget for TextInput

fn accessibility(&self, _: &PaintCx<'_>, node: &mut AccessNode)

Describes the widget to assistive technology: fills node, which starts as a Role::Group with the widget’s rectangle. Called only while assistive technology is listening; it may allocate.

fn access_action( &mut self, cx: &mut EventCx<'_>, request: &AccessRequest<'_>, ) -> Handled

Does what assistive technology asks (only actions the widget’s node lists are asked of it). Focus and scrolling into view are done for every widget; a request the widget does not handle goes on to its parent if it is a scroll.

fn measure(&mut self, cx: &mut LayoutCx<'_>, _: Constraints) -> Size

The size the widget wants within constraints, for a widget without children (one with children is sized by its style and its children). Physical pixels.

fn layout(&mut self, cx: &mut LayoutCx<'_>, size: Size)

Layout decided the widget’s size: re-wrap text or recompute anything that depends on it. Called after every layout pass that changed the size.

fn paint(&mut self, cx: &PaintCx<'_>, canvas: &mut Canvas<'_>)

Paints the widget below its children.

fn event(&mut self, cx: &mut EventCx<'_>, event: &Event<'_>) -> Handled

Handles event. An event the widget does not handle goes on to its parent.

fn accepts_focus(&self) -> bool

Whether the widget takes keyboard focus, by click or by Tab.

fn paint_over(&mut self, cx: &PaintCx<'_>, canvas: &mut Canvas<'_>)

Paints the widget over its children: scroll bars, focus rings, overlays.

fn focus_on_press(&self) -> bool

Whether a press on the widget, or on a widget inside it that takes no focus, focuses it (if it accepts focus). A container reachable by Tab, such as a dock’s tab list, says no, so clicks on its contents do not focus it; it can still ask for focus itself.