gtk:widget, gtk:buildable, gtk:orientable, gobject:object, common-lisp:standard-object, common-lisp:t

None

The gtk:progress-bar widget is typically used to display the progress of a long running operation. It provides a visual clue that processing is underway. The gtk:progress-bar widget can be used in two different modes: percentage mode and activity mode.


Figure: GtkProgressBar

When an application can determine how much work needs to take place, for example read a fixed number of bytes from a file, and can monitor its progress, it can use the progress bar 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 the gtk:progress-bar-fraction function 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 progress bar 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 the gtk:progress-bar-pulse function periodically to update the progress bar.

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

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

The gtk:progress-bar implementation 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 .pulse style class when in activity mode. It gets the .left, .right, .top or .bottom style classes added when the progress 'touches' the corresponding end of the progress bar. The .osd style class on the progressbar node is for use in overlays like the one Epiphany has for page loading progress.