Struct NumericUpDown

Source

pub struct NumericUpDown<T>where
    T: NumericType,{
    pub widget: Widget,
    pub field: InheritableVariable<Handle<UiNode>>,
    pub increase: InheritableVariable<Handle<UiNode>>,
    pub decrease: InheritableVariable<Handle<UiNode>>,
    pub value: InheritableVariable<T>,
    pub step: InheritableVariable<T>,
    pub min_value: InheritableVariable<T>,
    pub max_value: InheritableVariable<T>,
    pub precision: InheritableVariable<usize>,
    pub drag_context: Option<DragContext<T>>,
    pub drag_value_scaling: InheritableVariable<f32>,
    /* private fields */
}

Expand description

A widget that handles numbers of any machine type. Use this widget if you need to provide input field for a numeric type.

§How to create

Use NumericUpDownBuilder to create a new instance of the NumericUpDown widget:

fn create_numeric_widget(ctx: &mut BuildContext) -> Handle<UiNode> {
    NumericUpDownBuilder::new(WidgetBuilder::new())
        .with_value(123.0f32)
        .build(ctx)
}

Keep in mind, that this widget is generic and can work with any numeric types. Sometimes you might get an “unknown type” error message from the compiler (especially if your use 123.0 ambiguous numeric literals), in this case you need to specify the type explicitly (NumericUpDownBuilder::<f32>::new...).

§Limits

This widget supports lower and upper limits for the values. It can be specified by NumericUpDownBuilder::with_min_value and NumericUpDownBuilder::with_max_value (or changed at runtime using NumericUpDownMessage::MinValue and NumericUpDownMessage::MaxValue messages):

use fyrox_ui::{
    core::pool::Handle, numeric::NumericUpDownBuilder, widget::WidgetBuilder, BuildContext,
    UiNode,
};
fn create_numeric_widget(ctx: &mut BuildContext) -> Handle<UiNode> {
    NumericUpDownBuilder::new(WidgetBuilder::new())
        .with_value(123.0f32)
        .with_min_value(42.0)
        .with_max_value(666.0)
        .build(ctx)
}

The default limits for min and max are NumericType::min_value and NumericType::max_value respectively.

§Step

Since the value of the widget can be changed via up/down arrow buttons (also by dragging the cursor up or down on them), the widget provides a way to set the step of the value (for increment and decrement at the same time):

fn create_numeric_widget(ctx: &mut BuildContext) -> Handle<UiNode> {
    NumericUpDownBuilder::new(WidgetBuilder::new())
        .with_value(125.0f32)
        .with_step(5.0)
        .build(ctx)
}

The default value of the step is NumericType::one.

§Precision

It is possible to specify visual rounding of the value up to desired decimal place (it does not change the way how the actual value is rounded). For example, in some cases you might get irrational values such as 1/3 ~= 0.33333333, but you interested in only first two decimal places. In this case you can set the precision to 2:

fn create_numeric_widget(ctx: &mut BuildContext) -> Handle<UiNode> {
    NumericUpDownBuilder::new(WidgetBuilder::new())
        .with_value(0.3333333f32)
        .with_precision(2)
        .build(ctx)
}

Fields§

§widget: Widget

Base widget of the NumericUpDown widget.

§field: InheritableVariable<Handle<UiNode>>

A handle of the input field (usually a TextBox instance).

§increase: InheritableVariable<Handle<UiNode>>

A handle of the increase button.

§decrease: InheritableVariable<Handle<UiNode>>

A handle of the decrease button.

§value: InheritableVariable<T>

Current value of the widget.

§step: InheritableVariable<T>

Step value of the widget.

§min_value: InheritableVariable<T>

Min value of the widget.

§max_value: InheritableVariable<T>

Max value of the widget.

§precision: InheritableVariable<usize>

Current precision of the widget in decimal places.

§drag_context: Option<DragContext<T>>

Internal dragging context.

§drag_value_scaling: InheritableVariable<f32>

Defines how movement in Y axis will be translated in the actual value change. It is some sort of a scaling modifier.

Struct NumericUpDownCopy item path

§How to create

§Limits

§Step

§Precision

Fields§

Implementations§

impl<T> NumericUpDown<T>where T: NumericType,

pub const WIDGET: &'static str = "widget"

pub const FIELD: &'static str = "field"

pub const INCREASE: &'static str = "increase"

pub const DECREASE: &'static str = "decrease"

pub const VALUE: &'static str = "value"

pub const STEP: &'static str = "step"

