![]() |
![]() |
The Gtk::ProgressBar is typically used to display the progress of a long running operation. It provides a visual clue that processing is underway. The Gtk::ProgressBar 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 Gtk::ProgressBar 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 set_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 Gtk::ProgressBar 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 pulse() perodically to update the progress bar.
There is quite a bit of flexibility provided to control the appearance of the Gtk::ProgressBar. 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.
Public Member Functions | |
Pango::EllipsizeMode | get_ellipsize () const |
Returns the ellipsizing position of the progressbar. | |
double | get_fraction () const |
Returns the current fraction of the task that's been completed. | |
ProgressBarOrientation | get_orientation () const |
Retrieves the current progress bar orientation. | |
double | get_pulse_step () const |
Retrieves the pulse step set with set_pulse_step(). | |
Glib::ustring | get_text () const |
Retrieves the text displayed superimposed on the progress bar, if any. | |
const GtkProgressBar* | gobj () const |
Provides access to the underlying C GtkObject. | |
GtkProgressBar* | gobj () |
Provides access to the underlying C GtkObject. | |
ProgressBar () | |
Glib::PropertyProxy_ReadOnly< bool > | property_ellipsize () const |
The preferred place to ellipsize the string. | |
Glib::PropertyProxy<bool> | property_ellipsize () |
The preferred place to ellipsize the string. | |
Glib::PropertyProxy_ReadOnly< double > | property_fraction () const |
The fraction of total work that has been completed. | |
Glib::PropertyProxy<double> | property_fraction () |
The fraction of total work that has been completed. | |
Glib::PropertyProxy_ReadOnly< ProgressBarOrientation > | property_orientation () const |
Orientation and growth direction of the progress bar. | |
Glib::PropertyProxy<ProgressBarOrientation> | property_orientation () |
Orientation and growth direction of the progress bar. | |
Glib::PropertyProxy_ReadOnly< double > | property_pulse_step () const |
The fraction of total progress to move the bouncing block when pulsed. | |
Glib::PropertyProxy<double> | property_pulse_step () |
The fraction of total progress to move the bouncing block when pulsed. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_text () const |
Text to be displayed in the progress bar. | |
Glib::PropertyProxy<Glib::ustring> | property_text () |
Text to be displayed in the progress bar. | |
void | pulse () |
Indicates that some progress is made, but you don't know how much. | |
void | set_ellipsize (Pango::EllipsizeMode mode) |
Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough space to render the entire string. | |
void | set_fraction (double fraction) |
Causes the progress bar to "fill in" the given fraction of the bar. | |
void | set_orientation (ProgressBarOrientation orientation=PROGRESS_LEFT_TO_RIGHT) |
Causes the progress bar to switch to a different orientation (left-to-right, right-to-left, top-to-bottom, or bottom-to-top). | |
void | set_pulse_step (double fraction) |
Sets the fraction of total progress bar length to move the bouncing block for each call to pulse(). | |
void | set_text (const Glib::ustring& text) |
Causes the given text to appear superimposed on the progress bar. | |
virtual | ~ProgressBar () |
Related Functions | |
(Note that these are not member functions.) | |
Gtk::ProgressBar* | wrap (GtkProgressBar* object, bool take_copy=false) |
|
|
|
|
|
Returns the ellipsizing position of the progressbar. See set_ellipsize().
|
|
Returns the current fraction of the task that's been completed.
|
|
Retrieves the current progress bar orientation.
|
|
Retrieves the pulse step set with set_pulse_step().
|
|
Retrieves the text displayed superimposed on the progress bar, if any.
|
|
Provides access to the underlying C GtkObject.
Reimplemented from Gtk::Widget. |
|
Provides access to the underlying C GtkObject.
Reimplemented from Gtk::Widget. |
|
The preferred place to ellipsize the string. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
The preferred place to ellipsize the string. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
The fraction of total work that has been completed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
The fraction of total work that has been completed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Orientation and growth direction of the progress bar. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Orientation and growth direction of the progress bar. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
The fraction of total progress to move the bouncing block when pulsed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
The fraction of total progress to move the bouncing block when pulsed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Text to be displayed in the progress bar. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Text to be displayed in the progress bar. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
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 pulse() causes the block to move by a little bit (the amount of movement per pulse is determined by set_pulse_step()). |
|
Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough space to render the entire string.
|
|
Causes the progress bar to "fill in" the given fraction of the bar. 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).
|
|
Sets the fraction of total progress bar length to move the bouncing block for each call to pulse().
|
|
Causes the given text to appear superimposed on the progress bar.
|
|
|