Gtk.ProgressBar

g Atk.ImplementorIface Atk.ImplementorIface Gtk.Widget Gtk.Widget Atk.ImplementorIface->Gtk.Widget GObject.GInterface GObject.GInterface GObject.GInterface->Atk.ImplementorIface Gtk.Buildable Gtk.Buildable GObject.GInterface->Gtk.Buildable Gtk.Orientable Gtk.Orientable GObject.GInterface->Gtk.Orientable GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->Gtk.Widget GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gtk.Buildable->Gtk.Widget Gtk.ProgressBar Gtk.ProgressBar Gtk.Orientable->Gtk.ProgressBar Gtk.Widget->Gtk.ProgressBar

Example

../_images/ProgressBar.png
Subclasses:None

Methods

Inherited:Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10), Gtk.Orientable (2)
Structs:Gtk.WidgetClass (12), GObject.ObjectClass (5)
class new ()
  get_ellipsize ()
  get_fraction ()
  get_inverted ()
  get_pulse_step ()
  get_show_text ()
  get_text ()
  pulse ()
  set_ellipsize (mode)
  set_fraction (fraction)
  set_inverted (inverted)
  set_pulse_step (fraction)
  set_show_text (show_text)
  set_text (text)

Properties

Inherited:Gtk.Widget (39), Gtk.Orientable (1)
Name Type Flags Short Description
ellipsize Pango.EllipsizeMode r/w/en The preferred place to ellipsize the string, if the progress bar does not have enough room to display the entire string, if at all.
fraction float r/w/en The fraction of total work that has been completed
inverted bool r/w/en Invert the direction in which the progress bar grows
pulse-step float r/w/en The fraction of total progress to move the bouncing block when pulsed
show-text bool r/w/en Whether the progress is shown as text.
text str r/w Text to be displayed in the progress bar

Style Properties

Inherited:Gtk.Widget (17)
Name Type Default Flags Short Description
min-horizontal-bar-height int 6 d/r/w Minimum horizontal height of the progress bar deprecated
min-horizontal-bar-width int 150 d/r/w The minimum horizontal width of the progress bar deprecated
min-vertical-bar-height int 80 d/r/w The minimum vertical height of the progress bar deprecated
min-vertical-bar-width int 7 d/r/w The minimum vertical width of the progress bar deprecated
xspacing int 2 d/r/w Extra spacing applied to the width of a progress bar. deprecated
yspacing int 2 d/r/w Extra spacing applied to the height of a progress bar. deprecated

Fields

Inherited:Gtk.Widget (69), GObject.Object (1)
Name Type Access Description
parent Gtk.Widget r  

Class Details

class Gtk.ProgressBar(**kwargs)
Bases:Gtk.Widget, Gtk.Orientable
Abstract:No
Structure:Gtk.ProgressBarClass

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 Gtk.ProgressBar.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 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 Gtk.ProgressBar.pulse() periodically to update the progress bar.

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

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

Gtk.ProgressBar 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 Gtk.ProgressBar. The .osd class on the progressbar node is for use in overlays like the one Epiphany has for page loading progress.

classmethod new()[source]
Returns:a Gtk.ProgressBar.
Return type:Gtk.Widget

Creates a new Gtk.ProgressBar.

get_ellipsize()[source]
Returns:Pango.EllipsizeMode
Return type:Pango.EllipsizeMode

Returns the ellipsizing position of the progress bar. See Gtk.ProgressBar.set_ellipsize().

New in version 2.6.

get_fraction()[source]
Returns:a fraction from 0.0 to 1.0
Return type:float

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

get_inverted()[source]
Returns:True if the progress bar is inverted
Return type:bool

Gets the value set by Gtk.ProgressBar.set_inverted().

get_pulse_step()[source]
Returns:a fraction from 0.0 to 1.0
Return type:float

Retrieves the pulse step set with Gtk.ProgressBar.set_pulse_step().

get_show_text()[source]
Returns:True if text is shown in the progress bar
Return type:bool

Gets the value of the Gtk.ProgressBar :show-text property. See Gtk.ProgressBar.set_show_text().

New in version 3.0.

get_text()[source]
Returns:text, or None; this string is owned by the widget and should not be modified or freed.
Return type:str or None

Retrieves the text that is displayed with the progress bar, if any, otherwise None. 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.

pulse()[source]

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.ProgressBar.pulse() causes the block to move by a little bit (the amount of movement per pulse is determined by Gtk.ProgressBar.set_pulse_step()).

set_ellipsize(mode)[source]
Parameters:mode (Pango.EllipsizeMode) – a Pango.EllipsizeMode

Sets the mode used to ellipsize (add an ellipsis: “…”) the text if there is not enough space to render the entire string.

New in version 2.6.

set_fraction(fraction)[source]
Parameters:fraction (float) – fraction of the task that’s been completed

Causes the progress bar to “fill in” the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive.

set_inverted(inverted)[source]
Parameters:inverted (bool) – True to invert the progress bar

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

set_pulse_step(fraction)[source]
Parameters:fraction (float) – fraction between 0.0 and 1.0

Sets the fraction of total progress bar length to move the bouncing block for each call to Gtk.ProgressBar.pulse().

set_show_text(show_text)[source]
Parameters:show_text (bool) – whether to show text

Sets whether the progress bar will show text next to the bar. The shown text is either the value of the Gtk.ProgressBar :text property or, if that is None, the Gtk.ProgressBar :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 Gtk.ProgressBar :show-text to True and Gtk.ProgressBar :text to the empty string (not None).

New in version 3.0.

set_text(text)[source]
Parameters:text (str or None) – a UTF-8 string, or None

Causes the given text to appear next to the progress bar.

If text is None and Gtk.ProgressBar :show-text is True, the current value of Gtk.ProgressBar :fraction will be displayed as a percentage.

If text is non-None and Gtk.ProgressBar :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 Gtk.ProgressBar :show-text is True.

Property Details

Gtk.ProgressBar.props.ellipsize
Name:ellipsize
Type:Pango.EllipsizeMode
Default Value:Pango.EllipsizeMode.NONE
Flags:READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Note that setting this property to a value other than Pango.EllipsizeMode.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().

New in version 2.6.

Gtk.ProgressBar.props.fraction
Name:fraction
Type:float
Default Value:0.0
Flags:READABLE, WRITABLE, EXPLICIT_NOTIFY

The fraction of total work that has been completed

Gtk.ProgressBar.props.inverted
Name:inverted
Type:bool
Default Value:False
Flags:READABLE, WRITABLE, EXPLICIT_NOTIFY

Invert the direction in which the progress bar grows

Gtk.ProgressBar.props.pulse_step
Name:pulse-step
Type:float
Default Value:0.1
Flags:READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Gtk.ProgressBar.props.show_text
Name:show-text
Type:bool
Default Value:False
Flags:READABLE, WRITABLE, EXPLICIT_NOTIFY

Sets whether the progress bar will show a text in addition to the bar itself. The shown text is either the value of the Gtk.ProgressBar :text property or, if that is None, the Gtk.ProgressBar :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 Gtk.ProgressBar :show-text to True and Gtk.ProgressBar :text to the empty string (not None).

New in version 3.0.

Gtk.ProgressBar.props.text
Name:text
Type:str
Default Value:None
Flags:READABLE, WRITABLE

Text to be displayed in the progress bar