pub const MIN_VALUE: &'static str = "min_value"

pub const MAX_VALUE: &'static str = "max_value"

pub const PRECISION: &'static str = "precision"

pub const DRAG_VALUE_SCALING: &'static str = "drag_value_scaling"

Methods from Deref<Target = Widget>§

pub const NAME: &'static str = "name"

pub const DESIRED_LOCAL_POSITION: &'static str = "desired_local_position"

pub const WIDTH: &'static str = "width"

pub const HEIGHT: &'static str = "height"

pub const MIN_SIZE: &'static str = "min_size"

pub const MAX_SIZE: &'static str = "max_size"

pub const BACKGROUND: &'static str = "background"

pub const FOREGROUND: &'static str = "foreground"

pub const ROW: &'static str = "row"

pub const COLUMN: &'static str = "column"

pub const VERTICAL_ALIGNMENT: &'static str = "vertical_alignment"

pub const HORIZONTAL_ALIGNMENT: &'static str = "horizontal_alignment"

pub const MARGIN: &'static str = "margin"

pub const VISIBILITY: &'static str = "visibility"

pub const HIT_TEST_VISIBILITY: &'static str = "hit_test_visibility"

pub const Z_INDEX: &'static str = "z_index"

pub const ALLOW_DRAG: &'static str = "allow_drag"

pub const ALLOW_DROP: &'static str = "allow_drop"

pub const DRAW_ON_TOP: &'static str = "draw_on_top"

pub const ENABLED: &'static str = "enabled"

pub const CURSOR: &'static str = "cursor"

pub const OPACITY: &'static str = "opacity"

pub const TOOLTIP: &'static str = "tooltip"

pub const TOOLTIP_TIME: &'static str = "tooltip_time"

pub const CONTEXT_MENU: &'static str = "context_menu"

pub const CLIP_TO_BOUNDS: &'static str = "clip_to_bounds"

pub const PREVIEW_MESSAGES: &'static str = "preview_messages"

pub const HANDLE_OS_EVENTS: &'static str = "handle_os_events"

pub const TAB_INDEX: &'static str = "tab_index"

pub const TAB_STOP: &'static str = "tab_stop"

pub const NEED_UPDATE: &'static str = "need_update"

pub const IGNORE_LAYOUT_ROUNDING: &'static str = "ignore_layout_rounding"

pub const ACCEPTS_INPUT: &'static str = "accepts_input"

pub const ID: &'static str = "id"

pub const RESOURCE: &'static str = "resource"

pub fn handle(&self) -> Handle<UiNode>

pub fn name(&self) -> &str

pub fn set_name<P>(&mut self, name: P) -> &mut Widgetwhere P: AsRef<str>,

pub fn actual_local_size( &self, ) -> Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

pub fn actual_initial_size( &self, ) -> Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

pub fn actual_global_size( &self, ) -> Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

pub fn set_min_size( &mut self, value: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>, ) -> &mut Widget

pub fn set_min_width(&mut self, value: f32) -> &mut Widget

pub fn set_min_height(&mut self, value: f32) -> &mut Widget

pub fn min_size( &self, ) -> Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

pub fn min_width(&self) -> f32

pub fn min_height(&self) -> f32

pub fn is_drag_allowed(&self) -> bool

pub fn is_drop_allowed(&self) -> bool

pub fn screen_to_local( &self, point: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>, ) -> Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

pub fn invalidate_layout(&self)

pub fn invalidate_measure(&self)

pub fn invalidate_arrange(&self)

pub fn is_hit_test_visible(&self) -> bool

pub fn set_max_size( &mut self, value: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>, ) -> &mut Widget

pub fn max_size( &self, ) -> Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

pub fn max_width(&self) -> f32

pub fn max_height(&self) -> f32

pub fn set_z_index(&mut self, z_index: usize) -> &mut Widget

pub fn z_index(&self) -> usize

pub fn set_background(&mut self, brush: Brush) -> &mut Widget

Struct NumericUpDown

impl<T> NumericUpDown<T>
where T: NumericType,

pub fn set_name<P>(&mut self, name: P) -> &mut Widget
where P: AsRef<str>,

pub fn find_by_criteria_up<Func>( &self, ui: &UserInterface, func: Func, ) -> Handle<UiNode>
where Func: Fn(&UiNode) -> bool,

pub fn user_data_cloned<T>(&self) -> Option<T>
where T: Clone + 'static,

impl<T> Clone for NumericUpDown<T>
where T: Clone + NumericType,