QProgressBar

The QProgressBar widget provides a horizontal or vertical progress bar. More

Inheritance diagram of PySide6.QtWidgets.QProgressBar

Synopsis

Functions

Virtual functions

Detailed Description

../../_images/windows-progressbar.png

A progress bar is used to give the user an indication of the progress of an operation and to reassure them that the application is still running.

The progress bar uses the concept of steps. You set it up by specifying the minimum and maximum possible step values, and it will display the percentage of steps that have been completed when you later give it the current step value. The percentage is calculated by dividing the progress ( value() - minimum() ) divided by maximum() - minimum() .

You can specify the minimum and maximum number of steps with setMinimum() and setMaximum . The current number of steps is set with setValue() . The progress bar can be rewound to the beginning with reset() .

If minimum and maximum both are set to 0, the bar shows a busy indicator instead of a percentage of steps. This is useful, for example, when using QNetworkAccessManager to download items when they are unable to determine the size of the item being downloaded.

class PySide6.QtWidgets.QProgressBar([parent=None])
Parameters

parentPySide6.QtWidgets.QWidget

Constructs a progress bar with the given parent.

By default, the minimum step value is set to 0, and the maximum to 100.

See also

setRange()

PySide6.QtWidgets.QProgressBar.Direction

Specifies the reading direction of the text for vertical progress bars.

Constant

Description

QProgressBar.TopToBottom

The text is rotated 90 degrees clockwise.

QProgressBar.BottomToTop

The text is rotated 90 degrees counter-clockwise.

Note that whether or not the text is drawn is dependent on the style. Currently CleanLooks and Plastique draw the text. Mac, Windows and WindowsVista style do not.

See also

textDirection

PySide6.QtWidgets.QProgressBar.alignment()
Return type

Alignment

See also

setAlignment()

PySide6.QtWidgets.QProgressBar.format()
Return type

str

See also

setFormat()

PySide6.QtWidgets.QProgressBar.initStyleOption(option)
Parameters

optionPySide6.QtWidgets.QStyleOptionProgressBar

Initialize option with the values from this QProgressBar . This method is useful for subclasses when they need a QStyleOptionProgressBar , but don’t want to fill in all the information themselves.

See also

initFrom()

PySide6.QtWidgets.QProgressBar.invertedAppearance()
Return type

bool

PySide6.QtWidgets.QProgressBar.isTextVisible()
Return type

bool

PySide6.QtWidgets.QProgressBar.maximum()
Return type

int

See also

setMaximum()

PySide6.QtWidgets.QProgressBar.minimum()
Return type

int

See also

setMinimum()

PySide6.QtWidgets.QProgressBar.orientation()
Return type

Orientation

See also

setOrientation()

PySide6.QtWidgets.QProgressBar.reset()

Reset the progress bar. The progress bar “rewinds” and shows no progress.

PySide6.QtWidgets.QProgressBar.resetFormat()
PySide6.QtWidgets.QProgressBar.setAlignment(alignment)
Parameters

alignmentAlignment

See also

alignment()

PySide6.QtWidgets.QProgressBar.setFormat(format)
Parameters

format – str

See also

format()

PySide6.QtWidgets.QProgressBar.setInvertedAppearance(invert)
Parameters

invert – bool

PySide6.QtWidgets.QProgressBar.setMaximum(maximum)
Parameters

maximum – int

See also

maximum()

PySide6.QtWidgets.QProgressBar.setMinimum(minimum)
Parameters

minimum – int

See also

minimum()

PySide6.QtWidgets.QProgressBar.setOrientation(arg__1)
Parameters

arg__1Orientation

See also

orientation()

PySide6.QtWidgets.QProgressBar.setRange(minimum, maximum)
Parameters
  • minimum – int

  • maximum – int

Sets the progress bar’s minimum and maximum values to minimum and maximum respectively.

If maximum is smaller than minimum, minimum becomes the only legal value.

If the current value falls outside the new range, the progress bar is reset with reset() .

The QProgressBar can be set to undetermined state by using (0, 0).

See also

minimum maximum

PySide6.QtWidgets.QProgressBar.setTextDirection(textDirection)
Parameters

textDirectionDirection

See also

textDirection()

PySide6.QtWidgets.QProgressBar.setTextVisible(visible)
Parameters

visible – bool

See also

isTextVisible()

PySide6.QtWidgets.QProgressBar.setValue(value)
Parameters

value – int

See also

value()

PySide6.QtWidgets.QProgressBar.text()
Return type

str

PySide6.QtWidgets.QProgressBar.textDirection()
Return type

Direction

PySide6.QtWidgets.QProgressBar.value()
Return type

int

See also

setValue()

PySide6.QtWidgets.QProgressBar.valueChanged(value)
Parameters

value – int