Struct gtk4::ProgressBar

#[repr(transparent)]
pub struct ProgressBar { /* private fields */ }

ProgressBar is typically used to display the progress of a long running operation.

It provides a visual clue that processing is underway. ProgressBar can be used in two different modes: percentage mode and activity mode.

When an application can determine how much work needs to take place (e.g. read a fixed number of bytes from a file) and can monitor its progress, it can use the ProgressBar in percentage mode and the user sees a growing bar indicating the percentage of the work that has been completed. In this mode, the application is required to call set_fraction() periodically to update the progress bar.

When an application has no accurate way of knowing the amount of work to do, it can use the ProgressBar in activity mode, which shows activity by a block moving back and forth within the progress area. In this mode, the application is required to call pulse() periodically to update the progress bar.

There is quite a bit of flexibility provided to control the appearance of the ProgressBar. Functions are provided to control the orientation of the bar, optional text can be displayed along with the bar, and the step size used in activity mode can be set.

CSS nodes

progressbar[.osd]
├── [text]
╰── trough[.empty][.full]
    ╰── progress[.pulse]

ProgressBar has a main CSS node with name progressbar and subnodes with names text and trough, of which the latter has a subnode named progress. The text subnode is only present if text is shown. The progress subnode has the style class .pulse when in activity mode. It gets the style classes .left, .right, .top or .bottom added when the progress ‘touches’ the corresponding end of the GtkProgressBar. The .osd class on the progressbar node is for use in overlays like the one Epiphany has for page loading progress.

Accessibility

ProgressBar uses the AccessibleRole::ProgressBar role.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, OrientableExt, WidgetExtManual, AccessibleExtManual

Implementations

impl ProgressBar

pub fn new() -> ProgressBar

Creates a new ProgressBar.

Returns

a ProgressBar.

pub fn builder() -> ProgressBarBuilder

Creates a new builder-pattern struct instance to construct ProgressBar objects.

This method returns an instance of ProgressBarBuilder which can be used to create ProgressBar objects.

pub fn ellipsize(&self) -> EllipsizeMode

Returns the ellipsizing position of the progress bar.

See set_ellipsize().

Returns

pango::EllipsizeMode

pub fn fraction(&self) -> f64

Returns the current fraction of the task that’s been completed.

Returns

a fraction from 0.0 to 1.0

pub fn is_inverted(&self) -> bool

Returns whether the progress bar is inverted.

Returns

true if the progress bar is inverted

pub fn pulse_step(&self) -> f64

Retrieves the pulse step.

See set_pulse_step().

Returns

a fraction from 0.0 to 1.0

pub fn shows_text(&self) -> bool

Returns whether the ProgressBar shows text.

See set_show_text().

Returns

true if text is shown in the progress bar

pub fn text(&self) -> Option<GString>

Retrieves the text that is displayed with the progress bar.

The return value is a reference to the text, not a copy of it, so will become invalid if you change the text in the progress bar.

Returns

the text

pub fn pulse(&self)

Indicates that some progress has been made, but you don’t know how much.

Causes the progress bar to enter “activity mode,” where a block bounces back and forth. Each call to pulse() causes the block to move by a little bit (the amount of movement per pulse is determined by set_pulse_step()).

pub fn set_ellipsize(&self, mode: EllipsizeMode)

Sets the mode used to ellipsize the text.

The text is ellipsized if there is not enough space to render the entire string.

mode

a pango::EllipsizeMode

pub fn set_fraction(&self, fraction: f64)

Causes the progress bar to “fill in” the given fraction of the bar.

The fraction should be between 0.0 and 1.0, inclusive.

fraction

fraction of the task that’s been completed

pub fn set_inverted(&self, inverted: bool)

Sets whether the progress bar is inverted.

Progress bars normally grow from top to bottom or left to right. Inverted progress bars grow in the opposite direction.

inverted

true to invert the progress bar

pub fn set_pulse_step(&self, fraction: f64)

Sets the fraction of total progress bar length to move the bouncing block.

The bouncing block is moved when pulse() is called.

fraction

fraction between 0.0 and 1.0

pub fn set_show_text(&self, show_text: bool)

Sets whether the progress bar will show text next to the bar.

The shown text is either the value of the property::ProgressBar::text property or, if that is None, the property::ProgressBar::fraction value, as a percentage.

To make a progress bar that is styled and sized suitably for containing text (even if the actual text is blank), set property::ProgressBar::show-text to true and property::ProgressBar::text to the empty string (not None).

show_text

whether to show text

pub fn set_text(&self, text: Option<&str>)

Causes the given @text to appear next to the progress bar.

If @text is None and property::ProgressBar::show-text is true, the current value of property::ProgressBar::fraction will be displayed as a percentage.

If @text is non-None and property::ProgressBar::show-text is true, the text will be displayed. In this case, it will not display the progress percentage. If @text is the empty string, the progress bar will still be styled and sized suitably for containing text, as long as property::ProgressBar::show-text is true.

text

a UTF-8 string

pub fn connect_ellipsize_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_fraction_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_inverted_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_pulse_step_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_show_text_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_text_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for ProgressBar

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProgressBar

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ProgressBar

fn default() -> Self

Returns the “default value” for a type.

impl Display for ProgressBar

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for ProgressBar

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ProgressBar

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for ProgressBar

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for ProgressBar

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for ProgressBar

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ProgressBar

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ProgressBar

impl IsA<Accessible> for ProgressBar

impl IsA<Buildable> for ProgressBar

impl IsA<ConstraintTarget> for ProgressBar

impl IsA<Orientable> for ProgressBar

impl IsA<Widget> for ProgressBar