Class

GtkProgressBar

[]

Description [src]

final class Gtk.ProgressBar : Gtk.Widget
  implements Gtk.Accessible, Gtk.AccessibleRange, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Orientable {
  /* No available fields */
}

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

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

An example GtkProgressBar

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 GtkProgressBar 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 gtk_progress_bar_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 GtkProgressBar 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 gtk_progress_bar_pulse() periodically to update the progress bar.

There is quite a bit of flexibility provided to control the appearance of the GtkProgressBar. 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]

GtkProgressBar 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

GtkProgressBar uses the GTK_ACCESSIBLE_ROLE_PROGRESS_BAR role.

[]

Hierarchy

hierarchy this GtkProgressBar implements_0 GtkAccessible this--implements_0 implements_1 GtkAccessibleRange this--implements_1 implements_2 GtkBuildable this--implements_2 implements_3 GtkConstraintTarget this--implements_3 implements_4 GtkOrientable this--implements_4 ancestor_0 GtkWidget ancestor_0--this ancestor_1 GInitiallyUnowned ancestor_1--ancestor_0 ancestor_2 GObject ancestor_2--ancestor_1
[]

Constructors

gtk_progress_bar_new

Creates a new GtkProgressBar.

[]

Instance methods

gtk_progress_bar_get_ellipsize

Returns the ellipsizing position of the progress bar.

gtk_progress_bar_get_fraction

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

gtk_progress_bar_get_inverted

Returns whether the progress bar is inverted.

gtk_progress_bar_get_pulse_step

Retrieves the pulse step.

gtk_progress_bar_get_show_text

Returns whether the GtkProgressBar shows text.

gtk_progress_bar_get_text

Retrieves the text that is displayed with the progress bar.

gtk_progress_bar_pulse

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

gtk_progress_bar_set_ellipsize

Sets the mode used to ellipsize the text.

gtk_progress_bar_set_fraction

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

gtk_progress_bar_set_inverted

Sets whether the progress bar is inverted.

gtk_progress_bar_set_pulse_step

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

gtk_progress_bar_set_show_text

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

gtk_progress_bar_set_text

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

Methods inherited from GtkWidget (162)
Methods inherited from GObject (43)
Methods inherited from GtkAccessible (19)
Methods inherited from GtkBuildable (1)
Methods inherited from GtkOrientable (2)
[]

Properties

Gtk.ProgressBar:ellipsize

The preferred place to ellipsize the string.

Gtk.ProgressBar:fraction

The fraction of total work that has been completed.

Gtk.ProgressBar:inverted

Invert the direction in which the progress bar grows.

Gtk.ProgressBar:pulse-step

The fraction of total progress to move the bounding block when pulsed.

Gtk.ProgressBar:show-text

Sets whether the progress bar will show a text in addition to the bar itself.

Gtk.ProgressBar:text

Text to be displayed in the progress bar.

Properties inherited from GtkWidget (34)
Properties inherited from GtkAccessible (1)
Properties inherited from GtkOrientable (1)
[]

Signals

Signals inherited from GtkWidget (13)
Signals inherited from GObject (1)