168 lines
4.4 KiB
Rust
168 lines
4.4 KiB
Rust
//! Provide progress feedback to your users.
|
|
use crate::layout;
|
|
use crate::renderer;
|
|
use crate::widget::Tree;
|
|
use crate::{Color, Element, Layout, Length, Point, Rectangle, Size, Widget};
|
|
|
|
use std::ops::RangeInclusive;
|
|
|
|
pub use iced_style::progress_bar::{Appearance, StyleSheet};
|
|
|
|
/// A bar that displays progress.
|
|
///
|
|
/// # Example
|
|
/// ```
|
|
/// # type ProgressBar = iced_native::widget::ProgressBar<iced_native::renderer::Null>;
|
|
/// let value = 50.0;
|
|
///
|
|
/// ProgressBar::new(0.0..=100.0, value);
|
|
/// ```
|
|
///
|
|
/// 
|
|
#[allow(missing_debug_implementations)]
|
|
pub struct ProgressBar<Renderer>
|
|
where
|
|
Renderer: crate::Renderer,
|
|
Renderer::Theme: StyleSheet,
|
|
{
|
|
range: RangeInclusive<f32>,
|
|
value: f32,
|
|
width: Length,
|
|
height: Option<Length>,
|
|
style: <Renderer::Theme as StyleSheet>::Style,
|
|
}
|
|
|
|
impl<Renderer> ProgressBar<Renderer>
|
|
where
|
|
Renderer: crate::Renderer,
|
|
Renderer::Theme: StyleSheet,
|
|
{
|
|
/// The default height of a [`ProgressBar`].
|
|
pub const DEFAULT_HEIGHT: u16 = 30;
|
|
|
|
/// Creates a new [`ProgressBar`].
|
|
///
|
|
/// It expects:
|
|
/// * an inclusive range of possible values
|
|
/// * the current value of the [`ProgressBar`]
|
|
pub fn new(range: RangeInclusive<f32>, value: f32) -> Self {
|
|
ProgressBar {
|
|
value: value.clamp(*range.start(), *range.end()),
|
|
range,
|
|
width: Length::Fill,
|
|
height: None,
|
|
style: Default::default(),
|
|
}
|
|
}
|
|
|
|
/// Sets the width of the [`ProgressBar`].
|
|
pub fn width(mut self, width: Length) -> Self {
|
|
self.width = width;
|
|
self
|
|
}
|
|
|
|
/// Sets the height of the [`ProgressBar`].
|
|
pub fn height(mut self, height: Length) -> Self {
|
|
self.height = Some(height);
|
|
self
|
|
}
|
|
|
|
/// Sets the style of the [`ProgressBar`].
|
|
pub fn style(
|
|
mut self,
|
|
style: impl Into<<Renderer::Theme as StyleSheet>::Style>,
|
|
) -> Self {
|
|
self.style = style.into();
|
|
self
|
|
}
|
|
}
|
|
|
|
impl<Message, Renderer> Widget<Message, Renderer> for ProgressBar<Renderer>
|
|
where
|
|
Renderer: crate::Renderer,
|
|
Renderer::Theme: StyleSheet,
|
|
{
|
|
fn width(&self) -> Length {
|
|
self.width
|
|
}
|
|
|
|
fn height(&self) -> Length {
|
|
self.height.unwrap_or(Length::Units(Self::DEFAULT_HEIGHT))
|
|
}
|
|
|
|
fn layout(
|
|
&self,
|
|
_renderer: &Renderer,
|
|
limits: &layout::Limits,
|
|
) -> layout::Node {
|
|
let limits = limits
|
|
.width(self.width)
|
|
.height(self.height.unwrap_or(Length::Units(Self::DEFAULT_HEIGHT)));
|
|
|
|
let size = limits.resolve(Size::ZERO);
|
|
|
|
layout::Node::new(size)
|
|
}
|
|
|
|
fn draw(
|
|
&self,
|
|
_state: &Tree,
|
|
renderer: &mut Renderer,
|
|
theme: &Renderer::Theme,
|
|
_style: &renderer::Style,
|
|
layout: Layout<'_>,
|
|
_cursor_position: Point,
|
|
_viewport: &Rectangle,
|
|
) {
|
|
let bounds = layout.bounds();
|
|
let (range_start, range_end) = self.range.clone().into_inner();
|
|
|
|
let active_progress_width = if range_start >= range_end {
|
|
0.0
|
|
} else {
|
|
bounds.width * (self.value - range_start)
|
|
/ (range_end - range_start)
|
|
};
|
|
|
|
let style = theme.appearance(&self.style);
|
|
|
|
renderer.fill_quad(
|
|
renderer::Quad {
|
|
bounds: Rectangle { ..bounds },
|
|
border_radius: style.border_radius.into(),
|
|
border_width: 0.0,
|
|
border_color: Color::TRANSPARENT,
|
|
},
|
|
style.background,
|
|
);
|
|
|
|
if active_progress_width > 0.0 {
|
|
renderer.fill_quad(
|
|
renderer::Quad {
|
|
bounds: Rectangle {
|
|
width: active_progress_width,
|
|
..bounds
|
|
},
|
|
border_radius: style.border_radius.into(),
|
|
border_width: 0.0,
|
|
border_color: Color::TRANSPARENT,
|
|
},
|
|
style.bar,
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<'a, Message, Renderer> From<ProgressBar<Renderer>>
|
|
for Element<'a, Message, Renderer>
|
|
where
|
|
Message: 'a,
|
|
Renderer: 'a + crate::Renderer,
|
|
Renderer::Theme: StyleSheet,
|
|
{
|
|
fn from(
|
|
progress_bar: ProgressBar<Renderer>,
|
|
) -> Element<'a, Message, Renderer> {
|
|
Element::new(progress_bar)
|
|
}
|
|
}
|