A widget which indicates progress visually
Class GtkProgressBar
The GtkProgressBar is typically used to display the progress of a long running operation. It provides a visual clue that processing is underway. The GtkProgressBar can be used in two different modes: percentage mode and activity mode.
[...]
| Methods | |
| get_ellipsize | Returns the ellipsizing position of the progressbar. |
| get_fraction | Returns the current fraction of the task that's been completed. |
| get_orientation | Retrieves the current progress bar orientation. |
| get_pulse_step | Retrieves the pulse step set with gtk_progress_bar_set_pulse_step() |
| get_text | Retrieves the text displayed superimposed on the progress bar, if any, otherwise nil. |
| pulse | 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 gtk_progress_bar_pulse() causes the block to move by a little bit (the amount of movement per pulse is determined by gtk_progress_bar_set_pulse_step()). |
| set_ellipsize | Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough space to render the entire string. |
| set_fraction | Causes the progress bar to "fill in" the given fraction of the bar. |
| set_orientation | Causes the progress bar to switch to a different orientation (left-to-right, right-to-left, top-to-bottom, or bottom-to-top). |
| set_pulse_step | Sets the fraction of total progress bar length to move the bouncing block for each call to gtk_progress_bar_pulse(). |
| set_text | Causes the given text to appear superimposed on the progress bar. |
Returns the ellipsizing position of the progressbar.
GtkProgressBar.get_ellipsize()
| Return | PangoEllipsizeMode |
Returns the current fraction of the task that's been completed.
GtkProgressBar.get_fraction()
| Return | a fraction from 0.0 to 1.0 |
Retrieves the current progress bar orientation.
GtkProgressBar.get_orientation()
| Return | orientation of the progress bar |
Retrieves the pulse step set with gtk_progress_bar_set_pulse_step()
GtkProgressBar.get_pulse_step()
| Return | a fraction from 0.0 to 1.0 |
Retrieves the text displayed superimposed on the progress bar, if any, otherwise nil.
GtkProgressBar.get_text()
| Return | text, or nil. |
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 gtk_progress_bar_pulse() causes the block to move by a little bit (the amount of movement per pulse is determined by gtk_progress_bar_set_pulse_step()).
GtkProgressBar.pulse()
Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough space to render the entire string.
GtkProgressBar.set_ellipsize( mode )
| mode | a PangoEllipsizeMode |
Causes the progress bar to "fill in" the given fraction of the bar.
GtkProgressBar.set_fraction( fraction )
| fraction | fraction of the task that's been completed The fraction should be between 0.0 and 1.0, inclusive. |
Causes the progress bar to switch to a different orientation (left-to-right, right-to-left, top-to-bottom, or bottom-to-top).
GtkProgressBar.set_orientation( orientation )
| orientation | orientation of the progress bar |
Sets the fraction of total progress bar length to move the bouncing block for each call to gtk_progress_bar_pulse().
GtkProgressBar.set_pulse_step( fraction )
| fraction | fraction between 0.0 and 1.0 |
Causes the given text to appear superimposed on the progress bar.
GtkProgressBar.set_text( text )
| text | a UTF-8 string, or nil. |