GtkProgressBar

CSS nodes

progressbar[.osd]
├── [text]
╰── trough[.empty][.full]
    ╰── progress[.pulse]

GtkProgressBar has a main CSS node with name progressbar and subnodes with names text and trough, of which the latter has a subnode named progress. The text subnode is only present if text is shown. The progress subnode has the style class .pulse when in activity mode. It gets the style classes .left, .right, .top or .bottom added when the progress 'touches' the corresponding end of the GtkProgressBar. The .osd class on the progressbar node is for use in overlays like the one Epiphany has for page loading progress.

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 has been 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_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_get_fraction ()

gdouble
gtk_progress_bar_get_fraction (GtkProgressBar *pbar);

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

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.

gtk_progress_bar_get_inverted ()

gboolean
gtk_progress_bar_get_inverted (GtkProgressBar *pbar);

Gets the value set by gtk_progress_bar_set_inverted().

gtk_progress_bar_set_show_text ()

void
gtk_progress_bar_set_show_text (GtkProgressBar *pbar,
                                gboolean show_text);

Sets whether the progress bar will show text next to the bar. The shown text is either the value of the “text” property or, if that is NULL, the “fraction” value, as a percentage.

To make a progress bar that is styled and sized suitably for containing text (even if the actual text is blank), set “show-text” to TRUE and “text” to the empty string (not NULL).

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

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 next to the progress bar.

If text is NULL and “show-text” is TRUE, the current value of “fraction” will be displayed as a percentage.

If text is non-NULL and “show-text” is TRUE, the text will be displayed. In this case, it will not display the progress percentage. If text is the empty string, the progress bar will still be styled and sized suitably for containing text, as long as “show-text” is TRUE.

gtk_progress_bar_get_text ()

const gchar *
gtk_progress_bar_get_text (GtkProgressBar *pbar);

Retrieves the text that is displayed with 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_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

gtk_progress_bar_get_ellipsize ()

PangoEllipsizeMode
gtk_progress_bar_get_ellipsize (GtkProgressBar *pbar);

Returns the ellipsizing position of the progress bar. See gtk_progress_bar_set_ellipsize().

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

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

struct GtkProgressBar

struct GtkProgressBar;

The “ellipsize” property

  “ellipsize”                PangoEllipsizeMode

The preferred place to ellipsize the string, if the progress bar does not have enough room to display the entire string, specified as a PangoEllipsizeMode.

Note that setting this property to a value other than PANGO_ELLIPSIZE_NONE has the side-effect that the progress bar requests only enough space to display the ellipsis ("..."). Another means to set a progress bar's width is gtk_widget_set_size_request().

Owner: GtkProgressBar

Flags: Read / Write

Default value: PANGO_ELLIPSIZE_NONE

Since: 2.6

The “fraction” property

  “fraction”                 double

The fraction of total work that has been completed.

Owner: GtkProgressBar

Flags: Read / Write

Allowed values: [0,1]

Default value: 0

The “inverted” property

  “inverted”                 gboolean

Invert the direction in which the progress bar grows.

Owner: GtkProgressBar

Flags: Read / Write

Default value: FALSE

The “pulse-step” property

  “pulse-step”               double

The fraction of total progress to move the bouncing block when pulsed.

Owner: GtkProgressBar

Flags: Read / Write

Allowed values: [0,1]

Default value: 0.1

The “show-text” property

  “show-text”                gboolean

Sets whether the progress bar will show a text in addition to the bar itself. The shown text is either the value of the “text” property or, if that is NULL, the “fraction” value, as a percentage.

To make a progress bar that is styled and sized suitably for showing text (even if the actual text is blank), set “show-text” to TRUE and “text” to the empty string (not NULL).

Owner: GtkProgressBar

Flags: Read / Write

Default value: FALSE

Since: 3.0

The “text” property

  “text”                     char *

Text to be displayed in the progress bar.

Owner: GtkProgressBar

Flags: Read / Write

Default value: NULL

The “min-horizontal-bar-height” style property

  “min-horizontal-bar-height” int

Minimum horizontal height of the progress bar.

Owner: GtkProgressBar

Flags: Read / Write

Allowed values: >= 1

Default value: 6

Since: 2.14

The “min-horizontal-bar-width” style property

  “min-horizontal-bar-width” int

The minimum horizontal width of the progress bar.

Owner: GtkProgressBar

Flags: Read / Write

Allowed values: >= 1

Default value: 150

Since: 2.14

The “min-vertical-bar-height” style property

  “min-vertical-bar-height”  int

The minimum vertical height of the progress bar.

Owner: GtkProgressBar

Flags: Read / Write

Allowed values: >= 1

Default value: 80

Since: 2.14

The “min-vertical-bar-width” style property

  “min-vertical-bar-width”   int

The minimum vertical width of the progress bar.

Owner: GtkProgressBar

Flags: Read / Write

Allowed values: >= 1

Default value: 7

Since: 2.14

The “xspacing” style property

  “xspacing”                 int

Extra spacing applied to the width of a progress bar.

Owner: GtkProgressBar

Flags: Read / Write

Allowed values: >= 0

Default value: 2

The “yspacing” style property

  “yspacing”                 int

Extra spacing applied to the height of a progress bar.

Owner: GtkProgressBar

Flags: Read / Write

Allowed values: >= 0

Default value: 2