Fluent-Qt

Navigation

Breadcrumb

Shows the trail to the current location and lets people go back up the hierarchy.

Example

Breadcrumb: BreadcrumbSize

Usage

BreadcrumbSize

Standard uses the compact 20 px row; Large uses the 40 px row and larger item padding.

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

const QStringList path{"Home", "Documents", "Images"};

auto* standard = new Breadcrumb(this);
standard->setItems(path);
standard->setBreadcrumbSize(Breadcrumb::BreadcrumbSize::Standard);
standard->setFixedHeight(20);

auto* large = new Breadcrumb(this);
large->setItems(path);
large->setBreadcrumbSize(Breadcrumb::BreadcrumbSize::Large);
large->setFixedHeight(40);

fluent::navigation::Breadcrumb

Inherits QWidget · FluentElement · QMLPlus

Breadcrumb navigation control with overflow handling and item sizing.

Constructors

Properties

int itemCount

Number of items exposed by the navigation control.

Read itemCount()Notify itemsChanged()
BreadcrumbSize breadcrumbSize

Visual density used by breadcrumb items.

Read breadcrumbSize()Write setBreadcrumbSize()Notify breadcrumbSizeChanged()
OverflowMode overflowMode

Overflow behavior used by breadcrumb items.

Read overflowMode()Write setOverflowMode()Notify overflowModeChanged()
bool autoTruncateOnItemClick

Whether breadcrumb items collapse after item activation.

Read autoTruncateOnItemClick()Write setAutoTruncateOnItemClick()Notify autoTruncateOnItemClickChanged()
Typography::FontRole standardFontRole

Typography role used by standard breadcrumb items.

Read standardFontRole()Write setStandardFontRole()Notify standardFontRoleChanged()
Typography::FontRole largeFontRole

Typography role used by large breadcrumb items.

Read largeFontRole()Write setLargeFontRole()Notify largeFontRoleChanged()

Methods

int itemCount() const

Number of items exposed by the navigation control.

BreadcrumbSize breadcrumbSize() const

Visual density used by breadcrumb items.

void setBreadcrumbSize(BreadcrumbSize size)

Visual density used by breadcrumb items.

OverflowMode overflowMode() const

Overflow behavior used by breadcrumb items.

void setOverflowMode(OverflowMode mode)

Overflow behavior used by breadcrumb items.

bool autoTruncateOnItemClick() const

Whether breadcrumb items collapse after item activation.

void setAutoTruncateOnItemClick(bool enabled)

Whether breadcrumb items collapse after item activation.

Typography::FontRole standardFontRole() const

Typography role used by standard breadcrumb items.

void setStandardFontRole(Typography::FontRole role)

Typography role used by standard breadcrumb items.

Typography::FontRole largeFontRole() const

Typography role used by large breadcrumb items.

void setLargeFontRole(Typography::FontRole role)

Typography role used by large breadcrumb items.

Signals

void itemsChanged()

Number of items exposed by the navigation control.

void breadcrumbSizeChanged(BreadcrumbSize size)

Visual density used by breadcrumb items.

void overflowModeChanged(OverflowMode mode)

Overflow behavior used by breadcrumb items.

void autoTruncateOnItemClickChanged(bool enabled)

Whether breadcrumb items collapse after item activation.

void standardFontRoleChanged(Typography::FontRole role)

Typography role used by standard breadcrumb items.

void largeFontRoleChanged(Typography::FontRole role)

Typography role used by large breadcrumb items.

Enumerations

enum class OverflowMode
  • None
  • Beginning
  • Middle
Subclass interfaces

Methods

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.

QJsonObject themeOverrides() const

Returns this element's authored overrides.

void clearThemeOverrides()

Restores all token fields to global theme defaults.

const Colors& themeColorsRef() const

Non-copying access to the active color set (for hot paint paths).

Material::AcrylicToken themeAcrylic() const

Material, elevation, and adaptive layout tokens.

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.

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.

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 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

fluent::navigation::BreadcrumbItem

Constructors

Fields