Skip to content

progress_card

_progress_card

Task progress card widget.

Classes:

Name Description
FXProgressCard

A card widget showing task/step progress.

Classes

FXProgressCard

FXProgressCard(
    parent: Optional[QWidget] = None,
    title: str = "Task",
    description: Optional[str] = None,
    progress: int = 0,
    status: Optional[int] = None,
    show_percentage: bool = True,
    icon: Optional[str] = None,
)

Bases: FXThemeAware, QFrame


              flowchart TD
              fxgui.fxwidgets._progress_card.FXProgressCard[FXProgressCard]
              fxgui.fxstyle.FXThemeAware[FXThemeAware]

                              fxgui.fxstyle.FXThemeAware --> fxgui.fxwidgets._progress_card.FXProgressCard
                


              click fxgui.fxwidgets._progress_card.FXProgressCard href "" "fxgui.fxwidgets._progress_card.FXProgressCard"
              click fxgui.fxstyle.FXThemeAware href "" "fxgui.fxstyle.FXThemeAware"
            

A card widget showing task/step progress.

This widget provides a styled card with: - Title and description - Progress bar or circular progress - Status icon - Perfect for pipeline tools and task tracking

Parameters:

Name Type Description Default
parent
Optional[QWidget]

Parent widget.

None
title
str

Card title.

'Task'
description
Optional[str]

Optional description text.

None
progress
int

Initial progress value (0-100).

0
status
Optional[int]

Status icon type (SUCCESS, ERROR, WARNING, INFO, etc.).

None
show_percentage
bool

Whether to show percentage text.

True
icon
Optional[str]

Optional icon name to display next to the title.

None
Signals

progress_changed: Emitted when progress changes. completed: Emitted when progress reaches 100%.

Examples:

>>> card = FXProgressCard(
...     title="Rendering",
...     description="Frame 50/100",
...     progress=50
... )
>>> card.set_progress(75)

Methods:

Name Description
increment

Increment the progress by a given amount.

reset

Reset progress to 0.

set_description

Set the card description.

set_progress

Set the progress value.

set_status

Set the status icon.

set_title

Set the card title.

Attributes:

Name Type Description
progress int

Return the current progress value.

Attributes
progress property writable
progress: int

Return the current progress value.

Functions
increment
increment(amount: int = 1) -> None

Increment the progress by a given amount.

Parameters:

Name Type Description Default
amount int

Amount to increment (default 1).

1
reset
reset() -> None

Reset progress to 0.

set_description
set_description(description: str) -> None

Set the card description.

Parameters:

Name Type Description Default
description str

The new description.

required
set_progress
set_progress(value: int) -> None

Set the progress value.

Parameters:

Name Type Description Default
value int

Progress value (0-100).

required
set_status
set_status(status: Optional[int]) -> None

Set the status icon.

Parameters:

Name Type Description Default
status Optional[int]

Status constant (SUCCESS, ERROR, WARNING, etc.) or None.

required
set_title
set_title(title: str) -> None

Set the card title.

Parameters:

Name Type Description Default
title str

The new title.

required