Struct NumberInput 

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

A field that can only be filled with numeric type.

Example

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

let value = 12;
let max = 1275;

let input = NumberInput::new(
    value,
    0..=max,
    Message::NumberInputChanged,
)
.step(2);

Implementations

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

where T: Num + NumAssignOps + PartialOrd + Display + FromStr + Clone + Bounded + 'a, Message: Clone + 'a, Renderer: Renderer<Font = Font>, Theme: ExtendedCatalog,

pub fn new<F>(value: &T, bounds: impl RangeBounds<T>, on_change: F) -> Self

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

Creates a new NumberInput.

It expects:

• the current value
• the bound values
• a function that produces a message when the NumberInput changes

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

Sets the Id of the underlying TextInput.

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 NumberInput

If neither this method nor on_submit is called, the NumberInput 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 NumberInput, if Some.

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

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

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

pub fn on_submit_maybe(self, message: Option<Message>) -> Self

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

If this is None, and there is no on_change callback, the NumberInput 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 NumberInput, 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 NumberInput, resulting in a valid value, if Some

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

Sets the Font of the Text.

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

Sets the Icon of the NumberInput

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

Sets the width of the NumberInput.

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

👎Deprecated since 0.11.1: use width instead

Sets the width of the NumberInput.

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

Sets the padding of the NumberInput.

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

Sets the text size of the NumberInput.

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

Sets the text::LineHeight of the NumberInput.

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

Sets the horizontal alignment of the NumberInput.

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

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

Sets the style of the NumberInput.

pub fn input_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 NumberInput.

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

Sets the class of the input of the NumberInput.

pub fn bounds(self, bounds: impl RangeBounds<T>) -> Self

Sets the minimum & maximum value (bound) of the NumberInput.

Example

use iced_aw::widget::number_input;
// Creates a range from -5 till 5.
let input: iced_aw::NumberInput<'_, _, _, iced_widget::Theme, iced::Renderer> = number_input(&4 /* my_value */, 0..=4, |_| () /* my_message */).bounds(-5..=5);

pub fn step(self, step: T) -> Self

Sets the step of the NumberInput.

pub fn ignore_buttons(self, ignore: bool) -> Self

Enable or disable increase and decrease buttons of the NumberInput, by default this is set to false.

pub fn ignore_scroll(self, ignore: bool) -> Self

Enable or disable mouse scrolling events of the NumberInput, by default this is set to false.

Trait Implementations

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

where T: 'a + Num + NumAssignOps + PartialOrd + Display + FromStr + Clone + Bounded, Message: 'a + Clone, Renderer: 'a + Renderer<Font = Font>, Theme: 'a + ExtendedCatalog,

fn from(num_input: NumberInput<'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 NumberInput<'a, T, Message, Theme, Renderer>

where T: Num + NumAssignOps + PartialOrd + Display + FromStr + ToString + Clone + Bounded + 'a, Message: 'a + Clone, Renderer: 'a + Renderer<Font = Font>, Theme: ExtendedCatalog,

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, tree: &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, tree: &mut Tree, renderer: &Renderer, limits: &Limits, ) -> Node

Returns the layout::Node of the Widget.

fn operate( &mut self, tree: &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 mouse_interaction( &self, _state: &Tree, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction 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 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.