Struct SpinBox 

pub struct SpinBox<A, T: SpinValue> { /* private fields */ }

A numeric entry widget with up/down arrows

The value is constrained to a given range. Increment and decrement operations advance to the next/previous multiple of step.

Recommendations for optimal behaviour:

• Ensure that range end points are a multiple of step
• With floating-point types, ensure that step is exactly representable, e.g. an integer or a power of 2.

Messages

SetValueF64 may be used to set the input value.

IncrementStep and DecrementStep change the value by one step.

SetValueText may be used to set the input as a text value. ReplaceSelectedText may be used to replace the selected text.

Implementations

impl<A, T: SpinValue> SpinBox<A, T>

pub fn new( range: RangeInclusive<T>, state_fn: impl Fn(&ConfigCx<'_>, &A) -> T + 'static, ) -> Self

Construct a spin box

Values vary within the given range. The default step size is 1 for common types (see SpinValue::default_step).

pub fn new_msg<M: Debug + 'static>( range: RangeInclusive<T>, state_fn: impl Fn(&ConfigCx<'_>, &A) -> T + 'static, msg_fn: impl Fn(T) -> M + 'static, ) -> Self

Construct a spin box

• Values vary within the given range
• The default step size is 1 for common types (see SpinValue::default_step)
• state_fn extracts the current state from input data
• A message generated by msg_fn is emitted when toggled

pub fn with_msg<M>(self, f: impl Fn(T) -> M + 'static) -> Self

where M: Debug + 'static,

Send the message generated by f on change

pub fn with(self, f: impl Fn(&mut EventCx<'_>, &A, T) + 'static) -> Self

Call the handler f on change

This closure is called when the value is changed, specifically:

• If the increment/decrement buttons, Up/Down keys or mouse scroll wheel is used and the value changes
• If the value is adjusted via the edit box and the result is valid
• If Enter is pressed in the edit box

pub fn with_class(self, class: TextClass) -> Self

Set the text class used

The default is: TextClass::Edit(false).

pub fn class(&self) -> TextClass

Get the text class used

pub fn set_width_em(&mut self, min_em: f32, ideal_em: f32)

Adjust the width allocation

pub fn with_width_em(self, min_em: f32, ideal_em: f32) -> Self

Adjust the width allocation (inline)

pub fn set_unit(&mut self, cx: &mut EventState, unit: impl ToString)

Set the unit

This is an annotation shown after the value.

pub fn with_unit(self, unit: impl ToString) -> Self

Set the unit (inline)

This method should only be used before the UI has started.

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

Set the step size

Trait Implementations

impl<A, T: SpinValue> Events for SpinBox<A, T>

fn configure(&mut self, cx: &mut ConfigCx<'_>)

Configure self

fn handle_event( &mut self, cx: &mut EventCx<'_>, data: &A, event: Event<'_>, ) -> IsUsed

Handle an Event

fn handle_messages(&mut self, cx: &mut EventCx<'_>, data: &A)

Handler for messages from children/descendants

const REDRAW_ON_MOUSE_OVER: bool = false

Does this widget have a different appearance on mouse over?

fn mouse_over_icon(&self) -> Option<CursorIcon>

The mouse cursor icon to use on mouse over

fn make_child_id(&mut self, index: usize) -> Id

Make an identifier for a child

fn configure_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Configure children

fn update(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update self using input data

fn update_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update children

fn handle_mouse_over(&mut self, cx: &mut EventCx<'_>, state: bool)

Mouse focus handler

fn handle_scroll( &mut self, cx: &mut EventCx<'_>, data: &Self::Data, scroll: Scroll, )

Handler for scrolling

impl<A, T: SpinValue> Layout for SpinBox<A, T>

fn set_rect(&mut self, cx: &mut ConfigCx<'_>, rect: Rect, hints: AlignHints)

Set size and position

fn draw(&self, draw: DrawCx<'_>)

Draw a widget and its children

fn size_rules(&mut self, sizer: SizeCx<'_>, axis: AxisInfo) -> SizeRules

Get size rules for the given axis

fn rect(&self) -> Rect

Get the widget’s region

fn try_probe(&self, coord: Coord) -> Option<Id>

Probe a coordinate for a widget’s Id

impl<A, T: SpinValue> MacroDefinedLayout for SpinBox<A, T>

fn rect(&self) -> Rect

Get the widget’s region

fn size_rules(&mut self, sizer: SizeCx<'_>, axis: AxisInfo) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, cx: &mut ConfigCx<'_>, rect: Rect, hints: AlignHints)

Set size and position

fn try_probe(&self, coord: Coord) -> Option<Id>

Probe a coordinate for a widget’s Id

fn draw(&self, draw: DrawCx<'_>)

Draw a widget and its children

impl<A, T: SpinValue> Tile for SpinBox<A, T>

fn role(&self, _: &mut dyn RoleCx) -> Role<'_>

Describe the widget’s role

fn probe(&self, coord: Coord) -> Id

Probe a coordinate for a widget’s Id

fn as_tile(&self) -> &dyn Tile

Get as a dyn Tile

fn id_ref(&self) -> &Id

Get a reference to the widget’s identifier

fn identify(&self) -> IdentifyWidget<'_>

Return a Display-able widget identifier

fn get_child(&self, index: usize) -> Option<&dyn Tile>

Access a child as a dyn Tile, if available

fn child_indices(&self) -> ChildIndices

Get child indices available to recursion

fn nav_next(&self, reverse: bool, from: Option<usize>) -> Option<usize>

Navigation in spatial order

fn id(&self) -> Id

Get the widget’s identifier

fn navigable(&self) -> bool

Whether this widget supports navigation focus

fn tooltip(&self) -> Option<&str>

Tooltip

fn role_child_properties(&self, cx: &mut dyn RoleCx, index: usize)

Specify additional role properties for child index

fn find_child_index(&self, id: &Id) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn translation(&self, index: usize) -> Offset

Get translation of child index relative to this widget

impl<A, T: SpinValue> Widget for SpinBox<A, T>

type Data = A

Input data type

fn as_node<'__a>(&'__a mut self, data: &'__a Self::Data) -> Node<'__a>

Erase type

fn child_node<'__n>( &'__n mut self, data: &'__n Self::Data, index: usize, ) -> Option<Node<'__n>>

Access a child as a Node, if available