Struct cosmic::iced_widget::slider::Slider
source · pub struct Slider<'a, T, Message, Theme = Theme>where
Theme: Catalog,{ /* private fields */ }
Expand description
An horizontal bar and a handle that selects a single value from a range of values.
A Slider
will try to fill the horizontal space of its container.
The Slider
range of numeric values is generic and its step size defaults
to 1 unit.
§Example
use iced::widget::slider;
struct State {
value: f32,
}
#[derive(Debug, Clone)]
enum Message {
ValueChanged(f32),
}
fn view(state: &State) -> Element<'_, Message> {
slider(0.0..=100.0, state.value, Message::ValueChanged).into()
}
fn update(state: &mut State, message: Message) {
match message {
Message::ValueChanged(value) => {
state.value = value;
}
}
}
Implementations§
source§impl<'a, T, Message, Theme> Slider<'a, T, Message, Theme>
impl<'a, T, Message, Theme> Slider<'a, T, Message, Theme>
sourcepub const DEFAULT_HEIGHT: f32 = 16f32
pub const DEFAULT_HEIGHT: f32 = 16f32
The default height of a Slider
.
sourcepub fn new<F>(
range: RangeInclusive<T>,
value: T,
on_change: F,
) -> Slider<'a, T, Message, Theme>where
F: 'a + Fn(T) -> Message,
pub fn new<F>(
range: RangeInclusive<T>,
value: T,
on_change: F,
) -> Slider<'a, T, Message, Theme>where
F: 'a + Fn(T) -> Message,
sourcepub fn breakpoints(self, breakpoints: &'a [T]) -> Slider<'a, T, Message, Theme>
pub fn breakpoints(self, breakpoints: &'a [T]) -> Slider<'a, T, Message, Theme>
Defines breakpoints to visibly mark on the slider.
The slider will gravitate towards a breakpoint when near it.
sourcepub fn on_release(self, on_release: Message) -> Slider<'a, T, Message, Theme>
pub fn on_release(self, on_release: Message) -> Slider<'a, T, Message, Theme>
Sets the release message of the Slider
.
This is called when the mouse is released from the slider.
Typically, the user’s interaction with the slider is finished when this message is produced.
This is useful if you need to spawn a long-running task from the slider’s result, where
the default on_change
message could create too many events.
sourcepub fn width(self, width: impl Into<Length>) -> Slider<'a, T, Message, Theme>
pub fn width(self, width: impl Into<Length>) -> Slider<'a, T, Message, Theme>
Sets the width of the Slider
.
sourcepub fn height(self, height: impl Into<Pixels>) -> Slider<'a, T, Message, Theme>
pub fn height(self, height: impl Into<Pixels>) -> Slider<'a, T, Message, Theme>
Sets the height of the Slider
.
sourcepub fn step(self, step: impl Into<T>) -> Slider<'a, T, Message, Theme>
pub fn step(self, step: impl Into<T>) -> Slider<'a, T, Message, Theme>
Sets the step size of the Slider
.
sourcepub fn shift_step(
self,
shift_step: impl Into<T>,
) -> Slider<'a, T, Message, Theme>
pub fn shift_step( self, shift_step: impl Into<T>, ) -> Slider<'a, T, Message, Theme>
Sets the optional “shift” step for the Slider
.
If set, this value is used as the step while the shift key is pressed.
sourcepub fn style(
self,
style: impl Fn(&Theme, Status) -> Style + 'a,
) -> Slider<'a, T, Message, Theme>
pub fn style( self, style: impl Fn(&Theme, Status) -> Style + 'a, ) -> Slider<'a, T, Message, Theme>
Sets the style of the Slider
.
sourcepub fn class(
self,
class: impl Into<<Theme as Catalog>::Class<'a>>,
) -> Slider<'a, T, Message, Theme>
pub fn class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> Slider<'a, T, Message, Theme>
Sets the style class of the Slider
.
sourcepub fn name(
self,
name: impl Into<Cow<'a, str>>,
) -> Slider<'a, T, Message, Theme>
pub fn name( self, name: impl Into<Cow<'a, str>>, ) -> Slider<'a, T, Message, Theme>
Sets the name of the Slider
.
sourcepub fn description_widget(
self,
description: &impl Describes,
) -> Slider<'a, T, Message, Theme>
pub fn description_widget( self, description: &impl Describes, ) -> Slider<'a, T, Message, Theme>
Sets the description of the Slider
.
Trait Implementations§
source§impl<'a, T, Message, Theme, Renderer> From<Slider<'a, T, Message, Theme>> for Element<'a, Message, Theme, Renderer>
impl<'a, T, Message, Theme, Renderer> From<Slider<'a, T, Message, Theme>> for Element<'a, Message, Theme, Renderer>
source§impl<'a, T, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Slider<'a, T, Message, Theme>
impl<'a, T, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Slider<'a, T, Message, Theme>
source§fn on_event(
&mut self,
tree: &mut Tree,
event: Event,
layout: Layout<'_>,
cursor: Cursor,
_renderer: &Renderer,
_clipboard: &mut dyn Clipboard,
shell: &mut Shell<'_, Message>,
_viewport: &Rectangle,
) -> Status
fn on_event( &mut self, tree: &mut Tree, event: Event, layout: Layout<'_>, cursor: Cursor, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, _viewport: &Rectangle, ) -> Status
source§fn draw(
&self,
tree: &Tree,
renderer: &mut Renderer,
theme: &Theme,
_style: &Style,
layout: Layout<'_>,
cursor: Cursor,
_viewport: &Rectangle,
)
fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, _style: &Style, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, )
Widget
using the associated Renderer
.source§fn mouse_interaction(
&self,
tree: &Tree,
layout: Layout<'_>,
cursor: Cursor,
_viewport: &Rectangle,
_renderer: &Renderer,
) -> Interaction
fn mouse_interaction( &self, tree: &Tree, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction
source§fn a11y_nodes(
&self,
layout: Layout<'_>,
_state: &Tree,
cursor: Cursor,
) -> A11yTree
fn a11y_nodes( &self, layout: Layout<'_>, _state: &Tree, cursor: Cursor, ) -> A11yTree
source§fn set_id(&mut self, id: Id)
fn set_id(&mut self, id: Id)
source§fn operate(
&self,
_state: &mut Tree,
_layout: Layout<'_>,
_renderer: &Renderer,
_operation: &mut dyn Operation,
)
fn operate( &self, _state: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _operation: &mut dyn Operation, )
source§fn overlay<'a>(
&'a mut self,
_state: &'a mut Tree,
_layout: Layout<'_>,
_renderer: &Renderer,
_translation: Vector,
) -> Option<Element<'a, Message, Theme, Renderer>>
fn overlay<'a>( &'a mut self, _state: &'a mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>
Widget
, if there is any.source§fn drag_destinations(
&self,
_state: &Tree,
_layout: Layout<'_>,
_renderer: &Renderer,
_dnd_rectangles: &mut DndDestinationRectangles,
)
fn drag_destinations( &self, _state: &Tree, _layout: Layout<'_>, _renderer: &Renderer, _dnd_rectangles: &mut DndDestinationRectangles, )
Auto Trait Implementations§
impl<'a, T, Message, Theme> Freeze for Slider<'a, T, Message, Theme>
impl<'a, T, Message, Theme = Theme> !RefUnwindSafe for Slider<'a, T, Message, Theme>
impl<'a, T, Message, Theme = Theme> !Send for Slider<'a, T, Message, Theme>
impl<'a, T, Message, Theme = Theme> !Sync for Slider<'a, T, Message, Theme>
impl<'a, T, Message, Theme> Unpin for Slider<'a, T, Message, Theme>
impl<'a, T, Message, Theme = Theme> !UnwindSafe for Slider<'a, T, Message, Theme>
Blanket Implementations§
source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
source§impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
source§type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn cam16_into_unclamped(
self,
parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>,
) -> T
fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
angle
.source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
other
into Self
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
source§fn into_angle(self) -> U
fn into_angle(self) -> U
T
.source§impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
source§type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn into_cam16_unclamped(
self,
parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>,
) -> T
fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
source§fn into_color(self) -> U
fn into_color(self) -> U
source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
self
into T
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
source§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
try_into_colors
fails to cast.source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
OutOfBounds
error is returned which contains
the unclamped color. Read more