GtkProgressBar

GtkProgressBar — A widget which indicates progress visually

Synopsis

#include <gtk/gtk.h>

                    GtkProgressBar;
GtkWidget*          gtk_progress_bar_new                (void);
void                gtk_progress_bar_pulse              (GtkProgressBar *pbar);
void                gtk_progress_bar_set_fraction       (GtkProgressBar *pbar,
                                                         gdouble fraction);
gdouble             gtk_progress_bar_get_fraction       (GtkProgressBar *pbar);
void                gtk_progress_bar_set_inverted       (GtkProgressBar *pbar,
                                                         gboolean inverted);
gboolean            gtk_progress_bar_get_inverted       (GtkProgressBar *pbar);
void                gtk_progress_bar_set_show_text      (GtkProgressBar *pbar,
                                                         gboolean show_text);
gboolean            gtk_progress_bar_get_show_text      (GtkProgressBar *pbar);
void                gtk_progress_bar_set_text           (GtkProgressBar *pbar,
                                                         const gchar *text);
const gchar*        gtk_progress_bar_get_text           (GtkProgressBar *pbar);
void                gtk_progress_bar_set_ellipsize      (GtkProgressBar *pbar,
                                                         PangoEllipsizeMode mode);
PangoEllipsizeMode  gtk_progress_bar_get_ellipsize      (GtkProgressBar *pbar);
void                gtk_progress_bar_set_pulse_step     (GtkProgressBar *pbar,
                                                         gdouble fraction);
gdouble             gtk_progress_bar_get_pulse_step     (GtkProgressBar *pbar);

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() periodically 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.

Details

GtkProgressBar

typedef struct {
  GtkWidget parent;
} GtkProgressBar;


gtk_progress_bar_new ()

GtkWidget*          gtk_progress_bar_new                (void);

Creates a new GtkProgressBar.

Returns :

a 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_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()).

pbar :

a GtkProgressBar

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.

pbar :

a GtkProgressBar

fraction :

fraction of the task that's been completed

gtk_progress_bar_get_fraction ()

gdouble             gtk_progress_bar_get_fraction       (GtkProgressBar *pbar);

Returns the current fraction of the task that's been completed.

pbar :

a GtkProgressBar

Returns :

a fraction from 0.0 to 1.0

gtk_progress_bar_set_inverted ()

void                gtk_progress_bar_set_inverted       (GtkProgressBar *pbar,
                                                         gboolean inverted);

Progress bars normally grow from top to bottom or left to right. Inverted progress bars grow in the opposite direction.

pbar :

a GtkProgressBar

inverted :

TRUE to invert the progress bar

gtk_progress_bar_get_inverted ()

gboolean            gtk_progress_bar_get_inverted       (GtkProgressBar *pbar);

Gets the value set by gtk_progress_bar_set_inverted()

pbar :

a GtkProgressBar

Returns :

TRUE if the progress bar is inverted

gtk_progress_bar_set_show_text ()

void                gtk_progress_bar_set_show_text      (GtkProgressBar *pbar,
                                                         gboolean show_text);

Sets whether the progressbar will show text superimposed over the bar. The shown text is either the value of the "text" property or, if that is NULL, the "fraction" value, as a percentage.

pbar :

a GtkProgressBar

show_text :

whether to show superimposed text

Since 3.0


gtk_progress_bar_get_show_text ()

gboolean            gtk_progress_bar_get_show_text      (GtkProgressBar *pbar);

Gets the value of the "show-text" property. See gtk_progress_bar_set_show_text().

pbar :

a GtkProgressBar

Returns :

TRUE if text is shown in the progress bar

Since 3.0


gtk_progress_bar_set_text ()

void                gtk_progress_bar_set_text           (GtkProgressBar *pbar,
                                                         const gchar *text);

Causes the given text to appear superimposed on the progress bar.

pbar :

a GtkProgressBar

text :

a UTF-8 string, or NULL. [allow-none]

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 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.

pbar :

a GtkProgressBar

Returns :

text, or NULL; this string is owned by the widget and should not be modified or freed.

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.

pbar :

a GtkProgressBar

mode :

a PangoEllipsizeMode

Since 2.6


gtk_progress_bar_get_ellipsize ()

PangoEllipsizeMode  gtk_progress_bar_get_ellipsize      (GtkProgressBar *pbar);

Returns the ellipsizing position of the progressbar. See gtk_progress_bar_set_ellipsize().

pbar :

a GtkProgressBar

Returns :

PangoEllipsizeMode

Since 2.6


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_pulse().

pbar :

a GtkProgressBar

fraction :

fraction between 0.0 and 1.0

gtk_progress_bar_get_pulse_step ()

gdouble             gtk_progress_bar_get_pulse_step     (GtkProgressBar *pbar);

Retrieves the pulse step set with gtk_progress_bar_set_pulse_step()

pbar :

a GtkProgressBar

Returns :

a fraction from 0.0 to 1.0