Next: , Previous: progress, Up: Widgets


6.2.68 progress-bar

— Class: progress-bar

Superclass: progress atk-implementor-iface buildable

The progress-bar is typically used to display the progress of a long running operation. It provides a visual clue that processing is underway. The progress-bar 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 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 set progress-bar-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 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 progress-bar-pulse perodically 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.

Slots:

Signals:

— Method: progress-bar-pulse
     (progress-bar-pulse progress-bar)

Indicates that some progress is 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 progress-bar-pulse causes the block to move by a little bit (the amount of movement per pulse is determined by progress-bar-pulse-step).