edifice.ProgressBar

edifice.ProgressBar#

class edifice.ProgressBar(value, min_value=0, max_value=100, format=None, orientation=Orientation.Horizontal, **kwargs)[source]#

Bases: QtWidgetElement

Progress bar widget.

A progress bar is used to give the user an indication of the progress of an operation.

The value prop indicates the progress from min_value to max_value.

If min_value and max_value both are set to 0, the bar shows a busy indicator instead of a percentage of steps.

Parameters:
  • value (int) – The progress.

  • min_value (int) – The starting progress.

  • max_value (int) – The ending progress.

  • format (Optional[str]) – The descriptive text format. See format.

  • orientation (Orientation) – The orientation of the bar, either Horizontal or Vertical. See Orientation.

Methods

__init__(value[, min_value, max_value, ...])

register_ref(reference)

Registers provided Reference to this Element.

set_key(key)

Sets the key of the Element.

Attributes

children

The children of this Element.

props

The props of this Element.

underlying

The underlying QWidget, which may not exist if this Element has not rendered.