Move DEFAULT_HEIGHT
constant to Renderer
Also fixes some minor documentation issues.
This commit is contained in:
parent
0b663ca82a
commit
9116afaf59
@ -1,7 +1,4 @@
|
|||||||
//! Display a ProgressBar
|
//! Provide progress feedback to your users.
|
||||||
//!
|
|
||||||
//!
|
|
||||||
//! [`ProgressBar`]: struct.ProgressBar.html
|
|
||||||
use crate::{
|
use crate::{
|
||||||
layout, Background, Color, Element, Hasher, Layout, Length, Point,
|
layout, Background, Color, Element, Hasher, Layout, Length, Point,
|
||||||
Rectangle, Size, Widget,
|
Rectangle, Size, Widget,
|
||||||
@ -9,26 +6,24 @@ use crate::{
|
|||||||
|
|
||||||
use std::{hash::Hash, ops::RangeInclusive};
|
use std::{hash::Hash, ops::RangeInclusive};
|
||||||
|
|
||||||
const DEFAULT_HEIGHT: Length = Length::Units(30);
|
/// A bar that displays progress.
|
||||||
|
|
||||||
/// A ProgressBar
|
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Example
|
||||||
///
|
|
||||||
/// ```
|
/// ```
|
||||||
/// # use iced_native::ProgressBar;
|
/// # use iced_native::ProgressBar;
|
||||||
///
|
/// #
|
||||||
/// let value = 50.0;
|
/// let value = 50.0;
|
||||||
|
///
|
||||||
/// ProgressBar::new(0.0..=100.0, value);
|
/// ProgressBar::new(0.0..=100.0, value);
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// 
|
/// 
|
||||||
#[allow(missing_debug_implementations)]
|
#[allow(missing_debug_implementations)]
|
||||||
pub struct ProgressBar {
|
pub struct ProgressBar {
|
||||||
range: RangeInclusive<f32>,
|
range: RangeInclusive<f32>,
|
||||||
value: f32,
|
value: f32,
|
||||||
width: Length,
|
width: Length,
|
||||||
height: Length,
|
height: Option<Length>,
|
||||||
background: Option<Background>,
|
background: Option<Background>,
|
||||||
active_color: Option<Color>,
|
active_color: Option<Color>,
|
||||||
}
|
}
|
||||||
@ -46,7 +41,7 @@ impl ProgressBar {
|
|||||||
value: value.max(*range.start()).min(*range.end()),
|
value: value.max(*range.start()).min(*range.end()),
|
||||||
range,
|
range,
|
||||||
width: Length::Fill,
|
width: Length::Fill,
|
||||||
height: DEFAULT_HEIGHT,
|
height: None,
|
||||||
background: None,
|
background: None,
|
||||||
active_color: None,
|
active_color: None,
|
||||||
}
|
}
|
||||||
@ -64,7 +59,7 @@ impl ProgressBar {
|
|||||||
///
|
///
|
||||||
/// [`ProgressBar`]: struct.ProgressBar.html
|
/// [`ProgressBar`]: struct.ProgressBar.html
|
||||||
pub fn height(mut self, height: Length) -> Self {
|
pub fn height(mut self, height: Length) -> Self {
|
||||||
self.height = height;
|
self.height = Some(height);
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -95,6 +90,7 @@ where
|
|||||||
|
|
||||||
fn height(&self) -> Length {
|
fn height(&self) -> Length {
|
||||||
self.height
|
self.height
|
||||||
|
.unwrap_or(Length::Units(Renderer::DEFAULT_HEIGHT))
|
||||||
}
|
}
|
||||||
|
|
||||||
fn layout(
|
fn layout(
|
||||||
@ -102,7 +98,10 @@ where
|
|||||||
_renderer: &Renderer,
|
_renderer: &Renderer,
|
||||||
limits: &layout::Limits,
|
limits: &layout::Limits,
|
||||||
) -> layout::Node {
|
) -> layout::Node {
|
||||||
let limits = limits.width(self.width).height(self.height);
|
let limits = limits.width(self.width).height(
|
||||||
|
self.height
|
||||||
|
.unwrap_or(Length::Units(Renderer::DEFAULT_HEIGHT)),
|
||||||
|
);
|
||||||
|
|
||||||
let size = limits.resolve(Size::ZERO);
|
let size = limits.resolve(Size::ZERO);
|
||||||
|
|
||||||
@ -137,10 +136,14 @@ where
|
|||||||
/// [`ProgressBar`]: struct.ProgressBar.html
|
/// [`ProgressBar`]: struct.ProgressBar.html
|
||||||
/// [renderer]: ../../renderer/index.html
|
/// [renderer]: ../../renderer/index.html
|
||||||
pub trait Renderer: crate::Renderer {
|
pub trait Renderer: crate::Renderer {
|
||||||
|
/// The default height of a [`ProgressBar`].
|
||||||
|
///
|
||||||
|
/// [`ProgressBar`]: struct.ProgressBar.html
|
||||||
|
const DEFAULT_HEIGHT: u16;
|
||||||
|
|
||||||
/// Draws a [`ProgressBar`].
|
/// Draws a [`ProgressBar`].
|
||||||
///
|
///
|
||||||
/// It receives:
|
/// It receives:
|
||||||
/// * the local state of the [`ProgressBar`]
|
|
||||||
/// * the bounds of the [`ProgressBar`]
|
/// * the bounds of the [`ProgressBar`]
|
||||||
/// * the range of values of the [`ProgressBar`]
|
/// * the range of values of the [`ProgressBar`]
|
||||||
/// * the current value of the [`ProgressBar`]
|
/// * the current value of the [`ProgressBar`]
|
||||||
@ -148,8 +151,6 @@ pub trait Renderer: crate::Renderer {
|
|||||||
/// * maybe a specific active color 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(
|
fn draw(
|
||||||
&self,
|
&self,
|
||||||
bounds: Rectangle,
|
bounds: Rectangle,
|
||||||
@ -165,7 +166,7 @@ where
|
|||||||
Renderer: self::Renderer,
|
Renderer: self::Renderer,
|
||||||
Message: 'static,
|
Message: 'static,
|
||||||
{
|
{
|
||||||
fn from(progressbar: ProgressBar) -> Element<'a, Message, Renderer> {
|
fn from(progress_bar: ProgressBar) -> Element<'a, Message, Renderer> {
|
||||||
Element::new(progressbar)
|
Element::new(progress_bar)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -2,6 +2,8 @@ use crate::{Primitive, Renderer};
|
|||||||
use iced_native::{progress_bar, Background, Color, MouseCursor, Rectangle};
|
use iced_native::{progress_bar, Background, Color, MouseCursor, Rectangle};
|
||||||
|
|
||||||
impl progress_bar::Renderer for Renderer {
|
impl progress_bar::Renderer for Renderer {
|
||||||
|
const DEFAULT_HEIGHT: u16 = 30;
|
||||||
|
|
||||||
fn draw(
|
fn draw(
|
||||||
&self,
|
&self,
|
||||||
bounds: Rectangle,
|
bounds: Rectangle,
|
||||||
|
Loading…
Reference in New Issue
Block a user