Struct iced_pure::widget::text_input::TextInput

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

A field that can be filled with text.

Example

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

let value = "Some text";

let input = TextInput::new(
    "This is the placeholder...",
    value,
    Message::TextInputChanged,
)
.padding(10);

Implementations

impl<'a, Message, Renderer> TextInput<'a, Message, Renderer> where
    Message: Clone,
    Renderer: Renderer, 

pub fn new<F>(placeholder: &str, value: &str, on_change: F) -> Self where
    F: 'a + Fn(String) -> Message, 

Creates a new TextInput.

It expects:

• a placeholder,
• the current value, and
• a function that produces a message when the TextInput changes.

pub fn password(self) -> Self

Converts the TextInput into a secure password input.

pub fn font(self, font: Renderer::Font) -> Self

Sets the Font of the TextInput.

pub fn width(self, width: Length) -> Self

Sets the width of the TextInput.

pub fn padding<P: Into<Padding>>(self, padding: P) -> Self

Sets the [Padding] of the TextInput.

pub fn size(self, size: u16) -> Self

Sets the text size of the TextInput.

pub fn on_submit(self, message: Message) -> Self

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

pub fn style(self, style_sheet: impl Into<Box<dyn StyleSheet + 'a>>) -> Self

Sets the style of the TextInput.

Trait Implementations

impl<'a, Message, Renderer> From<TextInput<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
    Message: 'a + Clone,
    Renderer: 'a + Renderer, 

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

Converts to this type from the input type.

impl<'a, Message, Renderer> Widget<Message, Renderer> for TextInput<'a, Message, Renderer> where
    Message: Clone,
    Renderer: Renderer, 

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn width(&self) -> Length

Returns the width of the Widget.

fn height(&self) -> Length

Returns the height of the Widget.

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

Returns the layout::Node of the Widget.

fn on_event(
    &mut self,
    tree: &mut Tree,
    event: Event,
    layout: Layout<'_>,
    cursor_position: Point,
    renderer: &Renderer,
    clipboard: &mut dyn Clipboard,
    shell: &mut Shell<'_, Message>
) -> Status

Processes a runtime Event.

fn draw(
    &self,
    tree: &Tree,
    renderer: &mut Renderer,
    _style: &Style,
    layout: Layout<'_>,
    cursor_position: Point,
    _viewport: &Rectangle
)

Draws the Widget using the associated Renderer.

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

Returns the current [mouse::Interaction] of the Widget.

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

Returns the state Tree of the children of the Widget.

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

Reconciliates the Widget with the provided Tree.

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

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