diff options
Diffstat (limited to '')
-rw-r--r-- | src/widget/progress_bar.rs | 117 |
1 files changed, 117 insertions, 0 deletions
diff --git a/src/widget/progress_bar.rs b/src/widget/progress_bar.rs new file mode 100644 index 00000000..0ce274e4 --- /dev/null +++ b/src/widget/progress_bar.rs @@ -0,0 +1,117 @@ +//! Displays action progress to your users. + +use crate::{ + Style, Node, Element, MouseCursor, Layout, Hasher, Widget, + Point, Rectangle, +}; + +use std::hash::Hash; + +/// A widget that displays a progress of an action. +/// +/// It implements [`Widget`] when the associated [`core::Renderer`] implements +/// the [`button::Renderer`] trait. +/// +/// [`Widget`]: ../../core/trait.Widget.html +/// [`core::Renderer`]: ../../core/trait.Renderer.html +/// [`progress_bar::Renderer`]: trait.Renderer.html +/// # Example +/// +/// ``` +/// use coffee::ui::ProgressBar; +/// +/// let progress = 0.75; +/// +/// ProgressBar::new(progress); +/// ``` +#[derive(Debug)] +pub struct ProgressBar { + progress: f32, + style: Style, +} + +impl ProgressBar { + /// Creates a new [`ProgressBar`] with given progress. + /// + /// [`ProgressBar`]: struct.ProgressBar.html + pub fn new(progress: f32) -> Self { + ProgressBar { + progress, + style: Style::default().fill_width(), + } + } + + /// Sets the width of the [`ProgressBar`] in pixels. + /// + /// [`ProgressBar`]: struct.ProgressBar.html + pub fn width(mut self, width: u32) -> Self { + self.style = self.style.width(width); + self + } + + /// Makes the [`ProgressBar`] fill the horizontal space of its container. + /// + /// [`ProgressBar`]: struct.ProgressBar.html + pub fn fill_width(mut self) -> Self { + self.style = self.style.fill_width(); + self + } +} + +impl<Message, Renderer> Widget<Message, Renderer> for ProgressBar +where + Renderer: self::Renderer +{ + fn node(&self, _renderer: &Renderer) -> Node { + Node::new(self.style.height(50)) + } + + fn draw( + &self, + renderer: &mut Renderer, + layout: Layout<'_>, + _cursor_position: Point, + ) -> MouseCursor { + renderer.draw( + layout.bounds(), + self.progress, + ); + + MouseCursor::OutOfBounds + } + + fn hash(&self, state: &mut Hasher) { + self.style.hash(state); + } +} + +/// The renderer of a [`ProgressBar`]. +/// +/// Your [`core::Renderer`] will need to implement this trait before being +/// able to use a [`ProgressBar`] in your user interface. +/// +/// [`ProgressBar`]: struct.ProgressBar.html +/// [`core::Renderer`]: ../../core/trait.Renderer.html +pub trait Renderer { + /// Draws a [`ProgressBar`]. + /// + /// It receives: + /// * the bounds of the [`ProgressBar`] + /// * the progress of the [`ProgressBar`] + /// + /// [`ProgressBar`]: struct.ProgressBar.html + fn draw( + &mut self, + bounds: Rectangle<f32>, + progress: f32, + ); +} + +impl<'a, Message, Renderer> From<ProgressBar> for Element<'a, Message, Renderer> +where + Renderer: self::Renderer, +{ + fn from(progress_bar: ProgressBar) -> Element<'a, Message, Renderer> { + Element::new(progress_bar) + } +} |