Collections

TreeView

A control that presents hierarchical data with expandable nodes.

Example

Usage

Folder hierarchy

The essential tree: click a chevron to expand or collapse a folder, and selecting a row shows the accent indicator. A custom delegate paints the rotating chevron and per-row icon glyph.

#include <FluentQt/Collections.h>
using namespace fluent::collections;

auto* tree = new TreeView(this);
tree->setItemDelegate(new TreeRowDelegate(
    themeHost, rowHeight, tree, tree));
tree->setModel(model);
tree->setAccessibleName("Folders");
tree->expandAll();

import fluentqt

tree = fluentqt.TreeView()
tree.setAccessibleName('Folders')
tree.setItemDelegate(row_delegate)
tree.setModel(model)
tree.expandAll()

API

Declaration

`fluent::collections::TreeView`

Inherits QTreeView · FluentElement · QMLPlus

Fluent tree collection view with hierarchy-aware selection visuals.

Constructors

explicit TreeView(QWidget* parent = nullptr)

Properties

SelectionMode selectionMode: Selection mode used by the collection view.
Read selectionMode()Write setSelectionMode()Notify selectionModeChanged()
Typography::FontRole fontRole: Fluent typography role used for text rendering.
Read fontRole()Write setFontRole()Notify fontRoleChanged()
bool viewportHovered: Whether the item-view viewport is currently hovered.
Read viewportHovered()Notify viewportHoveredChanged()
qreal indicatorMotionProgress: Animated progress of the tree selection indicator.
Read indicatorMotionProgress()Notify indicatorMotionProgressChanged()
IndicatorVerticalDirection indicatorMotionDirection: Vertical direction used by tree indicator motion.
Read indicatorMotionDirection()Notify indicatorMotionDirectionChanged()
IndicatorHierarchyTransition indicatorHierarchyTransition: Hierarchy transition mode used by tree indicator motion.
Read indicatorHierarchyTransition()Notify indicatorHierarchyTransitionChanged()
bool indicatorMotionAnimationEnabled: Whether tree indicator motion animation is enabled.
Read isIndicatorMotionAnimationEnabled()Write setIndicatorMotionAnimationEnabled()Notify indicatorMotionAnimationEnabledChanged()
bool horizontalFluentScrollBarEnabled: Whether the Fluent horizontal scroll overlay is allowed to appear.
Read isHorizontalFluentScrollBarEnabled()Write setHorizontalFluentScrollBarEnabled()
bool borderVisible: Whether the control frame border is painted.
Read borderVisible()Write setBorderVisible()Notify borderVisibleChanged()
bool backgroundVisible: Whether the control background is painted.
Read backgroundVisible()Write setBackgroundVisible()Notify backgroundVisibleChanged()
QString headerText: Convenience text displayed in the header area.
Read headerText()Write setHeaderText()Notify headerTextChanged()
QString placeholderText: Text shown when the tree model has no rows to present.
Read placeholderText()Write setPlaceholderText()Notify placeholderTextChanged()
bool canReorderItems: Whether drag reordering is enabled.
Read canReorderItems()Write setCanReorderItems()Notify canReorderItemsChanged()
bool scrollChainingEnabled: Whether boundary wheel input may continue to an enclosing scroller.
Read isScrollChainingEnabled()Write setScrollChainingEnabled()Notify scrollChainingEnabledChanged()
bool overscrollEnabled: Whether the view shows an elastic overscroll/bounce at the scroll boundary. Enabled by default; disable for chrome (e.g. a navigation pane) that should stop cleanly at the edge so reversing the wheel scrolls again immediately.
Read isOverscrollEnabled()Write setOverscrollEnabled()Notify overscrollEnabledChanged()

Methods

