Description
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.
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 GtkProgressBar 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
gtk_progress_bar_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 GtkProgressBar 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 gtk_progress_bar_pulse() perodically
to update the progress bar.
There is quite a bit of flexibility provided to control the appearance
of the GtkProgressBar. 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.
Note: The GtkProgressBar/GtkProgress API in GTK 1.2 was bloated, needlessly complex
and hard to use properly. Therefore GtkProgress has been deprecated
completely and the GtkProgressBar API has been reduced to the following 9
functions: gtk_progress_bar_new(), gtk_progress_bar_pulse(), gtk_progress_bar_set_text(),
gtk_progress_bar_set_fraction(), gtk_progress_bar_set_pulse_step(),
gtk_progress_bar_set_orientation(), gtk_progress_bar_get_text(),
gtk_progress_bar_get_fraction(), gtk_progress_bar_get_pulse_step(). These have
been grouped at the beginning of this section, followed by a large chunk of
deprecated 1.2 compatibility functions.
Details
struct GtkProgressBar
The GtkProgressBar struct contains private data only,
and should be accessed using the functions below.
gtk_progress_bar_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()).
gtk_progress_bar_set_text ()
Causes the given text to appear superimposed on the progress bar.
gtk_progress_bar_set_fraction ()
Causes the progress bar to "fill in" the given fraction
of the bar. The fraction should be between 0.0 and 1.0,
inclusive.
gtk_progress_bar_set_pulse_step ()
Sets the fraction of total progress bar length to move the
bouncing block for each call to gtk_progress_bar_pulse().
gtk_progress_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).
enum GtkProgressBarOrientation
typedef enum
{
GTK_PROGRESS_LEFT_TO_RIGHT,
GTK_PROGRESS_RIGHT_TO_LEFT,
GTK_PROGRESS_BOTTOM_TO_TOP,
GTK_PROGRESS_TOP_TO_BOTTOM
} GtkProgressBarOrientation; |
An enumeration representing possible orientations and growth
directions for the visible progress bar.
gtk_progress_bar_get_text ()
Retrieves the text displayed superimposed on the progress bar,
if any, otherwise NULL. The return value is a reference
to the text, not a copy of it, so will become invalid
if you change the text in the progress bar.
gtk_progress_bar_get_fraction ()
Returns the current fraction of the task that's been completed.
gtk_progress_bar_get_orientation ()
Retrieves the current progress bar orientation.
gtk_progress_bar_new_with_adjustment ()
Warning |
gtk_progress_bar_new_with_adjustment is deprecated and should not be used in newly-written code. |
Creates a new GtkProgressBar with an associated GtkAdjustment.
gtk_progress_bar_set_bar_style ()
Warning |
gtk_progress_bar_set_bar_style is deprecated and should not be used in newly-written code. |
Sets the style of the GtkProgressBar. The default style is
GTK_PROGRESS_CONTINUOUS.
enum GtkProgressBarStyle
typedef enum
{
GTK_PROGRESS_CONTINUOUS,
GTK_PROGRESS_DISCRETE
} GtkProgressBarStyle; |
An enumeration representing the styles for drawing the progress bar.
gtk_progress_bar_set_discrete_blocks ()
Warning |
gtk_progress_bar_set_discrete_blocks is deprecated and should not be used in newly-written code. |
Sets the number of blocks that the progress bar is divided into
when the style is GTK_PROGRESS_DISCRETE.
gtk_progress_bar_set_activity_step ()
Warning |
gtk_progress_bar_set_activity_step is deprecated and should not be used in newly-written code. |
Sets the step value used when the progress bar is in activity
mode. The step is the amount by which the progress is incremented
each iteration.
gtk_progress_bar_set_activity_blocks ()
Warning |
gtk_progress_bar_set_activity_blocks is deprecated and should not be used in newly-written code. |
Sets the number of blocks used when the progress bar is in activity
mode. Larger numbers make the visible block smaller.