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:
integer. Accessor: progress-bar-activity-blocks.
The number of blocks which can fit in the progress bar area in activity mode (Deprecated).
Allowed values: >= 2
Default value: 5
integer. Accessor: progress-bar-activity-step.
The increment used for each iteration in activity mode (Deprecated).
Default value: 3
progress-bar-adjustment.
The adjustment connected to the progress bar (Deprecated
progress-bar-bar-style.
Specifies the visual style of the bar in percentage mode (Deprecated).
Default value: :continuous
integer. Accessor: progress-bar-discrete-blocks.
The number of discrete blocks in a progress bar (when shown in the discrete style).
Allowed values: >= 2
Default value: 10
progress-bar-ellipsize.
The preferred place to ellipsize the string, if the progressbar does not have enough room to display the entire string.
Note that setting this property to a value other than :none has the side-effect that the progressbar requests only enough space to display the ellipsis "...". Another means to set a progressbar's width is widget-width-request.
Default value: :none
double-float. Accessor: progress-bar-fraction.
The fraction of total work that has been completed.
Allowed values: [0,1]
Default value: 0
progress-bar-orientation.
Orientation and growth direction of the progress bar.
Default value: :left-to-right
double-float. Accessor: progress-bar-pulse-step.
The fraction of total progress to move the bouncing block when pulsed.
Allowed values: [0,1]
Default value: 0.1
string. Accessor: progress-bar-text.
Text to be displayed in the progress bar.
Default value: NIL
Signals:
(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).