Status & info

ProgressRing

Shows determinate or indeterminate progress around a ring.

Example

Usage

Active indeterminate sizes

An active indeterminate ProgressRing animates in small, medium, and large sizes.

#include <FluentQt/StatusInfo.h>
using namespace fluent::status_info;

auto* small = new ProgressRing(this);
small->setRingSize(ProgressRing::ProgressRingSize::Small);
small->setIsActive(true);

auto* large = new ProgressRing(this);
large->setRingSize(ProgressRing::ProgressRingSize::Large);
large->setIsActive(true);

import fluentqt

small = fluentqt.ProgressRing(row)
small.setRingSize(fluentqt.ProgressRing.ProgressRingSize.Small)
small.setIsActive(True)
medium = fluentqt.ProgressRing(row)
medium.setRingSize(fluentqt.ProgressRing.ProgressRingSize.Medium)
medium.setIsActive(True)
large = fluentqt.ProgressRing(row)
large.setRingSize(fluentqt.ProgressRing.ProgressRingSize.Large)
large.setIsActive(True)

API

Declaration

`fluent::status_info::ProgressRing`

Inherits QWidget · FluentElement · QMLPlus

Fluent circular progress indicator for active or indeterminate work.

Constructors

explicit ProgressRing(QWidget* parent = nullptr)

Properties

bool isActive: Whether progress animation is active.
Read isActive()Write setIsActive()Notify isActiveChanged()
bool animationEnabled: Whether indeterminate progress motion is enabled.
Read isAnimationEnabled()Write setAnimationEnabled()Notify animationEnabledChanged()
bool isIndeterminate: Whether the progress indicator uses indeterminate motion.
Read isIndeterminate()Write setIsIndeterminate()Notify isIndeterminateChanged()
int minimum: Lower bound used when calculating determinate ring progress.
Read minimum()Write setMinimum()Notify minimumChanged()
int maximum: Upper bound used when calculating determinate ring progress.
Read maximum()Write setMaximum()Notify maximumChanged()
int value: Current determinate ring value between minimum and maximum.
Read value()Write setValue()Notify valueChanged()
ProgressRingSize ringSize: Outer size of the progress ring.
Read ringSize()Write setRingSize()Notify ringSizeChanged()
qreal strokeWidth: Stroke width used by the progress ring.
Read strokeWidth()Write setStrokeWidth()Notify strokeWidthChanged()
ProgressRingStatus status: Semantic status used to choose visual treatment.
Read status()Write setStatus()Notify statusChanged()
bool backgroundVisible: Whether the inactive ring track is painted behind progress.
Read backgroundVisible()Write setBackgroundVisible()Notify backgroundVisibleChanged()

Methods

bool isActive() const: Whether progress animation is active.
void setIsActive(bool active): Whether progress animation is active.
bool isAnimationEnabled() const: Whether indeterminate progress motion is enabled.
void setAnimationEnabled(bool enabled): Whether indeterminate progress motion is enabled.
bool isIndeterminate() const: Whether the progress indicator uses indeterminate motion.
void setIsIndeterminate(bool indeterminate): Whether the progress indicator uses indeterminate motion.
int minimum() const: Lower bound used when calculating determinate ring progress.
void setMinimum(int minimum): Lower bound used when calculating determinate ring progress.
int maximum() const: Upper bound used when calculating determinate ring progress.
void setMaximum(int maximum): Upper bound used when calculating determinate ring progress.
void setRange(int minimum, int maximum)
int value() const: Current determinate ring value between minimum and maximum.
void setValue(int value): Current determinate ring value between minimum and maximum.
ProgressRingSize ringSize() const: Outer size of the progress ring.
void setRingSize(ProgressRingSize size): Outer size of the progress ring.
qreal strokeWidth() const: Stroke width used by the progress ring.
void setStrokeWidth(qreal width): Stroke width used by the progress ring.
ProgressRingStatus status() const: Semantic status used to choose visual treatment.
void setStatus(ProgressRingStatus status): Semantic status used to choose visual treatment.
bool backgroundVisible() const: Whether the inactive ring track is painted behind progress.
bool isBackgroundVisible() const
void setBackgroundVisible(bool visible): Whether the inactive ring track is painted behind progress.
double progressRatio() const
bool isAnimationRunning() const
QSize sizeHint() const override
QSize minimumSizeHint() const override
void onThemeUpdated() override

Signals

