Struct egui::widgets::progress_bar::ProgressBar

source ·
pub struct ProgressBar {
    progress: f32,
    desired_width: Option<f32>,
    desired_height: Option<f32>,
    text: Option<ProgressBarText>,
    fill: Option<Color32>,
    animate: bool,
    rounding: Option<Rounding>,
}
Expand description

A simple progress bar.

See also: crate::Spinner.

Fields§

§progress: f32§desired_width: Option<f32>§desired_height: Option<f32>§text: Option<ProgressBarText>§fill: Option<Color32>§animate: bool§rounding: Option<Rounding>

Implementations§

source§

impl ProgressBar

source

pub fn new(progress: f32) -> Self

Progress in the [0, 1] range, where 1 means “completed”.

source

pub fn desired_width(self, desired_width: f32) -> Self

The desired width of the bar. Will use all horizontal space if not set.

source

pub fn desired_height(self, desired_height: f32) -> Self

The desired height of the bar. Will use the default interaction size if not set.

source

pub fn fill(self, color: Color32) -> Self

The fill color of the bar.

source

pub fn text(self, text: impl Into<WidgetText>) -> Self

A custom text to display on the progress bar.

source

pub fn show_percentage(self) -> Self

Show the progress in percent on the progress bar.

source

pub fn animate(self, animate: bool) -> Self

Whether to display a loading animation when progress < 1. Note that this will cause the UI to be redrawn. Defaults to false.

If Self::rounding and Self::animate are used simultaneously, the animation is not rendered, since it requires a perfect circle to render correctly. However, the UI is still redrawn.

source

pub fn rounding(self, rounding: impl Into<Rounding>) -> Self

Set the rounding of the progress bar.

If Self::rounding and Self::animate are used simultaneously, the animation is not rendered, since it requires a perfect circle to render correctly. However, the UI is still redrawn.

Trait Implementations§

source§

impl Widget for ProgressBar

source§

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.