Class progress-bar - cl-cffi-gtk4 API documentation

Package: gtk

Class gtk:progress-bar

Superclasses

gtk:widget, gobject:initially-unowned, gtk:accessible-range, gtk:accessible, gtk:buildable, gtk:constraint-target, gtk:orientable, gobject:object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

None

Direct Slots

ellipsize

The ellipsize property of type pango:ellipsize-mode (Read / Write)
The preferred place to ellipsize the string, if the progress bar does not have enough room to display the entire string, specified as a value of the pango:ellipsize-mode enumeration. Note that setting this property to a value other than :none has the side-effect that the progress bar requests only enough space to display the ellipsis ("..."). Another means to set the width of the progress bar is the gtk:widget-size-request function.
Default value: :none

fraction

The fraction property of type :double (Read / Write)
The fraction of total work that has been completed.
Allowed values: [0.0, 1.0]
Default value: 0.0

inverted

The inverted property of type :boolean (Read / Write)
Invert the direction in which the progress bar grows.
Default value: false

pulse-step

The pulse-step property of type :double (Read / Write)
The fraction of total progress to move the bouncing block when pulsed.
Allowed values: [0.0, 1.0]
Default value: 0.1

show-text

The show-text property of type :boolean (Read / Write)
Sets whether the progress bar will show text superimposed over the progress bar. The shown text is either the value of the text property or, if that is nil, the 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 the show-text property to true and the text property to the empty string, not nil.
Default value: false

text

The text property of type :string (Read / Write)
Text to be displayed in the progress bar.
Default value: nil

Details

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 progress bar, optional text can be displayed along with the progress bar, and the step size used in activity mode can be set.

CSS nodes

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 progress bar node is for use in overlays like the one Epiphany has for page loading progress.