Struct Slider

pub struct Slider<'ui, Label, Data, Format = &'static str> { /* private fields */ }

Builder for a slider widget.

Implementations

impl<'ui, T, K> Slider<'ui, T, K>

where T: AsRef<str>, K: DataTypeKind,

pub fn new(ui: &'ui Ui, label: T, min: K, max: K) -> Slider<'ui, T, K>

👎Deprecated since 0.9.0: Use Ui::slider or Ui::slider_config.

Constructs a new slider builder with the given range.

impl<'ui, Label, Data, Format> Slider<'ui, Label, Data, Format>

where Label: AsRef<str>, Data: DataTypeKind, Format: AsRef<str>,

pub fn range(self, min: Data, max: Data) -> Slider<'ui, Label, Data, Format>

Sets the range inclusively, such that both values given are valid values which the slider can be dragged to.

ui.slider_config("Example", i8::MIN, i8::MAX)
    .range(4, 8)
    // Remember to call .build()
    ;

It is safe, though up to C++ Dear ImGui, on how to handle when min > max.

Note for f32 and f64 sliders, Dear ImGui limits the available range to half their full range (e.g f32::MIN/2.0 .. f32::MAX/2.0) Specifying a value above this will cause an abort. For large ranged values, consider using Ui::input_scalar instead

pub fn display_format<Format2>( self, display_format: Format2, ) -> Slider<'ui, Label, Data, Format2>

where Format2: AsRef<str>,

Sets the display format using a C-style printf string

pub fn flags(self, flags: SliderFlags) -> Slider<'ui, Label, Data, Format>

Replaces all current settings with the given flags

pub fn build(self, value: &mut Data) -> bool

Builds a slider that is bound to the given value.

Returns true if the slider value was changed.

pub fn build_array(self, values: &mut [Data]) -> bool

Builds a horizontal array of multiple sliders attached to the given slice.

Returns true if any slider value was changed.

Trait Implementations

impl<'ui, Label, Data, Format> Clone for Slider<'ui, Label, Data, Format>

where Label: Clone, Data: Clone, Format: Clone,

fn clone(&self) -> Slider<'ui, Label, Data, Format>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'ui, Label, Data, Format> Debug for Slider<'ui, Label, Data, Format>

where Label: Debug, Data: Debug, Format: Debug,

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

Formats the value using the given formatter.

impl<'ui, Label, Data, Format> Copy for Slider<'ui, Label, Data, Format>

where Label: Copy, Data: Copy, Format: Copy,