Struct iced::widget::ProgressBar

pub struct ProgressBar<Renderer>where
    Renderer: Renderer,
    <Renderer as Renderer>::Theme: StyleSheet,{ /* private fields */ }

A bar that displays progress.

Example

let value = 50.0;

ProgressBar::new(0.0..=100.0, value);

Implementations

impl<Renderer> ProgressBar<Renderer>where
    Renderer: Renderer,
    <Renderer as Renderer>::Theme: StyleSheet,

pub const DEFAULT_HEIGHT: u16 = 30u16

The default height of a ProgressBar.

pub fn new(range: RangeInclusive<f32>, value: f32) -> ProgressBar<Renderer>

Creates a new ProgressBar.

It expects:

• an inclusive range of possible values
• the current value of the ProgressBar

pub fn width(self, width: Length) -> ProgressBar<Renderer>

Sets the width of the ProgressBar.

pub fn height(self, height: Length) -> ProgressBar<Renderer>

Sets the height of the ProgressBar.

pub fn style(
    self,
    style: impl Into<<<Renderer as Renderer>::Theme as StyleSheet>::Style>
) -> ProgressBar<Renderer>

Sets the style of the ProgressBar.

Trait Implementations

impl<Message, Renderer> Widget<Message, Renderer> for ProgressBar<Renderer>where
    Renderer: Renderer,
    <Renderer as Renderer>::Theme: StyleSheet,

fn width(&self) -> Length

Returns the width of the Widget.

fn height(&self) -> Length

Returns the height of the Widget.

fn layout(&self, _renderer: &Renderer, limits: &Limits) -> Node

Returns the layout::Node of the Widget.

fn draw(
    &self,
    _state: &Tree,
    renderer: &mut Renderer,
    theme: &<Renderer as Renderer>::Theme,
    _style: &Style,
    layout: Layout<'_>,
    _cursor_position: Point,
    _viewport: &Rectangle<f32>
)

Draws the Widget using the associated Renderer.

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn children(&self) -> Vec<Tree, Global>

Returns the state Tree of the children of the Widget.

fn diff(&self, _tree: &mut Tree)

Reconciliates the Widget with the provided Tree.

fn operate(
    &self,
    _state: &mut Tree,
    _layout: Layout<'_>,
    _operation: &mut dyn Operation<Message>
)

Applies an Operation to the Widget.

fn on_event(
    &mut self,
    _state: &mut Tree,
    _event: Event,
    _layout: Layout<'_>,
    _cursor_position: Point,
    _renderer: &Renderer,
    _clipboard: &mut dyn Clipboard,
    _shell: &mut Shell<'_, Message>
) -> Status

Processes a runtime Event.

fn mouse_interaction(
    &self,
    _state: &Tree,
    _layout: Layout<'_>,
    _cursor_position: Point,
    _viewport: &Rectangle<f32>,
    _renderer: &Renderer
) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn overlay<'a>(
    &'a self,
    _state: &'a mut Tree,
    _layout: Layout<'_>,
    _renderer: &Renderer
) -> Option<Element<'a, Message, Renderer>>

Returns the overlay of the Widget, if there is any.