GtkProgressBar

typedef struct _GtkProgressBar GtkProgressBar;

The GtkProgressBar-struct 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_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_text ()

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

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

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

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

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

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

Since 2.6

gtk_progress_bar_new_with_adjustment ()

GtkWidget*  gtk_progress_bar_new_with_adjustment
                                            (GtkAdjustment *adjustment);

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);

Sets the style of the GtkProgressBar. The default style is GTK_PROGRESS_CONTINUOUS.

enum GtkProgressBarStyle

typedef 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);

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

void        gtk_progress_bar_set_activity_step
                                            (GtkProgressBar *pbar,
                                             guint 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 ()

void        gtk_progress_bar_set_activity_blocks
                                            (GtkProgressBar *pbar,
                                             guint 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_update ()

void        gtk_progress_bar_update         (GtkProgressBar *pbar,
                                             gdouble percentage);

This function is deprecated. Please use gtk_progress_set_value() or gtk_progress_set_percentage() instead.

The "activity-blocks" property

  "activity-blocks"      guint                 : Read / Write

The number of blocks which can fit in the progress bar area in activity mode (Deprecated).

Allowed values: >= 2

Default value: 5

The "activity-step" property

  "activity-step"        guint                 : Read / Write

The increment used for each iteration in activity mode (Deprecated).

Allowed values: >= 1

Default value: 3

The "adjustment" property

  "adjustment"           GtkAdjustment         : Read / Write

The GtkAdjustment connected to the progress bar (Deprecated).

The "bar-style" property

  "bar-style"            GtkProgressBarStyle   : Read / Write

Specifies the visual style of the bar in percentage mode (Deprecated).

Default value: GTK_PROGRESS_CONTINUOUS

The "discrete-blocks" property

  "discrete-blocks"      guint                 : Read / Write

The number of discrete blocks in a progress bar (when shown in the discrete style).

Allowed values: >= 2

Default value: 10

The "ellipsize" property

  "ellipsize"            PangoEllipsizeMode    : Read / Write

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

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

Default value: PANGO_ELLIPSIZE_NONE

Since 2.6

The "fraction" property

  "fraction"             gdouble               : Read / Write

The fraction of total work that has been completed.

Allowed values: [0,1]

Default value: 0

The "orientation" property

  "orientation"          GtkProgressBarOrientation  : Read / Write

Orientation and growth direction of the progress bar.

Default value: GTK_PROGRESS_LEFT_TO_RIGHT

The "pulse-step" property

  "pulse-step"           gdouble               : Read / Write

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

Allowed values: [0,1]

Default value: 0.1

The "text" property

  "text"                 gchararray            : Read / Write

Text to be displayed in the progress bar.

Default value: "%P %%"