Synopsis

class gtk.ProgressBar(gtk.Progress):
    gtk.ProgressBar()
    def pulse()
    def set_text(text)
    def set_fraction(fraction)
    def set_pulse_step(fraction)
    def set_orientation(orientation)
    def get_text()
    def get_fraction()
    def get_pulse_step()
    def get_orientation()
    def set_ellipsize(mode)
    def get_ellipsize()

Ancestry

+-- gobject.GObject
  +-- gtk.Object
    +-- gtk.Widget
      +-- gtk.Progress
        +-- gtk.ProgressBar

gtk.ProgressBar Properties

gtk.Object Properties

gtk.Widget Properties

gtk.Progress Properties

gtk.ProgressBar Style Properties

gtk.Widget Style Properties

gtk.ProgressBar Signal Prototypes

gobject.GObject Signal Prototypes

gtk.Object Signal Prototypes

gtk.Widget Signal Prototypes

Description

The gtk.ProgressBar is typically used to display the progress of a long running operation. It provides a visual clue that processing is underway. The gtk.ProgressBar 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 gtk.ProgressBar 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 the set_fraction() method 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 gtk.ProgressBar 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 the pulse() method periodically to update the progress bar.

There is quite a bit of flexibility provided to control the appearance of the gtk.ProgressBar. Methods 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.

Constructor

    gtk.ProgressBar()

Creates a new gtk.Progressbar widget.

Methods

    def pulse()

    def set_text(text)

    def set_fraction(fraction)

    def set_pulse_step(fraction)

    def set_orientation(orientation)

    def get_text()

    def get_fraction()

    def get_pulse_step()

    def get_orientation()

    def set_ellipsize(mode)

    def get_ellipsize()