Skip to main content

WindowsProgress

Progress bar shown in a Windows toast notification.

Set it as WindowsOptions.progress. To advance the bar without popping the toast up again, call Notifications.update_windows_progress.

Properties

  • indeterminate - Whether to show ongoing activity without a known completion amount.
  • label - Text shown instead of the percentage, such as "3/10" for discrete progress.
  • max - Value at which the progress bar is full.
  • status - Text describing the activity, such as "Downloading...".
  • title - Title shown above the progress bar.
  • value - Current progress, between 0 and max.

Properties​

indeterminateclass-attributeinstance-attribute​

indeterminate: bool = False

Whether to show ongoing activity without a known completion amount.

When True, value and max are ignored.

labelclass-attributeinstance-attribute​

label: str | None = None

Text shown instead of the percentage, such as "3/10" for discrete progress.

maxclass-attributeinstance-attribute​

max: int = 100

Value at which the progress bar is full.

statusinstance-attribute​

status: str

Text describing the activity, such as "Downloading...".

titleclass-attributeinstance-attribute​

title: str | None = None

Title shown above the progress bar.

valueclass-attributeinstance-attribute​

value: int = 0

Current progress, between 0 and max.