Widgets

ProgressBarWidget

class PySink.Widgets.ProgressBarWidget(parent=None)

Bases: QWidget

An implementation of a PySide6 Progress Bar. This has a couple helper functions that are natively compatible with PySink, allowing you to easily display the progress of an AsyncWorker.

Parameters:

parent (QWidget, optional) – The parent widget

reset() → None

Resets the state of the Progress Bar and clears current label text

set_text(message: str) → None

Sets the current progress message (this will only be displayed on Windows platforms). The text is overlaid on top of the progress bar…

Parameters:

message (str) – The current progress message

set_value(progress_value: int | float) → None

Sets the current progress value…

Parameters:

progress_value (Union[int, float]) – The current progress value. For discrete behavior, value should be in [0, 100]. For indeterminate behavior, value should be less than 0

update_progress(progress: AsyncWorkerProgress) → None

Updates the current progress to be displayed. This is natively emitted by an AsyncWorker (and the AsyncManager), so the emitted progress can be passed directly to this method…

Parameters:

progress (AsyncWorkerProgress) – The current progress