me/iced
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix docs for progress_bar

Browse source
This commit is contained in:
Héctor Ramón Jiménez 2019-09-03 14:17:36 +02:00
parent 5c5612d931
commit 3e41c4b590
1 changed files with 16 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

35
src/widget/progress_bar.rs
View file

@ -1,4 +1,4 @@
//! Displays action progress to your users. //! Provide visual feedback to your users when performing a slow task.
use crate::{ use crate::{
Element, Hasher, Layout, MouseCursor, Node, Point, Rectangle, Style, Widget, Element, Hasher, Layout, MouseCursor, Node, Point, Rectangle, Style, Widget,
@ -6,14 +6,14 @@ use crate::{
use std::hash::Hash; use std::hash::Hash;
/// A widget that displays a progress of an action. /// A bar that is filled based on an amount of progress.
/// ///
/// It implements [`Widget`] when the associated [`core::Renderer`] implements /// It implements [`Widget`] when the associated `Renderer` implements the
/// the [`button::Renderer`] trait. /// [`progress_bar::Renderer`] trait.
/// ///
/// [`Widget`]: ../../core/trait.Widget.html /// [`Widget`]: ../trait.Widget.html
/// [`core::Renderer`]: ../../core/trait.Renderer.html
/// [`progress_bar::Renderer`]: trait.Renderer.html /// [`progress_bar::Renderer`]: trait.Renderer.html
///
/// # Example /// # Example
/// ///
/// ``` /// ```
@ -30,7 +30,11 @@ pub struct ProgressBar {
} }
impl ProgressBar { impl ProgressBar {
/// Creates a new [`ProgressBar`] with given progress. /// Creates a new [`ProgressBar`] filled based on the given amount of
/// progress.
///
/// The progress should be in the `0.0..=1.0` range. `0` meaning no work
/// done, and `1` meaning work finished.
/// ///
/// [`ProgressBar`]: struct.ProgressBar.html /// [`ProgressBar`]: struct.ProgressBar.html
pub fn new(progress: f32) -> Self { pub fn new(progress: f32) -> Self {
@ -47,14 +51,6 @@ impl ProgressBar {
self.style = self.style.width(width); self.style = self.style.width(width);
self 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 impl<Message, Renderer> Widget<Message, Renderer> for ProgressBar
@ -83,17 +79,18 @@ where
/// The renderer of a [`ProgressBar`]. /// The renderer of a [`ProgressBar`].
/// ///
/// Your [`core::Renderer`] will need to implement this trait before being /// Your [renderer] will need to implement this trait before being able to use
/// able to use a [`ProgressBar`] in your user interface. /// a [`ProgressBar`] in your user interface.
/// ///
/// [`ProgressBar`]: struct.ProgressBar.html /// [`ProgressBar`]: struct.ProgressBar.html
/// [`core::Renderer`]: ../../core/trait.Renderer.html /// [renderer]: ../../renderer/index.html
pub trait Renderer { pub trait Renderer {
/// Draws a [`ProgressBar`]. /// Draws a [`ProgressBar`].
/// ///
/// It receives: /// It receives:
/// * the bounds of the [`ProgressBar`] /// * the bounds of the [`ProgressBar`]
/// * the progress of the [`ProgressBar`] /// * the current progress of the [`ProgressBar`], in the `0.0..=1.0`
/// range.
/// ///
/// [`ProgressBar`]: struct.ProgressBar.html /// [`ProgressBar`]: struct.ProgressBar.html
fn draw(&mut self, bounds: Rectangle, progress: f32); fn draw(&mut self, bounds: Rectangle, progress: f32);