Struct ScrollBar

Source

pub struct ScrollBar {Show 14 fields
    pub widget: Widget,
    pub min: InheritableVariable<f32>,
    pub max: InheritableVariable<f32>,
    pub value: InheritableVariable<f32>,
    pub step: InheritableVariable<f32>,
    pub orientation: InheritableVariable<Orientation>,
    pub is_dragging: bool,
    pub offset: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
    pub increase: InheritableVariable<Handle<UiNode>>,
    pub decrease: InheritableVariable<Handle<UiNode>>,
    pub indicator: InheritableVariable<Handle<UiNode>>,
    pub indicator_canvas: InheritableVariable<Handle<UiNode>>,
    pub value_text: InheritableVariable<Handle<UiNode>>,
    pub value_precision: InheritableVariable<usize>,
}

Expand description

Scroll bar is used to represent a value on a finite range. It has a thumb that shows the current value on on the bar. Usually it is used in pair with crate::scroll_panel::ScrollPanel to create something like crate::scroll_viewer::ScrollViewer widget. However, it could also be used to create sliders to show some value that lies within some range.

§Example

A simple example of how to create a new ScrollBar could be something like this:

fn create_scroll_bar(ctx: &mut BuildContext) -> Handle<UiNode> {
    ScrollBarBuilder::new(WidgetBuilder::new())
        .with_min(0.0)
        .with_max(200.0)
        .with_value(123.0)
        .build(ctx)
}

It creates a horizontal scroll bar with 123.0 value and a range of [0.0..200.0]. To fetch the new value of the scroll bar, use ScrollBarMessage::Value message:

if message.destination() == scroll_bar
    && message.direction() == MessageDirection::FromWidget
{
    if let Some(ScrollBarMessage::Value(value)) = message.data() {
        println!("{}", value);
    }
}

Please note, that you need to explicitly filter messages by MessageDirection::FromWidget, because it’s the only direction that is used as an “indicator” that the value was accepted by the scroll bar.

§Orientation

Scroll bar could be either horizontal (default) or vertical. You can select the orientation when building a scroll bar using ScrollBarBuilder::with_orientation method and provide a desired value from Orientation enum there.

§Show values

By default, scroll bar does not show its actual value, you can turn it on using ScrollBarBuilder::show_value method with true as the first argument. To change rounding of the value, use ScrollBarBuilder::with_value_precision and provide the desired amount of decimal places there.

§Step

Scroll bar provides arrows to change the current value using a fixed step value. You can change it using ScrollBarBuilder::with_step method.

Fields§

§widget: Widget

Base widget of the scroll bar.

§min: InheritableVariable<f32>

Min value of the scroll bar.

§max: InheritableVariable<f32>

Max value of the scroll bar.

§value: InheritableVariable<f32>

Current value of the scroll bar.

§step: InheritableVariable<f32>

Step of the scroll bar.

§orientation: InheritableVariable<Orientation>

Current orientation of the scroll bar.

§is_dragging: bool

Internal flag, that could be used to check whether the scroll bar’s thumb is being dragged or not.

§offset: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

Internal mouse offset that is used for dragging purposes.

§increase: InheritableVariable<Handle<UiNode>>

A handle of the increase button.

§decrease: InheritableVariable<Handle<UiNode>>

A handle of the decrease button.

§indicator: InheritableVariable<Handle<UiNode>>

A handle of the indicator (thumb).

§indicator_canvas: InheritableVariable<Handle<UiNode>>

A handle of the canvas that is used for the thumb.

§value_text: InheritableVariable<Handle<UiNode>>

A handle of the crate::text::Text widget that is used to show the current value of the scroll bar.

§value_precision: InheritableVariable<usize>

Current value precison in decimal places.

Struct ScrollBarCopy item path

§Example

§Orientation

§Show values

§Step

Fields§

Implementations§

impl ScrollBar

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

pub const MIN: &'static str = "min"

pub const MAX: &'static str = "max"

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

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

pub const ORIENTATION: &'static str = "orientation"

pub const IS_DRAGGING: &'static str = "is_dragging"

pub const OFFSET: &'static str = "offset"

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

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

pub const INDICATOR: &'static str = "indicator"

pub const INDICATOR_CANVAS: &'static str = "indicator_canvas"

pub const VALUE_TEXT: &'static str = "value_text"

pub const VALUE_PRECISION: &'static str = "value_precision"

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

Struct ScrollBar

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,