GtkProgress

struct GtkProgress

struct GtkProgress;

The GtkProgress struct contains private data only. and should be accessed using the functions below.

gtk_progress_set_show_text ()

void        gtk_progress_set_show_text      (GtkProgress *progress,
                                             gboolean show_text);

Controls whether progress text is shown.

gtk_progress_set_text_alignment ()

void        gtk_progress_set_text_alignment (GtkProgress *progress,
                                             gfloat x_align,
                                             gfloat y_align);

Controls the alignment of the text within the progress bar area.

gtk_progress_set_format_string ()

void        gtk_progress_set_format_string  (GtkProgress *progress,
                                             const gchar *format);

Sets a format string used to display text indicating the current progress. The string can contain the following substitution characters:

• %v - the current progress value.

• %l - the lower bound for the progress value.

• %u - the upper bound for the progress value.

• %p - the current progress percentage.

gtk_progress_set_adjustment ()

void        gtk_progress_set_adjustment     (GtkProgress *progress,
                                             GtkAdjustment *adjustment);

Associates a GtkAdjustment with the GtkProgress. A GtkAdjustment is used to represent the upper and lower bounds and the step interval of the underlying value for which progress is shown.

gtk_progress_set_percentage ()

void        gtk_progress_set_percentage     (GtkProgress *progress,
                                             gdouble percentage);

Sets the current percentage completion for the GtkProgress.

gtk_progress_set_value ()

void        gtk_progress_set_value          (GtkProgress *progress,
                                             gdouble value);

Sets the value within the GtkProgress to an absolute value. The value must be within the valid range of values for the underlying GtkAdjustment.

gtk_progress_get_value ()

gdouble     gtk_progress_get_value          (GtkProgress *progress);

Returns the current progress complete value.

gtk_progress_set_activity_mode ()

void        gtk_progress_set_activity_mode  (GtkProgress *progress,
                                             gboolean activity_mode);

A GtkProgress can be in one of two different modes: percentage mode (the default) and activity mode. In activity mode, the progress is simply indicated as activity rather than as a percentage complete.

gtk_progress_get_current_text ()

gchar*      gtk_progress_get_current_text   (GtkProgress *progress);

Returns the current text associated with the GtkProgress. This text is the based on the underlying format string after any substitutions are made.

gtk_progress_get_text_from_value ()

gchar*      gtk_progress_get_text_from_value
                                            (GtkProgress *progress,
                                             gdouble value);

Returns the text indicating the progress based on the supplied value. The current value for the GtkProgress remains unchanged.

gtk_progress_get_current_percentage ()

gdouble     gtk_progress_get_current_percentage
                                            (GtkProgress *progress);

Returns the current progress as a percentage.

gtk_progress_get_percentage_from_value ()

gdouble     gtk_progress_get_percentage_from_value
                                            (GtkProgress *progress,
                                             gdouble value);

Returns the progress as a percentage calculated from the supplied absolute progress value.

gtk_progress_configure ()

void        gtk_progress_configure          (GtkProgress *progress,
                                             gdouble value,
                                             gdouble min,
                                             gdouble max);

Allows the configuration of the minimum, maximum, and current values for the GtkProgress.