void isActiveChanged(bool active): Whether progress animation is active.
void animationEnabledChanged(bool enabled): Whether indeterminate progress motion is enabled.
void isIndeterminateChanged(bool indeterminate): Whether the progress indicator uses indeterminate motion.
void minimumChanged(int minimum): Lower bound used when calculating determinate ring progress.
void maximumChanged(int maximum): Upper bound used when calculating determinate ring progress.
void valueChanged(int value): Current determinate ring value between minimum and maximum.
void ringSizeChanged(ProgressRingSize size): Outer size of the progress ring.
void strokeWidthChanged(qreal width): Stroke width used by the progress ring.
void statusChanged(ProgressRingStatus status): Semantic status used to choose visual treatment.
void backgroundVisibleChanged(bool visible): Whether the inactive ring track is painted behind progress.

Enumerations

enum class ProgressRingSize: Small
Medium
Large
enum class ProgressRingStatus: Running
Paused
Error

Destructors

~ProgressRing() override

Subclass interfaces

Methods

void paintEvent(QPaintEvent* event) override
void timerEvent(QTimerEvent* event) override
void changeEvent(QEvent* event) override
void hideEvent(QHideEvent* event) override
void showEvent(QShowEvent* event) override

Inherited from fluent::FluentElement

Methods

static void setTheme(Theme theme): Updates the global theme and notifies active FluentElement instances.
static void setThemeDeferred(Theme theme): Schedules a visible-first batched theme refresh without blocking the current interaction.
static Theme currentTheme(): Returns the currently active global theme.
static bool themeUsesDarkAppearance(Theme theme): Returns whether a theme uses dark-backed chrome and material tokens.
static void refreshTheme(): Re-broadcasts the current theme to repaint after a design-token change.
static int themeGeneration(): Monotonic counter bumped on every theme change, for staleness checks.
Theme effectiveTheme() const: Resolves the theme used by this element, honoring an inherited QWidget override.
bool effectiveThemeUsesDarkAppearance() const: Returns whether this element's effective theme uses dark-backed chrome.
bool setThemeOverrides(const QJsonObject& overrides): Component-facing token accessors.
QJsonObject themeOverrides() const: Returns this element's authored overrides.
void clearThemeOverrides(): Restores all token fields to global theme defaults.
Colors themeColors() const
const Colors& themeColorsRef() const: Non-copying access to the active color set (for hot paint paths).
FontStyle themeFont(Typography::FontRole role = Typography::FontRole::Body) const
Radius themeRadius() const
Spacing themeSpacing() const
Animation themeAnimation() const
Material::AcrylicToken themeAcrylic() const: Material, elevation, and adaptive layout tokens.
Material::MicaToken themeMica() const
Material::SmokeToken themeSmoke() const
Elevation::ShadowParams themeShadow(Elevation::Level level) const
int themeBreakpoint(Breakpoints::Breakpoint breakpoint = Breakpoints::Breakpoint::Medium) const
QColor themeBackdrop(bool active) const: Window-chrome backdrop color for the given activation state.
virtual void onThemeUpdated(): Called after the global theme changes.

Enumerations

enum Theme: Global visual theme used when resolving design tokens.
Light = 0
Dark = 1
HighContrast = 2

Types and aliases

struct Colors: Design token snapshots returned to components.
struct FontStyle
struct Radius
struct Spacing
struct Animation

Inherited from fluent::QMLPlus

Methods

AnchorLayout::Anchors* anchors(): Returns mutable anchors for the QWidget host.
void setState(const QString& name): Applies a named state, or clears state when name is empty.
QString state() const
void addState(const QMLState& state): Registers or replaces a named state definition.
void evaluateStates(): Reevaluates conditions; the first registered true condition wins.
QMLPlusRuntime* runtime(): Returns the lazy host-owned state observation object.
void setAnchors(const AnchorLayout::Anchors& anchors): Replaces all host anchors and invalidates the parent layout.
void resetAnchors(): Clears all host anchors and invalidates the parent layout.
void bind(const char* targetProp, QObject* source, const char* sourceProp, PropertyBinder::Direction dir = PropertyBinder::OneWay): Binds a source property to a property on the QWidget host.
BindingHandle bindManaged(const char* targetProp, QObject* source, const char* sourceProp, PropertyBinder::Direction direction = PropertyBinder::OneWay, BindingOptions options = {}): Installs a managed direct binding on this QWidget host.
BindingHandle bindComputed(const char* targetProp, const QVector<BindingDependency>& dependencies, std::function<QVariant()> evaluate, BindingOptions options = {}): Installs an explicit-dependency C++ expression on this QWidget host.
void addTransition(const StateTransition& transition): Registers a state transition in precedence order.
void setBehavior(const char* propertyName, const PropertyAnimation& animation): Sets the default animation for this host's managed property writes.
void clearBehavior(const char* propertyName): Removes the default animation for future managed writes.
bool writeProperty(const char* propertyName, const QVariant& value): Writes a host property through Behavior without removing its binding.

All inherited Qt members：QWidget