change(widget): make height adjustable at widget level

addtionally rename Progressbar to ProgressBar
This commit is contained in:
Songtronix 2020-01-02 18:07:00 +01:00
parent bf8f83decc
commit 986f01237f
5 changed files with 61 additions and 59 deletions

View file

@ -1,7 +1,7 @@
//! Display a progressbar
//! Display a ProgressBar
//!
//!
//! [`Progressbar`]: struct.Progressbar.html
//! [`ProgressBar`]: struct.ProgressBar.html
use crate::{
layout, Background, Color, Element, Hasher, Layout, Length, Point,
Rectangle, Size, Widget,
@ -9,71 +9,83 @@ use crate::{
use std::{hash::Hash, ops::RangeInclusive};
/// A progressbar
const DEFAULT_HEIGHT: Length = Length::Units(30);
/// A ProgressBar
///
/// # Example
///
/// ```
/// # use iced_native::Progressbar;
///
/// # use iced_native::ProgressBar;
///
/// let value = 50.0;
/// Progressbar::new(0.0..=100.0, value);
/// ProgressBar::new(0.0..=100.0, value);
/// ```
///
/// ![Default Progressbar](https://user-images.githubusercontent.com/18618951/71662391-a316c200-2d51-11ea-9cef-52758cab85e3.png)
/// ![Default ProgressBar](https://user-images.githubusercontent.com/18618951/71662391-a316c200-2d51-11ea-9cef-52758cab85e3.png)
#[allow(missing_debug_implementations)]
pub struct Progressbar {
pub struct ProgressBar {
range: RangeInclusive<f32>,
value: f32,
width: Length,
height: Length,
background: Option<Background>,
active_color: Option<Color>,
}
impl Progressbar {
/// Creates a new [`Progressbar`].
impl ProgressBar {
/// Creates a new [`ProgressBar`].
///
/// It expects:
/// * an inclusive range of possible values
/// * the current value of the [`Progressbar`]
/// * the current value of the [`ProgressBar`]
///
/// [`Progressbar`]: struct.Progressbar.html
/// [`ProgressBar`]: struct.ProgressBar.html
pub fn new(range: RangeInclusive<f32>, value: f32) -> Self {
Progressbar {
ProgressBar {
value: value.max(*range.start()).min(*range.end()),
range,
width: Length::Fill,
height: DEFAULT_HEIGHT,
background: None,
active_color: None,
}
}
/// Sets the width of the [`Progressbar`].
/// Sets the width of the [`ProgressBar`].
///
/// [`Progressbar`]: struct.Progressbar.html
/// [`ProgressBar`]: struct.ProgressBar.html
pub fn width(mut self, width: Length) -> Self {
self.width = width;
self
}
/// Sets the background of the [`Progressbar`].
/// Sets the height of the [`ProgressBar`].
///
/// [`Progressbar`]: struct.Progressbar.html
/// [`ProgressBar`]: struct.ProgressBar.html
pub fn height(mut self, height: Length) -> Self {
self.height = height;
self
}
/// Sets the background of the [`ProgressBar`].
///
/// [`ProgressBar`]: struct.ProgressBar.html
pub fn background(mut self, background: Background) -> Self {
self.background = Some(background);
self
}
/// Sets the active color of the [`Progressbar`].
/// Sets the active color of the [`ProgressBar`].
///
/// [`Progressbar`]: struct.Progressbar.html
/// [`ProgressBar`]: struct.ProgressBar.html
pub fn active_color(mut self, active_color: Color) -> Self {
self.active_color = Some(active_color);
self
}
}
impl<Message, Renderer> Widget<Message, Renderer> for Progressbar
impl<Message, Renderer> Widget<Message, Renderer> for ProgressBar
where
Renderer: self::Renderer,
{
@ -82,17 +94,15 @@ where
}
fn height(&self) -> Length {
Length::Shrink
self.height
}
fn layout(
&self,
renderer: &Renderer,
_renderer: &Renderer,
limits: &layout::Limits,
) -> layout::Node {
let limits = limits
.width(self.width)
.height(Length::Units(renderer.height() as u16));
let limits = limits.width(self.width).height(self.height);
let size = limits.resolve(Size::ZERO);
@ -119,30 +129,25 @@ where
}
}
/// The renderer of a [`Progressbar`].
/// The renderer of a [`ProgressBar`].
///
/// Your [renderer] will need to implement this trait before being
/// able to use a [`Progressbar`] in your user interface.
/// able to use a [`ProgressBar`] in your user interface.
///
/// [`Progressbar`]: struct.Progressbar.html
/// [`ProgressBar`]: struct.ProgressBar.html
/// [renderer]: ../../renderer/index.html
pub trait Renderer: crate::Renderer {
/// Returns the height of the [`Progressbar`].
///
/// [`Progressbar`]: struct.Progressbar.html
fn height(&self) -> u32;
/// Draws a [`Progressbar`].
/// Draws a [`ProgressBar`].
///
/// It receives:
/// * the local state of the [`Progressbar`]
/// * the bounds of the [`Progressbar`]
/// * the range of values of the [`Progressbar`]
/// * the current value of the [`Progressbar`]
/// * maybe a specific background of the [`Progressbar`]
/// * maybe a specific active color of the [`Progressbar`]
/// * the local state of the [`ProgressBar`]
/// * the bounds of the [`ProgressBar`]
/// * the range of values of the [`ProgressBar`]
/// * the current value of the [`ProgressBar`]
/// * maybe a specific background of the [`ProgressBar`]
/// * maybe a specific active color of the [`ProgressBar`]
///
/// [`Progressbar`]: struct.Progressbar.html
/// [`ProgressBar`]: struct.ProgressBar.html
/// [`State`]: struct.State.html
/// [`Class`]: enum.Class.html
fn draw(
@ -155,12 +160,12 @@ pub trait Renderer: crate::Renderer {
) -> Self::Output;
}
impl<'a, Message, Renderer> From<Progressbar> for Element<'a, Message, Renderer>
impl<'a, Message, Renderer> From<ProgressBar> for Element<'a, Message, Renderer>
where
Renderer: self::Renderer,
Message: 'static,
{
fn from(progressbar: Progressbar) -> Element<'a, Message, Renderer> {
fn from(progressbar: ProgressBar) -> Element<'a, Message, Renderer> {
Element::new(progressbar)
}
}