Struct iced_native::widget::text_input::TextInput

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

A field that can be filled with text.

Example

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

let mut state = text_input::State::new();
let value = "Some text";

let input = TextInput::new(
    &mut state,
    "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>(
    state: &'a mut State,
    placeholder: &str,
    value: &str,
    on_change: F
) -> Self where
    F: 'static + Fn(String) -> Message, 

Creates a new TextInput.

It expects:

• some State
• a placeholder
• the current value
• 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 Text.

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

Sets the width of the TextInput.

pub fn max_width(self, max_width: u32) -> Self

Sets the maximum width of the TextInput.

pub fn padding(self, units: u16) -> 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: impl Into<Renderer::Style>) -> Self

Sets the style of the TextInput.

pub fn state(&self) -> &State

Returns the current State of the TextInput.

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

pub fn draw(
    &self,
    renderer: &mut Renderer,
    layout: Layout<'_>,
    cursor_position: Point,
    value: Option<&Value>
) -> Renderer::Output

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

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>

Performs the conversion.

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

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 Node of the Widget.

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

Processes a runtime Event.

fn draw(
    &self,
    renderer: &mut Renderer,
    _defaults: &Renderer::Defaults,
    layout: Layout<'_>,
    cursor_position: Point,
    _viewport: &Rectangle
) -> Renderer::Output

Draws the Widget using the associated Renderer.

fn hash_layout(&self, state: &mut Hasher)

Computes the layout hash of the Widget.

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

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