Skip to content

PythonQt.QtGui.QProgressDialog · declarations 001

Back to PythonQt.QtGui.QProgressDialog

accepted

accepted(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QProgressDialog.accepted; argument details are not documented.

autoClose instance-attribute

autoClose: bool

Qt 5 reference:

autoClose : bool

This property holds whether the dialog gets hidden by reset()

The default is true.

Access functions:

bool autoClose() const
void setAutoClose(bool close)

See also setAutoReset().

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#autoClose

autoReset instance-attribute

autoReset: bool

Qt 5 reference:

autoReset : bool

This property holds whether the progress dialog calls reset() as soon as value() equals maximum()

The default is true.

Access functions:

bool autoReset() const
void setAutoReset(bool reset)

See also setAutoClose().

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#autoReset

cancel

cancel() -> None

X.cancel()

Supplemental documentation: Qt 5 reference:

[slot] void QProgressDialog::cancel()

Resets the progress dialog. wasCanceled() becomes true until the progress dialog is reset. The progress dialog becomes hidden.

Upstream PySide2 reference signatures (binding differences may apply):

cancel(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#cancel

canceled

canceled(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QProgressDialog.canceled; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QProgressDialog::canceled()

This signal is emitted when the cancel button is clicked. It is connected to the cancel() slot by default.

See also wasCanceled().

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#canceled

changeEvent

changeEvent(event: Any) -> None

X.changeEvent(event)

Supplemental documentation: Qt 5 reference:

[override virtual protected] void QProgressDialog::changeEvent(QEvent *ev)

Reimplements: QWidget::changeEvent(QEvent *event).

Upstream PySide2 reference signatures (binding differences may apply):

changeEvent(self, event: PySide2.QtCore.QEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#changeEvent

closeEvent

closeEvent(event: Any) -> None

X.closeEvent(event)

Supplemental documentation: Qt 5 reference:

[override virtual protected] void QProgressDialog::closeEvent(QCloseEvent *e)

Reimplements: QDialog::closeEvent(QCloseEvent *e).

Upstream PySide2 reference signatures (binding differences may apply):

closeEvent(self, event: PySide2.QtGui.QCloseEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#closeEvent

customContextMenuRequested

customContextMenuRequested(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QProgressDialog.customContextMenuRequested; argument details are not documented.

destroyed

destroyed(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QProgressDialog.destroyed; argument details are not documented.

finished

finished(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QProgressDialog.finished; argument details are not documented.

labelText instance-attribute

labelText: str

Qt 5 reference:

labelText : QString

This property holds the label's text

The default text is an empty string.

Access functions:

QString labelText() const
void setLabelText(const QString \&text)

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#labelText

maximum instance-attribute

maximum: int

Qt 5 reference:

maximum : int

This property holds the highest value represented by the progress bar

The default is 100.

Access functions:

int maximum() const
void setMaximum(int maximum)

See also minimum and setRange().

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#maximum

minimum instance-attribute

minimum: int

Qt 5 reference:

minimum : int

This property holds the lowest value represented by the progress bar

The default is 0.

Access functions:

int minimum() const
void setMinimum(int minimum)

See also maximum and setRange().

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#minimum

minimumDuration instance-attribute

minimumDuration: int

Qt 5 reference:

minimumDuration : int

This property holds the time that must pass before the dialog appears

If the expected duration of the task is less than the minimumDuration, the dialog will not appear at all. This prevents the dialog popping up for tasks that are quickly over. For tasks that are expected to exceed the minimumDuration, the dialog will pop up after the minimumDuration time or as soon as any progress is set.

If set to 0, the dialog is always shown as soon as any progress is set. The default is 4000 milliseconds.

Access functions:

int minimumDuration() const
void setMinimumDuration(int ms)

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#minimumDuration

objectNameChanged

objectNameChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QProgressDialog.objectNameChanged; argument details are not documented.

open

open() -> None

X.open()

Supplemental documentation: Qt 5 reference:

void QProgressDialog::open(QObject *receiver, const char *member)

Opens the dialog and connects its canceled() signal to the slot specified by receiver and member.

The signal will be disconnected from the slot when the dialog is closed.

This function was introduced in Qt 4.5.

Upstream PySide2 reference signatures (binding differences may apply):

open(self) -> None
open(self, receiver: PySide2.QtCore.QObject, member: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#open

rejected

rejected(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QProgressDialog.rejected; argument details are not documented.

reset

reset() -> None

X.reset()

Supplemental documentation: Qt 5 reference:

[slot] void QProgressDialog::reset()

Resets the progress dialog. The progress dialog becomes hidden if autoClose() is true.

See also setAutoClose() and setAutoReset().

Upstream PySide2 reference signatures (binding differences may apply):

reset(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#reset

resizeEvent

resizeEvent(event: Any) -> None

X.resizeEvent(event)

Supplemental documentation: Qt 5 reference:

[override virtual protected] void QProgressDialog::resizeEvent(QResizeEvent *event)

Reimplements: QDialog::resizeEvent(QResizeEvent *).

Upstream PySide2 reference signatures (binding differences may apply):

resizeEvent(self, event: PySide2.QtGui.QResizeEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#resizeEvent

setAutoClose

setAutoClose(close: bool) -> None

X.setAutoClose(close)

Upstream PySide2 reference signatures (binding differences may apply):

setAutoClose(self, close: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#setAutoClose

setAutoReset

setAutoReset(reset: bool) -> None

X.setAutoReset(reset)

Upstream PySide2 reference signatures (binding differences may apply):

setAutoReset(self, reset: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#setAutoReset

setBar

setBar(bar: Any) -> None

X.setBar(bar)

Supplemental documentation: Qt 5 reference:

void QProgressDialog::setBar(QProgressBar *bar)

Sets the progress bar widget to bar. The progress dialog resizes to fit. The progress dialog takes ownership of the progress bar which will be deleted when necessary, so do not use a progress bar allocated on the stack.

Upstream PySide2 reference signatures (binding differences may apply):

setBar(self, bar: PySide2.QtWidgets.QProgressBar) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#setBar

setCancelButton

setCancelButton(button: Any) -> None

X.setCancelButton(button)

Supplemental documentation: Qt 5 reference:

void QProgressDialog::setCancelButton(QPushButton *cancelButton)

Sets the cancel button to the push button, cancelButton. The progress dialog takes ownership of this button which will be deleted when necessary, so do not pass the address of an object that is on the stack, i.e. use new() to create the button. If nullptr is passed, no cancel button will be shown.

See also setCancelButtonText().

Upstream PySide2 reference signatures (binding differences may apply):

setCancelButton(self, button: PySide2.QtWidgets.QPushButton) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#setCancelButton

setCancelButtonText

setCancelButtonText(text: str) -> None

X.setCancelButtonText(text)

Supplemental documentation: Qt 5 reference:

[slot] void QProgressDialog::setCancelButtonText(const QString \&cancelButtonText)

Sets the cancel button's text to cancelButtonText. If the text is set to QString() then it will cause the cancel button to be hidden and deleted.

See also setCancelButton().

Upstream PySide2 reference signatures (binding differences may apply):

setCancelButtonText(self, text: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#setCancelButtonText

setLabel

setLabel(label: Any) -> None

X.setLabel(label)

Supplemental documentation: Qt 5 reference:

void QProgressDialog::setLabel(QLabel *label)

Sets the label to label. The progress dialog resizes to fit. The label becomes owned by the progress dialog and will be deleted when necessary, so do not pass the address of an object on the stack.

See also setLabelText().

Upstream PySide2 reference signatures (binding differences may apply):

setLabel(self, label: PySide2.QtWidgets.QLabel) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#setLabel

setLabelText

setLabelText(text: str) -> None

X.setLabelText(text)

Upstream PySide2 reference signatures (binding differences may apply):

setLabelText(self, text: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#setLabelText

setMaximum

setMaximum(maximum: int) -> None

X.setMaximum(maximum)

Upstream PySide2 reference signatures (binding differences may apply):

setMaximum(self, maximum: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#setMaximum

setMinimum

setMinimum(minimum: int) -> None

X.setMinimum(minimum)

Upstream PySide2 reference signatures (binding differences may apply):

setMinimum(self, minimum: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#setMinimum

setMinimumDuration

setMinimumDuration(ms: int) -> None

X.setMinimumDuration(ms)

Upstream PySide2 reference signatures (binding differences may apply):

setMinimumDuration(self, ms: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#setMinimumDuration

setRange

setRange(minimum: int, maximum: int) -> None

X.setRange(minimum, maximum)

Supplemental documentation: Qt 5 reference:

[slot] void QProgressDialog::setRange(int minimum, int maximum)

Sets the progress dialog'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 dialog is reset with reset().

See also minimum and maximum.

Upstream PySide2 reference signatures (binding differences may apply):

setRange(self, minimum: int, maximum: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#setRange

setValue

setValue(progress: int) -> None

X.setValue(progress)

Upstream PySide2 reference signatures (binding differences may apply):

setValue(self, progress: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#setValue

showEvent

showEvent(event: Any) -> None

X.showEvent(event)

Supplemental documentation: Qt 5 reference:

[override virtual protected] void QProgressDialog::showEvent(QShowEvent *e)

Reimplements: QDialog::showEvent(QShowEvent *event).

Upstream PySide2 reference signatures (binding differences may apply):

showEvent(self, event: PySide2.QtGui.QShowEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#showEvent

sizeHint instance-attribute

sizeHint: QSize

Qt 5 reference:

[override virtual] QSize QProgressDialog::sizeHint() const

Reimplements: QDialog::sizeHint() const.

Returns a size that fits the contents of the progress dialog. The progress dialog resizes itself as required, so you should not need to call this yourself.

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#sizeHint

value instance-attribute

value: int

Qt 5 reference:

value : int

This property holds the current amount of progress made.

For the progress dialog to work as expected, you should initially set this property to QProgressDialog::minimum() and finally set it to QProgressDialog::maximum(); you can call setValue() any number of times in-between.

Warning: If the progress dialog is modal (see QProgressDialog::QProgressDialog()), setValue() calls QCoreApplication::processEvents(), so take care that this does not cause undesirable re-entrancy in your code. For example, don't use a QProgressDialog inside a paintEvent()!

Access functions:

int value() const
void setValue(int progress)

See also minimum and maximum.

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#value

wasCanceled instance-attribute

wasCanceled: bool

Qt 5 reference:

wasCanceled : const bool

This property holds whether the dialog was canceled

Access functions:

bool wasCanceled() const

Source: https://doc.qt.io/archives/qt-5.15/qprogressdialog.html#wasCanceled

windowIconChanged

windowIconChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QProgressDialog.windowIconChanged; argument details are not documented.

windowIconTextChanged

windowIconTextChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QProgressDialog.windowIconTextChanged; argument details are not documented.

windowTitleChanged

windowTitleChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QProgressDialog.windowTitleChanged; argument details are not documented.