logo
pub struct TextInput<'a, Message, Renderer> where
    Renderer: Renderer,
    Renderer::Theme: StyleSheet
{ /* private fields */ }
Expand description

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);

Text input drawn by iced_wgpu

Implementations

Creates a new TextInput.

It expects:

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

Sets the Id of the TextInput.

Converts the TextInput into a secure password input.

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

Sets the Font of the TextInput.

Sets the width of the TextInput.

Sets the Padding of the TextInput.

Sets the text size of the TextInput.

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

Sets the style of the TextInput.

Draws the TextInput with the given Renderer, overriding its [text_input::Value] if provided.

Trait Implementations

Converts to this type from the input type.

Returns the Tag of the Widget. Read more

Returns the State of the Widget. Read more

Returns the width of the Widget.

Returns the height of the Widget.

Returns the layout::Node of the Widget. Read more

Applies an Operation to the Widget.

Processes a runtime Event. Read more

Draws the Widget using the associated Renderer.

Returns the current mouse::Interaction of the Widget. Read more

Returns the state Tree of the children of the Widget.

Reconciliates the Widget with the provided Tree.

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

Auto Trait Implementations

Blanket Implementations

Convert the source color to the destination color using the specified method Read more

Convert the source color to the destination color using the bradford method by default Read more

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Convert into T with values clamped to the color defined bounds Read more

Convert into T. The resulting color might be invalid in its color space Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more