[][src]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);

Text input drawn by iced_wgpu

Implementations

impl<'a, Message, Renderer: Renderer> TextInput<'a, Message, Renderer>[src]

pub fn new<F>(
    state: &'a mut State,
    placeholder: &str,
    value: &str,
    on_change: F
) -> Self where
    F: 'static + Fn(String) -> Message, 
[src]

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[src]

Converts the TextInput into a secure password input.

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

Sets the Font of the Text.

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

Sets the width of the TextInput.

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

Sets the maximum width of the TextInput.

pub fn padding(self, units: u16) -> Self[src]

Sets the padding of the TextInput.

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

Sets the text size of the TextInput.

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

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[src]

Sets the style of the TextInput.

pub fn state(&self) -> &State[src]

Returns the current State of the TextInput.

Trait Implementations

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

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

Auto Trait Implementations

impl<'a, Message, Renderer> !RefUnwindSafe for TextInput<'a, Message, Renderer>

impl<'a, Message, Renderer> !Send for TextInput<'a, Message, Renderer>

impl<'a, Message, Renderer> !Sync for TextInput<'a, Message, Renderer>

impl<'a, Message, Renderer> Unpin for TextInput<'a, Message, Renderer> where
    Message: Unpin,
    <Renderer as Renderer>::Font: Unpin,
    <Renderer as Renderer>::Style: Unpin

impl<'a, Message, Renderer> !UnwindSafe for TextInput<'a, Message, Renderer>

Blanket Implementations

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
    D: AdaptFrom<S, Swp, Dwp, T>,
    Dwp: WhitePoint,
    Swp: WhitePoint,
    T: Component + Float
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T, U> ConvertInto<U> for T where
    U: ConvertFrom<T>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,