Struct orbtk_widgets::ProgressBar

pub struct ProgressBar { /* fields omitted */ }

The ProgressBar widget is used to indicating a finite progress (e.g. copying a file, downloading a video from the internet). A progress is visually represented as a horizontal bar which grows when the progress advances. The ProgressBar expects values between 0.0 and 1.0, whereas 0.0 means 0%, and 1.0 means 100%. Any value outside of this range considered as 100%.

This example creates a ProgressBar with default values:

ProgressBar::new().build(ctx)

The next example creates a ProgressBar initialized with 25% progress:

ProgressBar::new().val(0.25).build(ctx)

The progress can be controlled by changing the value of the val property. (this code assumes that you have a children with id "pgbar")

ctx.child("pgbar").set::<f64>("val", amount);

Implementations

impl ProgressBar

pub fn get<'a>(ctx: WidgetContainer<'a>) -> ProgressBarCtx<'a>

Gets a widget context that wraps the given widgets an provides access to the its properties.

impl ProgressBar

pub fn id(self, id: impl Into<String>) -> Self

Sets the id selector.

pub fn style(self, style: impl Into<String>) -> Self

Sets the style selector (replaces the old selector property).

pub fn position(self, position: impl IntoPropertySource<Point>) -> Self

Sets or shares the position of the widget. (Be careful the position could be adjusted by layouts).

pub fn constraint(self, constraint: impl IntoPropertySource<Constraint>) -> Self

Sets or shares the constraint property.

pub fn on_changed_filter(self, filter: impl IntoPropertySource<Filter>) -> Self

Sets or shares the filter for the on_changed property callback.

pub fn v_align(self, v_align: impl IntoPropertySource<Alignment>) -> Self

Sets or shares the vertical alignment property.

pub fn h_align(self, h_align: impl IntoPropertySource<Alignment>) -> Self

Sets or shares the horizontal alignment property.

pub fn vertical_alignment(
    self,
    vertical_alignment: impl IntoPropertySource<Alignment>
) -> Self

👎 Deprecated:

Use v_align instead

Sets or shares the vertical alignment property.

pub fn horizontal_alignment(
    self,
    horizontal_alignment: impl IntoPropertySource<Alignment>
) -> Self

👎 Deprecated:

Use h_align instead

Sets or shares the horizontal alignment property.

pub fn visibility(self, visibility: impl IntoPropertySource<Visibility>) -> Self

Sets or shares the visibility property.

pub fn margin(self, margin: impl IntoPropertySource<Thickness>) -> Self

Sets or shares the margin property.

pub fn enabled(self, enabled: impl IntoPropertySource<bool>) -> Self

Sets or shares the enabled property.

pub fn clip(self, clip: impl IntoPropertySource<bool>) -> Self

Sets or shares the clip property.

pub fn opacity(self, opacity: impl IntoPropertySource<f32>) -> Self

Sets or shares the opacity property.

pub fn width(self, width: impl Into<f64>) -> Self

Inserts a new width.

pub fn height(self, height: impl Into<f64>) -> Self

Inserts a new height.

pub fn size(self, width: impl Into<f64>, height: impl Into<f64>) -> Self

Inserts a new size.

pub fn min_width(self, min_width: impl Into<f64>) -> Self

Inserts a new min_width.

pub fn min_height(self, min_height: impl Into<f64>) -> Self

Inserts a new min_height.

pub fn min_size(
    self,
    min_width: impl Into<f64>,
    min_height: impl Into<f64>
) -> Self

Inserts a new min_size.

pub fn max_width(self, max_width: impl Into<f64>) -> Self

Inserts a new max_width.

pub fn max_height(self, max_height: impl Into<f64>) -> Self

Inserts a new max_height.

pub fn max_size(
    self,
    max_width: impl Into<f64>,
    max_height: impl Into<f64>
) -> Self

Inserts a new min_size.

pub fn name<P: Into<String>>(self, name: P) -> Self

Sets the debug name of the widget.

pub fn background<P: IntoPropertySource<Brush>>(self, background: P) -> Self

Sets or shares the background color property

pub fn border_brush<P: IntoPropertySource<Brush>>(self, border_brush: P) -> Self

Sets or shares the border color property

pub fn border_radius<P: IntoPropertySource<f64>>(self, border_radius: P) -> Self

Sets or shares the border radius property

pub fn border_width<P: IntoPropertySource<Thickness>>(
    self,
    border_width: P
) -> Self

Sets or shares the border width property

pub fn padding<P: IntoPropertySource<Thickness>>(self, padding: P) -> Self

Sets or shares the padding property

pub fn val<P: IntoPropertySource<f64>>(self, val: P) -> Self

Sets or shares the current progress property

Trait Implementations

impl ChangedHandler for ProgressBar

fn on_changed<H>(self, handler: H) -> Self where
    H: 'static + Fn(&mut StatesContext<'_>, Entity, &str), 

Register a on property changed handler.

impl Default for ProgressBar

fn default() -> ProgressBar

Returns the "default value" for a type.

impl Template for ProgressBar

fn template(self, _: Entity, ctx: &mut BuildContext<'_>) -> Self

Builds the template of the widget and returns it.

fn render_object(&self) -> Box<dyn RenderObject>

Returns a pointer to a heap allocated object which specifies how the widget should be drawn on the canvas. For the list of available render objects, see the [render_object] module.

fn layout(&self) -> Box<dyn Layout>

Returns a pointer to a heap allocated object which specifies the way in which the widget are arranged or laid out on the canvas. For the list of available layout objects, see the [layout] module.

impl Widget for ProgressBar

fn new() -> Self

Creates a new widget.

fn attach<P: Component + Debug>(self, property: AttachedProperty<P>) -> Self

fn insert_handler(self, handler: impl Into<Rc<dyn EventHandler>>) -> Self

Inerts a new event handler.

fn child(self, child: Entity) -> Self

Appends a child to the widget.

fn build(self, ctx: &mut BuildContext<'_>) -> Entity

Builds the widget and returns the template of the widget.

fn create() -> Self

👎 Deprecated:

Use new instead

Creates a new widget.