Struct TextInput

pub struct TextInput<'a, Message, Theme = Theme, Renderer = Renderer<Renderer, Renderer>>
where
    Theme: Catalog,
    Renderer: Renderer,
{ /* private fields */ }

A field that can be filled with text.

Example

use iced::widget::text_input;

struct State {
   content: String,
}

#[derive(Debug, Clone)]
enum Message {
    ContentChanged(String)
}

fn view(state: &State) -> Element<'_, Message> {
    text_input("Type something here...", &state.content)
        .on_input(Message::ContentChanged)
        .into()
}

fn update(state: &mut State, message: Message) {
    match message {
        Message::ContentChanged(content) => {
            state.content = content;
        }
    }
}

Implementations

impl<'a, Message, Theme, Renderer> TextInput<'a, Message, Theme, Renderer>

where Message: Clone, Theme: Catalog, Renderer: Renderer,

pub fn new( placeholder: &str, value: &str, ) -> TextInput<'a, Message, Theme, Renderer>

Creates a new TextInput with the given placeholder and its current value.

pub fn id(self, id: impl Into<Id>) -> TextInput<'a, Message, Theme, Renderer>

Sets the Id of the TextInput.

pub fn secure(self, is_secure: bool) -> TextInput<'a, Message, Theme, Renderer>

Converts the TextInput into a secure password input.

pub fn on_input( self, on_input: impl Fn(String) -> Message + 'a, ) -> TextInput<'a, Message, Theme, Renderer>

Sets the message that should be produced when some text is typed into the TextInput.

If this method is not called, the TextInput will be disabled.

pub fn on_input_maybe( self, on_input: Option<impl Fn(String) -> Message + 'a>, ) -> TextInput<'a, Message, Theme, Renderer>

Sets the message that should be produced when some text is typed into the TextInput, if Some.

If None, the TextInput will be disabled.

pub fn on_submit( self, message: Message, ) -> TextInput<'a, Message, Theme, Renderer>

Sets the message that should be produced when the TextInput is focused and the enter key is pressed.

pub fn on_submit_maybe( self, on_submit: Option<Message>, ) -> TextInput<'a, Message, Theme, Renderer>

Sets the message that should be produced when the TextInput is focused and the enter key is pressed, if Some.

pub fn on_paste( self, on_paste: impl Fn(String) -> Message + 'a, ) -> TextInput<'a, Message, Theme, Renderer>

Sets the message that should be produced when some text is pasted into the TextInput.

pub fn on_paste_maybe( self, on_paste: Option<impl Fn(String) -> Message + 'a>, ) -> TextInput<'a, Message, Theme, Renderer>

Sets the message that should be produced when some text is pasted into the TextInput, if Some.

pub fn font( self, font: <Renderer as Renderer>::Font, ) -> TextInput<'a, Message, Theme, Renderer>

Sets the Font of the TextInput.

pub fn icon( self, icon: Icon<<Renderer as Renderer>::Font>, ) -> TextInput<'a, Message, Theme, Renderer>

Sets the Icon of the TextInput.

pub fn width( self, width: impl Into<Length>, ) -> TextInput<'a, Message, Theme, Renderer>

Sets the width of the TextInput.

pub fn padding<P>(self, padding: P) -> TextInput<'a, Message, Theme, Renderer>

where P: Into<Padding>,

Sets the Padding of the TextInput.

pub fn size( self, size: impl Into<Pixels>, ) -> TextInput<'a, Message, Theme, Renderer>

Sets the text size of the TextInput.

pub fn line_height( self, line_height: impl Into<LineHeight>, ) -> TextInput<'a, Message, Theme, Renderer>

Sets the text::LineHeight of the TextInput.

pub fn align_x( self, alignment: impl Into<Horizontal>, ) -> TextInput<'a, Message, Theme, Renderer>

Sets the horizontal alignment of the TextInput.

pub fn style( self, style: impl Fn(&Theme, Status) -> Style + 'a, ) -> TextInput<'a, Message, Theme, Renderer>

where <Theme as Catalog>::Class<'a>: From<Box<dyn Fn(&Theme, Status) -> Style + 'a>>,

Sets the style of the TextInput.

pub fn class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> TextInput<'a, Message, Theme, Renderer>

Sets the style class of the TextInput.

pub fn layout( &self, tree: &mut Tree, renderer: &Renderer, limits: &Limits, value: Option<&Value>, ) -> Node

Lays out the TextInput, overriding its Value if provided.

pub fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, layout: Layout<'_>, _cursor: Cursor, value: Option<&Value>, viewport: &Rectangle, )

Draws the TextInput with the given Renderer, overriding its Value if provided.

Trait Implementations

impl<'a, Message, Theme, Renderer> From<TextInput<'a, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>

where Message: Clone + 'a, Theme: Catalog + 'a, Renderer: Renderer + 'a,

fn from( text_input: TextInput<'a, Message, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<'a, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for TextInput<'a, Message, Theme, Renderer>

where Message: Clone, Theme: Catalog, Renderer: Renderer,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn diff(&self, tree: &mut Tree)

Reconciles the Widget with the provided Tree.

fn size(&self) -> Size<Length>

Returns the Size of the Widget in lengths.

fn layout(&self, tree: &mut Tree, renderer: &Renderer, limits: &Limits) -> Node

Returns the layout::Node of the Widget.

fn operate( &self, tree: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, operation: &mut dyn Operation, )

Applies an Operation to the Widget.

fn update( &mut self, tree: &mut Tree, event: Event, layout: Layout<'_>, cursor: Cursor, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, _viewport: &Rectangle, )

Processes a runtime Event.

fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, _style: &Style, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

fn mouse_interaction( &self, _state: &Tree, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.

fn children(&self) -> Vec<Tree>

Returns the state Tree of the children of the Widget.

fn overlay<'a>( &'a mut self, _state: &'a mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>

Returns the overlay of the Widget, if there is any.