Navigation

Pivot

Header-based navigation between peer views with an animated indicator.

Example

Usage

Pivot with hosted pages

Selecting a pivot item changes the external StackContentHost page; disabled items stay visible but cannot be selected.

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

auto* pivot = new Pivot(this);
pivot->addItem({"All", Typography::Icons::Mail});
pivot->addItem({"Unread", Typography::Icons::Filter});
pivot->addItem({"Flagged", Typography::Icons::Flag});
pivot->addItem({"Locked", Typography::Icons::Lock, false});
pivot->addItem({"Mentions", Typography::Icons::Contact});

auto* host = new StackContentHost(this);
for (int i = 0; i < pivot->itemCount(); ++i)
    host->insertPage(i, createPage(pivot->itemAt(i).header));

connect(pivot, &Pivot::currentChanged,
        host, [host](int index) { host->setCurrentIndex(index, 0, true); });

import fluentqt

pivot = fluentqt.Pivot()
pivot.addItem(fluentqt.PivotItem("All", fluentqt.Typography.Icons.Mail))
pivot.addItem(fluentqt.PivotItem("Unread", fluentqt.Typography.Icons.Filter))
pivot.addItem(fluentqt.PivotItem("Flagged", fluentqt.Typography.Icons.Flag))
pivot.addItem(fluentqt.PivotItem("Locked", fluentqt.Typography.Icons.Lock, False))
pivot.addItem(fluentqt.PivotItem("Mentions", fluentqt.Typography.Icons.Contact))

host = fluentqt.StackContentHost()
for index in range(pivot.itemCount()):
    host.insertOwnedPage(index, create_page(pivot.itemAt(index).header))

pivot.currentChanged.connect(lambda index: host.setCurrentIndex(index, 0, True))

API

Declaration

`fluent::navigation::Pivot`

Inherits QWidget · FluentElement · QMLPlus

Pivot-style horizontal navigation selector.

Properties

int itemCount: Number of items exposed by the navigation control.
Read itemCount()Notify itemCountChanged()
int selectedIndex: Currently selected item index.
Read selectedIndex()Write setSelectedIndex()Notify selectedIndexChanged()
OverflowBehavior overflowBehavior: How the control handles items that exceed available width.
Read overflowBehavior()Write setOverflowBehavior()Notify overflowBehaviorChanged()
Typography::FontRole itemFontRole: Typography role used by selector items.
Read itemFontRole()Write setItemFontRole()Notify itemFontRoleChanged()
QString iconFontFamily: Iconfont family used for glyph rendering.
Read iconFontFamily()Write setIconFontFamily()Notify iconFontFamilyChanged()

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

Pivot

Example

Usage

Pivot with hosted pages

API

`fluent::navigation::Pivot`

Constructors

Properties

Methods

Signals

Enumerations

Destructors

Methods

Methods

Enumerations

Types and aliases

Methods

`fluent::navigation::PivotItem`

Constructors

Fields