Struct tuix::Slider

pub struct Slider {
    pub value: f32,
    // some fields omitted
}

Fields

value: f32

Implementations

impl Slider

pub fn new() -> Slider

Create a new slider widget with default values (min: 0.0, max: 1.0, val: 0.0).

Example

Slider::new().build(state, parent, |builder| builder);

pub fn with_init(self, val: f32) -> Slider

Set the initial value of the slider.

Example

Slider::new()
   .with_init(0.5)
   .build(state, parent, |builder| builder)

pub fn with_range(self, range: Range<f32>) -> Slider

Set the range of the slider. Min and Max values are extracted from the range.

Example

Slider::new()
    .with_range(0.0..5.0)
    .build(state, parent, |builder| builder)

pub fn with_min(self, val: f32) -> Slider

Set the minimum value of the slider.

Example

Slider::new()
    .with_min(0.2)
    .build(state, parent, |builder| builder)

pub fn with_max(self, val: f32) -> Slider

Set the maximum value of the slider.

Example

Slider::new()
    .with_max()
    .build(state, parent, |builder| builder)

pub fn on_change<F>(self, callback: F) -> Slider where
    F: 'static + Fn(&mut Slider, &mut State, Entity), 

Set the callback triggered when the slider value has changed.

Takes a closure which provides the current value and returns an event to be sent when the slider value has changed after releasing the slider. If the slider thumb is pressed but not moved, and thus the value is not changed, then the event will not be sent.

Example

Slider::new()
    .on_change(|slider, state, entity| {
        entity.emit(WindowEvent::Debug(format!("Slider on_change: {}", slider.value)));
    })
    .build(state, parent, |builder| builder);

pub fn on_changing<F>(self, callback: F) -> Slider where
    F: 'static + Fn(&mut Slider, &mut State, Entity), 

Set the callback triggered when the slider value is changing (dragging).

Takes a closure which triggers when the slider value is changing, either by pressing the track or dragging the thumb along the track.

Example

Slider::new()
    .on_changing(|slider, state, entity| {
        entity.emit(WindowEvent::Debug(format!("Slider on_changing: {}", slider.value)));
    })
    .build(state, parent, |builder| builder);

pub fn on_min<F>(self, callback: F) -> Slider where
    F: 'static + Fn(&mut Slider, &mut State, Entity), 

Set the callback triggered when the slider value reaches the minimum.

Takes a closure which triggers when the slider reaches the minimum value, either by pressing the track at the start or dragging the thumb to the start of the track. The event is sent once for each time the value reaches the minimum.

Example

Slider::new()
    .on_min(|slider, state, entity| {
        entity.emit(WindowEvent::Debug(format!("Slider on_min: {}", slider.value)));
    })
    .build(state, parent, |builder| builder);

pub fn on_max<F>(self, callback: F) -> Slider where
    F: 'static + Fn(&mut Slider, &mut State, Entity), 

Set the callback triggered when the slider value reaches the maximum.

Takes a closure which triggers when the slider reaches the maximum value, either by pressing the track at the end or dragging the thumb to the end of the track. The event is sent once for each time the value reaches the maximum.

Example

Slider::new()
    .on_max(|slider, state, entity| {
        entity.emit(WindowEvent::Debug(format!("Slider on_min: {}", slider.value)));
    })
    .build(state, parent, |builder| builder);

pub fn on_release<F>(self, callback: F) -> Slider where
    F: 'static + Fn(&mut Slider, &mut State, Entity), 

Set the event sent when the slider is pressed.

The event is sent when the left mouse button is pressed on any part of the slider.

Example

Slider::new()
    .on_max(|slider, state, entity| {
        entity.emit(WindowEvent::Debug(format!("Slider on_min: {}", slider.value)));
    })
    .build(state, parent, |builder| builder);

Set the event sent when the slider is released.

The event is sent when the left mouse button is released after being pressed on any part of the slider.

Example

Slider::new()
    .on_max(|slider, state, entity| {
        entity.emit(WindowEvent::Debug(format!("Slider on_min: {}", slider.value)));
    })
    .build(state, parent, |builder| builder);

pub fn on_over<F>(self, callback: F) -> Slider where
    F: 'static + Fn(&mut Slider, &mut State, Entity), 

Set the event sent when the mouse cursor enters the slider.

The event is sent when the mouse cursor enters the bounding box of the slider.

Example

Slider::new()
    .on_max(|slider, state, entity| {
        entity.emit(WindowEvent::Debug(format!("Slider on_min: {}", slider.value)));
    })
    .build(state, parent, |builder| builder);

pub fn on_out<F>(self, callback: F) -> Slider where
    F: 'static + Fn(&mut Slider, &mut State, Entity), 

Set the event sent when the mouse cursor leaves the slider

The event is sent when the mouse cursor leaves the bounding box of the slider.

Example

Slider::new()
    .on_max(|slider, state, entity| {
        entity.emit(WindowEvent::Debug(format!("Slider on_min: {}", slider.value)));
    })
    .build(state, parent, |builder| builder);

Trait Implementations

impl Default for Slider

pub fn default() -> Slider

Returns the “default value” for a type.

impl Widget for Slider

type Ret = Entity

type Data = f32

pub fn on_build(
    &mut self,
    state: &mut State,
    entity: Entity
) -> <Slider as Widget>::Ret

pub fn on_event(&mut self, state: &mut State, entity: Entity, event: &mut Event)

pub fn on_update(
    &mut self,
    state: &mut State,
    entity: Entity,
    data: &<Slider as Widget>::Data
)

fn widget_name(&self) -> String

fn build<F>(
    self,
    state: &mut State,
    parent: impl AsEntity,
    builder: F
) -> Self::Ret where
    Self: 'static,
    F: FnMut(Builder<'_, Self>) -> Builder<'_, Self>, 

Adds the widget into state and returns the associated type Ret - an entity id or a tuple of entity ids

fn bind<L, F>(self, lens: L, converter: F) -> Wrapper<L, Self> where
    L: Lens,
    F: 'static + Fn(&<L as Lens>::Target) -> Self::Data, 

fn bind2<L>(self, lens: L) -> LensWrap<L, Self> where
    L: Lens, 

fn on_style(
    &mut self,
    state: &mut State,
    entity: Entity,
    property: (String, PropType)
)

fn on_draw(
    &mut self,
    state: &mut State,
    entity: Entity,
    canvas: &mut Canvas<OpenGl>
)