Struct TypedInput 

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

A field that can only be filled with a specific type.

Example

#[derive(Debug, Clone)]
enum Message {
    TypedInputChanged(u32),
}

let value = 12;

let input = TypedInput::new(
    value,
    Message::TypedInputChanged,
);

Implementations

impl<'a, T, Message, Theme, Renderer> TypedInput<'a, T, Message, Theme, Renderer>

where T: Display + FromStr, Message: Clone, Renderer: Renderer, Theme: Catalog,

pub fn new(placeholder: &str, value: &T) -> Self

where T: 'a + Clone,

Creates a new TypedInput.

It expects:

• the current value
• a function that produces a message when the TypedInput changes

pub fn id(self, id: impl Into<Id>) -> Self

Sets the Id of the internal TextInput

pub fn secure(self, is_secure: bool) -> Self

Convert the TypedInput into a secure password input

pub fn on_input<F>(self, callback: F) -> Self

where F: 'a + Fn(T) -> Message,

Sets the message that should be produced when some valid text is typed into TypedInput

If neither this method nor on_submit is called, the TypedInput will be disabled

pub fn on_input_maybe<F>(self, callback: Option<F>) -> Self

where F: 'a + Fn(T) -> Message,

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

If this is None, and there is no on_submit callback, the TypedInput will be disabled.

pub fn on_submit<F>(self, callback: F) -> Self

where F: 'a + Fn(Result<T, String>) -> Message,

Sets the message that should be produced when the [TypedtInput] is focused and the enter key is pressed.

If neither this method nor on_input is called, the TypedInput will be disabled

pub fn on_submit_maybe<F>(self, callback: Option<F>) -> Self

where F: 'a + Fn(Result<T, String>) -> Message,

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

If this is None, and there is no on_change callback, the TypedInput will be disabled.

pub fn on_paste<F>(self, callback: F) -> Self

where F: 'a + Fn(T) -> Message,

Sets the message that should be produced when some text is pasted into the TypedInput, resulting in a valid value

pub fn on_paste_maybe<F>(self, callback: Option<F>) -> Self

where F: 'a + Fn(T) -> Message,

Sets the message that should be produced when some text is pasted into the TypedInput, resulting in a valid value, if Some

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

Sets the Font of the TypedInput.

pub fn icon(self, icon: Icon<Renderer::Font>) -> Self

Sets the Icon of the TypedInput

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

Sets the width of the TypedInput.

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

Sets the padding of the TypedInput.

pub fn size(self, size: impl Into<Pixels>) -> Self

Sets the text size of the TypedInput.

pub fn line_height(self, line_height: impl Into<LineHeight>) -> Self

Sets the text::LineHeight of the TypedInput.

pub fn align_x(self, alignment: impl Into<Horizontal>) -> Self

Sets the horizontal alignment of the TypedInput.

pub fn style(self, style: impl Fn(&Theme, Status) -> Style + 'a) -> Self

where <Theme as Catalog>::Class<'a>: From<StyleFn<'a, Theme>>,

Sets the style of the input of the TypedInput.

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

Sets the class of the input of the TypedInput.

pub fn text(&self) -> &str

Gets the current text of the TypedInput.

Trait Implementations

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

where T: 'a + Display + FromStr + Clone + PartialEq, Message: 'a + Clone, Renderer: 'a + Renderer, Theme: 'a + Catalog,

fn from(typed_input: TypedInput<'a, T, Message, Theme, Renderer>) -> Self

Converts to this type from the input type.

impl<'a, T, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for TypedInput<'a, T, Message, Theme, Renderer>

where T: Display + FromStr + Clone + PartialEq, Message: 'a + Clone, Renderer: 'a + Renderer, Theme: Catalog,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

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

Returns the state Tree of the children of the Widget.

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

Reconciles the Widget with the provided Tree.

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

Returns the Size of the Widget in lengths.

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

Returns the layout::Node of the Widget.

fn draw( &self, state: &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 operate( &mut self, state: &mut Tree, layout: Layout<'_>, renderer: &Renderer, operation: &mut dyn Operation<()>, )

Applies an Operation to the Widget.

fn update( &mut self, state: &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 size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.

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

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