Name
GtkProgressBar -- a widget which indicates progress visually.
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
either the gtk_progress_set_percentage() or gtk_progress_set_value()
functions 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. In this mode
the progress bar shows activity by a block moving back and forth within
the progress area.
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 which can be displayed along with
the bar, and the style in which the bar grows.
Details
struct GtkProgressBar
The GtkProgressBar struct contains private data only,
and should be accessed using the functions below.
enum GtkProgressBarStyle
typedef enum
{
GTK_PROGRESS_CONTINUOUS,
GTK_PROGRESS_DISCRETE
} GtkProgressBarStyle; |
An enumeration representing the styles for drawing the progress bar.
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_set_bar_style ()
Sets the style of the GtkProgressBar. The default style is
GTK_PROGRESS_CONTINUOUS.
gtk_progress_bar_set_discrete_blocks ()
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 ()
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 ()
Sets the number of blocks used when the progress bar is in activity
mode. Larger numbers make the visible block smaller.
gtk_progress_bar_set_orientation ()
Sets the orientation of the progress bar. This controls whether
the bar is horizontal or vertical and the direction in which it
grows.
Args
- "adjustment" (GtkAdjustment : Read / Write / Construct)
a GtkAdjustment to be used with the GtkProgressBar.
- "orientation" (GtkProgressBarOrientation : Read / Write)
a GtkProgressBarOrientation value which specifies the
orientation and growth direction of the bar.
- "bar_style" (GtkProgressBarStyle : Read / Write)
a GtkProgressBarStyle value which specifies the
visual style of the bar in percentage mode.
- "activity_step" (guint : Read / Write)
The increment used for each iteration in activity mode.
- "activity_blocks" (guint : Read / Write)
The number of blocks which can fit in the progress bar
area in activity mode.
- "discrete_blocks" (guint : Read / Write)
The number of blocks which which make up progress bar
when it is shown in GTK_PROGRESS_DISCRETE style.