Struct kas_widgets::Spinner

pub struct Spinner<T: SpinnerValue> { /* 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.

Implementations

impl<T: SpinnerValue> Spinner<T>

pub fn new(range: RangeInclusive<T>, step: T) -> Self

Construct a spinner with given range and step

pub fn new_on<F>(range: RangeInclusive<T>, step: T, f: F) -> Selfwhere F: Fn(&mut EventMgr<'_>, T) + 'static,

Construct a spinner with event handler f

This closure is called when the value is changed.

pub fn on_change<F>(self, f: F) -> Selfwhere F: Fn(&mut EventMgr<'_>, T) + 'static,

Set event handler f

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 with_value(self, value: T) -> Self

Set the initial value

pub fn value(&self) -> T

Get the current value

pub fn set_value(&mut self, value: T) -> Action

Set the value

Returns Action::REDRAW if a redraw is required.

Trait Implementations

impl<T: SpinnerValue> AutoLayout for Spinner<T>

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

Get size rules for the given axis

fn set_rect(&mut self, mgr: &mut ConfigMgr<'_>, rect: Rect)

Set size and position

fn find_id(&mut self, coord: Coord) -> Option<WidgetId>

Translate a coordinate to a WidgetId

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

Draw a widget and its children

impl<T: SpinnerValue> Debug for Spinner<T>

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

Formats the value using the given formatter.

impl<T: SpinnerValue> Layout for Spinner<T>

fn find_id(&mut self, coord: Coord) -> Option<WidgetId>

Translate a coordinate to a WidgetId

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

Draw a widget and its children

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

Get size rules for the given axis

fn set_rect(&mut self, mgr: &mut ConfigMgr<'_>, rect: Rect)

Set size and position

impl<T: SpinnerValue> Widget for Spinner<T>

fn configure(&mut self, mgr: &mut ConfigMgr<'_>)

Configure widget

fn steal_event( &mut self, mgr: &mut EventMgr<'_>, _: &WidgetId, event: &Event ) -> Response

Potentially steal an event before it reaches a child

fn handle_message(&mut self, mgr: &mut EventMgr<'_>)

Handler for messages from children/descendants

fn pre_configure(&mut self, _: &mut ConfigMgr<'_>, id: WidgetId)

Pre-configuration

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

Navigation in spatial order

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

fn translation(&self) -> Offset

Get translation of children relative to this widget

fn handle_event(&mut self, mgr: &mut EventMgr<'_>, event: Event) -> Response

Handle an Event sent to this widget

fn handle_unused(&mut self, mgr: &mut EventMgr<'_>, event: Event) -> Response

Handle an event sent to child index but left unhandled

fn handle_scroll(&mut self, mgr: &mut EventMgr<'_>, scroll: Scroll)

Handler for scrolling

impl<T: SpinnerValue> WidgetChildren for Spinner<T>

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, _index: usize) -> Option<&dyn Widget>

Get a reference to a child widget by index, or None if the index is out of bounds.

fn get_child_mut(&mut self, _index: usize) -> Option<&mut dyn Widget>

Mutable variant of get

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

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

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

Make an identifier for a child

impl<T: SpinnerValue> WidgetCore for Spinner<T>

fn id_ref(&self) -> &WidgetId

Get the widget’s identifier

fn rect(&self) -> Rect

Get the widget’s region, relative to its parent.

fn widget_name(&self) -> &'static str

Get the name of the widget struct

fn as_widget(&self) -> &dyn Widget

Erase type

fn as_widget_mut(&mut self) -> &mut dyn Widget

Erase type