Struct NumberInput 

pub struct NumberInput { /* private fields */ }

A number field with a step grid and, optionally, a range.

It never clamps. A value outside the range stays on screen exactly as it is and is published invalid, because silently correcting a number nobody chose hides the disagreement instead of reporting it.

Implementations

impl NumberInput

pub fn new( ident: impl Into<Ident>, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

pub fn value(self, value: f64) -> Self

Seeds the number the control draws. The caller keeps owning it.

pub fn range(self, min: f64, max: f64) -> Self

pub fn min(self, min: f64) -> Self

pub fn max(self, max: f64) -> Self

pub fn name(self, name: impl Into<SharedString>) -> Self

Names the control for a reader. A number field is usually labelled by the form around it, and the name is passed to the field that actually takes the keystrokes so a reader landing there knows what it is.

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

How far one arrow key or one step button moves.

pub fn page_step(self, page_step: f64) -> Self

How far page-up and page-down move. Ten steps unless told otherwise.

pub fn precision(self, precision: usize) -> Self

How many decimals the field draws and reports.

pub fn unit(self, unit: impl Into<SharedString>) -> Self

What the number counts, such as "ms". Shown after the field and carried in the published value.

pub fn required(self, required: bool) -> Self

pub fn set_value(&mut self, value: f64, cx: &mut Context<'_, Self>)

Replaces the number from the host side.

The host already knows the number it just set, so this reports nothing; only what a typist asks for is reported.

pub fn set_disabled(&mut self, disabled: bool, cx: &mut Context<'_, Self>)

pub fn current(&self) -> Option<f64>

The number the control last held, or None when nobody has given it one and nobody has typed one.

pub fn field(&self) -> &Entity<TextInput>

pub fn shown(&self, cx: &App) -> Option<f64>

The number in the field, which is the typist’s text rather than the host’s value while an edit is in progress.

pub fn is_invalid(&self, cx: &App) -> bool

Whether what the field holds is something the control was told to accept. An empty field holds no number and says nothing about one.

pub fn invalid_reason(&self, cx: &App) -> Option<SharedString>

Why the field is invalid, in words, or None when it is not. This and Self::is_invalid read the same range, so a control cannot be drawn as wrong without being able to say what is wrong with it.

pub fn can_step(&self, delta: f64, cx: &App) -> bool

Whether a step in this direction has anywhere to go.

At a boundary there is no next number, so nothing is reported and the button that would report it is refused rather than inert-looking.

Trait Implementations

impl Debug for NumberInput

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Disableable for NumberInput

fn disabled(self, disabled: bool) -> Self

impl EventEmitter<NumberInputEvent> for NumberInput

impl Focusable for NumberInput

fn focus_handle(&self, _cx: &App) -> FocusHandle

Returns the focus handle associated with this view.

impl Render for NumberInput

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.

impl Sizable for NumberInput

fn control_size(self, size: ControlSize) -> Self

fn xs(self) -> Self

fn small(self) -> Self

fn medium(self) -> Self

fn large(self) -> Self