QModelIndex indexAt(const QPoint& point) const override
void setModel(QAbstractItemModel* model) override
void setSelectionModel(QItemSelectionModel* selectionModel) override
SelectionMode selectionMode() const: --- Selection ---
void setSelectionMode(SelectionMode mode): Selection mode used by the collection view.
Typography::FontRole fontRole() const: --- Appearance ---
void setFontRole(Typography::FontRole role): Fluent typography role used for text rendering.
bool borderVisible() const: Whether the control frame border is painted.
bool isBorderVisible() const
void setBorderVisible(bool visible): Whether the control frame border is painted.
bool backgroundVisible() const: Whether the control background is painted.
bool isBackgroundVisible() const
void setBackgroundVisible(bool visible): Whether the control background is painted.
QString headerText() const: Convenience text displayed in the header area.
void setHeaderText(const QString& text): Convenience text displayed in the header area.
QString placeholderText() const: Text shown when the tree model has no rows to present.
void setPlaceholderText(const QString& text): Text shown when the tree model has no rows to present.
bool viewportHovered() const: Whether the item-view viewport is currently hovered.
bool isViewportHovered() const
bool canReorderItems() const: --- Drag reorder ---
void setCanReorderItems(bool enabled): Whether drag reordering is enabled.
bool isScrollChainingEnabled() const: Whether boundary wheel input may continue to an enclosing scroller.
void setScrollChainingEnabled(bool enabled): Whether boundary wheel input may continue to an enclosing scroller.
bool isOverscrollEnabled() const: Whether the view shows an elastic overscroll/bounce at the scroll boundary. Enabled by default; disable for chrome (e.g. a navigation pane) that should stop cleanly at the edge so reversing the wheel scrolls again immediately.
void setOverscrollEnabled(bool enabled): Whether the view shows an elastic overscroll/bounce at the scroll boundary. Enabled by default; disable for chrome (e.g. a navigation pane) that should stop cleanly at the edge so reversing the wheel scrolls again immediately.
void expandAll(): --- Tree API ---
void collapseAll()
void toggleExpanded(const QModelIndex& index)
QModelIndex selectedItem() const: --- Selection API ---
QModelIndexList selectedItems() const
void setSelectedItem(const QModelIndex& index)
qreal indicatorMotionProgress() const: --- Selected indicator motion API ---
IndicatorVerticalDirection indicatorMotionDirection() const: Vertical direction used by tree indicator motion.
IndicatorHierarchyTransition indicatorHierarchyTransition() const: Hierarchy transition mode used by tree indicator motion.
bool isIndicatorMotionAnimationEnabled() const: Whether tree indicator motion animation is enabled.
void setIndicatorMotionAnimationEnabled(bool enabled): Whether tree indicator motion animation is enabled.
qreal selectedIndicatorProgress(const QModelIndex& index) const
bool isIndicatorMotionActiveForIndex(const QModelIndex& index) const
QModelIndex indicatorMotionPreviousIndex() const
QModelIndex indicatorMotionCurrentIndex() const
QRectF selectedIndicatorRect() const: --- Selected indicator pill rendering ---
QRectF selectedIndicatorRect(qreal progress) const: Returns selected indicator geometry for a normalized transition progress.
SelectionIndicatorStyle selectionIndicatorStyle() const: Returns the style used by the selected indicator overlay.
void setSelectionIndicatorStyle(const SelectionIndicatorStyle& style): Sets the style used by the selected indicator overlay.
bool selectionIndicatorVisible() const: Whether the Fluent accent selection-indicator overlay is visible.
void setSelectionIndicatorVisible(bool visible)
qreal selectionIndicatorInset() const
void setSelectionIndicatorInset(qreal inset)
qreal selectionIndicatorHeight() const: Returns the height of the Fluent selection-indicator pill.
void setSelectionIndicatorHeight(qreal height): Sets the height of the Fluent selection-indicator pill.
::fluent::scrolling::ScrollBar* verticalFluentScrollBar() const
::fluent::scrolling::ScrollBar* horizontalFluentScrollBar() const
bool isHorizontalFluentScrollBarEnabled() const: Returns whether the Fluent horizontal scroll overlay may be shown.
void setHorizontalFluentScrollBarEnabled(bool enabled): Enables or disables the Fluent horizontal scroll overlay.
void refreshFluentScrollChrome()
qreal chevronRotation(const QModelIndex& index) const: Query chevron rotation progress for delegate painting. 0=right, 1=down.

Signals

void selectionModeChanged(): Selection mode used by the collection view.
void fontRoleChanged(): Fluent typography role used for text rendering.
void viewportHoveredChanged(): Whether the item-view viewport is currently hovered.
void borderVisibleChanged(): Whether the control frame border is painted.
void backgroundVisibleChanged(): Whether the control background is painted.
void headerTextChanged(): Convenience text displayed in the header area.
void placeholderTextChanged(): Text shown when the tree model has no rows to present.
void itemPressed(const QModelIndex& index): Mirrors the inherited pressed() signal for the same model index.
void itemClicked(const QModelIndex& index): Mirrors the inherited clicked() signal for the same model index.
void canReorderItemsChanged(): Whether drag reordering is enabled.
void scrollChainingEnabledChanged(): Whether boundary wheel input may continue to an enclosing scroller.
void overscrollEnabledChanged(): Whether the view shows an elastic overscroll/bounce at the scroll boundary. Enabled by default; disable for chrome (e.g. a navigation pane) that should stop cleanly at the edge so reversing the wheel scrolls again immediately.
void itemReordered(const QModelIndex& srcParent, int srcRow, const QModelIndex& dstParent, int dstRow)
void indicatorMotionProgressChanged(): Animated progress of the tree selection indicator.
void indicatorMotionDirectionChanged(): Vertical direction used by tree indicator motion.
void indicatorHierarchyTransitionChanged(): Hierarchy transition mode used by tree indicator motion.
void indicatorMotionAnimationEnabledChanged(): Whether tree indicator motion animation is enabled.
void selectionIndicatorStyleChanged()

Subclass interfaces

Methods

void paintEvent(QPaintEvent* event) override
void resizeEvent(QResizeEvent* event) override
void showEvent(QShowEvent* event) override
void enterEvent(FluentEnterEvent* event) override
void leaveEvent(QEvent* event) override
void mousePressEvent(QMouseEvent* event) override
void mouseMoveEvent(QMouseEvent* event) override
void mouseReleaseEvent(QMouseEvent* event) override
void wheelEvent(QWheelEvent* event) override
void currentChanged(const QModelIndex& current, const QModelIndex& previous) override
void selectionChanged(const QItemSelection& selected, const QItemSelection& deselected) override
int verticalOffset() const override
void drawRow(QPainter* painter, const QStyleOptionViewItem& options, const QModelIndex& index) const override
void drawBranches(QPainter* painter, const QRect& rect, const QModelIndex& index) const override
void onThemeUpdated() 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：QTreeView

`fluent::collections::TreeView::SelectionIndicatorStyle`

Style parameters used by the moving selection indicator overlay.

Example

Usage

Folder hierarchy

API

fluent::collections::TreeView

Constructors

Properties

Methods

Signals

Enumerations

Types and aliases

Destructors

PySide6 additions

Methods

Methods

Enumerations

Types and aliases

Methods

fluent::collections::TreeView::SelectionIndicatorStyle

Fields

`fluent::collections::TreeView`

`fluent::collections::TreeView::SelectionIndicatorStyle`