Synopsis#include <gtk/gtk.h> GtkProgressBar; GtkWidget* gtk_progress_bar_new (void); void gtk_progress_bar_pulse (GtkProgressBar *pbar); void gtk_progress_bar_set_text (GtkProgressBar *pbar, const gchar *text); void gtk_progress_bar_set_fraction (GtkProgressBar *pbar, gdouble fraction); void gtk_progress_bar_set_pulse_step (GtkProgressBar *pbar, gdouble fraction); void gtk_progress_bar_set_orientation (GtkProgressBar *pbar, GtkProgressBarOrientation orientation); void gtk_progress_bar_set_ellipsize (GtkProgressBar *pbar, PangoEllipsizeMode mode); enum GtkProgressBarOrientation; const gchar* gtk_progress_bar_get_text (GtkProgressBar *pbar); gdouble gtk_progress_bar_get_fraction (GtkProgressBar *pbar); gdouble gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar); GtkProgressBarOrientation gtk_progress_bar_get_orientation (GtkProgressBar *pbar); PangoEllipsizeMode gtk_progress_bar_get_ellipsize (GtkProgressBar *pbar); GtkWidget* gtk_progress_bar_new_with_adjustment (GtkAdjustment *adjustment); void gtk_progress_bar_set_bar_style (GtkProgressBar *pbar, GtkProgressBarStyle style); enum GtkProgressBarStyle; void gtk_progress_bar_set_discrete_blocks (GtkProgressBar *pbar, guint blocks); void gtk_progress_bar_set_activity_step (GtkProgressBar *pbar, guint step); void gtk_progress_bar_set_activity_blocks (GtkProgressBar *pbar, guint blocks); void gtk_progress_bar_update (GtkProgressBar *pbar, gdouble percentage); Object HierarchyGObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkProgress +----GtkProgressBar Properties"activity-blocks" guint : Read / Write "activity-step" guint : Read / Write "adjustment" GtkAdjustment* : Read / Write "bar-style" GtkProgressBarStyle : Read / Write "discrete-blocks" guint : Read / Write "ellipsize" PangoEllipsizeMode : Read / Write "fraction" gdouble : Read / Write "orientation" GtkProgressBarOrientation : Read / Write "pulse-step" gdouble : Read / Write "text" gchar* : Read / Write Style Properties"min-horizontal-bar-height" gint : Read / Write "min-horizontal-bar-width" gint : Read / Write "min-vertical-bar-height" gint : Read / Write "min-vertical-bar-width" gint : Read / Write "xspacing" gint : Read / Write "yspacing" gint : Read / Write DescriptionThe 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
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 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 10
functions: DetailsGtkProgressBartypedef struct _GtkProgressBar GtkProgressBar; The GtkProgressBar struct contains private data only, and should be accessed using the functions below. gtk_progress_bar_new ()GtkWidget* gtk_progress_bar_new (void); Creates a new GtkProgressBar.
gtk_progress_bar_pulse ()void gtk_progress_bar_pulse (GtkProgressBar *pbar);
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_set_text ()void gtk_progress_bar_set_text (GtkProgressBar *pbar, const gchar *text);
Causes the given
gtk_progress_bar_set_fraction ()void gtk_progress_bar_set_fraction (GtkProgressBar *pbar, gdouble 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 ()void gtk_progress_bar_set_pulse_step (GtkProgressBar *pbar, gdouble fraction);
Sets the fraction of total progress bar length to move the
bouncing block for each call to
gtk_progress_bar_set_orientation ()void gtk_progress_bar_set_orientation (GtkProgressBar *pbar, GtkProgressBarOrientation orientation); Causes the progress bar to switch to a different orientation (left-to-right, right-to-left, top-to-bottom, or bottom-to-top).
gtk_progress_bar_set_ellipsize ()void gtk_progress_bar_set_ellipsize (GtkProgressBar *pbar, PangoEllipsizeMode mode); Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough space to render the entire string.
Since 2.6 enum GtkProgressBarOrientationtypedef 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 ()const gchar* gtk_progress_bar_get_text (GtkProgressBar *pbar);
Retrieves the text displayed superimposed on the progress bar,
if any, otherwise
gtk_progress_bar_get_fraction ()gdouble gtk_progress_bar_get_fraction (GtkProgressBar *pbar); Returns the current fraction of the task that's been completed.
gtk_progress_bar_get_pulse_step ()gdouble gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar);
Retrieves the pulse step set with
gtk_progress_bar_get_orientation ()GtkProgressBarOrientation gtk_progress_bar_get_orientation (GtkProgressBar *pbar); Retrieves the current progress bar orientation.
gtk_progress_bar_get_ellipsize ()PangoEllipsizeMode gtk_progress_bar_get_ellipsize (GtkProgressBar *pbar);
Returns the ellipsizing position of the progressbar.
See
Since 2.6 gtk_progress_bar_new_with_adjustment ()GtkWidget* gtk_progress_bar_new_with_adjustment (GtkAdjustment *adjustment); Warning
Creates a new GtkProgressBar with an associated GtkAdjustment.
gtk_progress_bar_set_bar_style ()void gtk_progress_bar_set_bar_style (GtkProgressBar *pbar, GtkProgressBarStyle style); Warning
Sets the style of the GtkProgressBar. The default style is
enum GtkProgressBarStyletypedef enum { GTK_PROGRESS_CONTINUOUS, GTK_PROGRESS_DISCRETE } GtkProgressBarStyle; An enumeration representing the styles for drawing the progress bar. gtk_progress_bar_set_discrete_blocks ()void gtk_progress_bar_set_discrete_blocks (GtkProgressBar *pbar, guint blocks); Warning
Sets the number of blocks that the progress bar is divided into
when the style is
gtk_progress_bar_set_activity_step ()void gtk_progress_bar_set_activity_step (GtkProgressBar *pbar, guint step); Warning
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 ()void gtk_progress_bar_set_activity_blocks (GtkProgressBar *pbar, guint blocks); Warning
Sets the number of blocks used when the progress bar is in activity mode. Larger numbers make the visible block smaller.
gtk_progress_bar_update ()void gtk_progress_bar_update (GtkProgressBar *pbar, gdouble percentage); Warning
This function is deprecated. Please use
Property DetailsThe
|