QProgressBar¶
The
QProgressBar
widget provides a horizontal or vertical progress bar. More…
Synopsis¶
Functions¶
def
alignment
()def
format
()def
initStyleOption
(option)def
invertedAppearance
()def
isTextVisible
()def
maximum
()def
minimum
()def
orientation
()def
resetFormat
()def
setAlignment
(alignment)def
setFormat
(format)def
setInvertedAppearance
(invert)def
setTextDirection
(textDirection)def
setTextVisible
(visible)def
textDirection
()def
value
()
Virtual functions¶
def
text
()
Slots¶
def
reset
()def
setMaximum
(maximum)def
setMinimum
(minimum)def
setOrientation
(arg__1)def
setRange
(minimum, maximum)def
setValue
(value)
Signals¶
def
valueChanged
(value)
Detailed Description¶
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 bymaximum()
-minimum()
.You can specify the minimum and maximum number of steps with
setMinimum()
andsetMaximum
. The current number of steps is set withsetValue()
. The progress bar can be rewound to the beginning withreset()
.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 PySide2.QtWidgets.QProgressBar([parent=None])¶
- param parent:
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
- PySide2.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
- PySide2.QtWidgets.QProgressBar.alignment()¶
- Return type:
Alignment
This property holds the alignment of the progress bar.
- PySide2.QtWidgets.QProgressBar.format()¶
- Return type:
str
This property holds the string used to generate the current text.
%p - is replaced by the percentage completed. %v - is replaced by the current value. %m - is replaced by the total number of steps.
The default value is “%p%”.
See also
- PySide2.QtWidgets.QProgressBar.initStyleOption(option)¶
- Parameters:
Initialize
option
with the values from thisQProgressBar
. This method is useful for subclasses when they need aQStyleOptionProgressBar
, but don’t want to fill in all the information themselves.See also
- PySide2.QtWidgets.QProgressBar.invertedAppearance()¶
- Return type:
bool
This property holds whether or not a progress bar shows its progress inverted.
If this property is
true
, the progress bar grows in the other direction (e.g. from right to left). By default, the progress bar is not inverted.See also
- PySide2.QtWidgets.QProgressBar.isTextVisible()¶
- Return type:
bool
This property holds whether the current completed percentage should be displayed.
This property may be ignored by the style (e.g., QMacStyle never draws the text).
See also
- PySide2.QtWidgets.QProgressBar.maximum()¶
- Return type:
int
This property holds the progress bar’s maximum value.
When setting this property, the
minimum
is adjusted if necessary to ensure that the range remains valid. If the current value falls outside the new range, the progress bar is reset withreset()
.
- PySide2.QtWidgets.QProgressBar.minimum()¶
- Return type:
int
This property holds the progress bar’s minimum value.
When setting this property, the
maximum
is adjusted if necessary to ensure that the range remains valid. If the current value falls outside the new range, the progress bar is reset withreset()
.
- PySide2.QtWidgets.QProgressBar.orientation()¶
- Return type:
This property holds the orientation of the progress bar.
The orientation must be
Horizontal
(the default) orVertical
.See also
- PySide2.QtWidgets.QProgressBar.reset()¶
Reset the progress bar. The progress bar “rewinds” and shows no progress.
- PySide2.QtWidgets.QProgressBar.resetFormat()¶
This property holds the string used to generate the current text.
%p - is replaced by the percentage completed. %v - is replaced by the current value. %m - is replaced by the total number of steps.
The default value is “%p%”.
See also
- PySide2.QtWidgets.QProgressBar.setAlignment(alignment)¶
- Parameters:
alignment –
Alignment
This property holds the alignment of the progress bar.
- PySide2.QtWidgets.QProgressBar.setFormat(format)¶
- Parameters:
format – str
This property holds the string used to generate the current text.
%p - is replaced by the percentage completed. %v - is replaced by the current value. %m - is replaced by the total number of steps.
The default value is “%p%”.
See also
- PySide2.QtWidgets.QProgressBar.setInvertedAppearance(invert)¶
- Parameters:
invert – bool
This property holds whether or not a progress bar shows its progress inverted.
If this property is
true
, the progress bar grows in the other direction (e.g. from right to left). By default, the progress bar is not inverted.See also
- PySide2.QtWidgets.QProgressBar.setMaximum(maximum)¶
- Parameters:
maximum – int
This property holds the progress bar’s maximum value.
When setting this property, the
minimum
is adjusted if necessary to ensure that the range remains valid. If the current value falls outside the new range, the progress bar is reset withreset()
.
- PySide2.QtWidgets.QProgressBar.setMinimum(minimum)¶
- Parameters:
minimum – int
This property holds the progress bar’s minimum value.
When setting this property, the
maximum
is adjusted if necessary to ensure that the range remains valid. If the current value falls outside the new range, the progress bar is reset withreset()
.
- PySide2.QtWidgets.QProgressBar.setOrientation(arg__1)¶
- Parameters:
arg__1 –
Orientation
This property holds the orientation of the progress bar.
The orientation must be
Horizontal
(the default) orVertical
.See also
- PySide2.QtWidgets.QProgressBar.setRange(minimum, maximum)¶
- Parameters:
minimum – int
maximum – int
Sets the progress bar’s minimum and maximum values to
minimum
andmaximum
respectively.If
maximum
is smaller thanminimum
,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).
- PySide2.QtWidgets.QProgressBar.setTextDirection(textDirection)¶
- Parameters:
textDirection –
Direction
This property holds the reading direction of the
text
for vertical progress bars.This property has no impact on horizontal progress bars. By default, the reading direction is
TopToBottom
.See also
orientation
textVisible
- PySide2.QtWidgets.QProgressBar.setTextVisible(visible)¶
- Parameters:
visible – bool
This property holds whether the current completed percentage should be displayed.
This property may be ignored by the style (e.g., QMacStyle never draws the text).
See also
- PySide2.QtWidgets.QProgressBar.setValue(value)¶
- Parameters:
value – int
This property holds the progress bar’s current value.
Attempting to change the current value to one outside the minimum-maximum range has no effect on the current value.
- PySide2.QtWidgets.QProgressBar.text()¶
- Return type:
str
This property holds the descriptive text shown with the progress bar.
The text returned is the same as the text displayed in the center (or in some styles, to the left) of the progress bar.
The progress shown in the text may be smaller than the minimum value, indicating that the progress bar is in the “reset” state before any progress is set.
In the default implementation, the text either contains a percentage value that indicates the progress so far, or it is blank because the progress bar is in the reset state.
- PySide2.QtWidgets.QProgressBar.textDirection()¶
- Return type:
This property holds the reading direction of the
text
for vertical progress bars.This property has no impact on horizontal progress bars. By default, the reading direction is
TopToBottom
.See also
orientation
textVisible
- PySide2.QtWidgets.QProgressBar.value()¶
- Return type:
int
This property holds the progress bar’s current value.
Attempting to change the current value to one outside the minimum-maximum range has no effect on the current value.
- PySide2.QtWidgets.QProgressBar.valueChanged(value)¶
- Parameters:
value – int
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.