GtkProgressBar: GtkProgressBar

Description

A widget which indicates progress visually

Arguments

Methods and Functions

gtkProgressBarNew(show = TRUE) gtkProgressBarPulse(object) gtkProgressBarSetText(object, text) gtkProgressBarSetFraction(object, fraction) gtkProgressBarSetPulseStep(object, fraction) gtkProgressBarSetOrientation(object, orientation) gtkProgressBarSetEllipsize(object, mode) gtkProgressBarGetText(object) gtkProgressBarGetFraction(object) gtkProgressBarGetPulseStep(object) gtkProgressBarGetOrientation(object) gtkProgressBarGetEllipsize(object) gtkProgressBarNewWithAdjustment(adjustment = NULL, show = TRUE) gtkProgressBarSetBarStyle(object, style) gtkProgressBarSetDiscreteBlocks(object, blocks) gtkProgressBarSetActivityStep(object, step) gtkProgressBarSetActivityBlocks(object, blocks) gtkProgressBarUpdate(object, percentage) gtkProgressBar(adjustment = NULL, show = TRUE)

Hierarchy

GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkProgress +----GtkProgressBar

Interfaces

GtkProgressBar implements AtkImplementorIface and GtkBuildable.

Detailed 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 gtkProgressBarSetFraction 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 gtkProgressBarPulse perodically 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. PLEASE 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: gtkProgressBarNew, gtkProgressBarPulse, gtkProgressBarSetText, gtkProgressBarSetFraction, gtkProgressBarSetPulseStep, gtkProgressBarSetOrientation, gtkProgressBarGetText, gtkProgressBarGetFraction, gtkProgressBarGetPulseStep, gtkProgressBarGetOrientation. These have been grouped at the beginning of this section, followed by a large chunk of deprecated 1.2 compatibility functions.

Convenient Construction

gtkProgressBar is the result of collapsing the constructors of GtkProgressBar (gtkProgressBarNew, gtkProgressBarNewWithAdjustment) and accepts a subset of its arguments matching the required arguments of one of its delegate constructors.

References

http://developer.gnome.org/doc/API/2.0/gtk/GtkProgressBar.html