Gtk.ProgressBar¶

Example¶

Subclasses:: None

Methods¶

Inherited:: Gtk.Widget (181), GObject.Object (37), Gtk.Accessible (15), Gtk.Buildable (1), Gtk.Orientable (2)
Structs:: Gtk.WidgetClass (18), 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)

Virtual Methods¶

Inherited:: Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9), Gtk.AccessibleRange (1)

Properties¶

Inherited:: Gtk.Widget (34), Gtk.Accessible (1), Gtk.Orientable (1)

Name	Type	Flags
`ellipsize`	`Pango.EllipsizeMode`	r/w/en
`fraction`	`float`	r/w/en
`inverted`	`bool`	r/w/en
`pulse-step`	`float`	r/w/en
`show-text`	`bool`	r/w/en
`text`	`str`	r/w

Signals¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Fields¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Class Details¶

class Gtk.ProgressBar(**kwargs)¶

Bases:: Gtk.Widget, Gtk.AccessibleRange, Gtk.Orientable
Abstract:: No

GtkProgressBar is typically used to display the progress of a long running operation.

It provides a visual clue that processing is underway. GtkProgressBar can be used in two different modes: percentage mode and activity mode.

An example Gtk.ProgressBar

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 [method`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 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 [method`Gtk`.ProgressBar.pulse] periodically 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.

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

Accessibility

GtkProgressBar uses the Gtk.AccessibleRole.PROGRESS_BAR role.

classmethod new()[source]¶

Returns:: a GtkProgressBar.
Return type:: Gtk.Widget

Creates a new GtkProgressBar.

get_ellipsize()[source]¶

Returns:: PangoEllipsizeMode
Return type:: Pango.EllipsizeMode

Returns the ellipsizing position of the progress bar.

See [method`Gtk`.ProgressBar.set_ellipsize].

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

Returns whether the progress bar is inverted.

get_pulse_step()[source]¶

Returns:: a fraction from 0.0 to 1.0
Return type:: float

Retrieves the pulse step.

See [method`Gtk`.ProgressBar.set_pulse_step].

get_show_text()[source]¶

Returns:: True if text is shown in the progress bar
Return type:: bool

Returns whether the GtkProgressBar shows text.

See [method`Gtk`.ProgressBar.set_show_text].

get_text()[source]¶

Returns:: the text
Return type:: str or None

Retrieves the text that is displayed with the progress bar.

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

set_ellipsize(mode)[source]¶

Parameters:: mode (Pango.EllipsizeMode) – a PangoEllipsizeMode

Sets the mode used to ellipsize the text.

The text is ellipsized if there is not enough space to render the entire string.

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

Sets whether the progress bar is inverted.

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.

The bouncing block is moved when [method`Gtk`.ProgressBar.pulse] is called.

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 [property`Gtk`.ProgressBar:text] property or, if that is None, the [property`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 [property`Gtk`.ProgressBar:show-text] to True and [property`Gtk`.ProgressBar:text] to the empty string (not None).

set_text(text)[source]¶

Parameters:: text (str or None) – a UTF-8 string

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

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

If text is non-None and [property`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 [property`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.

The text will be ellipsized 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.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 [method`Gtk`.Widget.set_size_request].

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 bounding 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 [property`Gtk`.ProgressBar:text] property or, if that is None, the [property`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 [property`Gtk`.ProgressBar:show-text] to True and [property`Gtk`.ProgressBar:text] to the empty string (not None).

Gtk.ProgressBar.props.text¶

Name:: text
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Text to be displayed in the progress bar.