Gtk.CellRendererProgress

g GObject.GInterface GObject.GInterface Gtk.Orientable Gtk.Orientable GObject.GInterface->Gtk.Orientable GObject.InitiallyUnowned GObject.InitiallyUnowned Gtk.CellRenderer Gtk.CellRenderer GObject.InitiallyUnowned->Gtk.CellRenderer GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gtk.CellRendererProgress Gtk.CellRendererProgress Gtk.CellRenderer->Gtk.CellRendererProgress Gtk.Orientable->Gtk.CellRendererProgress

Subclasses:None

Virtual Methods

Inherited:Gtk.CellRenderer (12), GObject.Object (7)

Properties

Inherited:Gtk.CellRenderer (16), Gtk.Orientable (1)
Name Type Flags Short Description
inverted bool r/w/en Invert the direction in which the progress bar grows
pulse int r/w/en Set this to positive values to indicate that some progress is made, but you don’t know how much.
text str r/w Text on the progress bar
text-xalign float r/w The horizontal text alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.
text-yalign float r/w The vertical text alignment, from 0 (top) to 1 (bottom).
value int r/w/en Value of the progress bar

Fields

Inherited:Gtk.CellRenderer (2), GObject.Object (1)
Name Type Access Description
parent_instance Gtk.CellRenderer r  

Class Details

class Gtk.CellRendererProgress(**kwargs)
Bases:Gtk.CellRenderer, Gtk.Orientable
Abstract:No
Structure:Gtk.CellRendererProgressClass

Gtk.CellRendererProgress renders a numeric value as a progress par in a cell. Additionally, it can display a text on top of the progress bar.

The Gtk.CellRendererProgress cell renderer was added in GTK+ 2.6.

classmethod new()[source]
Returns:the new cell renderer
Return type:Gtk.CellRenderer

Creates a new Gtk.CellRendererProgress.

New in version 2.6.

Property Details

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

Invert the direction in which the progress bar grows

Gtk.CellRendererProgress.props.pulse
Name:pulse
Type:int
Default Value:-1
Flags:READABLE, WRITABLE, EXPLICIT_NOTIFY

Setting this to a non-negative value causes the cell renderer to enter “activity mode”, where a block bounces back and forth to indicate that some progress is made, without specifying exactly how much.

Each increment of the property causes the block to move by a little bit.

To indicate that the activity has not started yet, set the property to zero. To indicate completion, set the property to GObject.G_MAXINT.

New in version 2.12.

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

The “text” property determines the label which will be drawn over the progress bar. Setting this property to None causes the default label to be displayed. Setting this property to an empty string causes no label to be displayed.

New in version 2.6.

Gtk.CellRendererProgress.props.text_xalign
Name:text-xalign
Type:float
Default Value:0.5
Flags:READABLE, WRITABLE

The “text-xalign” property controls the horizontal alignment of the text in the progress bar. Valid values range from 0 (left) to 1 (right). Reserved for RTL layouts.

New in version 2.12.

Gtk.CellRendererProgress.props.text_yalign
Name:text-yalign
Type:float
Default Value:0.5
Flags:READABLE, WRITABLE

The “text-yalign” property controls the vertical alignment of the text in the progress bar. Valid values range from 0 (top) to 1 (bottom).

New in version 2.12.

Gtk.CellRendererProgress.props.value
Name:value
Type:int
Default Value:0
Flags:READABLE, WRITABLE, EXPLICIT_NOTIFY

The “value” property determines the percentage to which the progress bar will be “filled in”.

New in version 2.6.