Navigation

Stepper

Presents application-controlled steps with completion, error and availability states.

Example

Usage

Application-controlled steps

Click a step to request navigation. Completion, errors and availability stay independent of the current step.

#include <FluentQt/Navigation.h>
using namespace fluent::navigation;

auto* stepper = new Stepper(this);
for (int i = 0; i < 4; ++i) {
    StepperItem item(QString("Step %1").arg(i + 1), "Optional description");
    if (i == 0) item.state = Stepper::Completed;
    if (i == 3) item.enabled = false;
    stepper->addItem(item);
}
stepper->setCurrentIndex(1);
connect(stepper, &Stepper::stepRequested, stepper, &Stepper::setCurrentIndex);
connect(stepper, &Stepper::currentIndexChanged, statusLabel, [statusLabel](int i) {
    statusLabel->setText(QString("Current step: %1").arg(i + 1));
});
connect(toggleError, &Button::clicked, stepper, [stepper] {
    stepper->setItemState(1, stepper->itemAt(1).state == Stepper::Error ? Stepper::Pending : Stepper::Error);
});

import fluentqt

stepper = fluentqt.Stepper()
states = fluentqt.Stepper.State
for i in range(4):
    item = fluentqt.StepperItem(f'Step {i + 1}', 'Optional description')
    if i == 0:
        item.state = states.Completed
    if i == 3:
        item.enabled = False
    stepper.addItem(item)
stepper.setCurrentIndex(1)
stepper.stepRequested.connect(stepper.setCurrentIndex)
def update_status(index):
    status.setText(f'Current step: {index + 1}')
stepper.currentIndexChanged.connect(update_status)
toggle = fluentqt.Button('Toggle step 2 error')
def toggle_error():
    error = stepper.itemAt(1).state == states.Error
    stepper.setItemState(1, states.Pending if error else states.Error)
toggle.clicked.connect(toggle_error)

API

Declaration

`fluent::navigation::Stepper`

Inherits QWidget · FluentElement · QMLPlus

Presents application-controlled steps without owning pages or workflow rules.

Subclass interfaces

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.

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

Stepper

Example

Usage

Application-controlled steps

API

`fluent::navigation::Stepper`

Constructors

Properties

Methods

Signals

Enumerations

Destructors

Methods

Methods

Enumerations

Types and aliases

Methods

`fluent::navigation::StepperItem`

Constructors

Methods

Fields