Struct ProgressBar

pub struct ProgressBar<'a, Theme = Theme>
where
    Theme: Catalog,
{ /* private fields */ }

A bar that displays progress.

Example

use iced::widget::progress_bar;

struct State {
   progress: f32,
}

enum Message {
    // ...
}

fn view(state: &State) -> Element<'_, Message> {
    progress_bar(0.0..=100.0, state.progress).into()
}

Implementations

impl<'a, Theme> ProgressBar<'a, Theme>

where Theme: Catalog,

pub const DEFAULT_GIRTH: f32 = 30f32

The default girth of a ProgressBar.

pub fn new(range: RangeInclusive<f32>, value: f32) -> ProgressBar<'a, Theme>

Creates a new ProgressBar.

It expects:

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

pub fn length(self, length: impl Into<Length>) -> ProgressBar<'a, Theme>

Sets the width of the ProgressBar.

pub fn girth(self, girth: impl Into<Length>) -> ProgressBar<'a, Theme>

Sets the height of the ProgressBar.

pub fn vertical(self) -> ProgressBar<'a, Theme>

Turns the ProgressBar into a vertical ProgressBar.

By default, a ProgressBar is horizontal.

pub fn style( self, style: impl Fn(&Theme) -> Style + 'a, ) -> ProgressBar<'a, Theme>

where <Theme as Catalog>::Class<'a>: From<Box<dyn Fn(&Theme) -> Style + 'a>>,

Sets the style of the ProgressBar.

pub fn class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> ProgressBar<'a, Theme>

Sets the style class of the ProgressBar.

Trait Implementations

impl<'a, Message, Theme, Renderer> From<ProgressBar<'a, Theme>> for Element<'a, Message, Theme, Renderer>

where Message: 'a, Theme: 'a + Catalog, Renderer: 'a + Renderer,

fn from( progress_bar: ProgressBar<'a, Theme>, ) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<Message, Theme, Renderer> Widget<Message, Theme, Renderer> for ProgressBar<'_, Theme>

where Theme: Catalog, Renderer: Renderer,

fn size(&self) -> Size<Length>

Returns the Size of the Widget in lengths.

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

Returns the layout::Node of the Widget.

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

Draws the Widget using the associated Renderer.

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.

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>

Returns the state Tree of the children of the Widget.

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

Reconciles the Widget with the provided Tree.

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

Applies an Operation to the Widget.

fn update( &mut self, _state: &mut Tree, _event: &Event, _layout: Layout<'_>, _cursor: Cursor, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, _shell: &mut Shell<'_, Message>, _viewport: &Rectangle, )

Processes a runtime Event.

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

Returns the current mouse::Interaction of the Widget.

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

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